0026272: Visualization - provide a possibility to activate selection modes without...
[occt.git] / src / PrsMgr / PrsMgr_PresentationManager.hxx
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_PresentationManager_HeaderFile
18 #define _PrsMgr_PresentationManager_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Integer.hxx>
24 #include <PrsMgr_ListOfPresentations.hxx>
25 #include <Quantity_Color.hxx>
26 #include <MMgt_TShared.hxx>
27 #include <Standard_Boolean.hxx>
28 #include <Quantity_NameOfColor.hxx>
29 #include <Graphic3d_NameOfMaterial.hxx>
30 #include <Graphic3d_ZLayerId.hxx>
31 class Visual3d_ViewManager;
32 class V3d_Viewer;
33 class Standard_NoSuchObject;
34 class PrsMgr_PresentableObject;
35 class Prs3d_Presentation;
36 class Geom_Transformation;
37 class Graphic3d_StructureManager;
38 class Prs3d_ShadingAspect;
39 class PrsMgr_Presentation;
40
41
42 class PrsMgr_PresentationManager;
43 DEFINE_STANDARD_HANDLE(PrsMgr_PresentationManager, MMgt_TShared)
44
45 //! A framework to manage 3D displays, graphic entities and their updates.
46 //! Used in the AIS package (Application Interactive Services), to enable the advanced user to define the
47 //! default display mode of a new interactive object which extends the list of signatures and types.
48 //! Definition of new display types is handled by calling the presentation algorithms provided by the StdPrs package.
49 class PrsMgr_PresentationManager : public MMgt_TShared
50 {
51
52 public:
53
54   
55
56   //! Creates a framework to manage displays and graphic entities with the 3D view theStructureManager.
57   Standard_EXPORT PrsMgr_PresentationManager(const Handle(Visual3d_ViewManager)& theStructureManager);
58   
59   //! Displays the presentation of the object in the given Presentation manager with the given mode.
60   //! The mode should be enumerated by the object which inherits PresentableObject.
61   Standard_EXPORT void Display (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
62   
63   //! erases the presentation of the object in the given
64   //! Presentation manager with the given mode.
65   Standard_EXPORT void Erase (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
66   
67
68   //! Clears the presentation of the presentable object thePrsObject in this framework with the display mode theMode.
69   Standard_EXPORT virtual void Clear (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
70   
71   //! Sets the visibility of presentable object.
72   Standard_EXPORT void SetVisibility (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode, const Standard_Boolean theValue);
73   
74   //! Highlights the presentation of the presentable object
75   //! thePrsObject in this framework with the display mode theMode.
76   Standard_EXPORT void Highlight (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
77   
78   //! Removes highlighting from the presentation of the
79   //! presentable object thePrsObject in this framework with the display mode theMode.
80   Standard_EXPORT void Unhighlight (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
81   
82
83   //! Sets the display priority theNewPrior of the
84   //! presentable object thePrsObject in this framework with the display mode theMode.
85   Standard_EXPORT void SetDisplayPriority (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode, const Standard_Integer theNewPrior) const;
86   
87
88   //! Returns the display priority of the presentable object
89   //! thePrsObject in this framework with the display mode theMode.
90   Standard_EXPORT Standard_Integer DisplayPriority (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode) const;
91   
92   //! Set Z layer ID for all presentations of the object.
93   Standard_EXPORT void SetZLayer (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theLayerId);
94   
95   //! Get Z layer ID assigned to all presentations of the object.
96   //! Method returns -1 value if object has no presentations and is
97   //! impossible to get layer index.
98   Standard_EXPORT Standard_Integer GetZLayer (const Handle(PrsMgr_PresentableObject)& thePrsObject) const;
99   
100   Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
101   
102   //! Returns true if the presentation of the presentable
103   //! object thePrsObject in this framework with the display mode theMode is highlighted.
104   Standard_EXPORT Standard_Boolean IsHighlighted (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
105   
106   //! Updates the presentation of the presentable object
107   //! thePrsObject in this framework with the display mode theMode.
108   Standard_EXPORT void Update (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
109   
110   //! Resets the transient list of presentations previously displayed in immediate mode
111   //! and begins accumulation of new list by following AddToImmediateList()/Color()/Highlight() calls.
112   Standard_EXPORT void BeginImmediateDraw();
113   
114   //! Resets the transient list of presentations previously displayed in immediate mode.
115   Standard_EXPORT void ClearImmediateDraw();
116   
117   //! Stores thePrs in the transient list of presentations to be displayed in immediate mode.
118   //! Will be taken in account in EndImmediateDraw method.
119   Standard_EXPORT void AddToImmediateList (const Handle(Prs3d_Presentation)& thePrs);
120
121   //! Allows rapid drawing of the each view in theViewer by avoiding an update of the whole background.
122   Standard_EXPORT void EndImmediateDraw (const Handle(V3d_Viewer)& theViewer);
123
124   //! Clears and redisplays immediate structures of the viewer taking into account its affinity.
125   Standard_EXPORT void RedrawImmediate (const Handle(V3d_Viewer)& theViewer);
126
127   //! Returns true if Presentation Manager is accumulating transient list of presentations to be displayed in immediate mode.
128   Standard_EXPORT Standard_Boolean IsImmediateModeOn() const;
129
130   //! Highlights the graphic object thePrsObject in the color theColor.
131   //! thePrsObject has the display mode theMode;
132   //! this has the default value of 0, that is, the wireframe display mode.
133   Standard_EXPORT void Color (const Handle(PrsMgr_PresentableObject)& thePrsObject,
134                               const Quantity_NameOfColor theColor = Quantity_NOC_YELLOW,
135                               const Standard_Integer theMode = 0,
136                               const Handle(PrsMgr_PresentableObject)& theSelObj = NULL,
137                               const Graphic3d_ZLayerId theImmediateStructLayerId = Graphic3d_ZLayerId_Topmost);
138
139   //! highlights the boundbox of the presentation
140   Standard_EXPORT void BoundBox (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
141   
142   Standard_EXPORT void Connect (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Handle(PrsMgr_PresentableObject)& theOtherObject, const Standard_Integer theMode = 0, const Standard_Integer theOtherMode = 0);
143   
144
145   //! Sets the transformation theTransformation for the presentable object thePrsObject.
146   //! thePrsObject has the display mode theMode; this has the default value of 0, that is, the wireframe display mode.
147   Standard_EXPORT void Transform (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Handle(Geom_Transformation)& theTransformation, const Standard_Integer theMode = 0);
148   
149   //! Returns the structure manager.
150     const Handle(Graphic3d_StructureManager)& StructureManager() const;
151   
152   //! this method will change the color and the aspect of the presentations containing shaded structures.
153   Standard_EXPORT void SetShadingAspect (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Quantity_NameOfColor theColor, const Graphic3d_NameOfMaterial theMaterial, const Standard_Integer theMode = 0);
154   
155   //! this method will change the color and the aspect of the presentations containing shaded structures.
156   Standard_EXPORT void SetShadingAspect (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Handle(Prs3d_ShadingAspect)& theShadingAspect, const Standard_Integer theMode = 0);
157   
158   //! Returns true if there is a presentation of the
159   //! presentable object thePrsObject in this framework, thePrsObject having the display mode theMode.
160   Standard_EXPORT Standard_Boolean HasPresentation (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
161   
162   //! Returns the presentation Presentation of the presentable object thePrsObject in this framework.
163   //! When theToCreate is true - automatically creates presentation for specified mode when not exist.
164   //! Optional argument theSelObj specifies parent decomposed object to inherit its view affinity.
165   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;
166
167
168
169
170   DEFINE_STANDARD_RTTI(PrsMgr_PresentationManager,MMgt_TShared)
171
172 protected:
173
174   
175   //! Removes a presentation of the presentable object thePrsObject to this framework. thePrsObject has the display mode theMode.
176   Standard_EXPORT Standard_Boolean RemovePresentation (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
177
178   Handle(Visual3d_ViewManager) myStructureManager;
179   Standard_Integer myImmediateModeOn;
180   PrsMgr_ListOfPresentations myImmediateList;
181   PrsMgr_ListOfPresentations myViewDependentImmediateList;
182   Quantity_Color mySelectionColor;
183
184
185 private:
186
187   //! Handles the structures from <myImmediateList> and displays it separating view-dependent structures and taking into account
188   //! structure visibility by setting proper affinity.
189   void displayImmediate (const Handle(V3d_Viewer)& theViewer);
190 };
191
192
193 #include <PrsMgr_PresentationManager.lxx>
194
195
196
197
198
199 #endif // _PrsMgr_PresentationManager_HeaderFile