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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
-- File: TopoDS_Shape.cdl
-- Created: Tue Dec 11 16:55:01 1990
-- Author: Remi Lequette
---Copyright: Matra Datavision 1990, 1992
class Shape from TopoDS
---Purpose: Describes a shape which
-- - references an underlying shape with the potential
-- to be given a location and an orientation
-- - has a location for the underlying shape, giving its
-- placement in the local coordinate system
-- - has an orientation for the underlying shape, in
-- terms of its geometry (as opposed to orientation in
-- relation to other shapes).
-- Note: A Shape is empty if it references an underlying
-- shape which has an empty list of shapes.
uses
Orientation from TopAbs,
ShapeEnum from TopAbs,
TShape from TopoDS,
Location from TopLoc
raises
NullObject from Standard,
DomainError from Standard,
TypeMismatch from Standard
is
Create returns Shape from TopoDS;
---C++: inline
---Purpose: Creates a NULL Shape referring to nothing.
--
-- Data from the Shape itself
--
IsNull(me) returns Boolean
---C++: inline
---Purpose: Returns true if this shape is null. In other words, it
-- references no underlying shape with the potential to
-- be given a location and an orientation.
is static;
Nullify(me : in out)
---C++: inline
---Purpose: Destroys the reference to the underlying shape
-- stored in this shape. As a result, this shape becomes null.
is static;
Location(me) returns Location from TopLoc
---C++: inline
---C++: return const &
---Purpose: Returns the shape local coordinate system.
is static;
Location(me : in out; Loc : Location from TopLoc)
---C++: inline
---Purpose: Sets the shape local coordinate system.
is static;
Located(me; Loc : Location) returns Shape from TopoDS
---Purpose: Returns a shape similar to <me> with the local
-- coordinate system set to <Loc>.
--
---C++: inline
is static;
Orientation(me) returns Orientation from TopAbs
---Purpose: Returns the shape orientation.
--
---C++: inline
is static;
Orientation(me : in out; Orient : Orientation from TopAbs)
---Purpose: Sets the shape orientation.
---C++: inline
is static;
Oriented(me; Or : Orientation from TopAbs) returns Shape from TopoDS
---Purpose: Returns a shape similar to <me> with the
-- orientation set to <Or>.
--
---C++: inline
is static;
--
-- Data from the TShape
--
TShape(me) returns TShape from TopoDS
---C++: inline
---C++: return const &
is static;
ShapeType(me) returns ShapeEnum from TopAbs
---C++: inline
---Purpose: Returns the value of the TopAbs_ShapeEnum
-- enumeration that corresponds to this shape, for
-- example VERTEX, EDGE, and so on.
-- Exceptions
-- Standard_NullObject if this shape is null.
raises NullObject from Standard
is static;
Free(me) returns Boolean
---Purpose: Returns the free flag.
--
---C++: inline
raises NullObject from Standard
is static;
Free(me : in out; F : Boolean)
---Purpose: Sets the free flag.
--
---C++: inline
raises NullObject from Standard
is static;
Modified(me) returns Boolean
---Purpose: Returns the modification flag.
--
---C++: inline
raises NullObject from Standard
is static;
Modified(me : in out; M : Boolean)
---Purpose: Sets the modification flag.
--
---C++: inline
raises NullObject from Standard
is static;
Checked(me) returns Boolean
---Purpose: Returns the checked flag.
--
---C++: inline
raises NullObject from Standard
is static;
Checked(me : in out; C : Boolean)
---Purpose: Sets the checked flag.
--
---C++: inline
raises NullObject from Standard
is static;
Orientable(me) returns Boolean
---Purpose: Returns the orientability flag.
--
---C++: inline
raises NullObject from Standard
is static;
Orientable(me : in out; C : Boolean)
---Purpose: Sets the orientability flag.
--
---C++: inline
raises NullObject from Standard
is static;
Closed(me) returns Boolean
---Purpose: Returns the closedness flag.
--
---C++: inline
raises NullObject from Standard
is static;
Closed(me : in out; C : Boolean)
---Purpose: Sets the closedness flag.
--
---C++: inline
raises NullObject from Standard
is static;
Infinite(me) returns Boolean
---Purpose: Returns the infinity flag.
--
---C++: inline
raises NullObject from Standard
is static;
Infinite(me : in out; C : Boolean)
---Purpose: Sets the infinity flag.
--
---C++: inline
raises NullObject from Standard
is static;
Convex(me) returns Boolean
---Purpose: Returns the convexness flag.
--
---C++: inline
raises NullObject from Standard
is static;
Convex(me : in out; C : Boolean)
---Purpose: Sets the convexness flag.
--
---C++: inline
raises NullObject from Standard
is static;
--
-- Methods to modify the Shape data
--
Move(me : in out; position : Location from TopLoc)
---Purpose: Multiplies the Shape location by <position>.
--
---C++: inline
is static;
Moved(me; position : Location from TopLoc) returns Shape from TopoDS
---Purpose: Returns a shape similar to <me> with a location
-- multiplied by <position>.
--
---C++: inline
is static;
Reverse(me : in out)
---Purpose: Reverses the orientation, using the Reverse method
-- from the TopAbs package.
--
---C++: inline
is static;
Reversed(me) returns Shape from TopoDS
---Purpose: Returns a shape similar to <me> with the
-- orientation reversed, using the Reverse method
-- from the TopAbs package.
--
---C++: inline
is static;
Complement(me : in out)
---Purpose: Complements the orientation, using the Complement
-- method from the TopAbs package.
--
---C++: inline
is static;
Complemented(me) returns Shape from TopoDS
---Purpose: Returns a shape similar to <me> with the
-- orientation complemented, using the Complement
-- method from the TopAbs package.
--
---C++: inline
is static;
Compose(me : in out; Orient : Orientation from TopAbs)
---Purpose: Updates the Shape Orientation by composition with
-- <Orient>, using the Compose method from the TopAbs
-- package.
--
---C++: inline
is static;
Composed(me; Orient : Orientation from TopAbs) returns Shape from TopoDS
---Purpose: Returns a shape similar to <me> with the
-- orientation composed with <Orient>, using the
-- Compose method from the TopAbs package.
--
---C++: inline
is static;
--
-- Methods to compare Shapes
--
IsPartner(me; other : Shape) returns Boolean
---Purpose: Returns True if two shapes are partners, i.e. if
-- they share the same TShape. Locations and
-- Orientations may differ.
--
---C++: inline
is static;
IsSame(me; other : Shape) returns Boolean
---Purpose: Returns True if two shapes are same, i.e. if they
-- share the same TShape with the same Locations.
-- Orientations may differ.
---C++: inline
is static;
IsEqual(me; other : Shape) returns Boolean
---Purpose: Returns True if two shapes are equal, i.e. if they
-- share the same TShape with the same Locations and
-- Orientations.
--
---C++: inline
---C++: alias operator ==
is static;
IsNotEqual(me; other : Shape) returns Boolean
---Purpose: Negation of the IsEqual method.
--
---C++: inline
---C++: alias operator !=
is static;
HashCode (me; Upper : Integer ) returns Integer
---Purpose: Returns a hashed value denoting <me>. This value
-- is in the range 1..<Upper>. It is computed from
-- the TShape and the Location. The Orientation is
-- not used.
--
---C++: function call
is static;
EmptyCopy(me : in out)
---Purpose: Replace <me> by a new Shape with the same
-- Orientation and Location and a new TShape with the
-- same geometry and no sub-shapes.
--
---C++: inline
is static;
EmptyCopied(me) returns Shape from TopoDS
---Purpose: Returns a new Shape with the same Orientation and
-- Location and a new TShape with the same geometry
-- and no sub-shapes.
--
---C++: inline
is static;
--
-- To set the TShape
--
TShape(me : in out; T : TShape from TopoDS)
---C++: inline
is static;
fields
myTShape : TShape from TopoDS;
myLocation : Location from TopLoc;
myOrient : Orientation from TopAbs;
end Shape;
|
