0023024: Update headers of OCCT files
[occt.git] / src / AIS / AIS_MultipleConnectedShape.cdl
1 -- Created on: 1997-04-22
2 -- Created by: Guest Design
3 -- Copyright (c) 1997-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
22 class MultipleConnectedShape from AIS inherits MultipleConnectedInteractive from AIS
23
24     
25         ---Purpose: Constructs an Interactive Object connected to a list of
26         -- Interactive Objects having a Shape. These include
27         -- AIS_Shape, and AIS_ConnectedShape.
28         -- Presentation of Hidden parts is calculated automatically.
29         -- You define the Interactive Object by gathering
30         -- together several other object presentations as in
31         -- AIS_MultipleConnectedInteractive.
32         
33 uses
34
35     PresentationManager3d  from PrsMgr,
36     PresentationManager2d from PrsMgr,
37     GraphicObject         from Graphic2d,    
38     Shape                from TopoDS,
39     Projector            from Prs3d,
40     Presentation         from Prs3d,
41     Selection            from SelectMgr,
42     Integer              from Standard,
43     Transformation       from Geom,
44     KindOfInteractive    from AIS
45     
46 raises
47     NotImplemented from Standard
48
49 is
50
51     Create (aShape : Shape from TopoDS) 
52     returns  mutable  MultipleConnectedShape  from  AIS;
53         ---Purpose: Initializes the shape aShape, a multiple connected
54         -- Interactive Object grouping different
55         -- projector-dependent representations of an entity.
56     Type(me) returns KindOfInteractive from AIS
57     is redefined virtual;
58
59     Signature(me) returns Integer from Standard
60     is redefined virtual;
61
62     AcceptShapeDecomposition(me) 
63     returns Boolean from Standard is redefined virtual;
64         ---Purpose: Returns true is shape decomposition is accepted.
65
66     Set(me:mutable;ashap : Shape from TopoDS) is static;
67         ---Purpose: Constructs the reference shape ashap.
68         ---C++: inline
69
70     Shape(me)  returns Shape from TopoDS ;
71         ---Purpose: Returns the shape which is constructed in Set.
72         ---C++: inline
73         ---C++: return const&
74
75
76     Compute(me:mutable;
77                 aProjector   :         Projector    from Prs3d;
78                 aPresentation: mutable Presentation from Prs3d)
79     is redefined virtual protected;
80  
81     Compute(me:mutable;
82                 aProjector   :         Projector    from Prs3d;
83                 aTrsf        :         Transformation from Geom;
84                 aPresentation: mutable Presentation from Prs3d)
85     is redefined virtual protected;
86  
87     ComputeSelection(me:mutable; aSelection :mutable Selection from SelectMgr;
88                                  aMode      :        Integer   from Standard)
89     is redefined virtual protected;
90     
91     
92     
93     Compute(me:mutable;
94                 aProjector   :         Projector    from Prs3d;
95                 aPresentation: mutable Presentation from Prs3d;
96                 aShape       :         Shape from TopoDS)
97     is private;
98      
99     Compute(me:mutable;
100             aPresentationManager :         PresentationManager3d from PrsMgr;
101             aPresentation        : mutable Presentation          from Prs3d;
102             aMode                :         Integer               from Standard = 0)
103         ---Level: Internal 
104         ---Purpose: this method is redefined virtual;
105         --          when the instance is connected to another
106         --          InteractiveObject,this method doesn't
107         --          compute anything, but just uses the 
108         --          presentation of this last object, with
109         --          a transformation if there's one stored. 
110     is redefined virtual private;
111
112     Compute(me:mutable;
113                 aPresentationManager: PresentationManager2d from PrsMgr;
114                 aPresentation: mutable GraphicObject from Graphic2d;
115                 aMode: Integer from Standard = 0)
116         ---Level: Internal 
117         ---Purpose: this method should fill the presentation according to the
118         --          enumerated mode of the application and to the display parameter
119         --          of the application.
120                 
121     raises NotImplemented from Standard
122     is redefined;
123     
124 fields
125     myShape : Shape   from TopoDS; -- celle qui sert au compute Hidden lines et selection
126 end MultipleConnectedShape;