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
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 _Graphic3d_StructureManager_HeaderFile
18 #define _Graphic3d_StructureManager_HeaderFile
20 #include <Aspect_GenId.hxx>
21 #include <Aspect_TypeOfHighlightMethod.hxx>
22 #include <Graphic3d_CView.hxx>
23 #include <Graphic3d_MapOfObject.hxx>
24 #include <Graphic3d_MapOfStructure.hxx>
25 #include <Graphic3d_ViewAffinity.hxx>
26 #include <Graphic3d_ZLayerId.hxx>
27 #include <Graphic3d_ZLayerSettings.hxx>
28 #include <MMgt_TShared.hxx>
29 #include <NCollection_IndexedMap.hxx>
30 #include <Standard.hxx>
31 #include <Standard_Boolean.hxx>
32 #include <Standard_Integer.hxx>
33 #include <Standard_Type.hxx>
34 #include <TColStd_Array2OfReal.hxx>
36 typedef NCollection_IndexedMap<Graphic3d_CView*> Graphic3d_IndexedMapOfView;
38 class Graphic3d_GraphicDriver;
39 class Graphic3d_Structure;
40 class Graphic3d_DataStructureManager;
41 class Standard_Transient;
43 class Graphic3d_StructureManager;
44 DEFINE_STANDARD_HANDLE(Graphic3d_StructureManager, MMgt_TShared)
46 //! This class allows the definition of a manager to
47 //! which the graphic objects are associated.
48 //! It allows them to be globally manipulated.
49 //! It defines the global attributes.
50 //! Keywords: Structure, Structure Manager, Update Mode,
51 //! Destroy, Highlight, Visible
52 class Graphic3d_StructureManager : public MMgt_TShared
56 //! Initializes the ViewManager.
57 //! Currently creating of more than 100 viewer instances
58 //! is not supported and leads to InitializationError and
59 //! initialization failure.
60 //! This limitation might be addressed in some future OCCT releases.
61 //! Warning: Raises InitialisationError if the initialization
62 //! of the ViewManager failed.
63 Standard_EXPORT Graphic3d_StructureManager (const Handle(Graphic3d_GraphicDriver)& theDriver);
65 //! Deletes the manager <me>.
66 Standard_EXPORT ~Graphic3d_StructureManager();
68 //! Invalidates bounding box of specified ZLayerId.
69 Standard_EXPORT virtual void Update (const Graphic3d_ZLayerId theLayerId = Graphic3d_ZLayerId_UNKNOWN) const;
71 //! Deletes and erases the 3D structure manager.
72 Standard_EXPORT virtual void Remove();
74 //! Erases all the structures.
75 Standard_EXPORT virtual void Erase();
77 //! Returns the set of structures displayed in
79 Standard_EXPORT void DisplayedStructures (Graphic3d_MapOfStructure& SG) const;
81 //! Returns the set of highlighted structures
82 //! in a visualiser <me>.
83 Standard_EXPORT void HighlightedStructures (Graphic3d_MapOfStructure& SG) const;
85 //! Forces a new construction of the structure.
86 //! if <theStructure> is displayed and TOS_COMPUTED.
87 Standard_EXPORT virtual void ReCompute (const Handle(Graphic3d_Structure)& theStructure);
89 //! Forces a new construction of the structure.
90 //! if <theStructure> is displayed in <theProjector> and TOS_COMPUTED.
91 Standard_EXPORT virtual void ReCompute (const Handle(Graphic3d_Structure)& theStructure, const Handle(Graphic3d_DataStructureManager)& theProjector);
93 //! Clears the structure.
94 Standard_EXPORT virtual void Clear (const Handle(Graphic3d_Structure)& theStructure, const Standard_Boolean theWithDestruction);
96 //! Connects the structures.
97 Standard_EXPORT virtual void Connect (const Handle(Graphic3d_Structure)& theMother, const Handle(Graphic3d_Structure)& theDaughter);
99 //! Disconnects the structures.
100 Standard_EXPORT virtual void Disconnect (const Handle(Graphic3d_Structure)& theMother, const Handle(Graphic3d_Structure)& theDaughter);
102 //! Display the structure.
103 Standard_EXPORT virtual void Display (const Handle(Graphic3d_Structure)& theStructure);
105 //! Erases the structure.
106 Standard_EXPORT virtual void Erase (const Handle(Graphic3d_Structure)& theStructure);
108 //! Highlights the structure.
109 Standard_EXPORT virtual void Highlight (const Handle(Graphic3d_Structure)& theStructure);
111 //! Transforms the structure.
112 Standard_EXPORT virtual void SetTransform (const Handle(Graphic3d_Structure)& theStructure, const Handle(Geom_Transformation)& theTrsf);
114 //! Changes the display priority of the structure <AStructure>.
115 Standard_EXPORT virtual void ChangeDisplayPriority (const Handle(Graphic3d_Structure)& theStructure, const Standard_Integer theOldPriority, const Standard_Integer theNewPriority);
117 //! Change Z layer for structure. The Z layer mechanism allows to display structures in higher
118 //! layers in overlay of structures in lower layers.
119 Standard_EXPORT virtual void ChangeZLayer (const Handle(Graphic3d_Structure)& theStructure, const Graphic3d_ZLayerId theLayerId);
121 //! Returns the graphic driver of <me>.
122 Standard_EXPORT const Handle(Graphic3d_GraphicDriver)& GraphicDriver() const;
124 //! Attaches the view to this structure manager and sets its identification number within the manager.
125 Standard_EXPORT Standard_Integer Identification (Graphic3d_CView* theView);
127 //! Detach the view from this structure manager and release its identification.
128 Standard_EXPORT void UnIdentification (Graphic3d_CView* theView);
130 //! Returns the group of views defined in the structure manager.
131 Standard_EXPORT const Graphic3d_IndexedMapOfView& DefinedViews() const;
133 //! Returns the theoretical maximum number of definable views in the manager.
134 //! Warning: It's not possible to accept an infinite number of definable views because each
135 //! view must have an identification and we have different managers.
136 Standard_EXPORT Standard_Integer MaxNumOfViews() const;
138 //! Returns the structure with the identification number <AId>.
139 Standard_EXPORT virtual Handle(Graphic3d_Structure) Identification (const Standard_Integer AId) const;
141 //! Suppress the highlighting on the structure <AStructure>.
142 Standard_EXPORT virtual void UnHighlight (const Handle(Graphic3d_Structure)& AStructure);
144 //! Suppresses the highlighting on all the structures in <me>.
145 Standard_EXPORT virtual void UnHighlight();
147 Standard_EXPORT void RecomputeStructures();
149 //! Recomputes all structures from theStructures.
150 Standard_EXPORT void RecomputeStructures (const Graphic3d_MapOfStructure& theStructures);
152 Standard_EXPORT Handle(Graphic3d_ViewAffinity) RegisterObject (const Handle(Standard_Transient)& theObject);
154 Standard_EXPORT void UnregisterObject (const Handle(Standard_Transient)& theObject);
156 Standard_EXPORT Handle(Graphic3d_ViewAffinity) ObjectAffinity (const Handle(Standard_Transient)& theObject) const;
158 friend class Graphic3d_Structure;
160 DEFINE_STANDARD_RTTIEXT(Graphic3d_StructureManager,MMgt_TShared)
164 //! Returns the number of structures displayed in
166 //! Returns the structure displayed in visualizer <me>.
167 Standard_EXPORT Standard_Integer NumberOfDisplayedStructures() const;
171 Aspect_GenId myViewGenId;
172 Graphic3d_MapOfStructure myDisplayedStructure;
173 Graphic3d_MapOfStructure myHighlightedStructure;
174 Graphic3d_MapOfObject myRegisteredObjects;
175 Handle(Graphic3d_GraphicDriver) myGraphicDriver;
176 Graphic3d_IndexedMapOfView myDefinedViews;
179 #endif // _Graphic3d_StructureManager_HeaderFile