0027818: Visualization - provide an interface to define highlight presentation properties
[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_GraphicDriver.hxx>
28 #include <OpenGl_Group.hxx>
29 #include <OpenGl_Matrix.hxx>
30 #include <OpenGl_Vec.hxx>
31 #include <OpenGl_Workspace.hxx>
32
33 #include <NCollection_List.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() Standard_OVERRIDE;
73
74   //! Connect other structure to this one
75   Standard_EXPORT virtual void Connect    (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
76
77   //! Disconnect other structure to this one
78   Standard_EXPORT virtual void Disconnect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
79
80   //! Synchronize structure transformation
81   Standard_EXPORT virtual void SetTransformation (const Handle(Geom_Transformation)& theTrsf) Standard_OVERRIDE;
82
83   //! Highlights structure according to the given style and updates corresponding class fields
84   //! (highlight status and style)
85   Standard_EXPORT virtual void GraphicHighlight (const Handle(Graphic3d_HighlightStyle)& theStyle,
86                                                  const Handle(Graphic3d_Structure)&      theStruct) Standard_OVERRIDE;
87
88   //! Unighlights structure and updates corresponding class fields (highlight status and style)
89   Standard_EXPORT virtual void GraphicUnhighlight() Standard_OVERRIDE;
90
91   //! Create shadow link to this structure
92   Standard_EXPORT virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const Standard_OVERRIDE;
93
94   //! Create new group within this structure
95   Standard_EXPORT virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) Standard_OVERRIDE;
96
97   //! Remove group from this structure
98   Standard_EXPORT virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) Standard_OVERRIDE;
99
100 public:
101
102   //! Access graphic driver
103   OpenGl_GraphicDriver* GlDriver() const
104   {
105     return (OpenGl_GraphicDriver* )myGraphicDriver.operator->();
106   }
107
108   Standard_EXPORT void Clear (const Handle(OpenGl_Context)& theGlCtx);
109
110   //! Renders the structure.
111   virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
112
113   //! Releases structure resources.
114   virtual void Release (const Handle(OpenGl_Context)& theGlCtx);
115
116   //! Marks structure as not overlapping view volume (as it is by default).
117   void ResetCullingStatus() const
118   {
119     if (!IsAlwaysRendered())
120     {
121       myIsCulled = Standard_True;
122     }
123   }
124
125   //! Marks structure as overlapping the current view volume one.
126   //! The method is called during traverse of BVH tree.
127   void MarkAsNotCulled() const { myIsCulled = Standard_False; }
128
129   //! Returns Standard_False if the structure hits the current view volume, otherwise
130   //! returns Standard_True. The default value for all structures before each traverse
131   //! of BVH tree is Standard_True.
132   Standard_Boolean IsCulled() const { return myIsCulled; }
133
134   //! Checks if the structure should be included into BVH tree or not.
135   Standard_Boolean IsAlwaysRendered() const
136   {
137     return IsInfinite
138         || IsForHighlight
139         || IsMutable
140         || Is2dText
141         || (!myTrsfPers.IsNull() && myTrsfPers->IsTrihedronOr2d());
142   }
143
144   //! This method releases GL resources without actual elements destruction.
145   //! As result structure could be correctly destroyed layer without GL context
146   //! (after last window was closed for example).
147   //!
148   //! Notice however that reusage of this structure after calling this method is incorrect
149   //! and will lead to broken visualization due to loosed data.
150   Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
151
152   //! Returns instanced OpenGL structure.
153   const OpenGl_Structure* InstancedStructure() const { return myInstancedStructure; }
154
155   //! Returns structure modification state (for ray-tracing).
156   Standard_Size ModificationState() const { return myModificationState; }
157
158   //! Resets structure modification state (for ray-tracing).
159   void ResetModificationState() const { myModificationState = 0; }
160
161   //! Is the structure ray-tracable (contains ray-tracable elements)?
162   Standard_Boolean IsRaytracable() const;
163
164 protected:
165
166   Standard_EXPORT virtual ~OpenGl_Structure();
167
168   //! Updates ray-tracable status for structure and its parents.
169   void UpdateStateIfRaytracable (const Standard_Boolean toCheck = Standard_True) const;
170
171   //! Renders groups of structure without applying any attributes (i.e. transform, material etc).
172   //! @param theWorkspace current workspace
173   //! @param theHasClosed flag will be set to TRUE if structure contains at least one group of closed primitives
174   Standard_EXPORT void renderGeometry (const Handle(OpenGl_Workspace)& theWorkspace,
175                                        bool&                           theHasClosed) const;
176
177   //! Highlight structure using boundary box
178   Standard_EXPORT void highlightWithBndBox (const Handle(Graphic3d_Structure)& theStruct);
179
180   //! Invalidates highlight box and releases graphic resources it uses
181   Standard_EXPORT void clearHighlightBox (const Handle(OpenGl_Context)& theGlCtx);
182
183 protected:
184
185   Handle(OpenGl_Group)       myHighlightBox;
186
187   OpenGl_Structure*          myInstancedStructure;
188
189   mutable Standard_Boolean   myIsRaytracable;
190   mutable Standard_Size      myModificationState;
191
192   mutable Standard_Boolean   myIsCulled; //!< A status specifying is structure needs to be rendered after BVH tree traverse.
193
194   Standard_Boolean           myIsMirrored; //!< Used to tell OpenGl to interpret polygons in clockwise order.
195
196 public:
197
198   DEFINE_STANDARD_RTTIEXT(OpenGl_Structure,Graphic3d_CStructure) // Type definition
199
200 };
201
202 DEFINE_STANDARD_HANDLE(OpenGl_Structure, Graphic3d_CStructure)
203
204 #endif // OpenGl_Structure_Header