0026303: Problem with test cases boolean/gdml_private L1-9 and K1-K9
[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
a1073ae2 22#include <NCollection_Array1.hxx>
23#include <NCollection_Handle.hxx>
59f45b7c 24#include <NCollection_Sequence.hxx>
25#include <NCollection_DataMap.hxx>
26
27class OpenGl_Structure;
59f45b7c 28
c5751993 29typedef NCollection_Sequence<OpenGl_Layer> OpenGl_SequenceOfLayers;
59f45b7c 30typedef NCollection_DataMap<int, int> OpenGl_LayerSeqIds;
31
bd6a8454 32//! Class defining the list of layers.
59f45b7c 33class OpenGl_LayerList
34{
a1954302 35public:
36
59f45b7c 37 //! Constructor
38 OpenGl_LayerList (const Standard_Integer theNbPriorities = 11);
a1954302 39
59f45b7c 40 //! Destructor
a1954302 41 virtual ~OpenGl_LayerList();
42
59f45b7c 43 //! Method returns the number of available priorities
a1954302 44 Standard_Integer NbPriorities() const { return myNbPriorities; }
59f45b7c 45
46 //! Number of displayed structures
a1954302 47 Standard_Integer NbStructures() const { return myNbStructures; }
48
49 //! Return number of structures within immediate layers
50 Standard_Integer NbImmediateStructures() const { return myImmediateNbStructures; }
59f45b7c 51
52 //! Insert a new layer with id.
a1954302 53 void AddLayer (const Graphic3d_ZLayerId theLayerId);
54
59f45b7c 55 //! Remove layer by its id.
a1954302 56 void RemoveLayer (const Graphic3d_ZLayerId theLayerId);
57
59f45b7c 58 //! Add structure to list with given priority. The structure will be inserted
59 //! to specified layer. If the layer isn't found, the structure will be put
60 //! to default bottom-level layer.
a1954302 61 void AddStructure (const OpenGl_Structure* theStruct,
62 const Graphic3d_ZLayerId theLayerId,
63 const Standard_Integer thePriority,
64 Standard_Boolean isForChangePriority = Standard_False);
65
59f45b7c 66 //! Remove structure from structure list and return its previous priority
c357e426 67 void RemoveStructure (const OpenGl_Structure* theStructure);
a1954302 68
59f45b7c 69 //! Change structure z layer
70 //! If the new layer is not presented, the structure will be displayed
71 //! in default z layer
a1954302 72 void ChangeLayer (const OpenGl_Structure* theStructure,
73 const Graphic3d_ZLayerId theOldLayerId,
74 const Graphic3d_ZLayerId theNewLayerId);
c5751993 75
b7cd4ba7 76 //! Changes structure priority within its ZLayer
a1954302 77 void ChangePriority (const OpenGl_Structure* theStructure,
78 const Graphic3d_ZLayerId theLayerId,
79 const Standard_Integer theNewPriority);
b7cd4ba7 80
c5751993 81 //! Returns reference to the layer with given ID.
a1954302 82 OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId);
c5751993 83
84 //! Returns reference to the layer with given ID.
a1954302 85 const OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId) const;
86
87 //! Assign new settings to the layer.
88 void SetLayerSettings (const Graphic3d_ZLayerId theLayerId,
89 const Graphic3d_ZLayerSettings& theSettings);
90
59f45b7c 91 //! Render this element
a1954302 92 void Render (const Handle(OpenGl_Workspace)& theWorkspace,
91c60b57 93 const Standard_Boolean theToDrawImmediate,
a1073ae2 94 const OpenGl_LayerFilter theLayersToProcess,
95 OpenGl_FrameBuffer* theReadDrawFbo,
96 OpenGl_FrameBuffer* theOitAccumFbo) const;
e276548b 97
98 //! Returns the set of OpenGL Z-layers.
99 const OpenGl_SequenceOfLayers& Layers() const { return myLayers; }
e276548b 100
50d06d8f 101 //! Returns the map of Z-layer IDs to indexes.
102 const OpenGl_LayerSeqIds& LayerIDs() const { return myLayerIds; }
103
b7cd4ba7 104 //! Marks BVH tree for given priority list as dirty and
105 //! marks primitive set for rebuild.
a1954302 106 void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId);
b7cd4ba7 107
e276548b 108 //! Returns structure modification state (for ray-tracing).
bd6a8454 109 Standard_Size ModificationStateOfRaytracable() const { return myModifStateOfRaytraceable; }
e276548b 110
a1954302 111protected:
59f45b7c 112
a1073ae2 113 //! Filter of TKOpenGl elements for processing only shading geometry and
114 //! for collecting number of skipped elements to an external counter.
115 class OpenGl_OpaqueFilter : public OpenGl_RenderFilter
116 {
117 public:
118
119 //! Constructor.
120 //! @param thePrevFilter [in] the previously active filter that should have additive effect.
121 OpenGl_OpaqueFilter() : mySkippedCounter (0) {}
122
123 //! Sets the current active filter in workspace.
124 //! @param thePrevFilter [in] the previously active filter that should have additive effect.
125 void SetPreviousFilter (const Handle(OpenGl_RenderFilter)& thePrevFitler) { myFilter = thePrevFitler; }
126
127 //! Sets the value of the skipped elements counter.
128 void SetSkippedCounter (const Standard_Size theCounter) { mySkippedCounter = theCounter; }
129
130 //! Returns number of skipped elements.
131 Standard_Size NbSkipped() const { return mySkippedCounter; }
132
133 //! Checks whether the element should be rendered or skipped.
134 //! @param theWorkspace [in] the currently used workspace for rendering.
135 //! @param theGlElement [in] the TKOpenGl rendering queue element that should be checked before streaming to GPU.
136 Standard_EXPORT virtual Standard_Boolean ShouldRender (const Handle(OpenGl_Workspace)& theWorkspace,
137 const OpenGl_Element* theGlElement) Standard_OVERRIDE;
138
139 DEFINE_STANDARD_RTTI_INLINE (OpenGl_OpaqueFilter, OpenGl_RenderFilter)
140
141 private:
142
143 Standard_Size mySkippedCounter; //!< Counter of skipped elements.
144 Handle(OpenGl_RenderFilter) myFilter; //!< Previous active filter that should be combined.
145 };
146
147 //! Filter of TKOpenGl elements for keeping only shading geometry with transparency.
148 class OpenGl_TransparentFilter : public OpenGl_RenderFilter
149 {
150 public:
151
152 //! Constructor.
153 OpenGl_TransparentFilter() {}
154
155 //! Sets the current active filter in workspace.
156 //! @param thePrevFilter [in] the previously active filter that should have additive effect.
157 void SetPreviousFilter (const Handle(OpenGl_RenderFilter)& thePrevFitler) { myFilter = thePrevFitler; }
158
159 //! Checks whether the element should be rendered or skipped.
160 //! @param theWorkspace [in] the currently used workspace for rendering.
161 //! @param theGlElement [in] the TKOpenGl rendering queue element that should be checked before streaming to GPU.
162 Standard_EXPORT virtual Standard_Boolean ShouldRender (const Handle(OpenGl_Workspace)& theWorkspace,
163 const OpenGl_Element* theGlElement) Standard_OVERRIDE;
164
165 DEFINE_STANDARD_RTTI_INLINE (OpenGl_TransparentFilter, OpenGl_RenderFilter)
166
167 private:
168
169 Handle(OpenGl_RenderFilter) myFilter; //!< Previous active filter that should be combined.
170 };
171
172 //! Stack of references to existing layers of predefined maximum size.
173 class OpenGl_LayerStack
174 {
175 public:
176 typedef NCollection_Array1<const OpenGl_Layer*>::iterator iterator;
177
178 //! Reallocate internal buffer of the stack.
179 void Allocate (Standard_Integer theSize)
180 {
181 if (theSize > 0)
182 {
183 myStackSpace = new NCollection_Array1<const OpenGl_Layer*> (1, theSize);
184 myStackSpace->Init (NULL);
185 myBackPtr = myStackSpace->begin();
186 }
187 else
188 {
189 myStackSpace.Nullify();
190 myBackPtr = iterator();
191 }
192 }
193
194 //! Clear stack.
195 void Clear()
196 {
197 if (!myStackSpace.IsNull())
198 {
199 myStackSpace->Init (NULL);
200 myBackPtr = myStackSpace->begin();
201 }
202 }
203
204 //! Push a new layer reference to the stack.
205 void Push (const OpenGl_Layer* theLayer) { (*myBackPtr++) = theLayer; }
206
207 //! Returns iterator to the origin of the stack.
208 iterator Origin() const { return myStackSpace.IsNull() ? iterator() : myStackSpace->begin(); }
209
210 //! Returns iterator to the back of the stack (after last item added).
211 iterator Back() const { return myBackPtr; }
212
213 //! Returns true if nothing has been pushed into the stack.
214 Standard_Boolean IsEmpty() const { return Back() == Origin(); }
215
216 private:
217
218 NCollection_Handle<NCollection_Array1<const OpenGl_Layer*> > myStackSpace;
219 iterator myBackPtr;
220 };
221
222 //! Render transparent objects using blending operator.
223 //! Additional accumulation framebuffer is used for blended order-independent
224 //! transparency algorithm. It should support floating-point color components
225 //! and share depth with main reading/drawing framebuffer.
226 //! @param theWorkspace [in] the currently used workspace for rendering.
227 //! @param theLayerIter [in/out] the current iterator of transparent layers to process.
228 //! @param theGlobalSettings [in] the set of global settings used for rendering.
229 //! @param theReadDrawFbo [in] the framebuffer for reading depth and writing final color.
230 //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
231 void renderTransparent (const Handle(OpenGl_Workspace)& theWorkspace,
232 OpenGl_LayerStack::iterator& theLayerIter,
233 const OpenGl_GlobalLayerSettings& theGlobalSettings,
234 OpenGl_FrameBuffer* theReadDrawFbo,
235 OpenGl_FrameBuffer* theOitAccumFbo) const;
236
237protected:
238
59f45b7c 239 // number of structures temporary put to default layer
240 OpenGl_SequenceOfLayers myLayers;
241 OpenGl_LayerSeqIds myLayerIds;
bd6a8454 242 Standard_Integer myDefaultLayerIndex; //!< index of Graphic3d_ZLayerId_Default layer in myLayers sequence
a1954302 243
59f45b7c 244 Standard_Integer myNbPriorities;
245 Standard_Integer myNbStructures;
a1954302 246 Standard_Integer myImmediateNbStructures; //!< number of structures within immediate layers
59f45b7c 247
bd6a8454 248 mutable Standard_Size myModifStateOfRaytraceable;
e276548b 249
a1073ae2 250 //! Collection of references to layers with transparency gathered during rendering pass.
251 mutable OpenGl_LayerStack myTransparentToProcess;
252
253 Handle(OpenGl_OpaqueFilter) myRenderOpaqueFilter; //!< rendering filter for opaque drawing pass (blended OIT).
254 Handle(OpenGl_TransparentFilter) myRenderTranspFilter; //!< rendering filter for transparency drawing pass (blended OIT).
255
a1954302 256public:
257
65c62757 258 DEFINE_STANDARD_ALLOC
a1954302 259
59f45b7c 260};
261
262#endif //_OpenGl_LayerList_Header