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
319
320
321
|
---Copyright: Matra Datavision 1991
class XYZ from gp inherits Storable
--- Purpose :
-- This class describes a cartesian coordinate entity in
-- 3D space {X,Y,Z}. This entity is used for algebraic
-- calculation. This entity can be transformed
-- with a "Trsf" or a "GTrsf" from package "gp".
-- It is used in vectorial computations or for holding this type
-- of information in data structures.
uses Mat from gp
raises ConstructionError from Standard,
OutOfRange from Standard
is
Create returns XYZ;
---C++: inline
--- Purpose : Creates an XYZ object with zero co-ordinates (0,0,0)
Create (X, Y, Z : Real) returns XYZ;
---C++:inline
--- Purpose : creates an XYZ with given coordinates
SetCoord (me : in out; X, Y, Z : Real)
---C++: inline
---Purpose: For this XYZ object, assigns
-- the values X, Y and Z to its three coordinates
is static;
SetCoord (me : in out; Index : Integer; Xi : Real)
---C++:inline
--- Purpose :
-- modifies the coordinate of range Index
-- Index = 1 => X is modified
-- Index = 2 => Y is modified
-- Index = 3 => Z is modified
-- Raises OutOfRange if Index != {1, 2, 3}.
raises OutOfRange
is static;
SetX (me: in out; X : Real) is static;
---C++: inline
---Purpose: Assigns the given value to the X coordinate
SetY (me: in out; Y : Real) is static;
---C++: inline
---Purpose: Assigns the given value to the Y coordinate
SetZ (me: in out; Z : Real) is static;
---C++: inline
---Purpose: Assigns the given value to the Z coordinate
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
-- Index = 3 => Z is returned
--
-- Raises OutOfRange if Index != {1, 2, 3}.
raises OutOfRange
is static;
Coord (me; X, Y, Z : out Real) is static;
---C++: inline
--Purpose: For this XYZ object, returns:
-- - its coordinates X, Y, and Z
X (me) returns Real is static;
---C++: inline
---Purpose: Returns the X coordinate
Y (me) returns Real is static;
---C++: inline
---Purpose: Returns the Y coordinate
Z (me) returns Real is static;
---C++: inline
---Purpose: Returns the Z coordinate
Modulus (me) returns Real is static;
--- Purpose : computes Sqrt (X*X + Y*Y + Z*Z) where X, Y and Z are the three coordinates of this XYZ object.
---C++: inline
SquareModulus (me) returns Real is static;
--- Purpose : Computes X*X + Y*Y + Z*Z where X, Y and Z are the three coordinates of this XYZ object.
---C++: inline
IsEqual (me; Other : XYZ; Tolerance : Real) returns Boolean
--- Purpose :
-- Returns True if he coordinates of this XYZ object are
-- equal to the respective coordinates Other,
-- within the specified tolerance Tolerance. I.e.:
-- abs(<me>.X() - Other.X()) <= Tolerance and
-- abs(<me>.Y() - Other.Y()) <= Tolerance and
-- abs(<me>.Z() - Other.Z()) <= Tolerance.
is static;
Add (me : in out; Other : XYZ) is static;
--- Purposes :
-- <me>.X() = <me>.X() + Other.X()
-- <me>.Y() = <me>.Y() + Other.Y()
-- <me>.Z() = <me>.Z() + Other.Z()
---C++: inline
---C++: alias operator +=
Added (me; Other : XYZ) returns XYZ is static;
---C++:inline
--- Purposes :
-- new.X() = <me>.X() + Other.X()
-- new.Y() = <me>.Y() + Other.Y()
-- new.Z() = <me>.Z() + Other.Z()
---C++: alias operator +
Cross (me : in out; Right : XYZ) is static;
---C++:inline
---C++: alias operator ^=
--- Purposes :
-- <me>.X() = <me>.Y() * Other.Z() - <me>.Z() * Other.Y()
-- <me>.Y() = <me>.Z() * Other.X() - <me>.X() * Other.Z()
-- <me>.Z() = <me>.X() * Other.Y() - <me>.Y() * Other.X()
Crossed (me; Right : XYZ) returns XYZ is static;
---C++:inline
---C++: alias operator ^
--- Purposes :
-- new.X() = <me>.Y() * Other.Z() - <me>.Z() * Other.Y()
-- new.Y() = <me>.Z() * Other.X() - <me>.X() * Other.Z()
-- new.Z() = <me>.X() * Other.Y() - <me>.Y() * Other.X()
CrossMagnitude (me; Right : XYZ) returns Real is static;
---C++:inline
--- Purpose :
-- Computes the magnitude of the cross product between <me> and
-- Right. Returns || <me> ^ Right ||
CrossSquareMagnitude (me; Right : XYZ) returns Real is static;
---C++:inline
--- Purpose :
-- Computes the square magnitude of the cross product between <me> and
-- Right. Returns || <me> ^ Right ||**2
CrossCross (me : in out; Coord1, Coord2 : XYZ) is static;
---C++:inline
--- Purposes : Triple vector product
-- Computes <me> = <me>.Cross(Coord1.Cross(Coord2))
CrossCrossed (me; Coord1, Coord2 : XYZ) returns XYZ is static;
---C++:inline
--- Purposes : Triple vector product
-- computes New = <me>.Cross(Coord1.Cross(Coord2))
Divide (me : in out; Scalar : Real) is static;
--- Purpose : divides <me> by a real.
---C++: inline
---C++: alias operator /=
Divided (me; Scalar : Real) returns XYZ is static;
---C++:inline
--- Purpose : divides <me> by a real.
---C++: alias operator /
Dot (me; Other : XYZ) returns Real
--- Purpose : computes the scalar product between <me> and Other
---C++: inline
---C++: alias operator *
is static;
DotCross (me; Coord1, Coord2 : XYZ) returns Real is static;
---C++: inline
--- Purpose : computes the triple scalar product
Multiply (me : in out; Scalar : Real) is static;
---C++: inline
---C++: alias operator *=
--- Purpose :
-- <me>.X() = <me>.X() * Scalar;
-- <me>.Y() = <me>.Y() * Scalar;
-- <me>.Z() = <me>.Z() * Scalar;
Multiply (me : in out; Other : XYZ) is static;
---C++: inline
---C++: alias operator *=
--- Purpose :
-- <me>.X() = <me>.X() * Other.X();
-- <me>.Y() = <me>.Y() * Other.Y();
-- <me>.Z() = <me>.Z() * Other.Z();
Multiply (me : in out; Matrix : Mat) is static;
---C++:inline
---C++: alias operator *=
--- Purpose : <me> = Matrix * <me>
Multiplied (me; Scalar : Real) returns XYZ is static;
---C++:inline
--- Purpose :
-- New.X() = <me>.X() * Scalar;
-- New.Y() = <me>.Y() * Scalar;
-- New.Z() = <me>.Z() * Scalar;
---C++: alias operator *
Multiplied (me; Other : XYZ) returns XYZ is static;
---C++:inline
--- Purpose :
-- new.X() = <me>.X() * Other.X();
-- new.Y() = <me>.Y() * Other.Y();
-- new.Z() = <me>.Z() * Other.Z();
Multiplied (me; Matrix : Mat) returns XYZ is static;
---C++:inline
--- Purpose : New = Matrix * <me>
---C++: alias operator *
Normalize (me : in out)
---C++:inline
--- Purpose :
-- <me>.X() = <me>.X()/ <me>.Modulus()
-- <me>.Y() = <me>.Y()/ <me>.Modulus()
-- <me>.Z() = <me>.Z()/ <me>.Modulus()
raises ConstructionError
--- Purpose : Raised if <me>.Modulus() <= Resolution from gp
is static;
Normalized (me) returns XYZ
---C++:inline
--- Purpose :
-- New.X() = <me>.X()/ <me>.Modulus()
-- New.Y() = <me>.Y()/ <me>.Modulus()
-- New.Z() = <me>.Z()/ <me>.Modulus()
raises ConstructionError
--- Purpose : Raised if <me>.Modulus() <= Resolution from gp
is static;
Reverse (me : in out) is static;
---C++:inline
--- Purpose :
-- <me>.X() = -<me>.X()
-- <me>.Y() = -<me>.Y()
-- <me>.Z() = -<me>.Z()
Reversed (me) returns XYZ is static;
---C++:inline
--- Purpose :
-- New.X() = -<me>.X()
-- New.Y() = -<me>.Y()
-- New.Z() = -<me>.Z()
Subtract (me : in out; Right : XYZ) is static;
---C++: inline
---C++: alias operator -=
--- Purpose :
-- <me>.X() = <me>.X() - Other.X()
-- <me>.Y() = <me>.Y() - Other.Y()
-- <me>.Z() = <me>.Z() - Other.Z()
Subtracted (me; Right : XYZ) returns XYZ is static;
---C++: inline
---C++: alias operator -
--- Purpose :
-- new.X() = <me>.X() - Other.X()
-- new.Y() = <me>.Y() - Other.Y()
-- new.Z() = <me>.Z() - Other.Z()
SetLinearForm (me : in out;
A1 : Real; XYZ1 : XYZ; A2 : Real; XYZ2 : XYZ;
A3 : Real; XYZ3 : XYZ; XYZ4 : XYZ)
is static;
--- Purpose :
-- <me> is set to the following linear form :
-- A1 * XYZ1 + A2 * XYZ2 + A3 * XYZ3 + XYZ4
---C++: inline
SetLinearForm (me : in out;
A1 : Real; XYZ1 : XYZ; A2 : Real; XYZ2 : XYZ;
A3 : Real; XYZ3 : XYZ)
is static;
--- Purpose :
-- <me> is set to the following linear form :
-- A1 * XYZ1 + A2 * XYZ2 + A3 * XYZ3
---C++: inline
SetLinearForm (me : in out;
A1 : Real; XYZ1 : XYZ; A2 : Real; XYZ2 : XYZ; XYZ3 : XYZ)
is static;
--- Purpose :
-- <me> is set to the following linear form :
-- A1 * XYZ1 + A2 * XYZ2 + XYZ3
---C++: inline
SetLinearForm (me : in out; A1 : Real; XYZ1 : XYZ; A2 : Real; XYZ2 : XYZ)
is static;
--- Purpose :
-- <me> is set to the following linear form :
-- A1 * XYZ1 + A2 * XYZ2
---C++: inline
SetLinearForm (me : in out; A1 : Real; XYZ1 : XYZ; XYZ2 : XYZ)
is static;
--- Purpose :
-- <me> is set to the following linear form :
-- A1 * XYZ1 + XYZ2
---C++: inline
SetLinearForm (me : in out; XYZ1, XYZ2 : XYZ) is static;
--- Purpose :
-- <me> is set to the following linear form :
-- XYZ1 + XYZ2
---C++: inline
fields
x : Real;
y : Real;
z : Real;
end;
|
