1 // Created on: 2011-08-01
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef OpenGl_Structure_Header
17 #define OpenGl_Structure_Header
19 #include <Graphic3d_CStructure.hxx>
20 #include <Graphic3d_SequenceOfHClipPlane.hxx>
22 #include <OpenGl_AspectLine.hxx>
23 #include <OpenGl_AspectFace.hxx>
24 #include <OpenGl_AspectMarker.hxx>
25 #include <OpenGl_AspectText.hxx>
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>
33 #include <NCollection_List.hxx>
34 #include <InterfaceGraphic_Graphic3d.hxx>
36 class OpenGl_Structure;
37 class OpenGl_GraphicDriver;
39 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
41 //! Implementation of low-level graphic structure.
42 class OpenGl_Structure : public Graphic3d_CStructure
44 friend class OpenGl_Group;
48 //! Auxiliary wrapper to iterate OpenGl_Group sequence.
53 GroupIterator (const Graphic3d_SequenceOfGroup& theGroups) : myIter (theGroups) {}
54 Standard_Boolean More() const { return myIter.More(); }
55 void Next() { myIter.Next(); }
56 const OpenGl_Group* Value() const { return (const OpenGl_Group* )(myIter.Value().operator->()); }
57 OpenGl_Group* ChangeValue() { return (OpenGl_Group* )(myIter.ChangeValue().operator->()); }
60 Graphic3d_SequenceOfGroup::Iterator myIter;
66 //! Create empty structure
67 Standard_EXPORT OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager);
69 //! Setup structure graphic state
70 Standard_EXPORT virtual void OnVisibilityChanged() Standard_OVERRIDE;
72 //! Clear graphic data
73 Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
75 //! Connect other structure to this one
76 Standard_EXPORT virtual void Connect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
78 //! Disconnect other structure to this one
79 Standard_EXPORT virtual void Disconnect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
81 //! Synchronize structure transformation
82 Standard_EXPORT virtual void UpdateTransformation() Standard_OVERRIDE;
84 //! Highlight entire structure with color
85 Standard_EXPORT virtual void HighlightWithColor (const Graphic3d_Vec3& theColor,
86 const Standard_Boolean theToCreate) Standard_OVERRIDE;
88 //! Highlight structure using boundary box
89 Standard_EXPORT virtual void HighlightWithBndBox (const Handle(Graphic3d_Structure)& theStruct,
90 const Standard_Boolean theToCreate) Standard_OVERRIDE;
92 //! Create shadow link to this structure
93 Standard_EXPORT virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const Standard_OVERRIDE;
95 //! Create new group within this structure
96 Standard_EXPORT virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) Standard_OVERRIDE;
98 //! Remove group from this structure
99 Standard_EXPORT virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) Standard_OVERRIDE;
103 //! @return graphic groups
104 virtual const Graphic3d_SequenceOfGroup& DrawGroups() const
109 //! Access graphic driver
110 OpenGl_GraphicDriver* GlDriver() const
112 return (OpenGl_GraphicDriver* )myGraphicDriver.operator->();
115 void clearHighlightBox (const Handle(OpenGl_Context)& theGlCtx);
117 void setHighlightColor (const Handle(OpenGl_Context)& theGlCtx,
118 const Graphic3d_Vec3& theColor);
120 void clearHighlightColor (const Handle(OpenGl_Context)& theGlCtx);
122 Standard_EXPORT void Clear (const Handle(OpenGl_Context)& theGlCtx);
124 //! Renders groups of structure without applying any attributes (i.e. transform, material etc).
125 //! @param theWorkspace current workspace
126 //! @param theHasClosed flag will be set to TRUE if structure contains at least one group of closed primitives
127 virtual void renderGeometry (const Handle(OpenGl_Workspace)& theWorkspace,
128 bool& theHasClosed) const;
130 //! Renders groups of closed primitives without applying any attributes (i.e. transform, material etc).
131 virtual void renderClosedGeometry (const Handle(OpenGl_Workspace)& theWorkspace) const;
133 //! Renders the structure.
134 virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const;
136 //! Releases structure resources.
137 virtual void Release (const Handle(OpenGl_Context)& theGlCtx);
139 //! Marks structure as not overlapping view volume (as it is by default).
140 void ResetCullingStatus() const
142 if (!IsAlwaysRendered())
144 myIsCulled = Standard_True;
148 //! Marks structure as overlapping the current view volume one.
149 //! The method is called during traverse of BVH tree.
150 void MarkAsNotCulled() const { myIsCulled = Standard_False; }
152 //! Returns Standard_False if the structure hits the current view volume, otherwise
153 //! returns Standard_True. The default value for all structures before each traverse
154 //! of BVH tree is Standard_True.
155 Standard_Boolean IsCulled() const { return myIsCulled; }
157 //! Checks if the structure should be included into BVH tree or not.
158 Standard_Boolean IsAlwaysRendered() const
164 || (TransformPersistence.Flags & Graphic3d_TMF_2d) != 0
165 || (TransformPersistence.Flags & Graphic3d_TMF_PanPers) != 0
166 || (TransformPersistence.Flags & Graphic3d_TMF_TriedronPers) != 0;
169 //! This method releases GL resources without actual elements destruction.
170 //! As result structure could be correctly destroyed layer without GL context
171 //! (after last window was closed for example).
173 //! Notice however that reusage of this structure after calling this method is incorrect
174 //! and will lead to broken visualization due to loosed data.
175 Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
177 //! Returns instanced OpenGL structure.
178 const OpenGl_Structure* InstancedStructure() const { return myInstancedStructure; }
180 //! Returns structure modification state (for ray-tracing).
181 Standard_Size ModificationState() const { return myModificationState; }
183 //! Resets structure modification state (for ray-tracing).
184 void ResetModificationState() const { myModificationState = 0; }
186 //! Is the structure ray-tracable (contains ray-tracable elements)?
187 Standard_Boolean IsRaytracable() const;
191 Standard_EXPORT virtual ~OpenGl_Structure();
193 //! Updates ray-tracable status for structure and its parents.
194 void UpdateStateIfRaytracable (const Standard_Boolean toCheck = Standard_True) const;
198 Handle(OpenGl_Group) myHighlightBox;
199 TEL_COLOUR* myHighlightColor;
201 OpenGl_Structure* myInstancedStructure;
203 mutable Standard_Boolean myIsRaytracable;
204 mutable Standard_Size myModificationState;
206 mutable Standard_Boolean myIsCulled; //!< A status specifying is structure needs to be rendered after BVH tree traverse.
208 Standard_Boolean myIsMirrored; //!< Used to tell OpenGl to interpret polygons in clockwise order.
212 DEFINE_STANDARD_RTTIEXT(OpenGl_Structure,Graphic3d_CStructure) // Type definition
216 DEFINE_STANDARD_HANDLE(OpenGl_Structure, Graphic3d_CStructure)
218 #endif // OpenGl_Structure_Header