0026029: Visualization - Poor performance of connected objects
[occt.git] / src / OpenGl / OpenGl_Structure.hxx
1 // Created on: 2011-08-01
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef OpenGl_Structure_Header
17 #define OpenGl_Structure_Header
18
19 #include <Graphic3d_CStructure.hxx>
20 #include <Graphic3d_SequenceOfHClipPlane.hxx>
21
22 #include <OpenGl_AspectLine.hxx>
23 #include <OpenGl_AspectFace.hxx>
24 #include <OpenGl_AspectMarker.hxx>
25 #include <OpenGl_AspectText.hxx>
26
27 #include <OpenGl_Group.hxx>
28 #include <OpenGl_Matrix.hxx>
29 #include <OpenGl_Vec.hxx>
30 #include <OpenGl_Workspace.hxx>
31
32 #include <NCollection_List.hxx>
33 #include <InterfaceGraphic_Graphic3d.hxx>
34
35 class OpenGl_Structure;
36 class OpenGl_GraphicDriver;
37
38 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
39
40 //! Implementation of low-level graphic structure.
41 class OpenGl_Structure : public Graphic3d_CStructure
42 {
43   friend class OpenGl_Group;
44
45 public:
46
47   //! Auxiliary wrapper to iterate OpenGl_Group sequence.
48   class GroupIterator
49   {
50
51   public:
52     GroupIterator (const Graphic3d_SequenceOfGroup& theGroups) : myIter (theGroups) {}
53     Standard_Boolean More() const     { return myIter.More(); }
54     void Next()                       { myIter.Next(); }
55     const OpenGl_Group* Value() const { return (const OpenGl_Group* )(myIter.Value().operator->()); }
56     OpenGl_Group*       ChangeValue() { return (OpenGl_Group* )(myIter.ChangeValue().operator->()); }
57
58   private:
59     Graphic3d_SequenceOfGroup::Iterator myIter;
60
61   };
62
63 public:
64
65   //! Create empty structure
66   Standard_EXPORT OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager);
67
68   //! Setup structure graphic state
69   Standard_EXPORT virtual void OnVisibilityChanged() Standard_OVERRIDE;
70
71   //! Clear graphic data
72   Standard_EXPORT virtual void Clear();
73
74   //! Connect other structure to this one
75   Standard_EXPORT virtual void Connect    (Graphic3d_CStructure& theStructure);
76
77   //! Disconnect other structure to this one
78   Standard_EXPORT virtual void Disconnect (Graphic3d_CStructure& theStructure);
79
80   //! Synchronize structure aspects
81   Standard_EXPORT virtual void UpdateAspects();
82
83   //! Synchronize structure transformation
84   Standard_EXPORT virtual void UpdateTransformation();
85
86   //! Highlight entire structure with color
87   Standard_EXPORT virtual void HighlightWithColor (const Graphic3d_Vec3&  theColor,
88                                                    const Standard_Boolean theToCreate);
89
90   //! Highlight structure using boundary box
91   Standard_EXPORT virtual void HighlightWithBndBox (const Handle(Graphic3d_Structure)& theStruct,
92                                                     const Standard_Boolean             theToCreate);
93
94   //! Create shadow link to this structure
95   Standard_EXPORT virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const;
96
97   //! Create new group within this structure
98   Standard_EXPORT virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct);
99
100   //! Remove group from this structure
101   Standard_EXPORT virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup);
102
103 public:
104
105   //! @return graphic groups
106   virtual const Graphic3d_SequenceOfGroup& DrawGroups() const
107   {
108     return myGroups;
109   }
110
111   //! Access graphic driver
112   OpenGl_GraphicDriver* GlDriver() const
113   {
114     return (OpenGl_GraphicDriver* )myGraphicDriver.operator->();
115   }
116
117   void SetTransformPersistence (const CALL_DEF_TRANSFORM_PERSISTENCE &ATransPers);
118
119   void SetAspectLine   (const CALL_DEF_CONTEXTLINE &theAspect);
120   void SetAspectFace   (const CALL_DEF_CONTEXTFILLAREA& theAspect);
121   void SetAspectMarker (const CALL_DEF_CONTEXTMARKER& theAspect);
122   void SetAspectText   (const CALL_DEF_CONTEXTTEXT &theAspect);
123
124   void clearHighlightBox (const Handle(OpenGl_Context)& theGlCtx);
125
126   void setHighlightColor (const Handle(OpenGl_Context)& theGlCtx,
127                           const Graphic3d_Vec3&         theColor);
128
129   void clearHighlightColor (const Handle(OpenGl_Context)& theGlCtx);
130
131   Standard_EXPORT void Clear (const Handle(OpenGl_Context)& theGlCtx);
132
133   //! Renders groups of structure without applying any attributes (i.e. transform, material etc).
134   virtual void RenderGeometry  (const Handle(OpenGl_Workspace)& theWorkspace) const;
135
136   //! Renders the structure.
137   virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
138
139   //! Releases structure resources.
140   virtual void Release (const Handle(OpenGl_Context)& theGlCtx);
141
142   //! Marks structure as not overlapping view volume (as it is by default).
143   void ResetCullingStatus() const
144   {
145     if (!IsAlwaysRendered())
146     {
147       myIsCulled = Standard_True;
148     }
149   }
150
151   //! Marks structure as overlapping the current view volume one.
152   //! The method is called during traverse of BVH tree.
153   void MarkAsNotCulled() const { myIsCulled = Standard_False; }
154
155   //! Returns Standard_False if the structure hits the current view volume, otherwise
156   //! returns Standard_True. The default value for all structures before each traverse
157   //! of BVH tree is Standard_True.
158   Standard_Boolean IsCulled() const { return myIsCulled; }
159
160   //! Checks if the structure should be included into BVH tree or not.
161   const Standard_Boolean IsAlwaysRendered() const
162   {
163     return IsInfinite
164         || IsForHighlight
165         || IsMutable
166         || Is2dText
167         || TransformPersistence.Flag != 0;
168   }
169
170   //! This method releases GL resources without actual elements destruction.
171   //! As result structure could be correctly destroyed layer without GL context
172   //! (after last window was closed for example).
173   //!
174   //! Notice however that reusage of this structure after calling this method is incorrect
175   //! and will lead to broken visualization due to loosed data.
176   Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
177
178   //! Returns instanced OpenGL structure.
179   const OpenGl_Structure* InstancedStructure() const { return myInstancedStructure; }
180
181   //! Returns OpenGL face aspect.
182   const OpenGl_AspectFace* AspectFace() const { return myAspectFace; }
183
184   //! Returns OpenGL transformation matrix.
185   const OpenGl_Matrix* Transformation() const { return myTransformation; }
186   
187   //! Returns OpenGL persistent translation.
188   const TEL_TRANSFORM_PERSISTENCE* PersistentTranslation() const { return myTransPers; }
189
190   //! Returns structure modification state (for ray-tracing).
191   Standard_Size ModificationState() const { return myModificationState; }
192
193   //! Resets structure modification state (for ray-tracing)
194   void ResetModificationState() const { myModificationState = 0; }
195
196   //! Is the structure ray-tracable (contains ray-tracable elements)?
197   Standard_Boolean IsRaytracable() const;
198
199 protected:
200
201   Standard_EXPORT virtual ~OpenGl_Structure();
202
203   //! Updates ray-tracable status for structure and its parents.
204   void UpdateStateIfRaytracable (const Standard_Boolean toCheck = Standard_True) const;
205
206 protected:
207
208   OpenGl_Matrix*             myTransformation;
209   TEL_TRANSFORM_PERSISTENCE* myTransPers;
210   OpenGl_AspectLine*         myAspectLine;
211   OpenGl_AspectFace*         myAspectFace;
212   OpenGl_AspectMarker*       myAspectMarker;
213   OpenGl_AspectText*         myAspectText;
214
215   Handle(OpenGl_Group)       myHighlightBox;
216   TEL_COLOUR*                myHighlightColor;
217
218   OpenGl_Structure*          myInstancedStructure;
219
220   mutable Standard_Boolean   myIsRaytracable;
221   mutable Standard_Size      myModificationState;
222
223   mutable Standard_Boolean   myIsCulled; //!< A status specifying is structure needs to be rendered after BVH tree traverse.
224
225   Standard_Boolean           myIsMirrored; //!< Used to tell OpenGl to interpret polygons in clockwise order.
226
227 public:
228
229   DEFINE_STANDARD_RTTI(OpenGl_Structure) // Type definition
230
231 };
232
233 DEFINE_STANDARD_HANDLE(OpenGl_Structure, Graphic3d_CStructure)
234
235 #endif // OpenGl_Structure_Header