0030748: Visualization - Marker displayed in immediate layer ruins QT Quick view...
[occt.git] / src / OpenGl / OpenGl_LayerList.hxx
CommitLineData
6aca4d39 1// Created on: 2012-02-02
b311480e 2// Created by: Anton POLETAEV
6aca4d39 3// Copyright (c) 2012-2014 OPEN CASCADE SAS
b311480e 4//
973c2be1 5// This file is part of Open CASCADE Technology software library.
b311480e 6//
d5f74e42 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
973c2be1 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.
b311480e 12//
973c2be1 13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
59f45b7c 15
16#ifndef _OpenGl_LayerList_Header
17#define _OpenGl_LayerList_Header
18
c5751993 19#include <OpenGl_Layer.hxx>
91c60b57 20#include <OpenGl_LayerFilter.hxx>
59f45b7c 21
d325cb7f 22#include <Graphic3d_ZLayerId.hxx>
a1073ae2 23#include <NCollection_Array1.hxx>
24#include <NCollection_Handle.hxx>
59f45b7c 25#include <NCollection_Sequence.hxx>
26#include <NCollection_DataMap.hxx>
27
28class OpenGl_Structure;
d325cb7f 29class OpenGl_Workspace;
30struct OpenGl_GlobalLayerSettings;
59f45b7c 31
f5b72419 32typedef NCollection_Sequence<Handle(OpenGl_Layer)> OpenGl_SequenceOfLayers;
59f45b7c 33typedef NCollection_DataMap<int, int> OpenGl_LayerSeqIds;
34
bd6a8454 35//! Class defining the list of layers.
59f45b7c 36class OpenGl_LayerList
37{
a1954302 38public:
39
59f45b7c 40 //! Constructor
f5b72419 41 OpenGl_LayerList (const Standard_Integer theNbPriorities);
a1954302 42
59f45b7c 43 //! Destructor
a1954302 44 virtual ~OpenGl_LayerList();
45
59f45b7c 46 //! Method returns the number of available priorities
a1954302 47 Standard_Integer NbPriorities() const { return myNbPriorities; }
59f45b7c 48
49 //! Number of displayed structures
a1954302 50 Standard_Integer NbStructures() const { return myNbStructures; }
51
52 //! Return number of structures within immediate layers
53 Standard_Integer NbImmediateStructures() const { return myImmediateNbStructures; }
59f45b7c 54
55 //! Insert a new layer with id.
a1954302 56 void AddLayer (const Graphic3d_ZLayerId theLayerId);
57
59f45b7c 58 //! Remove layer by its id.
a1954302 59 void RemoveLayer (const Graphic3d_ZLayerId theLayerId);
60
59f45b7c 61 //! Add structure to list with given priority. The structure will be inserted
62 //! to specified layer. If the layer isn't found, the structure will be put
63 //! to default bottom-level layer.
a1954302 64 void AddStructure (const OpenGl_Structure* theStruct,
65 const Graphic3d_ZLayerId theLayerId,
66 const Standard_Integer thePriority,
67 Standard_Boolean isForChangePriority = Standard_False);
68
59f45b7c 69 //! Remove structure from structure list and return its previous priority
c357e426 70 void RemoveStructure (const OpenGl_Structure* theStructure);
a1954302 71
59f45b7c 72 //! Change structure z layer
73 //! If the new layer is not presented, the structure will be displayed
74 //! in default z layer
a1954302 75 void ChangeLayer (const OpenGl_Structure* theStructure,
76 const Graphic3d_ZLayerId theOldLayerId,
77 const Graphic3d_ZLayerId theNewLayerId);
c5751993 78
b7cd4ba7 79 //! Changes structure priority within its ZLayer
a1954302 80 void ChangePriority (const OpenGl_Structure* theStructure,
81 const Graphic3d_ZLayerId theLayerId,
82 const Standard_Integer theNewPriority);
b7cd4ba7 83
c5751993 84 //! Returns reference to the layer with given ID.
a1954302 85 OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId);
c5751993 86
87 //! Returns reference to the layer with given ID.
a1954302 88 const OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId) const;
89
90 //! Assign new settings to the layer.
91 void SetLayerSettings (const Graphic3d_ZLayerId theLayerId,
92 const Graphic3d_ZLayerSettings& theSettings);
93
2b8832bb 94 //! Update culling state - should be called before rendering.
95 void UpdateCulling (const Handle(OpenGl_Workspace)& theWorkspace,
96 const Standard_Boolean theToDrawImmediate);
97
59f45b7c 98 //! Render this element
a1954302 99 void Render (const Handle(OpenGl_Workspace)& theWorkspace,
91c60b57 100 const Standard_Boolean theToDrawImmediate,
a1073ae2 101 const OpenGl_LayerFilter theLayersToProcess,
102 OpenGl_FrameBuffer* theReadDrawFbo,
103 OpenGl_FrameBuffer* theOitAccumFbo) const;
e276548b 104
105 //! Returns the set of OpenGL Z-layers.
106 const OpenGl_SequenceOfLayers& Layers() const { return myLayers; }
e276548b 107
50d06d8f 108 //! Returns the map of Z-layer IDs to indexes.
109 const OpenGl_LayerSeqIds& LayerIDs() const { return myLayerIds; }
110
b7cd4ba7 111 //! Marks BVH tree for given priority list as dirty and
112 //! marks primitive set for rebuild.
a1954302 113 void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId);
b7cd4ba7 114
e276548b 115 //! Returns structure modification state (for ray-tracing).
bd6a8454 116 Standard_Size ModificationStateOfRaytracable() const { return myModifStateOfRaytraceable; }
e276548b 117
f5b72419 118 //! Returns BVH tree builder for frustom culling.
119 const Handle(Select3D_BVHBuilder3d)& FrustumCullingBVHBuilder() const { return myBVHBuilder; }
120
121 //! Assigns BVH tree builder for frustom culling.
122 void SetFrustumCullingBVHBuilder (const Handle(Select3D_BVHBuilder3d)& theBuilder);
123
a1954302 124protected:
59f45b7c 125
a1073ae2 126 //! Stack of references to existing layers of predefined maximum size.
127 class OpenGl_LayerStack
128 {
129 public:
d325cb7f 130 typedef NCollection_Array1<const Graphic3d_Layer*>::iterator iterator;
a1073ae2 131
132 //! Reallocate internal buffer of the stack.
133 void Allocate (Standard_Integer theSize)
134 {
135 if (theSize > 0)
136 {
d325cb7f 137 myStackSpace = new NCollection_Array1<const Graphic3d_Layer*> (1, theSize);
a1073ae2 138 myStackSpace->Init (NULL);
139 myBackPtr = myStackSpace->begin();
140 }
141 else
142 {
143 myStackSpace.Nullify();
144 myBackPtr = iterator();
145 }
146 }
147
148 //! Clear stack.
149 void Clear()
150 {
151 if (!myStackSpace.IsNull())
152 {
153 myStackSpace->Init (NULL);
154 myBackPtr = myStackSpace->begin();
155 }
156 }
157
158 //! Push a new layer reference to the stack.
159 void Push (const OpenGl_Layer* theLayer) { (*myBackPtr++) = theLayer; }
160
161 //! Returns iterator to the origin of the stack.
162 iterator Origin() const { return myStackSpace.IsNull() ? iterator() : myStackSpace->begin(); }
163
164 //! Returns iterator to the back of the stack (after last item added).
165 iterator Back() const { return myBackPtr; }
166
167 //! Returns true if nothing has been pushed into the stack.
168 Standard_Boolean IsEmpty() const { return Back() == Origin(); }
169
170 private:
171
172 NCollection_Handle<NCollection_Array1<const OpenGl_Layer*> > myStackSpace;
173 iterator myBackPtr;
174 };
175
176 //! Render transparent objects using blending operator.
177 //! Additional accumulation framebuffer is used for blended order-independent
178 //! transparency algorithm. It should support floating-point color components
179 //! and share depth with main reading/drawing framebuffer.
180 //! @param theWorkspace [in] the currently used workspace for rendering.
181 //! @param theLayerIter [in/out] the current iterator of transparent layers to process.
182 //! @param theGlobalSettings [in] the set of global settings used for rendering.
183 //! @param theReadDrawFbo [in] the framebuffer for reading depth and writing final color.
184 //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
185 void renderTransparent (const Handle(OpenGl_Workspace)& theWorkspace,
186 OpenGl_LayerStack::iterator& theLayerIter,
187 const OpenGl_GlobalLayerSettings& theGlobalSettings,
188 OpenGl_FrameBuffer* theReadDrawFbo,
189 OpenGl_FrameBuffer* theOitAccumFbo) const;
190
d325cb7f 191 // Render structures within specified layer.
192 void renderLayer (const Handle(OpenGl_Workspace)& theWorkspace,
193 const OpenGl_GlobalLayerSettings& theDefaultSettings,
194 const Graphic3d_Layer& theLayer) const;
195
a1073ae2 196protected:
197
59f45b7c 198 // number of structures temporary put to default layer
199 OpenGl_SequenceOfLayers myLayers;
200 OpenGl_LayerSeqIds myLayerIds;
f5b72419 201 Handle(Select3D_BVHBuilder3d) myBVHBuilder; //!< BVH tree builder for frustom culling
bd6a8454 202 Standard_Integer myDefaultLayerIndex; //!< index of Graphic3d_ZLayerId_Default layer in myLayers sequence
a1954302 203
59f45b7c 204 Standard_Integer myNbPriorities;
205 Standard_Integer myNbStructures;
a1954302 206 Standard_Integer myImmediateNbStructures; //!< number of structures within immediate layers
59f45b7c 207
bd6a8454 208 mutable Standard_Size myModifStateOfRaytraceable;
e276548b 209
a1073ae2 210 //! Collection of references to layers with transparency gathered during rendering pass.
211 mutable OpenGl_LayerStack myTransparentToProcess;
212
a1954302 213public:
214
65c62757 215 DEFINE_STANDARD_ALLOC
a1954302 216
59f45b7c 217};
218
219#endif //_OpenGl_LayerList_Header