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
6 // This file is part of Open CASCADE Technology software library.
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.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _PrsMgr_PresentationManager_HeaderFile
18 #define _PrsMgr_PresentationManager_HeaderFile
20 #include <Graphic3d_NameOfMaterial.hxx>
21 #include <Graphic3d_StructureManager.hxx>
22 #include <Graphic3d_ZLayerId.hxx>
23 #include <Standard_Transient.hxx>
24 #include <PrsMgr_ListOfPresentations.hxx>
25 #include <Quantity_Color.hxx>
26 #include <Quantity_NameOfColor.hxx>
27 #include <Standard.hxx>
28 #include <Standard_Boolean.hxx>
29 #include <Standard_Integer.hxx>
30 #include <Standard_Type.hxx>
32 class Graphic3d_Structure;
33 typedef Graphic3d_Structure Prs3d_Presentation;
35 class Geom_Transformation;
37 class PrsMgr_Presentation;
38 class PrsMgr_PresentableObject;
39 class Standard_NoSuchObject;
42 DEFINE_STANDARD_HANDLE(PrsMgr_PresentationManager, Standard_Transient)
44 //! A framework to manage 3D displays, graphic entities and their updates.
45 //! Used in the AIS package (Application Interactive Services), to enable the advanced user to define the
46 //! default display mode of a new interactive object which extends the list of signatures and types.
47 //! Definition of new display types is handled by calling the presentation algorithms provided by the StdPrs package.
48 class PrsMgr_PresentationManager : public Standard_Transient
50 DEFINE_STANDARD_RTTIEXT(PrsMgr_PresentationManager, Standard_Transient)
53 //! Creates a framework to manage displays and graphic entities with the 3D view theStructureManager.
54 Standard_EXPORT PrsMgr_PresentationManager(const Handle(Graphic3d_StructureManager)& theStructureManager);
56 //! Displays the presentation of the object in the given Presentation manager with the given mode.
57 //! The mode should be enumerated by the object which inherits PresentableObject.
58 Standard_EXPORT void Display (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
60 //! erases the presentation of the object in the given
61 //! Presentation manager with the given mode.
62 //! If @theMode is -1, then erases all presentations of the object.
63 Standard_EXPORT void Erase (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
66 //! Clears the presentation of the presentable object thePrsObject in this framework with the display mode theMode.
67 Standard_EXPORT virtual void Clear (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
69 //! Sets the visibility of presentable object.
70 Standard_EXPORT void SetVisibility (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode, const Standard_Boolean theValue);
72 //! Removes highlighting from the presentation of the presentable object.
73 Standard_EXPORT void Unhighlight (const Handle(PrsMgr_PresentableObject)& thePrsObject);
75 Standard_DEPRECATED("Deprecated method Unhighlight() - argument theMode will be ignored")
76 void Unhighlight (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode) { Unhighlight (thePrsObject); (void )theMode; }
78 //! Sets the display priority theNewPrior of the
79 //! presentable object thePrsObject in this framework with the display mode theMode.
80 Standard_EXPORT void SetDisplayPriority (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode, const Standard_Integer theNewPrior) const;
83 //! Returns the display priority of the presentable object
84 //! thePrsObject in this framework with the display mode theMode.
85 Standard_EXPORT Standard_Integer DisplayPriority (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode) const;
87 //! Set Z layer ID for all presentations of the object.
88 Standard_EXPORT void SetZLayer (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Graphic3d_ZLayerId theLayerId);
90 //! Get Z layer ID assigned to all presentations of the object.
91 //! Method returns -1 value if object has no presentations and is
92 //! impossible to get layer index.
93 Standard_EXPORT Graphic3d_ZLayerId GetZLayer (const Handle(PrsMgr_PresentableObject)& thePrsObject) const;
95 Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
97 //! Returns true if the presentation of the presentable
98 //! object thePrsObject in this framework with the display mode theMode is highlighted.
99 Standard_EXPORT Standard_Boolean IsHighlighted (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
101 //! Updates the presentation of the presentable object
102 //! thePrsObject in this framework with the display mode theMode.
103 Standard_EXPORT void Update (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
105 //! Resets the transient list of presentations previously displayed in immediate mode
106 //! and begins accumulation of new list by following AddToImmediateList()/Color()/Highlight() calls.
107 Standard_EXPORT void BeginImmediateDraw();
109 //! Resets the transient list of presentations previously displayed in immediate mode.
110 Standard_EXPORT void ClearImmediateDraw();
112 //! Stores thePrs in the transient list of presentations to be displayed in immediate mode.
113 //! Will be taken in account in EndImmediateDraw method.
114 Standard_EXPORT void AddToImmediateList (const Handle(Prs3d_Presentation)& thePrs);
116 //! Allows rapid drawing of the each view in theViewer by avoiding an update of the whole background.
117 Standard_EXPORT void EndImmediateDraw (const Handle(V3d_Viewer)& theViewer);
119 //! Clears and redisplays immediate structures of the viewer taking into account its affinity.
120 Standard_EXPORT void RedrawImmediate (const Handle(V3d_Viewer)& theViewer);
122 //! Returns true if Presentation Manager is accumulating transient list of presentations to be displayed in immediate mode.
123 Standard_Boolean IsImmediateModeOn() const { return myImmediateModeOn > 0; }
125 //! Highlights the graphic object thePrsObject in the color theColor.
126 //! thePrsObject has the display mode theMode;
127 //! this has the default value of 0, that is, the wireframe display mode.
128 Standard_EXPORT void Color (const Handle(PrsMgr_PresentableObject)& thePrsObject,
129 const Handle(Prs3d_Drawer)& theStyle,
130 const Standard_Integer theMode = 0,
131 const Handle(PrsMgr_PresentableObject)& theSelObj = NULL,
132 const Graphic3d_ZLayerId theImmediateStructLayerId = Graphic3d_ZLayerId_Topmost);
134 Standard_EXPORT void Connect (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Handle(PrsMgr_PresentableObject)& theOtherObject, const Standard_Integer theMode = 0, const Standard_Integer theOtherMode = 0);
137 //! Sets the transformation theTransformation for the presentable object thePrsObject.
138 //! thePrsObject has the display mode theMode; this has the default value of 0, that is, the wireframe display mode.
139 Standard_EXPORT void Transform (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Handle(Geom_Transformation)& theTransformation, const Standard_Integer theMode = 0);
141 //! Returns the structure manager.
142 const Handle(Graphic3d_StructureManager)& StructureManager() const { return myStructureManager; }
144 //! Returns true if there is a presentation of the
145 //! presentable object thePrsObject in this framework, thePrsObject having the display mode theMode.
146 Standard_EXPORT Standard_Boolean HasPresentation (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
148 //! Returns the presentation Presentation of the presentable object thePrsObject in this framework.
149 //! When theToCreate is true - automatically creates presentation for specified mode when not exist.
150 //! Optional argument theSelObj specifies parent decomposed object to inherit its view affinity.
151 Standard_EXPORT Handle(PrsMgr_Presentation) Presentation (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0, const Standard_Boolean theToCreate = Standard_False, const Handle(PrsMgr_PresentableObject)& theSelObj = NULL) const;
153 //! Allows to apply location transformation to shadow highlight presentation immediately.
154 //! @param theObj defines the base object, it local transformation will be applied to corresponding highlight structure
155 //! @param theMode defines display mode of the base object
156 //! @param theSelObj defines the object produced after decomposition of the base object for local selection
157 Standard_EXPORT void UpdateHighlightTrsf (const Handle(V3d_Viewer)& theViewer,
158 const Handle(PrsMgr_PresentableObject)& theObj,
159 const Standard_Integer theMode = 0,
160 const Handle(PrsMgr_PresentableObject)& theSelObj = NULL);
164 //! Removes a presentation of the presentable object thePrsObject to this framework. thePrsObject has the display mode theMode.
165 Standard_EXPORT Standard_Boolean RemovePresentation (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
169 //! Handles the structures from <myImmediateList> and displays it separating view-dependent structures and taking into account
170 //! structure visibility by setting proper affinity.
171 void displayImmediate (const Handle(V3d_Viewer)& theViewer);
175 Handle(Graphic3d_StructureManager) myStructureManager;
176 Standard_Integer myImmediateModeOn;
177 PrsMgr_ListOfPresentations myImmediateList;
178 PrsMgr_ListOfPresentations myViewDependentImmediateList;
182 #endif // _PrsMgr_PresentationManager_HeaderFile