0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / AIS / AIS_Circle.cdl
old mode 100755 (executable)
new mode 100644 (file)
index 9b8e5df..ad53755
@@ -1,25 +1,18 @@
 -- Created on: 1997-01-21
 -- Created by: Prestataire Christiane ARMAND
 -- Copyright (c) 1997-1999 Matra Datavision
--- Copyright (c) 1999-2012 OPEN CASCADE SAS
+-- Copyright (c) 1999-2014 OPEN CASCADE SAS
 --
--- The content of this file is subject to the Open CASCADE Technology Public
--- License Version 6.5 (the "License"). You may not use the content of this file
--- except in compliance with the License. Please obtain a copy of the License
--- at http://www.opencascade.org and read it completely before using this file.
+-- This file is part of Open CASCADE Technology software library.
 --
--- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
--- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
+-- This library is free software; you can redistribute it and/or modify it under
+-- the terms of the GNU Lesser General Public License version 2.1 as published
+-- by the Free Software Foundation, with special exception defined in the file
+-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+-- distribution for complete text of the license and disclaimer of any warranty.
 --
--- The Original Code and all software distributed under the License is
--- distributed on an "AS IS" basis, without warranty of any kind, and the
--- Initial Developer hereby disclaims all such warranties, including without
--- limitation, any warranties of merchantability, fitness for a particular
--- purpose or non-infringement. Please see the License for the specific terms
--- and conditions governing the rights and limitations under the License.
-
---   GG  :  GER61351 17/11/1999 Change SetColor() with a compatible Quantity_Color instead
---                                    the restricted NameOfColor.
+-- Alternatively, this file may be used under the terms of Open CASCADE
+-- commercial license or contractual agreement.
 
 class Circle from AIS inherits InteractiveObject from AIS
 
@@ -42,34 +35,34 @@ uses
 
 is
     Create(aCircle : Circle from Geom) 
-    returns mutable Circle from AIS;
+    returns Circle from AIS;
        ---Purpose: Initializes this algorithm for constructing AIS circle
        -- datums initializes the circle aCircle
-    Create(aCircle : Circle from Geom;
-          aUStart : Real from Standard;
-          aUEnd   : Real from Standard;
-          aSens   : Boolean from Standard = Standard_True) 
-    returns mutable Circle from AIS;
-       ---Purpose: Initializes this algorithm for constructing AIS circle datums.    
-       -- Initializes the circle aCircle, the arc
-       --   starting point UStart, the arc ending point UEnd,
-       --   and the direction aSens.
+    Create(theCircle : Circle from Geom;
+           theUStart : Real from Standard;
+           theUEnd   : Real from Standard;
+           theIsFilledCircleSens : Boolean from Standard = Standard_False) 
+    returns Circle from AIS;
+    ---Purpose: Initializes this algorithm for constructing AIS circle datums.    
+    -- Initializes the circle theCircle, the arc
+    --   starting point theUStart, the arc ending point theUEnd,
+    --   and the type of sensitivity theIsFilledCircleSens.
 
     Compute(me            : mutable;
            aPresentationManager: PresentationManager3d from PrsMgr;
-           aPresentation : mutable Presentation from Prs3d;
+           aPresentation : Presentation from Prs3d;
            aMode         : Integer from Standard = 0) 
     is redefined static  private;
     
     Compute(me:mutable;
                aProjector: Projector from Prs3d;
-                aPresentation: mutable Presentation from Prs3d)
+                aPresentation: Presentation from Prs3d)
     is redefined static private;     
 
     Compute(me            : mutable;
             aProjector    : Projector from Prs3d;
             aTrsf         : Transformation from Geom;
-            aPresentation : mutable Presentation from Prs3d)
+            aPresentation : Presentation from Prs3d)
     is redefined;
         ---Purpose: computes the presentation according to a point of view
         --          given by <aProjector>.
@@ -82,7 +75,7 @@ is
 -- Methods from SelectableObject
 
     ComputeSelection(me         : mutable;
-                    aSelection : mutable Selection from SelectMgr;
+                    aSelection : Selection from SelectMgr;
                     aMode      : Integer from Standard)is private;
 
  
@@ -136,21 +129,30 @@ is
     is redefined static; 
        ---Purpose: Removes width settings from the solid line boundary of the circle datum.
 
+    IsFilledCircleSens (me) returns Boolean from Standard;
+    ---C++: inline
+    ---Purpose: Returns the type of sensitivity for the circle;
+
+    SetFilledCircleSens (me: mutable;
+                         theIsFilledCircleSens : Boolean from Standard);
+    ---C++: inline
+    ---Purpose: Sets the type of sensitivity for the circle. If theIsFilledCircleSens set to Standard_True
+    -- then the whole circle will be detectable, otherwise only the boundary of the circle.
 
     ComputeCircle(me: mutable;
-                  aPresentation : mutable Presentation from Prs3d)
+                  aPresentation : Presentation from Prs3d)
     is private;
      
     ComputeArc(me: mutable;
-               aPresentation : mutable Presentation from Prs3d)
+               aPresentation : Presentation from Prs3d)
     is private;
 
     ComputeCircleSelection(me: mutable;
-                           aSelection : mutable Selection from SelectMgr)
+                           aSelection : Selection from SelectMgr)
     is private;
      
     ComputeArcSelection(me: mutable;
-                        aSelection : mutable Selection from SelectMgr)
+                        aSelection : Selection from SelectMgr)
     is private;
 
 fields
@@ -159,6 +161,6 @@ fields
     myUStart      : Real    from Standard;
     myUEnd        : Real    from Standard;
     myCircleIsArc : Boolean from Standard;
-    mySens        : Boolean from Standard;
+    myIsFilledCircleSens : Boolean from Standard;
     
 end Circle ;