summaryrefslogtreecommitdiff
path: root/src/HatchGen/HatchGen_Hatcher.cdl
blob: 45082c8c7efbdbc07846ea5b8c76ca055d245c0e (plain)
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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
-- File:	HatchGen_Hatcher.cdl
-- Created:	Mon Oct 25 17:01:45 1993
-- Author:	Jean Marc LACHAUME
--		<jml@phobox>
-- Copyright:   Matra Datavision 1993

generic class Hatcher from HatchGen
    (TheCurveE      as any ; -- as Curve       from Geom2dAdaptor
     TheCurveH      as any ; -- as Curve       from Geom2dAdaptor
     TheIntersector as any ) -- as Intersector from HatchGen

uses
    MapIntegerHasher from TColStd  ,
    PointOnHatching  from HatchGen ,
    Orientation      from TopAbs ,
    State            from TopAbs ,
    Domain           from HatchGen ,
    ErrorStatus      from HatchGen

raises
    NoSuchObject      from Standard ,
    OutOfRange        from Standard ,
    NotDone           from StdFail

----------------------------------------------------------------------
--  Nested classes descriptions.
----------------------------------------------------------------------

class Element from HatchGen instantiates ElementGen from HatchGen
    (TheCurveE) ;
    
class Elements from HatchGen instantiates ElementsGen from HatchGen
    (Integer          from Standard,
     Element          from HatchGen,
     MapIntegerHasher from TColStd ,
     TheCurveE                     ) ;
     
class Hatching from HatchGen instantiates HatchingGen from HatchGen
    (TheCurveH) ;
    
class Hatchings from HatchGen instantiates DataMap from TCollection
    (Integer          from Standard,
     Hatching         from HatchGen,
     MapIntegerHasher from TColStd) ;

class Classifier from HatchGen instantiates FaceClassifier from  TopClass 
    (Elements,
     TheCurveE,
     TheIntersector);

----------------------------------------------------------------------
--  class Hatcher description.
----------------------------------------------------------------------

is

---Category: General use


    Create (Intersector : TheIntersector ;
    	    Confusion2d : Real    from Standard ;
    	    Confusion3d : Real    from Standard ;
    	    KeepPnt     : Boolean from Standard = Standard_False ;
            KeepSeg     : Boolean from Standard = Standard_False)
    	    
    	---Purpose: Returns an empty hatcher.

    	returns Hatcher from HatchGen ;


    Intersector (me : in out ; Intersector : TheIntersector)
    
    	---Purpose: Sets the associated intersector.
    	is static ;
	

    Intersector (me : in out)
    
    	---Purpose: Returns the associated intersector.

    	---C++: inline
    	---C++: return const &

    	returns TheIntersector
	is static ;
	

    ChangeIntersector (me : in out)
    
    	---Purpose: Returns the associated intersector.

    	---C++: inline
    	---C++: return &

    	returns TheIntersector
	is static ;
	

    Confusion2d (me : in out ; Confusion : Real from Standard)
    
       	---Purpose: Sets the confusion tolerance.

    	is static ;


    Confusion2d (me)
    
    	---Purpose: Returns the 2d confusion tolerance, i.e. the value under
    	--          which two points are considered identical in the
    	--          parametric space of the hatching.
    	
    	---C++: inline
    	returns Real from Standard
	is static ;


    Confusion3d (me : in out ; Confusion : Real from Standard)
    
       	---Purpose: Sets the confusion tolerance.

    	is static ;


    Confusion3d (me)
    
    	---Purpose: Returns the 3d confusion tolerance, i.e. the value under
    	--          which two points are considered identical in the
    	--          3d space of the hatching.

    	---C++: inline
    	returns Real from Standard
	is static ;


    KeepPoints (me : in out; Keep : Boolean from Standard)
    
    	---Purpose: Sets the above flag.

    	is static ;


    KeepPoints (me)
    
    	---Purpose: Returns the flag about the points consideration.

    	---C++: inline
    	returns Boolean from Standard
    	is static ;


    KeepSegments (me : in out; Keep : Boolean from Standard)
    
    	---Purpose: Sets the above flag.

    	is static ;


    KeepSegments (me)
    
    	---Purpose: Returns the flag about the segments consideration.

    	---C++: inline
    	returns Boolean from Standard
    	is static ;


    Clear (me : in out)
    
    	---Purpose: Removes all the hatchings and all the elements.

    	---C++: inline
    	is static ;


