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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
|
---Copyright: Matra Datavision 1991
class Vec2d from gp inherits Storable
--- Purpose :
-- Defines a non-persistent vector in 2D space.
uses Ax2d from gp,
Dir2d from gp,
Pnt2d from gp,
Trsf2d from gp,
XY from gp
raises ConstructionError from Standard,
OutOfRange from Standard,
VectorWithNullMagnitude from gp
is
Create returns Vec2d;
---C++: inline
--- Purpose : Creates a zero vector.
Create (V : Dir2d) returns Vec2d;
---C++: inline
--- Purpose : Creates a unitary vector from a direction V.
Create (Coord : XY) returns Vec2d;
---C++: inline
--- Purpose : Creates a vector with a doublet of coordinates.
Create (Xv, Yv : Real) returns Vec2d;
---C++: inline
--- Purpose : Creates a point with its two cartesian coordinates.
Create (P1, P2 : Pnt2d) returns Vec2d;
---C++: inline
--- Purpose :
-- Creates a vector from two points. The length of the vector
-- is the distance between P1 and P2
SetCoord(me: in out; Index : Integer; Xi : Real)
---C++: inline
--- Purpose : Changes the coordinate of range Index
-- Index = 1 => X is modified
-- Index = 2 => Y is modified
-- Raises OutOfRange if Index != {1, 2}.
raises OutOfRange
is static;
SetCoord (me : in out; Xv, Yv : Real) is static;
---Purpose: For this vector, assigns
-- the values Xv and Yv to its two coordinates
---C++: inline
SetX (me: in out; X : Real) is static;
---Purpose : Assigns the given value to the X coordinate of this vector.
---C++: inline
SetY (me: in out; Y : Real) is static;
---Purpose : Assigns the given value to the Y coordinate of this vector.
---C++: inline
SetXY (me: in out; Coord : XY) is static;
---Purpose: Assigns the two coordinates of Coord to this vector.
---C++: inline
Coord (me; Index : Integer) returns Real
---C++: inline
--- Purpose :
-- Returns the coordinate of range Index :
-- Index = 1 => X is returned
-- Index = 2 => Y is returned
raises OutOfRange
--- Purpose : Raised if Index != {1, 2}.
is static;
Coord (me; Xv, Yv : out Real) is static;
---Purpose: For this vector, returns its two coordinates Xv and Yv
---C++: inline
X (me) returns Real is static;
---Purpose: For this vector, returns its X coordinate.
---C++: inline
Y (me) returns Real is static;
---Purpose: For this vector, returns its Y coordinate.
---C++: inline
XY (me) returns XY is static;
---Purpose: For this vector, returns its two coordinates as a number pair
---C++: inline
---C++: return const&
IsEqual (me; Other : Vec2d; LinearTolerance, AngularTolerance : Real)
returns Boolean
is static;
--- Purpose :
-- Returns True if the two vectors have the same magnitude value
-- and the same direction. The precision values are LinearTolerance
-- for the magnitude and AngularTolerance for the direction.
IsNormal (me; Other : Vec2d; AngularTolerance : Real)
returns Boolean
---C++: inline
--- Purpose :
-- Returns True if abs(Abs(<me>.Angle(Other)) - PI/2.)
-- <= AngularTolerance
-- Raises VectorWithNullMagnitude if <me>.Magnitude() <= Resolution or
-- Other.Magnitude() <= Resolution from gp.
raises VectorWithNullMagnitude
is static;
IsOpposite (me; Other : Vec2d; AngularTolerance : Real)
returns Boolean
---C++: inline
--- Purpose :
-- Returns True if PI - Abs(<me>.Angle(Other)) <= AngularTolerance
-- Raises VectorWithNullMagnitude if <me>.Magnitude() <= Resolution or
-- Other.Magnitude() <= Resolution from gp.
raises VectorWithNullMagnitude
is static;
IsParallel (me; Other : Vec2d; AngularTolerance : Real)
returns Boolean
---C++: inline
--- Purpose :
-- Returns true if Abs(Angle(<me>, Other)) <= AngularTolerance or
-- PI - Abs(Angle(<me>, Other)) <= AngularTolerance
-- Two vectors with opposite directions are considered as parallel.
-- Raises VectorWithNullMagnitude if <me>.Magnitude() <= Resolution or
-- Other.Magnitude() <= Resolution from gp
raises VectorWithNullMagnitude
is static;
Angle (me; Other : Vec2d) returns Real
--- Purpose :
-- Computes the angular value between <me> and <Other>
-- returns the angle value between -PI and PI in radian.
-- The orientation is from <me> to Other. The positive sense is the
-- trigonometric sense.
-- Raises VectorWithNullMagnitude if <me>.Magnitude() <= Resolution from gp or
-- Other.Magnitude() <= Resolution because the angular value is
-- indefinite if one of the vectors has a null magnitude.
raises VectorWithNullMagnitude
is static;
Magnitude (me) returns Real is static;
---Purpose: Computes the magnitude of this vector.
---C++: inline
SquareMagnitude (me) returns Real is static;
---Purpose: Computes the square magnitude of this vector.
---C++: inline
Add (me : in out; Other : Vec2d) is static;
---C++: inline
---C++: alias operator +=
Added (me; Other : Vec2d) returns Vec2d is static;
---C++: inline
---C++: alias operator +
--- Purpose : Adds two vectors
Crossed (me; Right : Vec2d) returns Real is static;
---C++: inline
--- Purpose : Computes the crossing product between two vectors
---C++: alias operator ^
CrossMagnitude (me; Right : Vec2d) returns Real is static;
---C++: inline
--- Purpose :
-- Computes the magnitude of the cross product between <me> and
-- Right. Returns || <me> ^ Right ||
CrossSquareMagnitude (me; Right : Vec2d) returns Real is static;
---C++: inline
--- Purpose :
-- Computes the square magnitude of the cross product between <me> and
-- Right. Returns || <me> ^ Right ||**2
Divide (me : in out; Scalar : Real) is static;
---C++: inline
---C++: alias operator /=
Divided (me; Scalar : Real) returns Vec2d is static;
---C++: inline
---C++: alias operator /
--- Purpose : divides a vector by a scalar
Dot (me; Other : Vec2d) returns Real is static;
---C++: inline
--- Purpose : Computes the scalar product
---C++: alias operator *
Multiply (me : in out; Scalar : Real) is static;
---C++: inline
---C++: alias operator *=
Multiplied (me; Scalar : Real) returns Vec2d is static;
---C++: inline
---C++: alias operator *
--- Purpose : Normalizes a vector
-- Raises an exception if the magnitude of the vector is
-- lower or equal to Resolution from package gp.
Normalize (me : in out) raises ConstructionError is static;
---C++: inline
Normalized (me) returns Vec2d raises ConstructionError is static;
---C++: inline
--- Purpose : Normalizes a vector
-- Raises an exception if the magnitude of the vector is
-- lower or equal to Resolution from package gp.
--- Purpose : Reverses the direction of a vector
Reverse (me : in out) is static;
---C++: inline
Reversed (me) returns Vec2d is static;
---C++: inline
---C++: alias operator -
--- Purpose : Reverses the direction of a vector
--- Purpose : Subtracts two vectors
Subtract (me : in out; Right : Vec2d) is static;
---C++: inline
---C++: alias operator -=
Subtracted (me; Right : Vec2d) returns Vec2d is static;
---C++: inline
---C++: alias operator -
--- Purpose : Subtracts two vectors
SetLinearForm (me : in out;
A1 : Real; V1 : Vec2d; A2 : Real; V2 : Vec2d; V3 : Vec2d)
is static;
--- Purpose :
-- <me> is setted to the following linear form :
-- A1 * V1 + A2 * V2 + V3
---C++: inline
SetLinearForm (me : in out; A1 : Real; V1 : Vec2d; A2 : Real; V2 : Vec2d)
is static;
--- Purpose :
-- <me> is setted to the following linear form : A1 * V1 + A2 * V2
---C++: inline
SetLinearForm (me : in out; A1 : Real; V1, V2 : Vec2d) is static;
--- Purpose :
-- <me> is setted to the following linear form : A1 * V1 + V2
---C++: inline
SetLinearForm (me : in out; Left, Right : Vec2d) is static;
--- Purpose :
-- <me> is setted to the following linear form : Left + Right
---C++: inline
--- Purpose :
-- Performs the symmetrical transformation of a vector
-- with respect to the vector V which is the center of
-- the symmetry.
Mirror (me : in out; V : Vec2d) is static;
Mirrored (me; V : Vec2d) returns Vec2d is static;
--- Purpose :
-- Performs the symmetrical transformation of a vector
-- with respect to the vector V which is the center of
-- the symmetry.
--- Purpose :
-- Performs the symmetrical transformation of a vector
-- with respect to an axis placement which is the axis
-- of the symmetry.
Mirror (me : in out; A1 : Ax2d) is static;
Mirrored (me; A1 : Ax2d) returns Vec2d is static;
--- Purpose :
-- Performs the symmetrical transformation of a vector
-- with respect to an axis placement which is the axis
-- of the symmetry.
Rotate (me : in out; Ang : Real) is static;
---C++: inline
Rotated (me; Ang : Real) returns Vec2d is static;
---C++: inline
--- Purpose :
-- Rotates a vector. Ang is the angular value of the
-- rotation in radians.
Scale (me : in out; S : Real) is static;
---C++: inline
Scaled (me; S : Real) returns Vec2d is static;
---C++: inline
--- Purpose : Scales a vector. S is the scaling value.
Transform (me : in out; T : Trsf2d) is static;
Transformed (me; T : Trsf2d) returns Vec2d is static;
---C++: inline
--- Purpose : Transforms a vector with a Trsf from gp.
fields
coord : XY;
end;
|
