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