0029570: Visualization, Graphic3d_Aspect - merge Graphic3d_Group aspects
[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_Aspects.hxx>
23
24 #include <OpenGl_GraphicDriver.hxx>
25 #include <OpenGl_Group.hxx>
26 #include <OpenGl_Matrix.hxx>
27 #include <OpenGl_Vec.hxx>
28 #include <OpenGl_Workspace.hxx>
29
30 #include <NCollection_List.hxx>
31
32 class OpenGl_Structure;
33 class OpenGl_GraphicDriver;
34
35 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
36
37 //! Implementation of low-level graphic structure.
38 class OpenGl_Structure : public Graphic3d_CStructure
39 {
40   friend class OpenGl_Group;
41
42 public:
43
44   //! Auxiliary wrapper to iterate OpenGl_Group sequence.
45   class GroupIterator
46   {
47
48   public:
49     GroupIterator (const Graphic3d_SequenceOfGroup& theGroups) : myIter (theGroups) {}
50     Standard_Boolean More() const     { return myIter.More(); }
51     void Next()                       { myIter.Next(); }
52     const OpenGl_Group* Value() const { return (const OpenGl_Group* )(myIter.Value().operator->()); }
53     OpenGl_Group*       ChangeValue() { return (OpenGl_Group* )(myIter.ChangeValue().operator->()); }
54
55   private:
56     Graphic3d_SequenceOfGroup::Iterator myIter;
57
58   };
59
60 public:
61
62   //! Create empty structure
63   Standard_EXPORT OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager);
64
65   //! Setup structure graphic state
66   Standard_EXPORT virtual void OnVisibilityChanged() Standard_OVERRIDE;
67
68   //! Clear graphic data
69   Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
70
71   //! Connect other structure to this one
72   Standard_EXPORT virtual void Connect    (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
73
74   //! Disconnect other structure to this one
75   Standard_EXPORT virtual void Disconnect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
76
77   //! Synchronize structure transformation
78   Standard_EXPORT virtual void SetTransformation (const Handle(Geom_Transformation)& theTrsf) Standard_OVERRIDE;
79
80   //! Set transformation persistence.
81   Standard_EXPORT virtual void SetTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers) Standard_OVERRIDE;
82
83   //! Set z layer ID to display the structure in specified layer
84   Standard_EXPORT virtual void SetZLayer(const Graphic3d_ZLayerId theLayerIndex) Standard_OVERRIDE;
85
86   //! Highlights structure according to the given style and updates corresponding class fields
87   //! (highlight status and style)
88   Standard_EXPORT virtual void GraphicHighlight (const Handle(Graphic3d_PresentationAttributes)& theStyle) Standard_OVERRIDE;
89
90   //! Unighlights structure and updates corresponding class fields (highlight status and style)
91   Standard_EXPORT virtual void GraphicUnhighlight() Standard_OVERRIDE;
92
93   //! Create shadow link to this structure
94   Standard_EXPORT virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const Standard_OVERRIDE;
95
96   //! Create new group within this structure
97   Standard_EXPORT virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) Standard_OVERRIDE;
98
99   //! Remove group from this structure
100   Standard_EXPORT virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) Standard_OVERRIDE;
101
102 public:
103
104   //! Access graphic driver
105   OpenGl_GraphicDriver* GlDriver() const
106   {
107     return (OpenGl_GraphicDriver* )myGraphicDriver.operator->();
108   }
109
110   Standard_EXPORT void Clear (const Handle(OpenGl_Context)& theGlCtx);
111
112   //! Renders the structure.
113   virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
114
115   //! Releases structure resources.
116   virtual void Release (const Handle(OpenGl_Context)& theGlCtx);
117
118   //! Marks structure as culled/not culled - note that IsAlwaysRendered() is ignored here!
119   void SetCulled (Standard_Boolean theIsCulled) const { myIsCulled = theIsCulled; }
120
121   //! Marks structure as overlapping the current view volume one.
122   //! The method is called during traverse of BVH tree.
123   void MarkAsNotCulled() const { myIsCulled = Standard_False; }
124
125   //! Returns Standard_False if the structure hits the current view volume, otherwise
126   //! returns Standard_True. The default value for all structures before each traverse
127   //! of BVH tree is Standard_True.
128   Standard_Boolean IsCulled() const { return myIsCulled; }
129
130   //! Checks if the structure should be included into BVH tree or not.
131   Standard_Boolean IsAlwaysRendered() const
132   {
133     return IsInfinite
134         || IsForHighlight
135         || IsMutable
136         || Is2dText
137         || (!myTrsfPers.IsNull() && myTrsfPers->IsTrihedronOr2d());
138   }
139
140   //! This method releases GL resources without actual elements destruction.
141   //! As result structure could be correctly destroyed layer without GL context
142   //! (after last window was closed for example).
143   //!
144   //! Notice however that reusage of this structure after calling this method is incorrect
145   //! and will lead to broken visualization due to loosed data.
146   Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
147
148   //! Returns instanced OpenGL structure.
149   const OpenGl_Structure* InstancedStructure() const { return myInstancedStructure; }
150
151   //! Returns structure modification state (for ray-tracing).
152   Standard_Size ModificationState() const { return myModificationState; }
153
154   //! Resets structure modification state (for ray-tracing).
155   void ResetModificationState() const { myModificationState = 0; }
156
157   //! Is the structure ray-tracable (contains ray-tracable elements)?
158   Standard_Boolean IsRaytracable() const;
159
160   //! Update render transformation matrix.
161   Standard_EXPORT void updateLayerTransformation();
162
163 protected:
164
165   Standard_EXPORT virtual ~OpenGl_Structure();
166
167   //! Updates ray-tracable status for structure and its parents.
168   void UpdateStateIfRaytracable (const Standard_Boolean toCheck = Standard_True) const;
169
170   //! Renders groups of structure without applying any attributes (i.e. transform, material etc).
171   //! @param theWorkspace current workspace
172   //! @param theHasClosed flag will be set to TRUE if structure contains at least one group of closed primitives
173   Standard_EXPORT void renderGeometry (const Handle(OpenGl_Workspace)& theWorkspace,
174                                        bool&                           theHasClosed) const;
175
176   //! Render the bounding box.
177   Standard_EXPORT void renderBoundingBox(const Handle(OpenGl_Workspace)& theWorkspace) const;
178
179 protected:
180
181   OpenGl_Structure*          myInstancedStructure;
182   Graphic3d_Mat4             myRenderTrsf; //!< transformation, actually used for rendering (includes Local Origin shift)
183
184   mutable Standard_Boolean   myIsRaytracable;
185   mutable Standard_Size      myModificationState;
186
187   mutable Standard_Boolean   myIsCulled; //!< A status specifying is structure needs to be rendered after BVH tree traverse.
188
189   Standard_Boolean           myIsMirrored; //!< Used to tell OpenGl to interpret polygons in clockwise order.
190
191 public:
192
193   DEFINE_STANDARD_RTTIEXT(OpenGl_Structure,Graphic3d_CStructure) // Type definition
194
195 };
196
197 DEFINE_STANDARD_HANDLE(OpenGl_Structure, Graphic3d_CStructure)
198
199 #endif // OpenGl_Structure_Header