0024420: Add methods to switch the type of sensitivity in AIS_Circle and AIS_Plane
[occt.git] / src / AIS / AIS_Plane.cdl
1 -- Created on: 1995-08-02
2 -- Created by: Arnaud BOUZY/Odile Olivier
3 -- Copyright (c) 1995-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 --   GG  :  GER61351 17/11/1999 Change SetColor() with a compatible Quantity_Color instead
22 --                                     the restricted NameOfColor.
23 --Modified by   rob Wed 11 feb 98 : add Size Methods
24
25
26 class Plane from AIS inherits InteractiveObject from AIS
27
28         ---Purpose: Constructs plane datums to be used in construction of
29         -- composite shapes.
30
31 uses 
32     Plane                 from Geom,
33     Presentation          from Prs3d,
34     PresentationManager3d from PrsMgr,
35     NameOfColor           from Quantity,
36     Color                         from Quantity,
37     Selection             from SelectMgr,
38     TypeOfSensitivity     from Select3D,
39     Pnt                   from gp,
40     Projector             from Prs3d,
41     Transformation        from Geom,
42     NameOfMaterial        from Graphic3d,
43     TypeOfPlane           from AIS, 
44     Axis2Placement        from Geom,
45     InteractiveContext    from AIS,
46     KindOfInteractive     from AIS
47
48 is
49     Create(aComponent : Plane from Geom;
50            aCurrentMode : Boolean from Standard = Standard_False) 
51     returns mutable Plane from AIS;
52         ---Purpose: initializes the plane aComponent. If
53         --   the mode aCurrentMode equals true, the drawing
54         --   tool, "Drawer" is not initialized.  
55     
56     Create(aComponent : Plane from Geom;
57            aCenter    : Pnt   from gp;
58            aCurrentMode : Boolean from Standard = Standard_False) 
59     returns mutable Plane from AIS;
60         --- Purpose:   initializes the plane aComponent and
61         --   the point aCenter. If the mode aCurrentMode
62         --   equals true, the drawing tool, "Drawer" is not
63         --   initialized. aCurrentMode equals true, the drawing
64         --   tool, "Drawer" is not initialized. 
65     
66     Create(aComponent : Plane from Geom;
67            aCenter    : Pnt   from gp;
68            aPmin      : Pnt   from gp;
69            aPmax      : Pnt   from gp;
70            aCurrentMode : Boolean from Standard = Standard_False) 
71     returns mutable Plane from AIS;
72         ---Purpose:   initializes the plane aComponent, the
73         --   point aCenter, and the minimum and maximum
74         --   points, aPmin and aPmax. If the mode
75         -- aCurrentMode equals true, the drawing tool, "Drawer" is not initialized.
76     
77     Create(aComponent : Axis2Placement from Geom;
78            aPlaneType : TypeOfPlane from AIS;
79            aCurrentMode : Boolean from Standard = Standard_False) 
80     returns mutable Plane from AIS;
81
82
83     ---Category: Size Modifications...
84
85     SetSize(me:mutable;aValue:Real from Standard);
86         ---Purpose: Same value for x and y directions
87
88     SetSize(me:mutable;Xval,YVal:Real from Standard);
89         ---Purpose: Sets the size defined by the length along the X axis
90         -- XVal and the length along the Y axis YVal.
91
92     UnsetSize(me:mutable) ;
93
94     Size(me;X,Y:out Real from Standard) returns Boolean from Standard;
95     
96     HasOwnSize(me) returns Boolean from Standard;
97         ---C++: inline
98
99
100
101     Signature(me) returns Integer from Standard is redefined;
102
103     Type(me) returns KindOfInteractive from AIS is redefined;
104
105
106
107     Component(me: mutable) returns Plane from Geom 
108     is static;
109         ---Purpose: Returns the component specified in SetComponent.
110         ---C++: inline
111         ---C++: return const&
112     
113     SetComponent(me: mutable;aComponent : Plane from Geom) is static;
114         ---Purpose: Creates an instance of the plane aComponent.
115
116     PlaneAttributes(me: mutable;
117                aComponent : out Plane from Geom;
118                aCenter    : out Pnt   from gp;
119                aPmin      : out Pnt   from gp;
120                aPmax      : out Pnt   from gp)
121     returns Boolean from Standard;
122         ---Purpose: Returns the settings for the selected plane
123         -- aComponent, provided in SetPlaneAttributes.
124         -- These include the points aCenter, aPmin, and aPmax
125
126     SetPlaneAttributes(me: mutable;
127                aComponent : Plane from Geom;
128                aCenter    : Pnt   from gp;
129                aPmin      : Pnt   from gp;
130                aPmax      : Pnt   from gp)
131     is static;
132         ---Purpose: Allows you to provide settings other than default ones
133         -- for the selected plane. These include: center point
134         -- aCenter, maximum aPmax and minimum aPmin.
135         
136     Center (me) returns Pnt from gp;
137         ---Purpose: Returns the coordinates of the center point.
138         ---C++: inline
139         ---C++: return const&
140         
141     SetCenter (me: mutable; aCenter : Pnt from gp);
142         ---Purpose:
143         -- Provides settings for the center aCenter other than (0, 0, 0).
144         ---C++: inline
145   
146     SetAxis2Placement(me: mutable;
147                       aComponent : Axis2Placement from Geom;
148                       aPlaneType : TypeOfPlane from AIS)
149     is static;
150         ---Purpose: Allows you to provide settings for the position and
151         -- direction of one of the plane's axes, aComponent, in
152         -- 3D space. The coordinate system used is
153         -- right-handed, and the type of plane aPlaneType is one of:
154         -- -   AIS_ TOPL_Unknown
155         -- -   AIS_ TOPL_XYPlane
156         -- -   AIS_ TOPL_XZPlane
157         -- -   AIS_ TOPL_YZPlane}.
158         
159     Axis2Placement(me: mutable) returns Axis2Placement from Geom 
160     is static;
161         ---Purpose: Returns the position of the plane's axis2 system
162         -- identifying the x, y, or z axis and giving the plane a
163         -- direction in 3D space. An axis2 system is a right-handed coordinate system.
164         
165     TypeOfPlane (me : mutable) returns TypeOfPlane from AIS;
166         ---Purpose: Returns the type of plane - xy, yz, xz or unknown.
167         ---C++: inline
168
169
170     IsXYZPlane  (me : mutable) returns Boolean from Standard;
171         ---Purpose: Returns the type of plane - xy, yz, or xz.
172         ---C++: inline
173
174     CurrentMode  (me : mutable) returns Boolean from Standard;
175         ---Purpose: Returns the non-default current display mode set by SetCurrentMode.
176         ---C++: inline
177
178     SetCurrentMode  (me : mutable; aCurrentMode : Boolean from Standard ) ;
179         ---Purpose:
180         -- Allows you to provide settings for a non-default
181         -- current display mode.
182         ---C++: inline
183     
184     AcceptDisplayMode(me;aMode:Integer from Standard) returns Boolean from  Standard 
185     is redefined virtual;
186         ---Purpose: Returns true if the display mode selected, aMode, is valid for planes.
187
188     SetContext(me:mutable; aCtx : InteractiveContext from AIS) is redefined;
189         ---Purpose: connection to <aCtx> default drawer implies a recomputation of Frame values.
190
191     TypeOfSensitivity (me) returns TypeOfSensitivity from Select3D;
192     ---C++: inline
193     ---Purpose: Returns the type of sensitivity for the plane;
194
195     SetTypeOfSensitivity (me: mutable;
196                           theTypeOfSensitivity: TypeOfSensitivity from Select3D);
197     ---C++: inline
198     ---Purpose: Sets the type of sensitivity for the plane.
199
200 -- Methods from PresentableObject
201
202     Compute(me            : mutable;
203             aPresentationManager: PresentationManager3d from PrsMgr;
204             aPresentation : mutable Presentation from Prs3d;
205             aMode         : Integer from Standard = 0) 
206     is redefined virtual private;
207
208     Compute(me:mutable;
209                 aProjector: Projector from Prs3d;
210                 aPresentation: mutable Presentation from Prs3d)
211     is redefined virtual private;
212
213     Compute(me            : mutable;
214             aProjector    : Projector from Prs3d;
215             aTrsf         : Transformation from Geom;
216             aPresentation : mutable Presentation from Prs3d)
217     is redefined;
218     ---Purpose: computes the presentation according to a point of view
219     --          given by <aProjector>.
220     --          To be Used when the associated degenerated Presentations
221     --          have been transformed by <aTrsf> which is not a Pure
222     --          Translation. The HLR Prs can't be deducted automatically
223     --          WARNING :<aTrsf> must be applied
224     --           to the object to display before computation  !!!
225
226 -- Methods from SelectableObject
227
228     ComputeSelection(me         : mutable;
229                      aSelection : mutable Selection from SelectMgr;
230                      aMode      : Integer from Standard) is redefined virtual;
231
232 -- Methods from InteractiveObject
233
234     SetColor(me :mutable; aColor : NameOfColor from Quantity)
235     is redefined static;
236
237     SetColor(me :mutable; aColor : Color from Quantity) 
238     is redefined static;
239     
240     UnsetColor(me:mutable) is redefined static;
241     
242     ComputeFrame(me: mutable)
243     is private;
244
245     ComputeFields(me: mutable)
246     is private;
247     
248     InitDrawerAttributes(me:mutable)  is  private;
249      
250 fields
251
252     myComponent    : Plane   from Geom;    
253     myAx2          : Axis2Placement from Geom;
254     myCenter       : Pnt     from gp;
255     myPmin         : Pnt     from gp;
256     myPmax         : Pnt     from gp;
257     myCurrentMode  : Boolean from Standard;    
258     myAutomaticPosition : Boolean from Standard;    
259     myTypeOfPlane  : TypeOfPlane from AIS;
260     myIsXYZPlane   : Boolean from Standard;
261     myHasOwnSize   : Boolean from Standard;
262     myTypeOfSensitivity: TypeOfSensitivity from Select3D;
263     
264 end Plane;