1bfef8bb3d3379c55f46f73d6bfde012dc59b57a
[occt.git] / src / Geom2dGcc / Geom2dGcc.cdl
1 -- Created on: 1992-06-29
2 -- Created by: Remi GILET
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
23 package Geom2dGcc 
24
25         --- Purpose: The Geom2dGcc package describes qualified 2D
26         -- curves used in the construction of constrained geometric
27         -- objects by an algorithm provided by the Geom2dGcc package.
28         -- A qualified 2D curve is a curve with a qualifier which
29         -- specifies whether the solution of a construction
30         -- algorithm using the qualified curve (as an argument):
31         -- -   encloses the curve, or
32         -- -   is enclosed by the curve, or
33         -- -   is built so that both the curve and this solution are external to one another, or
34         -- -   is undefined (all solutions apply).
35         -- These package methods provide simpler functions to construct a qualified curve.
36         -- Note: the interior of a curve is defined as the left-hand
37         -- side of the curve in relation to its orientation.
38
39
40 uses GccEnt,
41      GccGeo,
42      GccAna,
43      GccIter,
44      StdFail,
45      Geom2dInt,
46      Geom2d,
47      TColStd,
48      TopAbs,    
49      Standard,
50      Geom2dAdaptor,
51      Extrema,
52      Adaptor3d,
53      Adaptor2d,
54      TColgp,
55      gp
56
57 is
58
59 class CurveTool;
60
61 class QualifiedCurve;
62
63 class Circ2d3Tan;
64
65 class Circ2d2TanRad;
66
67 class Circ2d2TanOn;
68
69 class Circ2dTanOnRad;
70
71 class Circ2dTanCen;
72
73 class Lin2d2Tan;
74
75 class Lin2dTanObl;
76
77 class MyQCurve instantiates QualifiedCurv from GccEnt
78             (Curve  from Geom2dAdaptor);
79
80 class MyCurveTool instantiates CurvePGTool from GccGeo
81             (Curve       from Geom2dAdaptor,
82              CurveTool   from Geom2dGcc    ,
83              OffsetCurve from Adaptor3d);
84             
85 class MyCirc2d2TanOn instantiates Circ2d2TanOn from GccGeo
86             (Curve                          from Geom2dAdaptor,
87              CurveTool                      from Geom2dGcc,
88              MyQCurve                       from Geom2dGcc,
89              OffsetCurve                    from Adaptor3d,
90              HCurve                         from Geom2dAdaptor,
91              MyCurveTool                    from Geom2dGcc,
92              TheIntConicCurveOfGInter from Geom2dInt);
93              
94 class MyCirc2d2TanRad instantiates Circ2d2TanRad from GccGeo
95             (Curve                           from Geom2dAdaptor ,
96              CurveTool                       from Geom2dGcc,
97              MyQCurve                        from Geom2dGcc,
98              OffsetCurve                     from Adaptor3d, 
99              HCurve                         from Geom2dAdaptor,      
100              MyCurveTool                     from Geom2dGcc,
101              TheIntConicCurveOfGInter  from Geom2dInt,
102              GInter                    from Geom2dInt);
103
104 class MyCirc2dTanOnRad instantiates Circ2dTanOnRad from GccGeo
105             (Curve                           from Geom2dAdaptor ,
106              CurveTool                       from Geom2dGcc,
107              MyQCurve                        from Geom2dGcc,
108              OffsetCurve                     from Adaptor3d,
109              HCurve                         from Geom2dAdaptor,      
110              MyCurveTool                     from Geom2dGcc,
111              TheIntConicCurveOfGInter  from Geom2dInt,
112              GInter                    from Geom2dInt);
113
114 class MyC2d3Tan instantiates Circ2d3Tan from GccIter         
115             (Curve          from Geom2dAdaptor,
116              CurveTool      from Geom2dGcc,
117              MyQCurve       from Geom2dGcc);
118              
119 class MyCirc2dTanCen instantiates Circ2dTanCen from GccGeo           
120             (Curve          from Geom2dAdaptor,
121              CurveTool      from Geom2dGcc,
122              ExtPC2d          from Extrema,
123              MyQCurve       from Geom2dGcc);
124              
125 class MyC2d2TanOn instantiates Circ2d2TanOn from GccIter             
126             (Curve          from Geom2dAdaptor,
127              CurveTool      from Geom2dGcc,
128              MyQCurve       from Geom2dGcc);
129
130 class MyL2dTanObl instantiates Lin2dTanObl from GccIter      
131             (Curve          from Geom2dAdaptor,
132              CurveTool      from Geom2dGcc,
133              MyQCurve       from Geom2dGcc);
134              
135 class MyL2d2Tan instantiates Lin2d2Tan from GccIter          
136             (Curve          from Geom2dAdaptor,
137              CurveTool      from Geom2dGcc,
138              MyQCurve       from Geom2dGcc);
139
140 Unqualified(Obj : Curve from Geom2dAdaptor) returns QualifiedCurve;
141         ---Purpose: Constructs such a qualified curve that the relative
142         -- position of the solution computed by a construction
143         -- algorithm using the qualified curve to the circle or line is
144         -- not qualified, i.e. all solutions apply.
145         -- Warning
146         -- Obj is an adapted curve, i.e. an object which is an interface between:
147         -- -   the services provided by a 2D curve from the package Geom2d,
148         -- -   and those required on the curve by a computation algorithm.
149         --  The adapted curve is created in the following way:
150         -- Handle(Geom2d_Curve) mycurve = ...
151         -- ;
152         -- Geom2dAdaptor_Curve Obj ( mycurve )
153         -- ;
154         -- The qualified curve is then constructed with this object:
155         -- Geom2dGcc_QualifiedCurve
156         -- myQCurve = Geom2dGcc::Unqualified(Obj);
157     
158 Enclosing(Obj : Curve from Geom2dAdaptor) returns QualifiedCurve;
159         ---Purpose: Constructs such a qualified curve that the solution
160         -- computed by a construction algorithm using the qualified
161         -- curve encloses the curve.
162         -- Warning
163         -- Obj is an adapted curve, i.e. an object which is an interface between:
164         -- -   the services provided by a 2D curve from the package Geom2d,
165         -- -   and those required on the curve by a computation algorithm.
166         -- The adapted curve is created in the following way:
167         -- Handle(Geom2d_Curve) mycurve = ...
168         -- ;
169         -- Geom2dAdaptor_Curve Obj ( mycurve )
170         -- ;
171         -- The qualified curve is then constructed with this object:
172         -- Geom2dGcc_QualifiedCurve
173         --              myQCurve = Geom2dGcc::Enclosing(Obj);
174   
175 Enclosed(Obj : Curve from Geom2dAdaptor) returns QualifiedCurve;
176         ---Purpose: Constructs such a qualified curve that the solution
177         -- computed by a construction algorithm using the qualified
178         -- curve is enclosed by the curve.
179         -- Warning
180         -- Obj is an adapted curve, i.e. an object which is an interface between:
181         -- -   the services provided by a 2D curve from the package Geom2d,
182         -- -   and those required on the curve by a computation algorithm.
183         -- The adapted curve is created in the following way:
184         -- Handle(Geom2d_Curve) mycurve = ...
185         -- ;
186         -- Geom2dAdaptor_Curve Obj ( mycurve )
187         -- ;
188         -- The qualified curve is then constructed with this object:
189         -- Geom2dGcc_QualifiedCurve
190         --              myQCurve = Geom2dGcc::Enclosed(Obj);
191     
192 Outside(Obj : Curve from Geom2dAdaptor) returns QualifiedCurve;
193         ---Purpose: Constructs such a qualified curve that the solution
194         -- computed by a construction algorithm using the qualified
195         -- curve and the curve are external to one another.
196         -- Warning
197         -- Obj is an adapted curve, i.e. an object which is an interface between:
198         -- -   the services provided by a 2D curve from the package Geom2d,
199         -- -   and those required on the curve by a computation algorithm.
200         -- The adapted curve is created in the following way:
201         -- Handle(Geom2d_Curve) mycurve = ...
202         -- ;
203         -- Geom2dAdaptor_Curve Obj ( mycurve )
204         -- ;
205         -- The qualified curve is then constructed with this object:
206         -- Geom2dGcc_QualifiedCurve
207         --              myQCurve = Geom2dGcc::Outside(Obj);
208              
209 end Geom2dGcc;