---Category: Element


    Element (me : in out ; IndE : Integer from Standard)
    
    	---Purpose: Returns the IndE-th element.

    	---Category: Element

    	---C++: inline
    	---C++: return &

    	returns Element from HatchGen
        raises NoSuchObject from Standard
    	is static protected ;


    ElementCurve (me; IndE : Integer from Standard)
    
    	---Purpose: Returns the curve associated to the IndE-th element.

    	---Category: Element

    	---C++: inline
    	---C++: return const &

    	returns TheCurveE
    	raises NoSuchObject from Standard
    	is static ;


    AddElement (me : in out ; Curve       : TheCurveE ;
    	    	    	      Orientation : Orientation from TopAbs = TopAbs_FORWARD)
    
    	---Purpose: Adds an element to the hatcher and returns its index.

    	---Category: Element

    	returns Integer from Standard
    	is static ;


    RemElement (me : in out ; IndE : Integer from Standard)
    
    	---Purpose: Removes the IndE-th element from the hatcher.

    	---Category: Element

    	raises NoSuchObject from Standard
    	is static ;


    ClrElements (me : in out)
    
    	---Purpose: Removes all the elements from the hatcher.

    	---Category: Element

    	is static ;


---Category: Hatching


    Hatching (me : in out ; IndH : Integer from Standard)
    
    	---Purpose: Returns the IndH-th hatching.

    	---Category: Hatching

    	---C++: inline
    	---C++: return &

    	returns Hatching from HatchGen
    	raises NoSuchObject from Standard
    	is static protected ;


    HatchingCurve (me; IndH : Integer from Standard)
    
    	---Purpose: Returns the curve associated to the IndH-th hatching.

    	---Category: Hatching

    	---C++: inline
    	---C++: return const &

    	returns TheCurveH
    	raises NoSuchObject from Standard
    	is static ;


    AddHatching (me : in out ; Curve : TheCurveH)
    
    	---Purpose: Adds a hatching to the hatcher and returns its index.

    	---Category: Hatching

    	returns Integer from Standard
        is static ;


    RemHatching (me : in out ; IndH : Integer from Standard)
    
    	---Purpose: Removes the IndH-th hatching from the hatcher.

    	---Category: Hatching

    	raises NoSuchObject from Standard
    	is static ;


    ClrHatchings (me : in out)
    
    	---Purpose: Removes all the hatchings from the hatcher.

    	---Category: Hatching

    	is static ;


    NbPoints (me; IndH : Integer from Standard)

    	---Purpose: Returns the number of intersection points of
    	--          the IndH-th hatching.

    	---Category: Hatching - Test

    	---C++: inline
    	returns Integer from Standard
    	raises NoSuchObject from Standard
    	is static ;


    Point (me; IndH, IndP : Integer from Standard)
    
    	---Purpose: Returns the IndP-th intersection point of the
    	--          IndH-th hatching.

    	---Category: Hatching - Test

    	---C++: inline
    	---C++: return const &

    	returns PointOnHatching from HatchGen
    	raises NoSuchObject from Standard,
	       OutOfRange   from Standard
    	is static ;


