e062d4a2109b5b8d88b3361831588a831cbda101
[occt.git] / src / Graphic3d / Graphic3d_Structure.cdl
1 -- Created on: 1991-06-12
2 -- Created by: NW,JPB,CAL
3 -- Copyright (c) 1991-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21 --              11/97 ; CAL : gestion du GraphicClear
22 --              11/97 ; CAL : ajout pointer StructPtr
23 --              11/97 ; CAL : amelioration de l'effacement SetManager
24 --              01/98 ; CAL : gestion du HLRValidation
25 --              05/98 ; CAL : gestion du GraphicConnect et Disconnect
26 --              02/00 ; GG  : Made Transform() methode not mutable.
27 --              31/05/01 ; GG : Add ResetDisplayPriority() method
28
29 class Structure from Graphic3d inherits TShared
30
31         ---Version:
32
33         ---Purpose: This class allows the definition a graphic object.
34         --          This graphic structure can be displayed,
35         --          erased, or highlighted.
36         --          This graphic structure can be connected with
37         --          another graphic structure.
38         --  Keywords: Structure, StructureManager, Display, Erase, Highlight,
39         --           UnHighlight, Visible, Priority, Selectable, Visible,
40         --           Visual, Connection, Ancestors, Descendants, Transformation
41
42         ---Warning:
43         ---References:
44
45 uses
46
47         Array2OfReal            from TColStd,
48         SequenceOfAddress       from TColStd,
49
50         Color                   from Quantity,
51
52         GenId                   from Aspect,
53         TypeOfHighlightMethod   from Aspect,
54
55         DataStructureManager    from Graphic3d,
56         AspectFillArea3d        from Graphic3d,
57         AspectLine3d            from Graphic3d,
58         AspectMarker3d          from Graphic3d,
59         AspectText3d            from Graphic3d,
60         CStructure              from Graphic3d,
61         GraphicDriver           from Graphic3d,
62         Group                   from Graphic3d,
63         SequenceOfGroup         from Graphic3d,
64         HSequenceOfGroup        from Graphic3d,
65         SequenceOfStructure     from Graphic3d,
66         HSequenceOfStructure    from Graphic3d,
67         MapOfStructure          from Graphic3d,
68         Plotter                 from Graphic3d,
69         StructureManager        from Graphic3d,
70         TypeOfComposition       from Graphic3d,
71         TypeOfConnection        from Graphic3d,
72         TypeOfPrimitive         from Graphic3d,
73         TypeOfStructure         from Graphic3d,
74         Vector                  from Graphic3d,
75         Vertex                  from Graphic3d,
76         TransModeFlags          from Graphic3d,
77         Pnt                     from gp
78
79 raises
80
81         PriorityDefinitionError         from Graphic3d,
82         StructureDefinitionError        from Graphic3d,
83         TransformError                  from Graphic3d
84
85 is
86
87         ------------------------
88         -- Category: Constructor
89         ------------------------
90
91         Create ( AManager       : StructureManager from Graphic3d )
92                 returns mutable Structure from Graphic3d;
93         ---Level: Public
94         ---Purpose: Creates a graphic object in the manager <AManager>.
95         --          It will appear in all the views of the visualiser.
96         --  Warning: The default values AspectLine, AspectFillArea,
97         --          AspectText and AspectMarker are NOT applied to the
98         --          structure.
99         --          The structure is not displayed when it is created.
100
101         ---------------------------------------------------
102         -- Category: Methods to modify the class definition
103         ---------------------------------------------------
104
105         --------------------------------------------------------
106         -- Summary of Display Priorities                      --
107         --                                                    --
108         -- Structure display priorities  control the order in --
109         -- which structures are redrawn.                      --
110         --                                                    --
111         -- When  you  display  a structure, you  specify  its --
112         -- priority.  The  lower  the  value, the  lower  the --
113         -- display priority. When the display is regenerated, --
114         -- the structures  with the lowest priority are drawn --
115         -- first.                                             --
116         -- For  structures  with the  same display  priority, --
117         -- the  order in which they were displayed determines --
118         -- determines the drawing order.                      --
119         --                                                    --
120         -- CAS.CADE supports 11 structure display priorities, --
121         -- 0 to 10.                                           --
122         --------------------------------------------------------
123
124         Clear ( me              : mutable;
125                 WithDestruction : Boolean from Standard = Standard_True )
126                 is virtual;
127         ---Level: Public
128         ---Purpose: if WithDestruction == Standard_True then
129         --              suppress all the groups of primitives in the structure.
130         --              and it is mandatory to create a new group in <me>.
131         --          if WithDestruction == Standard_False then
132         --              clears all the groups of primitives in the structure.
133         --              and all the groups are conserved and empty.
134         --          They will be erased at the next screen update.
135         --          The structure itself is conserved.
136         --          The transformation and the attributes of <me> are conserved.
137         --          The childs of <me> are conserved.
138         ---Category: Methods to modify the class definition
139
140         Destroy ( me    : mutable )
141                 is virtual;
142         ---Level: Public
143         ---Purpose: Suppresses the structure <me>.
144         --          It will be erased at the next screen update.
145         ---Category: Methods to modify the class definition
146         ---C++: alias ~
147
148         Display ( me    : mutable )
149                 is virtual;
150         ---Level: Public
151         ---Purpose: Displays the structure <me> in all the views of
152         --          the visualiser.
153         ---Category: Methods to modify the class definition
154
155         Display ( me            : mutable;
156                   Priority      : Integer from Standard )
157         ---Level: Public
158         ---Purpose: Displays the structure <me> in all the views of
159         --          the visualiser, while modifying its current priority.
160         --          Note: Display Priorities
161         --          Structure display priorities control the order in which
162         --          structures are redrawn.   When you display a
163         --          structure, you specify its priority. The lower the value,
164         --          the lower the display priority. When the display is
165         --          regenerated, the structures with the lowest priority
166         --          are drawn first. For structures with the same display
167         --          priority, the order in which they were displayed
168         --          determines the drawing order. Open CASCADE
169         --          supports 11 structure display priorities, 0 to 10.
170         --          Warning: Raises PriorityDefinitionError if <Priority> is
171         --          greater than 10 or a negative value.
172         raises PriorityDefinitionError from Graphic3d is static;
173
174         DisplayPriority ( me )
175                 returns Integer from Standard
176                 is static;
177         ---Level: Public
178         ---Purpose: Returns the current display priority for the
179         --          structure <me>.
180         ---Category: Methods to modify the class definition
181
182         Erase ( me      : mutable )
183                 is virtual;
184         ---Level: Public
185         ---Purpose: Erases the structure <me> in all the views
186         --          of the visualiser.
187         ---Category: Methods to modify the class definition
188
189         Highlight ( me          : mutable;
190                     Method      : TypeOfHighlightMethod from Aspect )
191                 is static;
192         ---Level: Public
193         ---Purpose: Highlights the structure <me> in all the
194         --          views of the visualiser, using the following methods:
195         --
196         --   TOHM_COLOR         = drawn in the highlight color
197         --                                (default white)
198         --          TOHM_BLINK          = blinking
199         --   TOHM_BOUNDBOX      = enclosed by the boundary box
200         --                                (default white)
201         --
202         ---Category: Methods to modify the class definition
203
204         Remove ( me     : mutable )
205                 is static;
206         ---Level: Public
207         ---Purpose: Suppress the structure <me>.
208         --          It will be erased at the next screen update.
209         --  Warning: No more graphic operations in <me> after this call.
210         --  Category: Methods to modify the class definition
211
212         SetHighlightColor ( me          : mutable;
213                             AColor      : Color from Quantity )
214                 is static;
215         ---Level: Public
216         ---Purpose: Modifies the highlight color for the Highlight method
217         --          with the highlight method TOHM_COLOR or TOHM_BOUNDBOX.
218         ---Category: Methods to modify the class definition
219
220         SetInfiniteState ( me           : mutable;
221                            AFlag        : Boolean from Standard )
222                 is static;
223         ---Level: Internal
224         ---Purpose: Modifies the coordinates of the boundary box
225         --          of the structure <me>.
226         --          if <AFlag> is Standard_True then <me> is infinite and
227         --          the MinMaxValues method or the MinMaxCoord method return :
228         --          XMin = YMin = ZMin = RealFirst ().
229         --          XMax = YMax = ZMax = RealLast ().
230         --          By default, <me> is not infinite but empty.
231         ---Category: Methods to modify the class definition
232
233         SetDisplayPriority ( me         : mutable;
234                              Priority   : Integer from Standard )
235         ---Level: Public
236         ---Purpose: Modifies the order of displaying the structure.
237         --          Values are between 0 and 10.
238         --          Structures are drawn according to their display priorities
239         --          in ascending order.
240         --          A structure of priority 10 is displayed the last and appears over the others.
241         --          The default value is 5.
242         --  Category: Methods to modify the class definition
243         --  Warning: If <me> is displayed then the SetDisplayPriority
244         --          method erase <me> and display <me> with the
245         --          new priority.
246         --          Raises PriorityDefinitionError if <Priority> is
247         --          greater than 10 or a negative value.
248         raises PriorityDefinitionError from Graphic3d is static;
249
250         ResetDisplayPriority ( me               : mutable)
251                 is static;
252         ---Level: Public
253         ---Purpose: Reset the current priority of the structure to the
254         --          previous priority.
255         --  Category: Methods to modify the class definition
256         --  Warning: If <me> is displayed then the SetDisplayPriority
257         --          method erase <me> and display <me> with the
258         --          previous priority.
259         
260         SetZLayer ( me         : mutable;
261                     theLayerId : Integer from Standard )
262            is static;
263         ---Purpose: Set Z layer ID for the structure. The Z layer mechanism
264         -- allows to display structures presented in higher layers in overlay
265         -- of structures in lower layers by switching off z buffer depth
266         -- test between layers
267
268         GetZLayer ( me )
269           returns Integer from Standard is static;
270         ---Purpose: Get Z layer ID of displayed structure. The method
271         -- returns -1 if the structure has no ID (deleted from graphic driver).
272
273         SetPick ( me            : mutable;
274                   AValue        : Boolean from Standard )
275                 is static;
276         ---Level: Public
277         ---Purpose: Modifies the detectability indicator to Standard_True
278         --          or Standard_False for the structure <me>.
279         --          The default value at the definition of <me> is
280         --          Standard_True.
281         ---Category: Methods to modify the class definition
282
283         SetPrimitivesAspect ( me        : mutable;
284                               CTX       : AspectLine3d from Graphic3d )
285                 is static;
286         ---Level: Public
287         ---Purpose: Modifies the default attributes for lines
288         --          in the structure <me>.
289         ---Category: Methods to modify the class definition
290
291         SetPrimitivesAspect ( me        : mutable;
292                               CTX       : AspectFillArea3d from Graphic3d )
293                 is static;
294         ---Level: Public
295         ---Purpose: Modifies the default attributes for faces
296         --          in the structure <me>.
297         ---Category: Methods to modify the class definition
298
299         SetPrimitivesAspect ( me        : mutable;
300                               CTX       : AspectText3d from Graphic3d )
301                 is static;
302         ---Level: Public
303         ---Purpose: Modifies the default attributes for text
304         --          in the structure <me>.
305         ---Category: Methods to modify the class definition
306
307         SetPrimitivesAspect ( me        : mutable;
308                               CTX       : AspectMarker3d from Graphic3d )
309                 is static;
310         ---Level: Public
311         ---Purpose: Modifies the default attributes for markers
312         --          in the structure <me>.
313         ---Category: Methods to modify the class definition
314
315         SetVisible ( me         : mutable;
316                      AValue     : Boolean from Standard )
317                 is static;
318         ---Level: Public
319         ---Purpose: Modifies the visibility indicator to Standard_True or
320         --          Standard_False for the structure <me>.
321         --          The default value at the definition of <me> is
322         --          Standard_True.
323         ---Category: Methods to modify the class definition
324
325         SetManager ( me                 : mutable;
326                      AManager           : StructureManager from Graphic3d;
327                      WithPropagation    : Boolean from Standard = Standard_False)
328                 is static;
329         ---Level: Public
330         ---Purpose: Moves the graphic object <me> in the manager <AManager>.
331         --          If <WithPropagation> is Standard_True then all the connected
332         --          graphic objects to <me> are moved.
333
334         SetVisual ( me          : mutable;
335                     AVisual     : TypeOfStructure from Graphic3d )
336                 is virtual;
337         ---Level: Public
338         ---Purpose: Modifies the visualisation mode for the structure <me>.
339         ---Warning: It is not possible to display a structure with
340         --          an incompatible display mode.
341         --          If the display mode is different from the current one,
342         --          the structure is erased.
343         --
344         --          TOS_WIREFRAME for a wireframe visualisation
345         --          TOS_SHADING for a shaded visualisation
346         --          TOS_ALL for all visualisations
347         --          TOS_COMPUTED for a computed visualisation
348         --          The default value is TOS_ALL
349         --
350         ---Category: Methods to modify the class definition
351
352         SetZoomLimit ( me                       : mutable;
353                        LimitInf, LimitSup       : Real from Standard )
354         ---Level: Internal
355         ---Purpose: Modifies the minimum and maximum zoom coefficients
356         --          for the structure <me>.
357         --          The default value at the definition of <me> is unlimited.
358         --  Category: Methods to modify the class definition
359         --  Warning: Raises StructureDefinitionError if <LimitInf> is
360         --          greater than <LimitSup> or if <LimitInf> or
361         --          <LimitSup> is a negative value.
362         raises StructureDefinitionError from Graphic3d is static;
363
364         UnHighlight ( me        : mutable )
365                 is static;
366         ---Level: Public
367         ---Purpose: Suppresses the highlight for the structure <me>
368         --           in all the views of the visualiser.
369         ---Category: Methods to modify the class definition
370
371         ----------------------------
372         -- Category: Compute methods
373         ----------------------------
374
375         Compute ( me    : mutable;
376                   aProjector    : DataStructureManager from Graphic3d )
377                 returns Structure from Graphic3d is virtual;
378         ---Level: Advanced
379         ---Purpose: Returns the new Structure defined for the new visualization
380         ---Category: Methods to modify the class definition
381
382         Compute ( me    : mutable;
383                   aProjector    : DataStructureManager from Graphic3d;
384                   AMatrix       : Array2OfReal from TColStd )
385                 returns Structure from Graphic3d is virtual;
386         ---Level: Advanced
387         ---Purpose: Returns the new Structure defined for the new visualization
388         ---Category: Methods to modify the class definition
389
390         Compute ( me    : mutable;
391                   aProjector    : DataStructureManager from Graphic3d;
392                   aStructure    : in out Structure from Graphic3d )
393                 is virtual;
394         ---Level: Advanced
395         ---Purpose: Returns the new Structure defined for the new visualization
396         ---Category: Methods to modify the class definition
397
398         Compute ( me    : mutable;
399                   aProjector    : DataStructureManager from Graphic3d;
400                   AMatrix       : Array2OfReal from TColStd;
401                   aStructure    : in out Structure from Graphic3d )
402                 is virtual;
403         ---Level: Advanced
404         ---Purpose: Returns the new Structure defined for the new visualization
405         ---Category: Methods to modify the class definition
406
407         ReCompute ( me  : mutable );
408         ---Level: Advanced
409         ---Purpose: Forces a new construction of the structure <me>
410         --          if <me> is displayed and TOS_COMPUTED.
411         ---Category: Methods to modify the class definition
412
413         ReCompute ( me          : mutable;
414                     aProjector  : DataStructureManager from Graphic3d );
415         ---Level: Advanced
416         ---Purpose: Forces a new construction of the structure <me>
417         --          if <me> is displayed in <aProjetor> and TOS_COMPUTED.
418         ---Category: Methods to modify the class definition
419
420         ----------------------------
421         -- Category: Inquire methods
422         ----------------------------
423
424         ContainsFacet ( me )
425                 returns Boolean from Standard
426                 is static;
427         ---Level: Public
428         ---Purpose: Returns Standard_True if the structure <me> contains
429         --          Polygons, Triangles or Quadrangles.
430         ---Category: Inquire methods
431
432         
433         FillArea3dAspect ( me )
434                 returns AspectFillArea3d from Graphic3d
435                 is static;
436         ---Level: Public
437         ---Purpose: Returns the values of the current default attributes.
438         ---Category: Inquire methods
439
440         Groups ( me )
441                 returns SequenceOfGroup from Graphic3d
442                 is static;
443         ---C++: return const &
444         ---Level: Internal
445         ---Purpose: Returns the groups sequence included in the structure <me> (internal storage).
446         ---Category: Inquire methods
447
448         NumberOfGroups ( me )
449                 returns Integer from Standard
450                 is static;
451         ---Level: Public
452         ---Purpose: Returns the current number of groups in the
453         --          structure <me>.
454         ---Category: Inquire methods
455
456         HighlightColor ( me )
457                 returns Color from Quantity
458                 is static;
459         ---Level: Public
460         ---Purpose: Returns the highlight color for the Highlight method
461         --          with the highlight method TOHM_COLOR or TOHM_BOUNDBOX.
462         ---Category: Inquire methods
463
464         IsDeleted ( me )
465                 returns Boolean from Standard
466                 is static;
467         ---Level: Public
468         ---Purpose: Returns Standard_True if the structure <me> is deleted.
469         --          <me> is deleted after the call Remove (me).
470         ---Category: Inquire methods
471
472         IsDisplayed ( me )
473                 returns Boolean from Standard
474                 is virtual;
475         ---Level: Public
476         ---Purpose: Returns the display indicator for the structure <me>.
477         ---Category: Inquire methods
478
479         IsEmpty ( me )
480                 returns Boolean from Standard
481                 is static;
482         ---Level: Public
483         ---Purpose: Returns Standard_True if the structure <me> is empty.
484         --  Warning: A structure is empty if :
485         --              it do not have group or all the groups are empties
486         --              and it do not have descendant or all the descendants
487         --              are empties.
488         ---Category: Inquire methods
489
490         IsInfinite ( me )
491                 returns Boolean from Standard
492                 is static;
493         ---Level: Internal
494         ---Purpose: Returns Standard_True if the structure <me> is infinite.
495         ---Category: Inquire methods
496
497         IsHighlighted ( me )
498                 returns Boolean from Standard
499                 is virtual;
500         ---Level: Public
501         ---Purpose: Returns the highlight indicator for the structure <me>.
502         ---Category: Inquire methods
503
504         IsSelectable ( me )
505                 returns Boolean from Standard
506                 is static;
507         ---Level: Public
508         ---Purpose: Returns the detectability indicator for the structure <me>.
509         ---Category: Inquire methods
510
511         IsRotated ( me )
512                 returns Boolean from Standard
513                 is static;
514         ---Level: Public
515         ---Purpose: Returns Standard_True if the structure <me> is rotated.
516         --          <=> The transformation != Identity, != Scale, != Translation.
517         ---Category: Inquire methods
518
519         IsTransformed ( me )
520                 returns Boolean from Standard
521                 is static;
522         ---Level: Public
523         ---Purpose: Returns Standard_True if the structure <me> is transformed.
524         --          <=> The transformation != Identity.
525         ---Category: Inquire methods
526
527         IsVisible ( me )
528                 returns Boolean from Standard
529                 is static;
530         ---Level: Public
531         ---Purpose: Returns the visibility indicator for the structure <me>.
532         ---Category: Inquire methods
533
534         Line3dAspect ( me )
535                 returns AspectLine3d from Graphic3d
536                 is static;
537         ---Level: Public
538         ---Purpose: Returns the values of the current default attributes.
539         ---Category: Inquire methods
540
541         Marker3dAspect ( me )
542                 returns AspectMarker3d from Graphic3d
543                 is static;
544         ---Purpose: Returns the current group of graphic attributes used
545         -- for 3d marker primitives.
546
547         MinMaxValues ( me;
548                        XMin, YMin, ZMin : out Real from Standard;
549                        XMax, YMax, ZMax : out Real from Standard )
550                 is static;
551         ---Level: Public
552         ---Purpose: Returns the coordinates of the boundary box
553         --          of the structure <me>.
554         --  Warning: If the structure <me> is empty or infinite then :
555         --          XMin = YMin = ZMin = RealFirst ().
556         --          XMax = YMax = ZMax = RealLast ().
557         ---Category: Inquire methods
558
559         PrimitivesAspect ( me;
560                            CTXL : out AspectLine3d from Graphic3d;
561                            CTXT : out AspectText3d from Graphic3d;
562                            CTXM : out AspectMarker3d from Graphic3d;
563                            CTXF : out AspectFillArea3d from Graphic3d )
564                 is static;
565         ---Level: Public
566         ---Purpose: Returns the current values of the default attributes.
567         ---Category: Inquire methods
568
569         Text3dAspect ( me )
570                 returns AspectText3d from Graphic3d
571                 is static;
572         ---Level: Public
573         ---Purpose: Returns the values of the current default attributes.
574         ---Category: Inquire methods
575
576         Visual ( me )
577                 returns TypeOfStructure from Graphic3d
578                 is static;
579         ---Level: Public
580         ---Purpose: Returns the visualisation mode for the structure <me>.
581         ---Category: Inquire methods
582
583         ----------------------------------------------------
584         -- Category: Methods to manage the structure network
585         ----------------------------------------------------
586
587         -----------------------------------------------------
588         -- Summary of Structure Hierarchies                --
589         --                                                 --
590         -- The root  is the top  of a  structure hierarchy --
591         -- or structure network.                           --
592         --                                                 --
593         -- The attributes of a parent structure are passed --
594         -- passed to its descendants.                      --
595         --                                                 --
596         -- The  attributes  of the  descendant  structures --
597         -- don't affect the parent.                        --
598         --                                                 --
599         -- Recursive structure networks are not supported. --
600         -----------------------------------------------------
601
602         AcceptConnection ( myclass;
603                            AStructure1  : Structure from Graphic3d;
604                            AStructure2  : Structure from Graphic3d;
605                            AType        : TypeOfConnection from Graphic3d )
606                 returns Boolean from Standard;
607         ---Level: Internal
608         ---Purpose: Returns Standard_True if the connection is possible between
609         --          <AStructure1> and <AStructure2> without a creation
610         --          of a cycle.
611         --
612         --          It's not possible to call the method
613         --             AStructure1->Connect (AStructure2, TypeOfConnection)
614         --          if
615         --          - the set of all ancestors of <AStructure1> contains
616         --            <AStructure1> and if the
617         --            TypeOfConnection == TOC_DESCENDANT
618         --          - the set of all descendants of <AStructure1> contains
619         --            <AStructure2> and if the
620         --            TypeOfConnection == TOC_ANCESTOR
621         ---Category: Methods to manage the structure network
622
623         Ancestors ( me; SG: in out MapOfStructure from Graphic3d )
624                 is static;
625         ---Level: Internal
626         ---Purpose: Returns the group of structures to which <me> is connected.
627         ---Category: Methods to manage the structure network
628
629         Connect ( me            : mutable;
630                   AStructure    : Structure from Graphic3d;
631                   AType         : TypeOfConnection from Graphic3d;
632                   WithCheck     : Boolean from Standard = Standard_False );
633         ---Level: Public
634         ---Purpose: If Atype is TOC_DESCENDANT then add <AStructure>
635         --          as a child structure of  <me>.
636         --          If Atype is TOC_ANCESTOR then add <AStructure>
637         --          as a parent structure of <me>.
638         --          The connection propagates Display, Highlight, Erase,
639         --          Remove, and stacks the transformations.
640         --          No connection if the graph of the structures
641         --          contains a cycle and <WithCheck> is Standard_True;
642         ---Category: Methods to manage the structure network
643
644         Descendants ( me; SG : in out MapOfStructure from Graphic3d )
645                 is static;
646         ---Level: Internal
647         ---Purpose: Returns the group of structures connected to <me>.
648         ---Category: Methods to manage the structure network
649
650         Disconnect ( me         : mutable;
651                      AStructure : Structure from Graphic3d )
652                 is static;
653         ---Level: Public
654         ---Purpose: Suppress the connection between <AStructure> and <me>.
655         ---Category: Methods to manage the structure network
656
657         DisconnectAll ( me      : mutable;
658                         AType   : TypeOfConnection from Graphic3d )
659                 is static;
660         ---Level: Public
661         ---Purpose: If Atype is TOC_DESCENDANT then suppress all
662         --          the connections with the child structures of <me>.
663         --          If Atype is TOC_ANCESTOR then suppress all
664         --          the connections with the parent structures of <me>.
665         ---Category: Methods to manage the structure network
666
667         Network ( myclass;
668                   AStructure    : Structure from Graphic3d;
669                   AType         : TypeOfConnection from Graphic3d;
670                   ASet          : in out MapOfStructure from Graphic3d );
671         ---Level: Internal
672         ---Purpose: Returns <ASet> the group of structures :
673         --          - directly or indirectly connected to <AStructure> if the
674         --            TypeOfConnection == TOC_DESCENDANT
675         --          - to which <AStructure> is directly or indirectly connected
676         --            if the TypeOfConnection == TOC_ANCESTOR
677         ---Category: Methods to manage the structure network
678
679         SetOwner ( me   : mutable;
680                    Owner        : Address from Standard )
681                 is static;
682         ---Level: Advanced
683
684         Owner ( me )
685                 returns Address from Standard
686                 is static;
687         ---Level: Advanced
688
689         SetHLRValidation ( me   : mutable;
690                            AFlag        : Boolean from Standard )
691                 is static;
692         ---Level: Advanced
693
694         HLRValidation ( me )
695                 returns Boolean from Standard
696                 is static;
697         ---Level: Advanced
698
699         -----------------------------------------------------------
700         -- Category: Methods to manage the structure transformation
701         -----------------------------------------------------------
702
703         Composition ( me )
704                 returns TypeOfComposition from Graphic3d
705                 is static;
706         ---Level: Public
707         ---Purpose: Returns the type of composition applied to matrices
708         --          of transformation of <me>.
709         ---Category: Methods to manage the structure transformation
710
711         SetTransform ( me       : mutable;
712                        AMatrix  : Array2OfReal from TColStd;
713                        AType    : TypeOfComposition from Graphic3d )
714         ---Level: Public
715         ---Purpose: Modifies the current local modelling transformation
716         --          in the structure <me>.
717         --
718         --          It is defined as a 4*4 real matrix.
719         --
720         --          -------------------
721         --          | a11 a12 a13  t1 |
722         --          | a21 a22 a23  t2 |
723         --          | a31 a32 a33  t3 |
724         --          |  0   0   0   1  |
725         --          -------------------
726         --
727         --          TypeOfComposition : TOC_REPLACE
728         --                              TOC_POSTCONCATENATE
729         --
730         -- Then the modified Local Modelling Transformation is composed
731         -- with the current Global Modelling Transformation to create a
732         -- new Composite Modelling Transformation.
733         --
734         -- The compose type specifies the role of the current local
735         -- modelling transformation (L) in composing the new value for
736         -- the current local modelling transformation (L'), which is
737         -- then combined with the current global modelling transforma-
738         -- tion (G) to calculate the new composite modelling transfor-
739         -- mation (C).
740         --
741         -- TOC_REPLACE
742         -- The transformation matrix (T) replaces the value of
743         -- current local modelling transformation (L).
744         --
745         --      L' <- T
746         --      C <- G x L'
747         --
748         -- TOC_POSTCONCATENATE
749         -- The current local modelling transformation (L) is multiplied
750         -- by the transformation matrix (T):
751         --
752         --      L' <- T x L
753         --      C <- G x L'
754         --
755         --  Category: Methods to manage the structure transformation
756         --  Warning: Raises TransformError if the matrix is not a 4x4 matrix.
757         raises TransformError from Graphic3d is static;
758
759         -- Transform ( me               : mutable;
760         Transform ( me;
761                     AMatrix     : in out Array2OfReal from TColStd )
762                 is static;
763         ---Level: Public
764         ---Purpose: Returns the transformation associated with
765         --          the structure <me>.
766         ---Category: Methods to manage the structure transformation
767
768         SetTransformPersistence( me     : mutable;
769                                  AFlag  : TransModeFlags from Graphic3d;
770                                  APoint : Pnt from gp  )
771         ---Level: Public
772         ---Purpose: Modifies the current modelling transform persistence (pan, zoom or rotate)
773         is static;
774
775         SetTransformPersistence(  me  :  mutable;
776                                   AFlag  :  TransModeFlags  from  Graphic3d  )
777         --  Calls previous   method  with  point  (0,0,0)
778         is  static;
779
780
781         TransformPersistenceMode( me )
782                         returns TransModeFlags from Graphic3d
783         ---Level: Public
784         ---Purpose: Get the current modelling transform persistence (pan, zoom or rotate)
785         is static;
786
787         TransformPersistencePoint( me )
788                         returns Pnt from gp
789         ---Level: Public
790         ---Purpose: Get the current point of relative modelling transform persistence
791         is static;
792
793         ----------------------------
794         -- Category: Private methods
795         ----------------------------
796
797         Add ( me        : mutable;
798               AGroup    : Group from Graphic3d )
799                 is static private;
800         ---Level: Internal
801         ---Purpose: Inserts in the structure <me>, the group <G>.
802         --          It will be erased at the next screen update.
803         ---Category: Private methods
804
805         ComputeVisual ( me )
806                 returns TypeOfStructure from Graphic3d
807                 is static;
808         ---Level: Internal
809         ---Category: Private methods
810
811         GroupsWithFacet ( me    : mutable;
812                         ADelta  : Integer from Standard )
813                 is static private;
814         ---Level: Internal
815         ---Purpose: Manages the number of groups in the structure <me>
816         --          which contains facet.
817         --          Polygons, Triangles or Quadrangles.
818         --          <ADelta> = +1 or -1
819         ---Category: Private methods
820
821         GraphicClear ( me       : mutable;
822                        WithDestruction  : Boolean from Standard )
823                 is static;
824         ---Level: Internal
825         ---Purpose: Clears the structure <me>.
826         ---Category: Private methods
827
828         GraphicConnect ( me     : mutable;
829                          ADaughter      : Structure from Graphic3d )
830                 is static;
831         ---Level: Internal
832         ---Purpose:
833         ---Category: Private methods
834
835         GraphicDisconnect ( me  : mutable;
836                             ADaughter   : Structure from Graphic3d )
837                 is static;
838         ---Level: Internal
839         ---Purpose:
840         ---Category: Private methods
841
842         GraphicHighlight ( me           : mutable;
843                            Method       : TypeOfHighlightMethod from Aspect )
844                 is static;
845         ---Level: Internal
846         ---Purpose: Highlights the structure <me>.
847         ---Category: Private methods
848
849         GraphicTransform ( me           : mutable;
850                            AMatrix      : Array2OfReal from TColStd )
851                 is static;
852         ---Level: Internal
853         ---Purpose:
854         ---Category: Private methods
855
856         GraphicUnHighlight ( me : mutable )
857                 is static;
858         ---Level: Internal
859         ---Purpose: Suppress the highlight for the structure <me>.
860         ---Category: Private methods
861
862         Identification ( me )
863                 returns Integer from Standard
864                 is static;
865         ---Level: Internal
866         ---Purpose: Returns the identification number of the structure <me>.
867         ---Category: Private methods
868
869         MinMaxCoord ( me;
870                       XMin, YMin, ZMin  : out Real from Standard;
871                       XMax, YMax, ZMax  : out Real from Standard )
872                 is static private;
873         ---Level: Internal
874         ---Purpose: Returns the extreme coordinates found in the
875         --          structure <me>.
876         --  Warning: If the structure <me> is empty or infinite then :
877         --          XMin = YMin = ZMin = RealFirst ().
878         --          XMax = YMax = ZMax = RealLast ().
879         ---Category: Private methods
880
881         Plot ( me       : mutable;
882                aPlotter : Plotter from Graphic3d )
883                 is virtual;
884         ---Level: Internal
885         ---Category: Private methods
886
887         PrintNetwork ( myclass;
888                        AStructure       : Structure from Graphic3d;
889                        AType            : TypeOfConnection from Graphic3d );
890         ---Level: Internal
891         ---Purpose: Prints informations about the network associated
892         --          with the structure <AStructure>.
893         ---Category: Private methods
894
895         Remove ( me     : mutable;
896                  APtr   : Address from Standard;
897                  AType  : TypeOfConnection from Graphic3d )
898                 is static;
899         ---Level: Internal
900         ---Purpose: Suppress the adress <APtr> in the list
901         --          of descendants or in the list of ancestors.
902         ---Category: Private methods
903
904         Remove ( me     : mutable;
905                  AGroup : Group from Graphic3d )
906                 is static private;
907         ---Level: Internal
908         ---Purpose: Suppress in the structure <me>, the group <AGroup>.
909         --          It will be erased at the next screen update.
910         ---Category: Private methods
911
912         SetComputeVisual ( me           : mutable;
913                            AVisual      : TypeOfStructure from Graphic3d )
914                 is static;
915         ---Level: Internal
916         ---Category: Private methods
917
918         StructureManager ( me )
919                 returns StructureManager from Graphic3d
920                 is static private;
921         ---Level: Internal
922         ---Purpose: Returns the manager to which <me> is associated.
923         ---Category: Private methods
924
925         Transforms ( myclass;
926                      ATrsf              : Array2OfReal from TColStd;
927                      X, Y, Z            : Real from Standard;
928                      NewX, NewY, NewZ   : out Real from Standard );
929         ---Level: Internal
930         ---Purpose: Transforms <X>, <Y>, <Z> with the transformation <ATrsf>.
931         ---Category: Private methods
932
933         Transforms ( myclass;
934                      ATrsf      : Array2OfReal from TColStd;
935                      Coord      : Vector from Graphic3d )
936                 returns Vector from Graphic3d;
937         ---Level: Internal
938         ---Purpose: Transforms <Coord> with the transformation <ATrsf>.
939         ---Category: Private methods
940
941         Transforms ( myclass;
942                      ATrsf      : Array2OfReal from TColStd;
943                      Coord      : Vertex from Graphic3d )
944                 returns Vertex from Graphic3d;
945         ---Level: Internal
946         ---Purpose: Transforms <Coord> with the transformation <ATrsf>.
947         ---Category: Private methods
948
949         Update ( me )
950                 is static private;
951         ---Level: Internal
952         ---Purpose: Calls the Update method of the StructureManager which
953         --          contains the Structure <me>.
954         ---Category: Private methods
955
956         UpdateStructure ( me    : mutable;
957                           CTXL  : AspectLine3d from Graphic3d;
958                           CTXT  : AspectText3d from Graphic3d;
959                           CTXM  : AspectMarker3d from Graphic3d;
960                           CTXF  : AspectFillArea3d from Graphic3d )
961                 is static private;
962         ---Level: Internal
963         ---Purpose: Updates the c structure associated to <me>.
964         ---Category: Private methods
965
966         CStructure ( me : mutable )
967                 returns CStructure from Graphic3d
968                 is static;
969         ---Level: Internal
970         ---Purpose: Returns the c structure associated to <me>.
971         ---Category: Private methods
972         ---C++: return *
973
974 fields
975
976 --
977 -- Class        :       Graphic3d_Structure
978 --
979 -- Purpose      :       Declaration of variables specific to
980 --                      graphic structures.
981 -- Reminder     :       A structure is defined in a manager.
982 --                      It is a sequence of groups of primitives.
983 --
984
985         -- the associated C structure
986         MyCStructure            :       CStructure from Graphic3d;
987
988         -- the structures to which the structure is attached
989         MyAncestors             :       SequenceOfAddress from TColStd;
990
991         -- the structures attached to the structure
992         MyDescendants           :       SequenceOfAddress from TColStd;
993
994         -- the sequence of groups
995         MyGroups                :       SequenceOfGroup from Graphic3d;
996
997         -- the graphic driver used
998         MyGraphicDriver         :       GraphicDriver from Graphic3d;
999
1000         -- the highlight method of the structure
1001         MyHighlightColor        :       Color from Quantity;
1002         MyHighlightMethod       :       TypeOfHighlightMethod from Aspect;
1003
1004         -- the manager accepting the structure
1005         MyPtrStructureManager           :       Address from Standard is protected;
1006         MyFirstPtrStructureManager      :       Address from Standard is protected;
1007         MyOwner                         :       Address from Standard;
1008
1009         -- the type of visualisation accepted by the structure
1010         MyVisual                :       TypeOfStructure from Graphic3d;
1011         MyComputeVisual         :       TypeOfStructure from Graphic3d is protected;
1012
1013 friends
1014
1015         -- a lot of methods of Group use the methods of Structure
1016         class Group     from Graphic3d
1017
1018 end Structure;