0024133: Development of improvement of dimensions implementation; new length, radius...
[occt.git] / src / AIS / AIS_DimensionOwner.cdl
index c52f2a4..bc96076 100755 (executable)
 
 class DimensionOwner from AIS inherits EntityOwner from SelectMgr
 
-       ---Purpose: The owner is the entity which makes it possible to link
-       -- the sensitive primitives and the reference shapes that
-       -- you want to detect. It stocks the various pieces of
-       -- information which make it possible to find objects. An
-       -- owner has a priority which you can modulate, so as to
-       -- make one entity more selectable than another. You
-       -- might want to make edges more selectable than
-       -- faces, for example. In that case, you could attribute sa
-       -- higher priority to the one compared to the other. An
-       -- edge, could have priority 5, for example, and a face,
-       -- priority 4. The default priority is 5.
+  ---Purpose: The owner is the entity which makes it possible to link
+    -- the sensitive primitives and the reference shapes that
+    -- you want to detect. It stocks the various pieces of
+    -- information which make it possible to find objects. An
+    -- owner has a priority which you can modulate, so as to
+    -- make one entity more selectable than another. You
+    -- might want to make edges more selectable than
+    -- faces, for example. In that case, you could attribute sa
+    -- higher priority to the one compared to the other. An
+    -- edge, could have priority 5, for example, and a face,
+    -- priority 4. The default priority is 5.
 
 uses
 
-    SelectableObject from SelectMgr,
-    Shape            from TopoDS
+    SelectableObject      from SelectMgr,
+    PresentationManager   from PrsMgr,
+    PresentationManager3d from PrsMgr,
+    NameOfColor           from Quantity,
+    DimensionDisplayMode  from AIS
 
 is
 
-    Create ( aSO      : SelectableObject;
-            aPriority : Integer from Standard =0)
+    Create (theSelObject  : SelectableObject;
+            theDisplayMode    : DimensionDisplayMode from AIS;
+            thePriority   : Integer from Standard = 0)
     returns mutable DimensionOwner from AIS;
-       ---Purpose:
-       -- Initializes the dimension owner, aSO, and attributes it
-       -- the priority, aPriority.    
-    
-    SetShape(me : mutable; aShape : Shape from TopoDS);
-        ---C++: inline
-       ---Purpose:
-       -- Constructs the reference shape owner aShape for
-       -- presentation primitives.
-    
-    FixedShape(me)
-        ---C++: return const &
-       ---C++: inline    
-       ---Purpose:
-       -- Returns the owner shape whose primitives we are concerned with.   
-    returns Shape from TopoDS;
-    
+      ---Purpose:
+      -- Initializes the dimension owner, theSO, and attributes it
+      -- the priority, thePriority.
 
+    SetDisplayMode (me : mutable; theMode : DimensionDisplayMode from AIS);
+
+    DisplayMode (me)
+    returns DimensionDisplayMode from AIS;
+
+    HilightWithColor (me       : mutable;
+                      thePM    : PresentationManager3d from PrsMgr;
+                      theColor : NameOfColor from Quantity;
+                      theMode  : Integer  from  Standard = 0)
+    is redefined virtual;
+
+    IsHilighted (me;
+                 thePM   : PresentationManager from PrsMgr;
+                 theMode : Integer  from  Standard  =0)
+    returns Boolean from Standard is redefined virtual;
+    ---Purpose: Returns true if an object with the selection mode
+    -- aMode is highlighted in the presentation manager aPM.
+
+    Hilight(me    : mutable;
+            thePM   : PresentationManager from PrsMgr;
+            theMode : Integer  from  Standard  =0) is redefined virtual;
+
+    Unhilight(me    : mutable;
+              thePM   : PresentationManager from PrsMgr;
+              theMode : Integer  from  Standard  =0) is redefined virtual;
+    ---Purpose: Removes highlighting from the selected part of dimension.
 fields
 
-    myFixedShape : Shape from TopoDS;
+    myDisplayMode : DimensionDisplayMode from AIS;
 
 end DimensionOwner;
-