0024343: AIS_DisplayStatus - outdated description
[occt.git] / src / AIS / AIS.cdl
index b1885a7..087521e 100755 (executable)
@@ -1,8 +1,23 @@
--- File:       AIS.cdl
--- Created:    Wed Dec 11 11:16:37 1996
--- Author:     Robert COUBLANC
---             <rob@robox.paris1.matra-dtv.fr>
----Copyright:   Matra Datavision 1996
+-- Created on: 1996-12-11
+-- Created by: Robert COUBLANC
+-- Copyright (c) 1996-1999 Matra Datavision
+-- Copyright (c) 1999-2012 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.
+--
+-- 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.
+--
+-- 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.
+
 
 
 package AIS 
@@ -126,7 +141,6 @@ uses
     Geom,
     Bnd,
     Aspect,
-    Graphic2d,
     Graphic3d,
     V3d,
     TopAbs,
@@ -143,7 +157,7 @@ uses
 is
     
     
-    enumeration DisplayMode is WireFrame, Shaded, QuickHLR, ExactHLR;
+    enumeration DisplayMode is WireFrame, Shaded;
         ---Purpose:
         -- Sets display modes other than neutral point ones,
         -- for interactive objects. The possibilities include:
@@ -175,7 +189,6 @@ is
     enumeration DisplayStatus is 
     DS_Displayed,  
     DS_Erased,     
-    DS_FullErased,
     DS_Temporary, 
     DS_None;     
         ---Purpose:
@@ -183,9 +196,7 @@ is
         -- This will be one of the following:
         -- -   DS_Displayed: the Interactive Object is
         --   displayed in the main viewer;
-        -- -   DS_Erased: the Interactive Object is erased in the collector;
-        -- -   DS_FullErased: the Interactive Object is erased
-        --   but not in the collector;
+        -- -   DS_Erased: the Interactive Object is hidden in main viewer;
         -- -   DS_Temporary: the Interactive Object is temporarily displayed;
         -- -   DS_None: the Interactive Object is nowhere displayed.
         
@@ -262,7 +273,7 @@ is
         -- for example, are only created for the selection
         -- process. By means of these enumerations, they can
         -- be cleared from local context.
-        
+
     enumeration KindOfUnit is 
     TOU_LENGTH,
     TOU_SURFACE,
@@ -272,19 +283,19 @@ is
     TOU_MASS,
     TOU_FORCE,
     TOU_TIME;
-        ---Purpose: Declares the type of Interactive Object unit.
-        
+    ---Purpose: Declares the type of Interactive Object unit.
+
     enumeration TypeOfAxis is TOAX_Unknown,TOAX_XAxis,TOAX_YAxis,TOAX_ZAxis;
-        ---Purpose: Declares the type of axis.
-        
+    ---Purpose: Declares the type of axis.
+
     enumeration TypeOfPlane is TOPL_Unknown,TOPL_XYPlane,TOPL_XZPlane,TOPL_YZPlane;
-        ---Purpose: Declares the type of plane.
+     ---Purpose: Declares the type of plane.
     enumeration TypeOfDist is TOD_Unknown,TOD_Horizontal,TOD_Vertical;
----Purpose: To declare the type of distance.
-    
+    ---Purpose: To declare the type of distance.
+
     enumeration TypeOfAttribute is 
     TOA_Line,
-    TOA_Angle,
+    TOA_Dimension,
     TOA_Wire,
     TOA_Plane,
     TOA_Vector,
@@ -298,16 +309,21 @@ is
     TOA_FirstAxis,
     TOA_SecondAxis,
     TOA_ThirdAxis;
-    
-    enumeration StandardDatum is SD_None,SD_Point,SD_Axis,SD_Trihedron,SD_PlaneTrihedron,SD_Line,SD_Circle,SD_Plane;
-       --- Purpose: Declares the type of standard datum of an Interactive Object. 
 
--- New ------------------------------------------------
+    enumeration StandardDatum is SD_None,SD_Point,SD_Axis,SD_Trihedron,SD_PlaneTrihedron,SD_Line,SD_Circle,SD_Plane;
+    --- Purpose: Declares the type of standard datum of an Interactive Object. 
 
     enumeration KindOfSurface is KOS_Plane, KOS_Cylinder, KOS_Cone, KOS_Sphere, KOS_Torus,
-               KOS_Revolution, KOS_Extrusion, KOS_OtherSurface;
--------------------------------------------------------    
-   
+                                 KOS_Revolution, KOS_Extrusion, KOS_OtherSurface;
+
+-- Enumerations for dimensions management --
+
+    enumeration DisplaySpecialSymbol is DSS_No, DSS_Before, DSS_After;
+    ---Purpose: Specifies dimension special symbol display options
+
+    enumeration DimensionDisplayMode is DDM_All, DDM_Line, DDM_Text;
+    ---Purpose: Specifies dimension display modes for advanced highlighting and selection.
+
     class Triangulation;
 
     class TexturedShape;
@@ -361,10 +377,10 @@ is
     deferred class EllipseRadiusDimension; 
     class MaxRadiusDimension; 
     class MinRadiusDimension; 
-    class LengthDimension;
-    class AngleDimension;
-    class RadiusDimension;
-    class DiameterDimension;
+    imported LengthDimension;
+    imported AngleDimension;
+    imported RadiusDimension;
+    imported DiameterDimension;
     class Chamf2dDimension;
     class Chamf3dDimension;
     class OffsetDimension;