0026886: Visualization, TKV3d - eliminate global variables
[occt.git] / src / Graphic3d / Graphic3d_StructureManager.hxx
1 // Created on: 1991-09-05
2 // Created by: NW,JPB,CAL
3 // Copyright (c) 1991-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 _Graphic3d_StructureManager_HeaderFile
18 #define _Graphic3d_StructureManager_HeaderFile
19
20 #include <Aspect_GenId.hxx>
21 #include <Aspect_TypeOfHighlightMethod.hxx>
22 #include <Aspect_TypeOfUpdate.hxx>
23 #include <Graphic3d_CView.hxx>
24 #include <Graphic3d_MapOfObject.hxx>
25 #include <Graphic3d_MapOfStructure.hxx>
26 #include <Graphic3d_ViewAffinity.hxx>
27 #include <Graphic3d_ZLayerId.hxx>
28 #include <Graphic3d_ZLayerSettings.hxx>
29 #include <MMgt_TShared.hxx>
30 #include <NCollection_IndexedMap.hxx>
31 #include <Standard.hxx>
32 #include <Standard_Boolean.hxx>
33 #include <Standard_Integer.hxx>
34 #include <Standard_Type.hxx>
35 #include <TColStd_Array2OfReal.hxx>
36 #include <TColStd_SequenceOfInteger.hxx>
37
38 typedef NCollection_IndexedMap<Graphic3d_CView*> Graphic3d_IndexedMapOfView;
39
40 class Graphic3d_AspectLine3d;
41 class Graphic3d_AspectText3d;
42 class Graphic3d_AspectMarker3d;
43 class Graphic3d_AspectFillArea3d;
44 class Graphic3d_GraphicDriver;
45 class Graphic3d_InitialisationError;
46 class Graphic3d_Structure;
47 class Graphic3d_DataStructureManager;
48 class Standard_Transient;
49
50 class Graphic3d_StructureManager;
51 DEFINE_STANDARD_HANDLE(Graphic3d_StructureManager, MMgt_TShared)
52
53 //! This class allows the definition of a manager to
54 //! which the graphic objects are associated.
55 //! It allows them to be globally manipulated.
56 //! It defines the global attributes.
57 //! Keywords: Structure, Structure Manager, Update Mode,
58 //! Destroy, Highlight, Visible
59 class Graphic3d_StructureManager : public MMgt_TShared
60 {
61 public:
62
63   //! Initializes the ViewManager.
64   //! Currently creating of more than 100 viewer instances
65   //! is not supported and leads to InitializationError and
66   //! initialization failure.
67   //! This limitation might be addressed in some future OCCT releases.
68   //! Warning: Raises InitialisationError if the initialization
69   //! of the ViewManager failed.
70   Standard_EXPORT Graphic3d_StructureManager (const Handle(Graphic3d_GraphicDriver)& theDriver);
71
72   //! Deletes the manager <me>.
73   Standard_EXPORT ~Graphic3d_StructureManager();
74
75   //! Modifies the default attributes for lines
76   //! in the visualiser.
77   Standard_EXPORT void SetPrimitivesAspect (const Handle(Graphic3d_AspectLine3d)& CTX);
78
79   //! Modifies the default attributes for faces
80   //! in the visualiser.
81   Standard_EXPORT void SetPrimitivesAspect (const Handle(Graphic3d_AspectFillArea3d)& CTX);
82
83   //! Modifies the default attributes for text
84   //! in the visualiser.
85   Standard_EXPORT void SetPrimitivesAspect (const Handle(Graphic3d_AspectText3d)& CTX);
86
87   //! Modifies the default attributes for markers
88   //! in the visualiser.
89   Standard_EXPORT void SetPrimitivesAspect (const Handle(Graphic3d_AspectMarker3d)& CTX);
90
91   //! Modifies the screen update mode.
92   //!
93   //! TOU_ASAP - as soon as possible
94   //! TOU_WAIT - on demand (with the Update function)
95   //! Note : Dynamic Operations and Update Mode
96   //! Use SetUpdateMode to control when changes to
97   //! the display are made.   Use one of the   following
98   //! functions to update one or more views:
99   //! - Update all views of the viewer: Graphic3d_StructureManager::Update()
100   //! - Update one view of the viewer:  Graphic3d_View::Update()
101   //! Use one of the following functions to update the entire display:
102   //! - Redraw all structures in all views: Graphic3d_StructureManager::Redraw()
103   //! - Redraw all structures in one view:  Graphic3d_View::Redraw()
104   Standard_EXPORT void SetUpdateMode (const Aspect_TypeOfUpdate theType);
105
106   //! Returns the screen update mode.
107   //!
108   //! TOU_ASAP  as soon as possible
109   //! TOU_WAIT  on demand (Update)
110   Standard_EXPORT Aspect_TypeOfUpdate UpdateMode() const;
111
112   //! Updates screen in function of modifications of the structures.
113   Standard_EXPORT virtual void Update (const Aspect_TypeOfUpdate theMode = Aspect_TOU_ASAP) const;
114
115   //! Deletes and erases the 3D structure manager.
116   Standard_EXPORT virtual void Remove();
117
118   //! Erases all the structures.
119   Standard_EXPORT virtual void Erase();
120
121   //! Returns the set of structures displayed in
122   //! visualiser <me>.
123   Standard_EXPORT void DisplayedStructures (Graphic3d_MapOfStructure& SG) const;
124
125   //! Returns the set of highlighted structures
126   //! in a visualiser <me>.
127   Standard_EXPORT void HighlightedStructures (Graphic3d_MapOfStructure& SG) const;
128
129   //! Returns the values of the current default attributes.
130   Standard_EXPORT Handle(Graphic3d_AspectFillArea3d) FillArea3dAspect() const;
131
132   //! Returns the values of the current default attributes.
133   Standard_EXPORT Handle(Graphic3d_AspectLine3d) Line3dAspect() const;
134
135   //! Returns the values of the current default attributes.
136   Standard_EXPORT Handle(Graphic3d_AspectMarker3d) Marker3dAspect() const;
137
138   //! Returns the values of the current default attributes.
139   Standard_EXPORT void PrimitivesAspect (Handle(Graphic3d_AspectLine3d)& CTXL, Handle(Graphic3d_AspectText3d)& CTXT, Handle(Graphic3d_AspectMarker3d)& CTXM, Handle(Graphic3d_AspectFillArea3d)& CTXF) const;
140
141   //! Returns the values of the current default attributes.
142   Standard_EXPORT Handle(Graphic3d_AspectText3d) Text3dAspect() const;
143
144   //! Forces a new construction of the structure.
145   //! if <theStructure> is displayed and TOS_COMPUTED.
146   Standard_EXPORT virtual void ReCompute (const Handle(Graphic3d_Structure)& theStructure);
147
148   //! Forces a new construction of the structure.
149   //! if <theStructure> is displayed in <theProjector> and TOS_COMPUTED.
150   Standard_EXPORT virtual void ReCompute (const Handle(Graphic3d_Structure)& theStructure, const Handle(Graphic3d_DataStructureManager)& theProjector);
151
152   //! Clears the structure.
153   Standard_EXPORT virtual void Clear (const Handle(Graphic3d_Structure)& theStructure, const Standard_Boolean theWithDestruction);
154
155   //! Connects the structures.
156   Standard_EXPORT virtual void Connect (const Handle(Graphic3d_Structure)& theMother, const Handle(Graphic3d_Structure)& theDaughter);
157
158   //! Disconnects the structures.
159   Standard_EXPORT virtual void Disconnect (const Handle(Graphic3d_Structure)& theMother, const Handle(Graphic3d_Structure)& theDaughter);
160
161   //! Display the structure.
162   Standard_EXPORT virtual void Display (const Handle(Graphic3d_Structure)& theStructure);
163
164   //! Erases the structure.
165   Standard_EXPORT virtual void Erase (const Handle(Graphic3d_Structure)& theStructure);
166
167   //! Highlights the structure.
168   Standard_EXPORT virtual void Highlight (const Handle(Graphic3d_Structure)& theStructure, const Aspect_TypeOfHighlightMethod theMethod);
169
170   //! Transforms the structure.
171   Standard_EXPORT virtual void SetTransform (const Handle(Graphic3d_Structure)& theStructure, const TColStd_Array2OfReal& theTrsf);
172
173   //! Changes the display priority of the structure <AStructure>.
174   Standard_EXPORT virtual void ChangeDisplayPriority (const Handle(Graphic3d_Structure)& theStructure, const Standard_Integer theOldPriority, const Standard_Integer theNewPriority);
175
176   //! Change Z layer for structure. The Z layer mechanism allows to display structures in higher
177   //! layers in overlay of structures in lower layers.
178   Standard_EXPORT virtual void ChangeZLayer (const Handle(Graphic3d_Structure)& theStructure, const Graphic3d_ZLayerId theLayerId);
179
180   //! Returns the graphic driver of <me>.
181   Standard_EXPORT const Handle(Graphic3d_GraphicDriver)& GraphicDriver() const;
182
183   //! Attaches the view to this structure manager and sets its identification number within the manager.
184   Standard_EXPORT Standard_Integer Identification (Graphic3d_CView* theView);
185
186   //! Detach the view from this structure manager and release its identification.
187   Standard_EXPORT void UnIdentification (Graphic3d_CView* theView);
188
189   //! Returns the group of views defined in the structure manager.
190   Standard_EXPORT const Graphic3d_IndexedMapOfView& DefinedViews() const;
191
192   //! Returns the theoretical maximum number of definable views in the manager.
193   //! Warning: It's not possible to accept an infinite number of definable views because each
194   //! view must have an identification and we have different managers.
195   Standard_EXPORT Standard_Integer MaxNumOfViews() const;
196
197   //! Returns the structure with the identification number <AId>.
198   Standard_EXPORT virtual Handle(Graphic3d_Structure) Identification (const Standard_Integer AId) const;
199
200   //! Suppress the highlighting on the structure <AStructure>.
201   Standard_EXPORT virtual void UnHighlight (const Handle(Graphic3d_Structure)& AStructure);
202
203   //! Suppresses the highlighting on all the structures in <me>.
204   Standard_EXPORT virtual void UnHighlight();
205
206   Standard_EXPORT void RecomputeStructures();
207
208   //! Recomputes all structures from theStructures.
209   Standard_EXPORT void RecomputeStructures (const Graphic3d_MapOfStructure& theStructures);
210
211   Standard_EXPORT Handle(Graphic3d_ViewAffinity) RegisterObject (const Handle(Standard_Transient)& theObject);
212
213   Standard_EXPORT void UnregisterObject (const Handle(Standard_Transient)& theObject);
214
215   Standard_EXPORT Handle(Graphic3d_ViewAffinity) ObjectAffinity (const Handle(Standard_Transient)& theObject) const;
216
217   friend class Graphic3d_Structure;
218
219   DEFINE_STANDARD_RTTIEXT(Graphic3d_StructureManager,MMgt_TShared)
220
221 protected:
222
223   //! Returns the number of structures displayed in
224   //! visualizer <me>.
225   //! Returns the structure displayed in visualizer <me>.
226   Standard_EXPORT Standard_Integer NumberOfDisplayedStructures() const;
227
228   Standard_Integer myId;
229   Aspect_GenId myViewGenId;
230   Aspect_TypeOfUpdate myUpdateMode;
231   Handle(Graphic3d_AspectLine3d) myAspectLine3d;
232   Handle(Graphic3d_AspectText3d) myAspectText3d;
233   Handle(Graphic3d_AspectMarker3d) myAspectMarker3d;
234   Handle(Graphic3d_AspectFillArea3d) myAspectFillArea3d;
235   Graphic3d_MapOfStructure myDisplayedStructure;
236   Graphic3d_MapOfStructure myHighlightedStructure;
237   Graphic3d_MapOfObject myRegisteredObjects;
238   Handle(Graphic3d_GraphicDriver) myGraphicDriver;
239   Graphic3d_IndexedMapOfView myDefinedViews;
240 };
241
242 #endif // _Graphic3d_StructureManager_HeaderFile