---Category: Computation - Trimming

    Trim (me : in out)
    
    	---Purpose: Trims all the hatchings of the hatcher by all the
    	--          elements of the hatcher.

    	is static ;


    Trim (me : in out ; Curve : TheCurveH)
    
    	---Purpose: Adds a hatching to the hatcher and trims it by
    	--          the elements already given and returns its index.

    	---Category: Computation

    	returns Integer from Standard
    	is static ;


    Trim (me : in out ; IndH : Integer from Standard)
    
    	---Purpose: Trims the IndH-th hatching by the elements
    	--          already given.

    	---Category: Computation

    	raises NoSuchObject from Standard
        is static ;


    Trim (me : in out ; IndH, IndE : Integer from Standard)
    
    	---Purpose: Trims the IndH-th hatching of the hatcher by the
    	--          IndE-th element.

    	---Category: Computation

    	returns Boolean from Standard
    	is static private ;


---Category: Computation - Domains

    GlobalTransition (me : in out; Point : in out PointOnHatching from HatchGen)
    
    	---Purpose: Sets the global transition (the before and after
    	--          states and segment extremities flags) of the point.

    	---Category: Computation - Domains

    	returns Boolean from Standard
    	is static private ;


    ComputeDomains (me : in out)

    	---Purpose: Computes the domains of all the hatchings.

    	---Category: Computation - Domains

    	is static ;


    ComputeDomains (me : in out ; IndH : Integer from Standard)

    	---Purpose: Computes the domains of the IndH-th hatching.

    	---Category: Computation - Domains

    	raises NoSuchObject from Standard
    	is static ;


---Category: Results

    TrimDone (me; IndH : Integer from Standard)
    
    	---Purpose: Returns the fact that the intersections were computed
    	--          for the IndH-th hatching. 

    	---C++: inline
    	returns Boolean from Standard
	raises NoSuchObject from Standard
	is static ;


    TrimFailed (me; IndH : Integer from Standard)
    
    	---Purpose: Returns the fact that the intersections failed
    	--          for the IndH-th hatching. 

    	---C++: inline
    	returns Boolean from Standard
	raises NoSuchObject from Standard
	is static ;


    IsDone (me)
    
    	---Purpose: Returns the fact that the domains were computed
    	--          for all the hatchings. 

    	---C++: inline
    	returns Boolean from Standard
	raises NoSuchObject from Standard
	is static ;


    IsDone (me; IndH : Integer from Standard)
    
    	---Purpose: Returns the fact that the domains were computed
    	--          for the IndH-th hatching. 

    	returns Boolean from Standard
	raises NoSuchObject from Standard
	is static ;


    Status (me; IndH : Integer from Standard)
    
    	---Purpose: Returns the status about the IndH-th hatching. 

    	---C++: inline
    	returns ErrorStatus from HatchGen
	raises NoSuchObject from Standard
	is static ;


    NbDomains (me; IndH : Integer from Standard)

    	---Purpose: Returns the number of domains of the IndH-th hatching.
    	--          Only ONE "INFINITE" domain means that the hatching is
    	--          fully included in the contour defined by the elements.

    	---C++: inline
    	returns Integer from Standard
    	raises NoSuchObject from Standard ,
	       NotDone      from StdFail
    	is static ;


    Domain (me; IndH : Integer from Standard ;
    	    	IDom : Integer from Standard )

    	---Purpose: Returns the IDom-th domain of the IndH-th hatching.

    	---C++: return const &

    	returns Domain from HatchGen
    	raises NoSuchObject from Standard ,
	       NotDone      from StdFail ,
	       OutOfRange   from Standard
    	is static ;


---Category: Dump

    Dump (me)
    
    	---Purpose: Dump the hatcher.

    	is static ;


fields

    myIntersector  : TheIntersector ;
    myConfusion2d  : Real      from Standard ;
    myConfusion3d  : Real      from Standard ;
    myKeepPoints   : Boolean   from Standard ;
    myKeepSegments : Boolean   from Standard ;
    myNbElements   : Integer   from Standard ;
    myElements     : Elements  from HatchGen ;
    myNbHatchings  : Integer   from Standard ;
    myHatchings    : Hatchings from HatchGen ;

end Hatcher from HatchGen ;