0023959: Getting rid of generic classes in Visualization: generic classes were remove...
[occt.git] / src / Prs3d / Prs3d.cdl
1 -- Created on: 1992-08-26
2 -- Created by: Jean Louis FRENKEL
3 -- Copyright (c) 1992-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22 package Prs3d
23
24         ---Purpose: The Prs3d package provides the following services
25         -- -   a presentation object (the context for all
26         --   modifications to the display, its presentation will be
27         --   displayed in every view of an active viewer)
28         -- -   an attribute manager governing how objects such
29         --   as color, width, and type of line are displayed;
30         --   these are generic objects, whereas those in
31         --   StdPrs are specific geometries and topologies.
32         -- -   generic   algorithms providing default settings for
33         --   objects such as points, curves, surfaces and shapes
34         -- -   a root object which provides the abstract
35         --   framework for the DsgPrs definitions at work in
36         --   display of dimensions, relations and trihedra.
37     
38 uses
39   Graphic3d,
40   Aspect,
41   Quantity,
42   MMgt,
43   Standard,
44   Adaptor3d,
45   BRepAdaptor,
46   Geom,
47   CPnts,
48   GCPnts,
49   TopAbs,
50   TopLoc,
51   TopoDS,
52   TopTools,
53   TopExp,
54   HLRAlgo,
55   TCollection,
56   TColgp,
57   Bnd,
58   gp,
59   Poly,
60   TColStd
61 is  
62   exception InvalidAngle inherits RangeError from Standard;
63
64   enumeration TypeOfLinePicking is TOLP_Point,
65                                    TOLP_Segment
66   end TypeOfLinePicking;
67         
68   enumeration TypeOfHLR is TOH_NotSet,
69                            TOH_PolyAlgo,
70                            TOH_Algo;
71   ---Purpose: Declares types of hidden line removal algorithm.
72   --          TOH_Algo enables using of exact HLR algorithm.
73   --          TOH_PolyAlgo enables using of polygonal HLR algorithm.
74   --          TOH_NotSet is used by AIS_Drawer class, it means that the drawer should return the global value.
75   --          For more details see AIS_Drawer class, AIS_Shape::Compute() method and
76   --          HLRAlgo package from TKHLR toolkit.
77
78   class Presentation;
79   ---Purpose: defines the presentation object. This object can be
80   --          displayed, highlighted, erased, etc... The output
81   --          of the presentation algorithms are sent in a
82   --          presentation object. A presentation object is attached
83   --          to a given Viewer.
84
85         ---Category: Aspect classes.
86         ---Purpose: The aspect classes qualifies how to represent
87         --          a given kind of object.
88         --          
89
90   deferred class BasicAspect;   
91   class PointAspect;
92   class LineAspect;
93         class ShadingAspect;
94         class TextAspect;
95   deferred class CompositeAspect;       
96   class IsoAspect;
97         class PlaneAspect;
98   class ArrowAspect;    
99         class LengthAspect;
100         class AngleAspect;
101         class RadiusAspect;
102         class DatumAspect;
103
104   class Drawer;
105         ---Purpose: qualifies how the presentation algorithms compute
106         --          the presentation of a specific kind of object. 
107         --          This includes for example color, width and type
108         --          of lines, maximal chordial deviation, etc...
109         --          A drawer includes an instance of the Aspect classes
110         --          with particular default values.
111         
112   class Projector;
113         ---Purpose: defines the projection parameters for the hidden
114         --          lines removal algorithm.
115         
116   class PlaneSet;
117         ---Purpose: defines a set of planes used for a presentation
118         --          by sections.
119         -- 
120
121   deferred class Root;
122         ---Purpose: defines the root of the presentation algorithms.
123
124   ---Category: Basis construction elements.
125
126   class LengthPresentation;
127
128         class AnglePresentation;
129
130         class Text;
131
132         ---Category: Class signatures.
133
134         class ShapeTool;
135         ---Purpose: describes the behaviour requested for a wireframe
136         --          shape presentation.
137
138   class Arrow;
139         ---Purpose: draws an arrow at a given location, with respect
140         --          to a given direction. 
141
142   imported NListOfSequenceOfPnt; 
143   imported NListIteratorListOfSequenceOfPnt;
144   imported Point;
145   imported WFShape;
146   
147   MatchSegment(X,Y,Z: Length from Quantity;
148                     aDistance: Length from Quantity;
149                           p1,p2: Pnt from gp;
150               dist: out Length from Quantity)
151         returns Boolean from Standard;
152 end Prs3d;