0030652: Configuration, genproj - reuse PRODUCTS_PATH within generated custom.bat
[occt.git] / src / PrsMgr / PrsMgr_PresentableObject.hxx
CommitLineData
42cf5bc1 1// Created on: 1995-01-25
2// Created by: Jean-Louis Frenkel
3// Copyright (c) 1995-1999 Matra Datavision
4// Copyright (c) 1999-2014 OPEN CASCADE SAS
5//
6// This file is part of Open CASCADE Technology software library.
7//
8// This library is free software; you can redistribute it and/or modify it under
9// the terms of the GNU Lesser General Public License version 2.1 as published
10// by the Free Software Foundation, with special exception defined in the file
11// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12// distribution for complete text of the license and disclaimer of any warranty.
13//
14// Alternatively, this file may be used under the terms of Open CASCADE
15// commercial license or contractual agreement.
16
17#ifndef _PrsMgr_PresentableObject_HeaderFile
18#define _PrsMgr_PresentableObject_HeaderFile
19
1f7f5a90 20#include <gp_GTrsf.hxx>
21#include <Graphic3d_ClipPlane.hxx>
42cf5bc1 22#include <Graphic3d_SequenceOfHClipPlane.hxx>
1f7f5a90 23#include <Graphic3d_TransformPers.hxx>
24#include <Graphic3d_TransModeFlags.hxx>
42cf5bc1 25#include <Graphic3d_ZLayerId.hxx>
b5cce1ab 26#include <Prs3d_Drawer.hxx>
42cf5bc1 27#include <PrsMgr_ListOfPresentableObjects.hxx>
42cf5bc1 28#include <PrsMgr_Presentation.hxx>
1f7f5a90 29#include <PrsMgr_Presentations.hxx>
42cf5bc1 30#include <PrsMgr_PresentationManager3d.hxx>
1f7f5a90 31#include <PrsMgr_PresentableObjectPointer.hxx>
32#include <PrsMgr_TypeOfPresentation3d.hxx>
42cf5bc1 33#include <TColStd_ListOfInteger.hxx>
42cf5bc1 34
35//! A framework to supply the Graphic3d
36//! structure of the object to be presented. On the first
37//! display request, this structure is created by calling the
38//! appropriate algorithm and retaining this frameworkfor
39//! further display.
40//! This abstract framework is inherited in Application
41//! Interactive Services (AIS), notably in:
42//! - AIS_InteractiveObject
43//! - AIS_ConnectedInteractive
44//! - AIS_MultipleConnectedInteractive
45//! - AIS_Shape
46//! Consequently, 3D presentation should be handled by
47//! the relevant daughter classes and their member
48//! functions in AIS. This is particularly true in the
49//! creation of new interactive objects.
f838dac4 50class PrsMgr_PresentableObject : public Standard_Transient
42cf5bc1 51{
f838dac4 52 DEFINE_STANDARD_RTTIEXT(PrsMgr_PresentableObject, Standard_Transient)
53 friend class PrsMgr_Presentation;
54 friend class PrsMgr_PresentationManager;
42cf5bc1 55public:
56
1f7f5a90 57 PrsMgr_Presentations& Presentations() { return myPresentations; }
be5c3602 58
42cf5bc1 59 //! Returns information on whether the object accepts display in HLR mode or not.
3202bf1e 60 PrsMgr_TypeOfPresentation3d TypeOfPresentation3d() const { return myTypeOfPresentation3d; }
be5c3602 61
67160f4e 62 //! Returns Transformation Persistence defining a special Local Coordinate system where this presentable object is located or NULL handle if not defined.
63 //! Position of the object having Transformation Persistence is mutable and depends on camera position.
64 //! The same applies to a bounding box of the object.
65 //! @sa Graphic3d_TransformPers class description
778cd667 66 const Handle(Graphic3d_TransformPers)& TransformPersistence() const { return myTransformPersistence; }
67
67160f4e 68 //! Sets up Transform Persistence defining a special Local Coordinate system where this object should be located.
69 //! Note that management of Transform Persistence object is more expensive than of the normal one,
70 //! because it requires its position being recomputed basing on camera position within each draw call / traverse.
71 //! @sa Graphic3d_TransformPers class description
778cd667 72 Standard_EXPORT virtual void SetTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers);
73
42cf5bc1 74 //! Sets up Transform Persistence Mode for this object.
75 //! This function used to lock in object position, rotation and / or zooming relative to camera position.
778cd667 76 //! Object will be drawn in the origin setted by thePoint parameter (except Graphic3d_TMF_TriedronPers flag
77 //! - see description later). theMode should be:
42cf5bc1 78 //! - Graphic3d_TMF_None - no persistence attributes (reset);
42cf5bc1 79 //! - Graphic3d_TMF_ZoomPers - object doesn't resize;
80 //! - Graphic3d_TMF_RotatePers - object doesn't rotate;
778cd667 81 //! - Graphic3d_TMF_ZoomRotatePers - object doesn't resize and rotate;
82 //! - Graphic3d_TMF_RotatePers - object doesn't rotate;
83 //! - Graphic3d_TMF_TriedronPers - object behaves like trihedron.
84 //! If Graphic3d_TMF_TriedronPers or Graphic3d_TMF_2d persistence mode selected thePoint coordinates X and Y means:
42cf5bc1 85 //! - X = 0.0, Y = 0.0 - center of view window;
86 //! - X > 0.0, Y > 0.0 - right upper corner of view window;
87 //! - X > 0.0, Y < 0.0 - right lower corner of view window;
88 //! - X < 0.0, Y > 0.0 - left upper corner of view window;
89 //! - X < 0.0, Y < 0.0 - left lower corner of view window.
90 //! And Z coordinate defines the gap from border of view window (except center position).
778cd667 91 Standard_DEPRECATED("This method is deprecated - SetTransformPersistence() taking Graphic3d_TransformPers should be called instead")
92 void SetTransformPersistence (const Graphic3d_TransModeFlags theMode, const gp_Pnt& thePoint = gp_Pnt (0.0, 0.0, 0.0))
93 {
94 SetTransformPersistence (Graphic3d_TransformPers::FromDeprecatedParams (theMode, thePoint));
95 }
1d92133e 96
42cf5bc1 97 //! Gets Transform Persistence Mode for this object
778cd667 98 Standard_DEPRECATED("This method is deprecated - TransformPersistence() should be called instead")
99 Graphic3d_TransModeFlags GetTransformPersistenceMode() const
100 {
101 return myTransformPersistence.IsNull()
102 ? Graphic3d_TMF_None
103 : myTransformPersistence->Mode();
104 }
105
42cf5bc1 106 //! Gets point of transform persistence for this object
778cd667 107 Standard_DEPRECATED("This method is deprecated - TransformPersistence() should be called instead")
42cf5bc1 108 Standard_EXPORT gp_Pnt GetTransformPersistencePoint() const;
825aa485 109
42cf5bc1 110 Standard_EXPORT void SetTypeOfPresentation (const PrsMgr_TypeOfPresentation3d aType);
111
226fce20 112 //! Returns TRUE if any active presentation has invalidation flag.
113 //! @param theToIncludeHidden when TRUE, also checks hidden presentations
114 Standard_EXPORT Standard_Boolean ToBeUpdated (Standard_Boolean theToIncludeHidden = Standard_False) const;
115
116 //! Flags presentation to be updated; UpdatePresentations() will recompute these presentations.
117 //! @param theMode presentation (display mode) to invalidate, or -1 to invalidate them all
118 Standard_EXPORT void SetToUpdate (Standard_Integer theMode);
119
42cf5bc1 120 //! flags all the Presentations to be Updated.
226fce20 121 void SetToUpdate() { SetToUpdate (-1); }
122
42cf5bc1 123 //! gives the list of modes which are flagged "to be updated".
226fce20 124 Standard_DEPRECATED("This method is deprecated - UpdatePresentations() should be called instead")
42cf5bc1 125 Standard_EXPORT void ToBeUpdated (TColStd_ListOfInteger& ListOfMode) const;
126
1f7f5a90 127 //! Return the local transformation.
67160f4e 128 //! Note that the local transformation of the object having Transformation Persistence
129 //! is applied within Local Coordinate system defined by this Persistence.
1f7f5a90 130 const Handle(Geom_Transformation)& LocalTransformationGeom() const { return myLocalTransformation; }
131
42cf5bc1 132 //! Sets local transformation to theTransformation.
67160f4e 133 //! Note that the local transformation of the object having Transformation Persistence
134 //! is applied within Local Coordinate system defined by this Persistence.
1f7f5a90 135 void SetLocalTransformation (const gp_Trsf& theTrsf) { setLocalTransformation (new Geom_Transformation (theTrsf)); }
136
137 //! Sets local transformation to theTransformation.
67160f4e 138 //! Note that the local transformation of the object having Transformation Persistence
139 //! is applied within Local Coordinate system defined by this Persistence.
1f7f5a90 140 void SetLocalTransformation (const Handle(Geom_Transformation)& theTrsf) { setLocalTransformation (theTrsf); }
141
42cf5bc1 142 //! Returns true if object has a transformation that is different from the identity.
1f7f5a90 143 Standard_Boolean HasTransformation() const { return !myTransformation.IsNull() && myTransformation->Form() != gp_Identity; }
3202bf1e 144
1f7f5a90 145 //! Return the transformation taking into account transformation of parent object(s).
67160f4e 146 //! Note that the local transformation of the object having Transformation Persistence
147 //! is applied within Local Coordinate system defined by this Persistence.
1f7f5a90 148 const Handle(Geom_Transformation)& TransformationGeom() const { return myTransformation; }
3202bf1e 149
1f7f5a90 150 //! Return the local transformation.
67160f4e 151 //! Note that the local transformation of the object having Transformation Persistence
152 //! is applied within Local Coordinate system defined by this Persistence.
1f7f5a90 153 const gp_Trsf& LocalTransformation() const { return !myLocalTransformation.IsNull()
154 ? myLocalTransformation->Trsf()
155 : getIdentityTrsf(); }
156
157 //! Return the transformation taking into account transformation of parent object(s).
67160f4e 158 //! Note that the local transformation of the object having Transformation Persistence
159 //! is applied within Local Coordinate system defined by this Persistence.
1f7f5a90 160 const gp_Trsf& Transformation() const { return !myTransformation.IsNull()
161 ? myTransformation->Trsf()
162 : getIdentityTrsf(); }
3202bf1e 163
164 const gp_GTrsf& InversedTransformation() const { return myInvTransformation; }
1b63268e 165
42cf5bc1 166 //! resets local transformation to identity.
167 Standard_EXPORT virtual void ResetTransformation();
1b63268e 168
169 //! Updates final transformation (parent + local) of presentable object and its presentations.
42cf5bc1 170 Standard_EXPORT virtual void UpdateTransformation();
1b63268e 171
42cf5bc1 172 //! Set Z layer ID and update all presentations of the presentable object.
173 //! The layers mechanism allows drawing objects in higher layers in overlay of objects in lower layers.
174 Standard_EXPORT virtual void SetZLayer (const Graphic3d_ZLayerId theLayerId);
175
176 //! Get ID of Z layer.
177 Standard_EXPORT Graphic3d_ZLayerId ZLayer() const;
178
179 //! Adds clip plane for graphical clipping for all display mode
180 //! presentations. The composition of clip planes truncates the rendering
181 //! space to convex volume. Please be aware that number of supported
182 //! clip plane is limited. The planes which exceed the limit are ignored.
183 //! Besides of this, some planes can be already set in view where the object
184 //! is shown: the number of these planes should be substracted from limit
185 //! to predict the maximum possible number of object clipping planes.
186 //! @param thePlane [in] the clip plane to be appended to map of clip planes.
187 Standard_EXPORT virtual void AddClipPlane (const Handle(Graphic3d_ClipPlane)& thePlane);
188
189 //! Removes previously added clip plane.
190 //! @param thePlane [in] the clip plane to be removed from map of clip planes.
191 Standard_EXPORT virtual void RemoveClipPlane (const Handle(Graphic3d_ClipPlane)& thePlane);
192
193 //! Set clip planes for graphical clipping for all display mode presentations.
3202bf1e 194 //! The composition of clip planes truncates the rendering space to convex volume.
195 //! Please be aware that number of supported clip plane is limited.
196 //! The planes which exceed the limit are ignored.
197 //! Besides of this, some planes can be already set in view where the object is shown:
198 //! the number of these planes should be subtracted from limit to predict the maximum
42cf5bc1 199 //! possible number of object clipping planes.
3202bf1e 200 Standard_EXPORT virtual void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes);
201
202 Standard_DEPRECATED("This method is deprecated - overload taking Handle should be used instead")
203 void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane& thePlanes)
204 {
205 Handle(Graphic3d_SequenceOfHClipPlane) aPlanes = new Graphic3d_SequenceOfHClipPlane (thePlanes);
206 SetClipPlanes (aPlanes);
207 }
208
42cf5bc1 209 //! Get clip planes.
210 //! @return set of previously added clip planes for all display mode presentations.
3202bf1e 211 const Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const { return myClipPlanes; }
212
42cf5bc1 213 //! Sets if the object has mutable nature (content or location will be changed regularly).
214 //! This method should be called before object displaying to take effect.
215 Standard_EXPORT virtual void SetMutable (const Standard_Boolean theIsMutable);
216
217 //! Returns true if object has mutable nature (content or location are be changed regularly).
218 //! Mutable object will be managed in different way than static onces (another optimizations).
3202bf1e 219 Standard_Boolean IsMutable() const { return myIsMutable; }
42cf5bc1 220
221 //! Makes theObject child of current object in scene hierarchy.
222 Standard_EXPORT virtual void AddChild (const Handle(PrsMgr_PresentableObject)& theObject);
223
224 //! Removes theObject from children of current object in scene hierarchy.
225 Standard_EXPORT virtual void RemoveChild (const Handle(PrsMgr_PresentableObject)& theObject);
226
227 //! Returns children of the current object.
3202bf1e 228 const PrsMgr_ListOfPresentableObjects& Children() const { return myChildren; }
be5c3602 229
42cf5bc1 230 //! Returns true if object should have own presentations.
3202bf1e 231 Standard_Boolean HasOwnPresentations() const { return myHasOwnPresentations; }
be5c3602 232
42cf5bc1 233 //! Returns parent of current object in scene hierarchy.
3202bf1e 234 PrsMgr_PresentableObjectPointer Parent() const { return myParent; }
42cf5bc1 235
f838dac4 236 //! Initializes the drawing tool theDrawer.
237 Standard_EXPORT virtual void SetAttributes(const Handle(Prs3d_Drawer)& theDrawer);
42cf5bc1 238
f838dac4 239 //! Returns the attributes settings.
240 const Handle(Prs3d_Drawer)& Attributes() const
241 {
242 return myDrawer;
243 }
244
245 //! Clears settings provided by the drawing tool theDrawer.
246 Standard_EXPORT virtual void UnsetAttributes();
247
248 //! Returns the hilight attributes settings.
cee2b556 249 //! When not NULL, overrides both Prs3d_TypeOfHighlight_LocalSelected and Prs3d_TypeOfHighlight_Selected defined within AIS_InteractiveContext.
f838dac4 250 const Handle(Prs3d_Drawer)& HilightAttributes() const { return myHilightDrawer; }
251
252 //! Initializes the hilight drawing tool theDrawer.
253 virtual void SetHilightAttributes(const Handle(Prs3d_Drawer)& theDrawer) { myHilightDrawer = theDrawer; }
254
255 //! Returns the hilight attributes settings.
cee2b556 256 //! When not NULL, overrides both Prs3d_TypeOfHighlight_LocalDynamic and Prs3d_TypeOfHighlight_Dynamic defined within AIS_InteractiveContext.
f838dac4 257 const Handle(Prs3d_Drawer)& DynamicHilightAttributes() const { return myDynHilightDrawer; }
258
259 //! Initializes the dynamic hilight drawing tool.
260 virtual void SetDynamicHilightAttributes (const Handle(Prs3d_Drawer)& theDrawer) { myDynHilightDrawer = theDrawer; }
261
262 //! Clears settings provided by the hilight drawing tool theDrawer.
263 virtual void UnsetHilightAttributes() { myHilightDrawer.Nullify(); }
42cf5bc1 264
42cf5bc1 265protected:
266
267
268 Standard_EXPORT PrsMgr_PresentableObject(const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d = PrsMgr_TOP_AllView);
269Standard_EXPORT virtual ~PrsMgr_PresentableObject();
270
271 //! Calculates the 3D view aPresentation and its
272 //! updates. The latter are managed by aPresentationManager.
273 //! aPresentableObject has the display mode aMode;
274 //! this has the default value of 0, that is, the wireframe display mode.
8b9a309b 275 Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager3d)& aPresentationManager, const Handle(Prs3d_Presentation)& aPresentation, const Standard_Integer aMode);
42cf5bc1 276
277 //! Calculates the 3D view aPresentation and its
278 //! updates. The latter are managed by
279 //! aPresentationManager. Each of the views in the
280 //! viewer and every modification such as rotation, for
281 //! example, entails recalculation.
282 //! It must be redefined to implement hidden line removal
283 //! for the object. The user never calls this method
284 //! himself. This is done via the InteractiveContext object
285 //! and is dependent on the point of view from which the
286 //! object is displayed.
287 Standard_EXPORT virtual void Compute (const Handle(Prs3d_Projector)& aProjector, const Handle(Prs3d_Presentation)& aPresentation);
288
289 //! Calculates the 3D view aPresentation and its
290 //! updates. The latter are managed by
291 //! aPresentationManager. A point of view is provided
292 //! by the projector aProjector, and the geometric
293 //! transformation which has transformed associated
294 //! presentable objects is specified by aTrsf.
295 //! This function is to be used in case where a hidden
296 //! line removal display cannot be calculated
297 //! automatically. This occurs when associated
298 //! presentable objects have been transformed
299 //! geometrically, but not translated.
300 //! Warning
301 //! The transformation aTrsf must be applied to the
302 //! object before computation.
303 Standard_EXPORT virtual void Compute (const Handle(Prs3d_Projector)& aProjector, const Handle(Geom_Transformation)& aTrsf, const Handle(Prs3d_Presentation)& aPresentation);
304
226fce20 305 //! Recomputes invalidated presentations of the object.
306 //! @param theToIncludeHidden if TRUE, then even hidden invalidated presentations will be updated
307 //! @return TRUE if some presentations were recomputed
308 Standard_EXPORT Standard_Boolean UpdatePresentations (Standard_Boolean theToIncludeHidden = Standard_False);
309
310 //! Recomputes all presentations of the object.
311 Standard_DEPRECATED("This method is deprecated - SetToUpdate() + UpdatePresentations() should be called instead")
312 void Update (Standard_Boolean theToIncludeHidden = Standard_False)
313 {
314 SetToUpdate();
315 UpdatePresentations (theToIncludeHidden);
316 }
317
42cf5bc1 318 //! Recomputes the presentation in the given mode.
226fce20 319 //! @param theMode presentation (display mode) to recompute
320 //! @param theToClearOther when TRUE, other presentations (display modes) will be removed
321 Standard_DEPRECATED("This method is deprecated - SetToUpdate() + UpdatePresentations() should be called instead")
322 Standard_EXPORT void Update (Standard_Integer theMode, Standard_Boolean theToClearOther);
42cf5bc1 323
324 //! High-level interface for controlling polygon offsets
8b9a309b 325 Standard_EXPORT virtual void Fill (const Handle(PrsMgr_PresentationManager)& aPresentationManager, const Handle(PrsMgr_Presentation)& aPresentation, const Standard_Integer aMode);
42cf5bc1 326
327 //! Sets myCombinedParentTransform to theTransformation. Thus object receives transformation
328 //! from parent node and able to derive its own.
1f7f5a90 329 Standard_EXPORT virtual void SetCombinedParentTransform (const Handle(Geom_Transformation)& theTrsf);
42cf5bc1 330
331 //! General virtual method for internal update of presentation state
332 //! when some modifications on list of clip planes occurs. Base
333 //! implementation propagate clip planes to every presentation.
334 Standard_EXPORT virtual void UpdateClipping();
335
1f7f5a90 336 //! Sets local transformation to theTransformation.
337 Standard_EXPORT virtual void setLocalTransformation (const Handle(Geom_Transformation)& theTransformation);
338
bf5f0ca2 339 //! Recompute computed (HLR) presentations (when view is in computed mode).
340 Standard_EXPORT void recomputeComputed() const;
341
1f7f5a90 342private:
343
344 //! Return the identity transformation.
345 Standard_EXPORT static const gp_Trsf& getIdentityTrsf();
346
3202bf1e 347protected:
348
42cf5bc1 349 PrsMgr_Presentations myPresentations;
3202bf1e 350 Handle(Graphic3d_SequenceOfHClipPlane) myClipPlanes;
f838dac4 351 Handle(Prs3d_Drawer) myDrawer;
352 Handle(Prs3d_Drawer) myHilightDrawer;
353 Handle(Prs3d_Drawer) myDynHilightDrawer;
354 PrsMgr_TypeOfPresentation3d myTypeOfPresentation3d;
42cf5bc1 355 Standard_Boolean myIsMutable;
42cf5bc1 356 Standard_Boolean myHasOwnPresentations;
357
42cf5bc1 358private:
359
778cd667 360 Handle(Graphic3d_TransformPers) myTransformPersistence;
42cf5bc1 361 PrsMgr_PresentableObjectPointer myParent;
1f7f5a90 362 Handle(Geom_Transformation) myLocalTransformation;
363 Handle(Geom_Transformation) myTransformation;
364 Handle(Geom_Transformation) myCombinedParentTransform;
91d96372 365 gp_GTrsf myInvTransformation;
42cf5bc1 366 PrsMgr_ListOfPresentableObjects myChildren;
367
42cf5bc1 368};
369
f838dac4 370DEFINE_STANDARD_HANDLE(PrsMgr_PresentableObject, Standard_Transient)
1f7f5a90 371
42cf5bc1 372#endif // _PrsMgr_PresentableObject_HeaderFile