0024157: Parallelization of assembly part of BO
[occt.git] / src / DrawTrSurf / DrawTrSurf.cdl
1 -- Created on: 1991-06-24
2 -- Created by: Christophe MARION
3 -- Copyright (c) 1991-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
23
24 package DrawTrSurf 
25
26         ---Purpose: This  package supports the   display of parametric
27         --          curves and surfaces.
28         --          
29         --          The  Drawable deferred  classes is  inherited from
30         --          the Drawable3D  class  from  the package Draw,  it
31         --          adds methods to  draw 3D Curves  and  Curves on 3D
32         --          Surfaces.
33         --          
34         --          The classes Curve Curve2d and Surface are drawable
35         --          and  can be  used  to  draw a   single  curve from
36         --          packages Geom or Geom2d or a surface from Geom.
37         --          
38         --          The  Triangulation  and Polygon  from the  package
39         --          Poly are also supported.
40
41 uses
42    MMgt,
43    TCollection,
44    TColStd,
45    Draw,
46    Adaptor3d,
47    Adaptor2d,
48    GeomAbs,
49    Geom,
50    Geom2d,
51    gp,
52    Poly
53
54 is
55     
56    deferred class Drawable;
57    
58    class Point;
59    
60    class Curve;
61    
62       class BSplineCurve;
63       
64       class BezierCurve;
65       
66
67    class Curve2d;
68    
69       class BSplineCurve2d;
70       
71       class BezierCurve2d;
72
73    class Triangulation2D;
74
75    class Surface;
76
77       class BSplineSurface;
78
79       class BezierSurface;
80
81    class Triangulation;
82
83    class Polygon3D;
84
85    class Polygon2D;
86
87
88     --     
89     -- package methods to handle named points curves and surface.
90     -- 
91
92     Set(Name : CString; G : Pnt from gp);
93         ---Purpose: Sets <G> in the variable <Name>.  Overwrite the
94         --          variable if already set.
95     
96     Set(Name : CString; G : Pnt2d from gp);
97         ---Purpose: Sets <G> in the variable <Name>.  Overwrite the
98         --          variable if already set.
99     
100     Set(Name : CString; G : Geometry from Geom;
101         isSenseMarker : Boolean = Standard_True);
102         ---Purpose: Sets <G> in the variable <Name>.  Overwrite the
103         --          variable if already set.
104   --          isSenseMarker indicates whether to render the
105   --          sense glyph (arrow) for curves or not
106     
107     Set(Name : CString; C : Curve from Geom2d;
108         isSenseMarker : Boolean = Standard_True);
109         ---Purpose: Sets <C> in the variable <Name>.  Overwrite the
110         --          variable if already set.
111   --          isSenseMarker indicates whether to render the
112   --          sense glyph (arrow) for curves or not
113     
114     Set(Name : CString; T : Triangulation from Poly);
115         ---Purpose: Sets <T> in the variable <Name>.  Overwrite the
116         --          variable if already set.
117     
118     Set(Name : CString; P : Polygon3D from Poly);
119         ---Purpose: Sets <P> in the variable <Name>.  Overwrite the
120         --          variable if already set.
121     
122     Set(Name : CString; P : Polygon2D from Poly);
123         ---Purpose: Sets <P> in the variable <Name>.  Overwrite the
124         --          variable if already set.
125     
126     
127     -- if the variable name is a void string a graphic selection is made.
128     
129     Get(Name : in out CString) returns Geometry from Geom;
130         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
131         --          none, and print a warning message.
132
133     GetPoint(Name :  in out CString; P : in out Pnt from gp)
134     returns Boolean;
135         ---Purpose: Gets the variable. Returns False if none and print
136         --          a warning message.
137     
138     GetPoint2d(Name :  in out CString; P : in out Pnt2d from gp)
139     returns Boolean;
140         ---Purpose: Gets the variable. Returns False if none and print
141         --          a warning message.
142     
143     GetCurve(Name : in out CString) returns Curve from Geom;
144         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
145         --          none, and print a warning message.
146     
147     GetBezierCurve(Name :  in out CString) returns BezierCurve from Geom;
148         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
149         --          none, and print a warning message.
150     
151     GetBSplineCurve(Name :  in out CString) returns BSplineCurve from Geom;
152         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
153         --          none, and print a warning message.
154     
155     GetCurve2d(Name :   in out CString) returns Curve from Geom2d;
156         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
157         --          none, and print a warning message.
158     
159     GetBezierCurve2d(Name : in out CString) returns BezierCurve from Geom2d;
160         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
161         --          none, and print a warning message.
162     
163     GetBSplineCurve2d(Name : in out CString) returns BSplineCurve from Geom2d;
164         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
165         --          none, and print a warning message.
166     
167     GetSurface(Name : in out CString) returns Surface from Geom;
168         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
169         --          none, and print a warning message.
170     
171     GetBezierSurface(Name : in out CString) returns BezierSurface from Geom;
172         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
173         --          none, and print a warning message.
174     
175     GetBSplineSurface(Name : in out CString) returns BSplineSurface from Geom;
176         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
177         --          none, and print a warning message.
178     
179     GetTriangulation(Name : in out CString) returns Triangulation from  Poly;
180         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
181         --          none, and print a warning message.
182     
183     GetPolygon3D(Name : in out CString) returns Polygon3D from  Poly;
184         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
185         --          none, and print a warning message.
186     
187     GetPolygon2D(Name : in out CString) returns Polygon2D from  Poly;
188         ---Purpose: Get  the variable <S>.  Returns a  null  handle if
189         --          none, and print a warning message.
190     
191     
192     
193     BasicCommands(I : in out Interpretor from Draw);
194         ---Purpose: defines display commands.
195     
196 end DrawTrSurf;