1 // Created on: 2011-11-02
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2015 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_Layer_Header
17 #define _OpenGl_Layer_Header
19 #include <NCollection_Sequence.hxx>
20 #include <NCollection_Array1.hxx>
22 #include <OpenGl_BVHClipPrimitiveSet.hxx>
23 #include <OpenGl_BVHClipPrimitiveTrsfPersSet.hxx>
24 #include <OpenGl_BVHTreeSelector.hxx>
26 #include <Graphic3d_ZLayerSettings.hxx>
27 #include <Graphic3d_Camera.hxx>
28 #include <OpenGl_GlCore11.hxx>
31 struct OpenGl_GlobalLayerSettings
37 //! Defines index map of OpenGL structures.
38 typedef NCollection_IndexedMap<const OpenGl_Structure*> OpenGl_IndexedMapOfStructure;
40 //! Defines array of indexed maps of OpenGL structures.
41 typedef NCollection_Array1<OpenGl_IndexedMapOfStructure> OpenGl_ArrayOfIndexedMapOfStructure;
43 //! Presentations list sorted within priorities.
48 //! Initializes associated priority list and layer properties
49 OpenGl_Layer (const Standard_Integer theNbPriorities = 11);
52 virtual ~OpenGl_Layer();
54 //! Returns settings of the layer object.
55 const Graphic3d_ZLayerSettings& LayerSettings() const { return myLayerSettings; };
57 //! Sets settings of the layer object.
58 void SetLayerSettings (const Graphic3d_ZLayerSettings& theSettings)
60 myLayerSettings = theSettings;
63 //! Returns true if theSetting is enabled for the layer.
64 Standard_Boolean IsSettingEnabled (const Graphic3d_ZLayerSetting theSetting) const
66 return myLayerSettings.IsSettingEnabled (theSetting);
69 void Add (const OpenGl_Structure* theStruct,
70 const Standard_Integer thePriority,
71 Standard_Boolean isForChangePriority = Standard_False);
73 //! Remove structure and returns its priority, if the structure is not found, method returns negative value
74 bool Remove (const OpenGl_Structure* theStruct,
75 Standard_Integer& thePriority,
76 Standard_Boolean isForChangePriority = Standard_False);
78 //! @return the number of structures
79 Standard_Integer NbStructures() const { return myNbStructures; }
81 //! Returns the number of available priority levels
82 Standard_Integer NbPriorities() const { return myArray.Length(); }
84 //! Append layer of acceptable type (with similar number of priorities or less).
85 //! Returns Standard_False if the list can not be accepted.
86 Standard_Boolean Append (const OpenGl_Layer& theOther);
88 //! Returns array of OpenGL structures.
89 const OpenGl_ArrayOfIndexedMapOfStructure& ArrayOfStructures() const { return myArray; }
91 //! Marks BVH tree for given priority list as dirty and
92 //! marks primitive set for rebuild.
93 void InvalidateBVHData() const;
95 //! Marks cached bounding box as obsolete.
96 void InvalidateBoundingBox() const
98 myIsBoundingBoxNeedsReset[0] = myIsBoundingBoxNeedsReset[1] = true;
101 //! Returns layer bounding box.
102 //! @param theViewId view index to consider View Affinity in structure
103 //! @param theCamera camera definition
104 //! @param theWindowWidth viewport width (for applying transformation-persistence)
105 //! @param theWindowHeight viewport height (for applying transformation-persistence)
106 //! @param theToIncludeAuxiliary consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence)
107 //! @return computed bounding box
108 Graphic3d_BndBox4f BoundingBox (const Standard_Integer theViewId,
109 const Handle(Graphic3d_Camera)& theCamera,
110 const Standard_Integer theWindowWidth,
111 const Standard_Integer theWindowHeight,
112 const Standard_Boolean theToIncludeAuxiliary) const;
114 //! Returns zoom-scale factor.
115 Standard_Real considerZoomPersistenceObjects (const Standard_Integer theViewId,
116 const Handle(Graphic3d_Camera)& theCamera,
117 const Standard_Integer theWindowWidth,
118 const Standard_Integer theWindowHeight) const;
120 // Render all structures.
121 void Render (const Handle(OpenGl_Workspace)& theWorkspace,
122 const OpenGl_GlobalLayerSettings& theDefaultSettings) const;
124 //! Returns number of transform persistence objects.
125 Standard_Integer NbOfTransformPersistenceObjects() const
127 return myBVHPrimitivesTrsfPers.Size();
132 //! Updates BVH trees if their state has been invalidated.
133 void updateBVH() const;
135 //! Traverses through BVH tree to determine which structures are in view volume.
136 void traverse (OpenGl_BVHTreeSelector& theSelector) const;
138 //! Iterates through the hierarchical list of existing structures and renders them all.
139 void renderAll (const Handle(OpenGl_Workspace)& theWorkspace) const;
141 //! Iterates through the hierarchical list of existing structures and renders only overlapping ones.
142 void renderTraverse (const Handle(OpenGl_Workspace)& theWorkspace) const;
146 //! Array of OpenGl_Structures by priority rendered in layer.
147 OpenGl_ArrayOfIndexedMapOfStructure myArray;
149 //! Overall number of structures rendered in the layer.
150 Standard_Integer myNbStructures;
152 //! Layer setting flags.
153 Graphic3d_ZLayerSettings myLayerSettings;
155 //! Set of OpenGl_Structures structures for building BVH tree.
156 mutable OpenGl_BVHClipPrimitiveSet myBVHPrimitives;
158 //! Set of transform persistent OpenGl_Structures for building BVH tree.
159 mutable OpenGl_BVHClipPrimitiveTrsfPersSet myBVHPrimitivesTrsfPers;
161 //! Indexed map of always rendered structures.
162 NCollection_IndexedMap<const OpenGl_Structure*> myAlwaysRenderedMap;
164 //! Is needed for implementation of stochastic order of BVH traverse.
165 mutable Standard_Boolean myBVHIsLeftChildQueuedFirst;
167 //! Defines if the primitive set for BVH is outdated.
168 mutable Standard_Boolean myIsBVHPrimitivesNeedsReset;
170 //! Defines if the cached bounding box is outdated.
171 mutable bool myIsBoundingBoxNeedsReset[2];
173 //! Cached layer bounding box.
174 mutable Graphic3d_BndBox4f myBoundingBox[2];
178 DEFINE_STANDARD_ALLOC
182 #endif //_OpenGl_Layer_Header