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_Aspects.hxx>
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>
30 #include <NCollection_List.hxx>
32 class OpenGl_GraphicDriver;
34 DEFINE_STANDARD_HANDLE(OpenGl_Structure, Graphic3d_CStructure)
35 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
37 //! Implementation of low-level graphic structure.
38 class OpenGl_Structure : public Graphic3d_CStructure
40 friend class OpenGl_Group;
41 DEFINE_STANDARD_RTTIEXT(OpenGl_Structure, Graphic3d_CStructure)
44 //! Auxiliary wrapper to iterate OpenGl_Structure sequence.
45 typedef SubclassStructIterator<OpenGl_Structure> StructIterator;
47 //! Auxiliary wrapper to iterate OpenGl_Group sequence.
48 typedef SubclassGroupIterator<OpenGl_Group> GroupIterator;
52 //! Create empty structure
53 Standard_EXPORT OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager);
55 //! Setup structure graphic state
56 Standard_EXPORT virtual void OnVisibilityChanged() Standard_OVERRIDE;
58 //! Clear graphic data
59 Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
61 //! Connect other structure to this one
62 Standard_EXPORT virtual void Connect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
64 //! Disconnect other structure to this one
65 Standard_EXPORT virtual void Disconnect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE;
67 //! Synchronize structure transformation
68 Standard_EXPORT virtual void SetTransformation (const Handle(Geom_Transformation)& theTrsf) Standard_OVERRIDE;
70 //! Set transformation persistence.
71 Standard_EXPORT virtual void SetTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers) Standard_OVERRIDE;
73 //! Set z layer ID to display the structure in specified layer
74 Standard_EXPORT virtual void SetZLayer(const Graphic3d_ZLayerId theLayerIndex) Standard_OVERRIDE;
76 //! Highlights structure according to the given style and updates corresponding class fields
77 //! (highlight status and style)
78 Standard_EXPORT virtual void GraphicHighlight (const Handle(Graphic3d_PresentationAttributes)& theStyle) Standard_OVERRIDE;
80 //! Unighlights structure and updates corresponding class fields (highlight status and style)
81 Standard_EXPORT virtual void GraphicUnhighlight() Standard_OVERRIDE;
83 //! Create shadow link to this structure
84 Standard_EXPORT virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const Standard_OVERRIDE;
86 //! Create new group within this structure
87 Standard_EXPORT virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) Standard_OVERRIDE;
89 //! Remove group from this structure
90 Standard_EXPORT virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) Standard_OVERRIDE;
94 //! Access graphic driver
95 OpenGl_GraphicDriver* GlDriver() const
97 return (OpenGl_GraphicDriver* )myGraphicDriver.operator->();
100 Standard_EXPORT void Clear (const Handle(OpenGl_Context)& theGlCtx);
102 //! Renders the structure.
103 Standard_EXPORT virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const;
105 //! Releases structure resources.
106 Standard_EXPORT virtual void Release (const Handle(OpenGl_Context)& theGlCtx);
108 //! This method releases GL resources without actual elements destruction.
109 //! As result structure could be correctly destroyed layer without GL context
110 //! (after last window was closed for example).
112 //! Notice however that reusage of this structure after calling this method is incorrect
113 //! and will lead to broken visualization due to loosed data.
114 Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
116 //! Returns instanced OpenGL structure.
117 const OpenGl_Structure* InstancedStructure() const { return myInstancedStructure; }
119 //! Returns structure modification state (for ray-tracing).
120 Standard_Size ModificationState() const { return myModificationState; }
122 //! Resets structure modification state (for ray-tracing).
123 void ResetModificationState() const { myModificationState = 0; }
125 //! Is the structure ray-tracable (contains ray-tracable elements)?
126 Standard_Boolean IsRaytracable() const;
128 //! Update render transformation matrix.
129 Standard_EXPORT virtual void updateLayerTransformation() Standard_OVERRIDE;
131 //! Dumps the content of me into the stream
132 Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
136 Standard_EXPORT virtual ~OpenGl_Structure();
138 //! Updates ray-tracable status for structure and its parents.
139 void UpdateStateIfRaytracable (const Standard_Boolean toCheck = Standard_True) const;
141 //! Renders groups of structure without applying any attributes (i.e. transform, material etc).
142 //! @param theWorkspace current workspace
143 //! @param theHasClosed flag will be set to TRUE if structure contains at least one group of closed primitives
144 Standard_EXPORT void renderGeometry (const Handle(OpenGl_Workspace)& theWorkspace,
145 bool& theHasClosed) const;
147 //! Render the bounding box.
148 Standard_EXPORT void renderBoundingBox(const Handle(OpenGl_Workspace)& theWorkspace) const;
152 OpenGl_Structure* myInstancedStructure;
153 Graphic3d_Mat4 myRenderTrsf; //!< transformation, actually used for rendering (includes Local Origin shift)
155 mutable Standard_Boolean myIsRaytracable;
156 mutable Standard_Size myModificationState;
158 Standard_Boolean myIsMirrored; //!< Used to tell OpenGl to interpret polygons in clockwise order.
162 #endif // OpenGl_Structure_Header