1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
-- File: GeomAPI_ExtremaCurveCurve.cdl
-- Created: Fri Mar 18 10:09:20 1994
-- Author: Bruno DUMORTIER
-- <dub@fuegox>
---Copyright: Matra Datavision 1994
class ExtremaCurveCurve from GeomAPI
---Purpose: Describes functions for computing all the extrema
-- between two 3D curves.
-- An ExtremaCurveCurve algorithm minimizes or
-- maximizes the distance between a point on the first
-- curve and a point on the second curve. Thus, it
-- computes start and end points of perpendiculars
-- common to the two curves (an intersection point is
-- not an extremum unless the two curves are tangential at this point).
-- Solutions consist of pairs of points, and an extremum
-- is considered to be a segment joining the two points of a solution.
-- An ExtremaCurveCurve object provides a framework for:
-- - defining the construction of the extrema,
-- - implementing the construction algorithm, and
-- - consulting the results.
-- Warning
-- In some cases, the nearest points between two
-- curves do not correspond to one of the computed
-- extrema. Instead, they may be given by:
-- - a limit point of one curve and one of the following:
-- - its orthogonal projection on the other curve,
-- - a limit point of the other curve; or
-- - an intersection point between the two curves.
uses
Curve from Geom,
Curve from GeomAdaptor,
ExtCC from Extrema,
Pnt from gp,
Length from Quantity,
Parameter from Quantity
raises
OutOfRange from Standard,
NotDone from StdFail
is
Create
---Purpose: Constructs an empty algorithm for computing
-- extrema between two curves. Use an Init function
-- to define the curves on which it is going to work.
returns ExtremaCurveCurve from GeomAPI;
Create(C1 , C2 : Curve from Geom)
---Purpose: Computes the extrema between the curves C1 and C2.
returns ExtremaCurveCurve from GeomAPI;
Create(C1 , C2 : Curve from Geom;
U1min, U1max : Parameter from Quantity;
U2min, U2max : Parameter from Quantity)
---Purpose: Computes the portion of the curve C1 limited by the two
-- points of parameter (U1min,U1max), and
-- - the portion of the curve C2 limited by the two
-- points of parameter (U2min,U2max).
-- Warning
-- Use the function NbExtrema to obtain the number
-- of solutions. If this algorithm fails, NbExtrema returns 0.
returns ExtremaCurveCurve from GeomAPI;
Init(me : in out;
C1 , C2 : Curve from Geom)
---Purpose: Initializes this algorithm with the given arguments
-- and computes the extrema between the curves C1 and C2
is static;
Init(me : in out;
C1 , C2 : Curve from Geom;
U1min, U1max : Parameter from Quantity;
U2min, U2max : Parameter from Quantity)
---Purpose: Initializes this algorithm with the given arguments
-- and computes the extrema between :
-- - the portion of the curve C1 limited by the two
-- points of parameter (U1min,U1max), and
-- - the portion of the curve C2 limited by the two
-- points of parameter (U2min,U2max).
-- Warning
-- Use the function NbExtrema to obtain the number
-- of solutions. If this algorithm fails, NbExtrema returns 0.
is static;
NbExtrema(me)
---Purpose: Returns the number of extrema computed by this algorithm.
-- Note: if this algorithm fails, NbExtrema returns 0.
returns Integer from Standard
---C++: alias "Standard_EXPORT operator Standard_Integer() const;"
is static;
Points(me; Index : Integer from Standard;
P1, P2 : out Pnt from gp )
---Purpose: Returns the points P1 on the first curve and P2 on
-- the second curve, which are the ends of the
-- extremum of index Index computed by this algorithm.
-- Exceptions
-- Standard_OutOfRange if Index is not in the range [
-- 1,NbExtrema ], where NbExtrema is the
-- number of extrema computed by this algorithm.
raises
OutOfRange from Standard
is static;
Parameters(me; Index : Integer from Standard;
U1, U2 : out Parameter from Quantity)
---Purpose: Returns the parameters U1 of the point on the first
-- curve and U2 of the point on the second curve, which
-- are the ends of the extremum of index Index computed by this algorithm.
-- Exceptions
-- Standard_OutOfRange if Index is not in the range [
-- 1,NbExtrema ], where NbExtrema is the
-- number of extrema computed by this algorithm.
raises
OutOfRange from Standard
is static;
Distance(me; Index : Integer from Standard)
returns Length from Quantity
---Purpose: Computes the distance between the end points of the
-- extremum of index Index computed by this algorithm.
-- Exceptions
-- Standard_OutOfRange if Index is not in the range [
-- 1,NbExtrema ], where NbExtrema is the
-- number of extrema computed by this algorithm.
raises
OutOfRange from Standard
is static;
NearestPoints(me; P1, P2 : out Pnt from gp)
---Purpose: Returns the points P1 on the first curve and P2 on
-- the second curve, which are the ends of the shortest
-- extremum computed by this algorithm.
-- Exceptions StdFail_NotDone if this algorithm fails.
raises
NotDone from StdFail
is static;
LowerDistanceParameters(me; U1, U2 : out Parameter from Quantity)
---Purpose: Returns the parameters U1 of the point on the first
-- curve and U2 of the point on the second curve, which
-- are the ends of the shortest extremum computed by this algorithm.
-- Exceptions StdFail_NotDone if this algorithm fails.
raises
NotDone from StdFail
is static;
LowerDistance(me)
---Purpose: Computes the distance between the end points of the
-- shortest extremum computed by this algorithm.
-- Exceptions StdFail_NotDone if this algorithm fails.
---C++: alias "Standard_EXPORT operator Standard_Real() const;"
returns Length from Quantity
raises
NotDone from StdFail
is static;
Extrema(me)
---Purpose: return the algorithmic object from Extrema
---Level: Advanced
---C++: return const&
---C++: inline
returns ExtCC from Extrema
is static;
TotalNearestPoints(me : in out; P1, P2 : out Pnt from gp )
---Purpose: set in <P1> and <P2> the couple solution points
-- such a the distance [P1,P2] is the minimum. taking in account
-- extremity points of curves.
---Level: Public
returns Boolean from Standard
-- returns "true" if it is possible to compute points and "false"
-- if such points do not exist, for ex. - infinite parallel lines
is static;
TotalLowerDistanceParameters(me : in out; U1, U2 : out Parameter from Quantity)
---Purpose: set in <U1> and <U2> the parameters of the couple
-- solution points which represents the total nearest
-- solution.
---Level: Public
returns Boolean from Standard
-- returns "true" if it is possible to compute points and "false"
-- if such points do not exist, for ex. - infinite parallel lines
is static;
TotalLowerDistance(me : in out)
---Purpose: return the distance of the total nearest couple solution
-- point.
---Level: Public
returns Length from Quantity
raises
NotDone from StdFail
---Purpose: if <myExtCC> is not done
is static;
TotalPerform(me : in out)
is static private;
fields
myIsDone: Boolean from Standard;
myIndex : Integer from Standard; -- index of the nearest solution
myExtCC : ExtCC from Extrema;
myC1 : Curve from GeomAdaptor;
myC2 : Curve from GeomAdaptor;
-- Fields to compute total min. dist with extremities of curves
myTotalExt : Boolean from Standard; -- indicate that total extr.
-- has been computed
myIsInfinite : Boolean from Standard; -- infinite extremity points
myTotalDist : Real from Standard; -- total min. dist
myTotalPoints : Pnt[2];
myTotalPars : Real[2];
end ExtremaCurveCurve;
|
