Commit | Line | Data |
---|---|---|
b311480e | 1 | // Created on: 2011-09-20 |
2 | // Created by: Sergey ZERCHANINOV | |
973c2be1 | 3 | // Copyright (c) 2011-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. | |
b311480e | 15 | |
2166f0fa SK |
16 | #ifndef _OpenGl_View_Header |
17 | #define _OpenGl_View_Header | |
18 | ||
25e59720 | 19 | #include <Standard_Transient.hxx> |
ec357c5c | 20 | #include <Standard_Type.hxx> |
2166f0fa SK |
21 | |
22 | #include <TColStd_Array2OfReal.hxx> | |
23 | #include <NCollection_List.hxx> | |
189f85a3 | 24 | #include <math_BullardGenerator.hxx> |
2166f0fa SK |
25 | |
26 | #include <Quantity_NameOfColor.hxx> | |
27 | #include <Aspect_FillMethod.hxx> | |
28 | #include <Aspect_GradientFillMethod.hxx> | |
2166f0fa | 29 | |
2166f0fa | 30 | #include <Graphic3d_CView.hxx> |
d325cb7f | 31 | #include <Graphic3d_CullingTool.hxx> |
a79f67f8 | 32 | #include <Graphic3d_GraduatedTrihedron.hxx> |
51b10cd4 | 33 | #include <Graphic3d_SequenceOfHClipPlane.hxx> |
eb85ed36 | 34 | #include <Graphic3d_ToneMappingMethod.hxx> |
c357e426 | 35 | #include <Graphic3d_TypeOfShadingModel.hxx> |
825aa485 | 36 | #include <Graphic3d_WorldViewProjState.hxx> |
c5751993 | 37 | #include <Graphic3d_ZLayerSettings.hxx> |
2166f0fa | 38 | |
bf5f0ca2 | 39 | #include <OpenGl_Aspects.hxx> |
0b0320e7 | 40 | #include <OpenGl_BackgroundArray.hxx> |
c357e426 | 41 | #include <OpenGl_Context.hxx> |
42 | #include <OpenGl_FrameBuffer.hxx> | |
15669413 | 43 | #include <OpenGl_FrameStatsPrs.hxx> |
c357e426 | 44 | #include <OpenGl_GraduatedTrihedron.hxx> |
59f45b7c | 45 | #include <OpenGl_LayerList.hxx> |
73192b37 | 46 | #include <OpenGl_LineAttributes.hxx> |
c357e426 | 47 | #include <OpenGl_SceneGeometry.hxx> |
48 | #include <OpenGl_Structure.hxx> | |
c357e426 | 49 | #include <OpenGl_Window.hxx> |
50 | #include <OpenGl_Workspace.hxx> | |
3a9b5dc8 | 51 | #include <OpenGl_TileSampler.hxx> |
2166f0fa | 52 | |
c357e426 | 53 | #include <map> |
54 | #include <set> | |
2166f0fa | 55 | |
b5ac8292 | 56 | struct OpenGl_Matrix; |
2166f0fa | 57 | |
c357e426 | 58 | class Graphic3d_StructureManager; |
78c4e836 | 59 | class OpenGl_DepthPeeling; |
c357e426 | 60 | class OpenGl_GraphicDriver; |
67312b79 | 61 | class OpenGl_PBREnvironment; |
c357e426 | 62 | class OpenGl_StateCounter; |
d84e8669 | 63 | class OpenGl_ShadowMap; |
64 | class OpenGl_ShadowMapArray; | |
c357e426 | 65 | class OpenGl_TriangleSet; |
66 | class OpenGl_Workspace; | |
c04c30b3 | 67 | class OpenGl_View; |
d84e8669 | 68 | |
c357e426 | 69 | DEFINE_STANDARD_HANDLE(OpenGl_View,Graphic3d_CView) |
c04c30b3 | 70 | |
c357e426 | 71 | //! Implementation of OpenGl view. |
72 | class OpenGl_View : public Graphic3d_CView | |
2166f0fa | 73 | { |
c357e426 | 74 | |
75 | public: | |
76 | ||
77 | //! Constructor. | |
78 | Standard_EXPORT OpenGl_View (const Handle(Graphic3d_StructureManager)& theMgr, | |
79 | const Handle(OpenGl_GraphicDriver)& theDriver, | |
80 | const Handle(OpenGl_Caps)& theCaps, | |
c357e426 | 81 | OpenGl_StateCounter* theCounter); |
82 | ||
83 | //! Default destructor. | |
84 | Standard_EXPORT virtual ~OpenGl_View(); | |
2166f0fa | 85 | |
ba00aab7 | 86 | //! Release OpenGL resources. |
655e883c | 87 | Standard_EXPORT virtual void ReleaseGlResources (const Handle(OpenGl_Context)& theCtx); |
bf75be98 | 88 | |
c357e426 | 89 | //! Deletes and erases the view. |
90 | Standard_EXPORT virtual void Remove() Standard_OVERRIDE; | |
91 | ||
92 | //! @param theDrawToFrontBuffer Advanced option to modify rendering mode: | |
93 | //! 1. TRUE. Drawing immediate mode structures directly to the front buffer over the scene image. | |
94 | //! Fast, so preferred for interactive work (used by default). | |
95 | //! However these extra drawings will be missed in image dump since it is performed from back buffer. | |
96 | //! Notice that since no pre-buffering used the V-Sync will be ignored and rendering could be seen | |
97 | //! in run-time (in case of slow hardware) and/or tearing may appear. | |
98 | //! So this is strongly recommended to draw only simple (fast) structures. | |
99 | //! 2. FALSE. Drawing immediate mode structures to the back buffer. | |
100 | //! The complete scene is redrawn first, so this mode is slower if scene contains complex data and/or V-Sync | |
101 | //! is turned on. But it works in any case and is especially useful for view dump because the dump image is read | |
102 | //! from the back buffer. | |
103 | //! @return previous mode. | |
104 | Standard_EXPORT Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer) Standard_OVERRIDE; | |
105 | ||
106 | //! Creates and maps rendering window to the view. | |
c357e426 | 107 | //! @param theWindow [in] the window. |
108 | //! @param theContext [in] the rendering context. If NULL the context will be created internally. | |
a521d90d | 109 | Standard_EXPORT virtual void SetWindow (const Handle(Aspect_Window)& theWindow, |
110 | const Aspect_RenderingContext theContext) Standard_OVERRIDE; | |
c357e426 | 111 | |
112 | //! Returns window associated with the view. | |
79104795 | 113 | virtual Handle(Aspect_Window) Window() const Standard_OVERRIDE |
114 | { return myWindow->PlatformWindow(); } | |
c357e426 | 115 | |
116 | //! Returns True if the window associated to the view is defined. | |
79104795 | 117 | virtual Standard_Boolean IsDefined() const Standard_OVERRIDE |
118 | { return !myWindow.IsNull(); } | |
c357e426 | 119 | |
120 | //! Handle changing size of the rendering window. | |
121 | Standard_EXPORT virtual void Resized() Standard_OVERRIDE; | |
122 | ||
123 | //! Redraw content of the view. | |
124 | Standard_EXPORT virtual void Redraw() Standard_OVERRIDE; | |
125 | ||
126 | //! Redraw immediate content of the view. | |
127 | Standard_EXPORT virtual void RedrawImmediate() Standard_OVERRIDE; | |
128 | ||
129 | //! Marks BVH tree for given priority list as dirty and marks primitive set for rebuild. | |
130 | Standard_EXPORT virtual void Invalidate() Standard_OVERRIDE; | |
131 | ||
132 | //! Return true if view content cache has been invalidated. | |
d2eddacc | 133 | virtual Standard_Boolean IsInvalidated() Standard_OVERRIDE { return !myBackBufferRestored; } |
c357e426 | 134 | |
c357e426 | 135 | //! Dump active rendering buffer into specified memory buffer. |
38d90bb3 | 136 | //! In Ray-Tracing allow to get a raw HDR buffer using Graphic3d_BT_RGB_RayTraceHdrLeft buffer type, |
137 | //! only Left view will be dumped ignoring stereoscopic parameter. | |
c357e426 | 138 | Standard_EXPORT virtual Standard_Boolean BufferDump (Image_PixMap& theImage, |
139 | const Graphic3d_BufferType& theBufferType) Standard_OVERRIDE; | |
140 | ||
c357e426 | 141 | //! Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated. |
8f138407 | 142 | Standard_EXPORT virtual void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE; |
c357e426 | 143 | |
1c728f2d | 144 | //! Add a layer to the view. |
145 | //! @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers). | |
146 | //! @param theSettings [in] new layer settings | |
147 | //! @param theLayerAfter [in] id of layer to append new layer before | |
148 | Standard_EXPORT virtual void InsertLayerBefore (const Graphic3d_ZLayerId theLayerId, | |
149 | const Graphic3d_ZLayerSettings& theSettings, | |
150 | const Graphic3d_ZLayerId theLayerAfter) Standard_OVERRIDE; | |
151 | ||
152 | //! Add a layer to the view. | |
153 | //! @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers). | |
154 | //! @param theSettings [in] new layer settings | |
155 | //! @param theLayerBefore [in] id of layer to append new layer after | |
156 | Standard_EXPORT virtual void InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId, | |
157 | const Graphic3d_ZLayerSettings& theSettings, | |
158 | const Graphic3d_ZLayerId theLayerBefore) Standard_OVERRIDE; | |
c357e426 | 159 | |
160 | //! Remove a z layer with the given ID. | |
161 | Standard_EXPORT virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE; | |
2166f0fa | 162 | |
c357e426 | 163 | //! Sets the settings for a single Z layer of specified view. |
164 | Standard_EXPORT virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, | |
165 | const Graphic3d_ZLayerSettings& theSettings) Standard_OVERRIDE; | |
b5ac8292 | 166 | |
50d06d8f | 167 | //! Returns the maximum Z layer ID. |
168 | //! First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax(). | |
169 | Standard_EXPORT virtual Standard_Integer ZLayerMax() const Standard_OVERRIDE; | |
170 | ||
1c728f2d | 171 | //! Returns the list of layers. |
172 | Standard_EXPORT virtual const NCollection_List<Handle(Graphic3d_Layer)>& Layers() const Standard_OVERRIDE; | |
50d06d8f | 173 | |
1c728f2d | 174 | //! Returns layer with given ID or NULL if undefined. |
175 | Standard_EXPORT virtual Handle(Graphic3d_Layer) Layer (const Graphic3d_ZLayerId theLayerId) const Standard_OVERRIDE; | |
176 | ||
177 | //! Returns the bounding box of all structures displayed in the view. | |
178 | //! If theToIncludeAuxiliary is TRUE, then the boundary box also includes minimum and maximum limits | |
179 | //! of graphical elements forming parts of infinite and other auxiliary structures. | |
3fe9ce0e | 180 | //! @param theToIncludeAuxiliary consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence) |
181 | //! @return computed bounding box | |
1c728f2d | 182 | Standard_EXPORT virtual Bnd_Box MinMaxValues (const Standard_Boolean theToIncludeAuxiliary) const Standard_OVERRIDE; |
50d06d8f | 183 | |
c357e426 | 184 | //! Returns pointer to an assigned framebuffer object. |
b128c892 | 185 | Standard_EXPORT virtual Handle(Standard_Transient) FBO() const Standard_OVERRIDE; |
2166f0fa | 186 | |
c357e426 | 187 | //! Sets framebuffer object for offscreen rendering. |
b128c892 | 188 | Standard_EXPORT virtual void SetFBO (const Handle(Standard_Transient)& theFbo) Standard_OVERRIDE; |
2166f0fa | 189 | |
c357e426 | 190 | //! Generate offscreen FBO in the graphic library. |
191 | //! If not supported on hardware returns NULL. | |
b128c892 | 192 | Standard_EXPORT virtual Handle(Standard_Transient) FBOCreate (const Standard_Integer theWidth, |
193 | const Standard_Integer theHeight) Standard_OVERRIDE; | |
2166f0fa | 194 | |
c357e426 | 195 | //! Remove offscreen FBO from the graphic library |
b128c892 | 196 | Standard_EXPORT virtual void FBORelease (Handle(Standard_Transient)& theFbo) Standard_OVERRIDE; |
2166f0fa | 197 | |
c357e426 | 198 | //! Read offscreen FBO configuration. |
b128c892 | 199 | Standard_EXPORT virtual void FBOGetDimensions (const Handle(Standard_Transient)& theFbo, |
c357e426 | 200 | Standard_Integer& theWidth, |
201 | Standard_Integer& theHeight, | |
202 | Standard_Integer& theWidthMax, | |
203 | Standard_Integer& theHeightMax) Standard_OVERRIDE; | |
204 | ||
205 | //! Change offscreen FBO viewport. | |
b128c892 | 206 | Standard_EXPORT virtual void FBOChangeViewport (const Handle(Standard_Transient)& theFbo, |
c357e426 | 207 | const Standard_Integer theWidth, |
208 | const Standard_Integer theHeight) Standard_OVERRIDE; | |
2166f0fa | 209 | |
78c4e836 | 210 | //! Returns additional buffers for depth peeling OIT. |
211 | const Handle(OpenGl_DepthPeeling)& DepthPeelingFbos() const { return myDepthPeelingFbos; } | |
212 | ||
c357e426 | 213 | public: |
2166f0fa | 214 | |
c357e426 | 215 | //! Returns gradient background fill colors. |
216 | Standard_EXPORT virtual Aspect_GradientBackground GradientBackground() const Standard_OVERRIDE; | |
2166f0fa | 217 | |
c357e426 | 218 | //! Sets gradient background fill colors. |
219 | Standard_EXPORT virtual void SetGradientBackground (const Aspect_GradientBackground& theBackground) Standard_OVERRIDE; | |
220 | ||
99289bed | 221 | //! Returns background image texture map. |
222 | virtual Handle(Graphic3d_TextureMap) BackgroundImage() Standard_OVERRIDE { return myBackgroundImage; } | |
c357e426 | 223 | |
99289bed | 224 | //! Sets image texture or environment cubemap as backround. |
225 | //! @param theTextureMap [in] source to set a background; | |
226 | //! should be either Graphic3d_Texture2D or Graphic3d_CubeMap | |
227 | //! @param theToUpdatePBREnv [in] defines whether IBL maps will be generated or not | |
228 | //! (see GeneratePBREnvironment()) | |
229 | Standard_EXPORT virtual void SetBackgroundImage (const Handle(Graphic3d_TextureMap)& theTextureMap, | |
230 | Standard_Boolean theToUpdatePBREnv = Standard_True) Standard_OVERRIDE; | |
c357e426 | 231 | |
232 | //! Returns background image fill style. | |
233 | Standard_EXPORT virtual Aspect_FillMethod BackgroundImageStyle() const Standard_OVERRIDE; | |
234 | ||
235 | //! Sets background image fill style. | |
236 | Standard_EXPORT virtual void SetBackgroundImageStyle (const Aspect_FillMethod theFillStyle) Standard_OVERRIDE; | |
237 | ||
077a220c | 238 | //! Returns cubemap being set last time on background. |
239 | Standard_EXPORT Handle(Graphic3d_CubeMap) BackgroundCubeMap() const Standard_OVERRIDE; | |
240 | ||
67312b79 | 241 | //! Generates PBR specular probe and irradiance map |
242 | //! in order to provide environment indirect illumination in PBR shading model (Image Based Lighting). | |
243 | //! The source of environment data is background cubemap. | |
244 | //! If PBR is unavailable it does nothing. | |
245 | //! If PBR is available but there is no cubemap being set to background it clears all IBL maps (see 'ClearPBREnvironment'). | |
246 | virtual void GeneratePBREnvironment() Standard_OVERRIDE { myPBREnvRequest = OpenGl_PBREnvRequest_BAKE; } | |
247 | ||
248 | //! Fills PBR specular probe and irradiance map with white color. | |
249 | //! So that environment indirect illumination will be constant | |
250 | //! and will be fully controlled by ambient light sources. | |
251 | //! If PBR is unavailable it does nothing. | |
252 | virtual void ClearPBREnvironment() Standard_OVERRIDE { myPBREnvRequest = OpenGl_PBREnvRequest_CLEAR; } | |
253 | ||
254 | //! Returns number of mipmap levels used in specular IBL map. | |
255 | //! 0 if PBR environment is not created. | |
256 | Standard_EXPORT unsigned int SpecIBLMapLevels() const; | |
077a220c | 257 | |
c357e426 | 258 | //! Returns environment texture set for the view. |
0f57ab75 | 259 | virtual Handle(Graphic3d_TextureEnv) TextureEnv() const Standard_OVERRIDE { return myTextureEnvData; } |
c357e426 | 260 | |
261 | //! Sets environment texture for the view. | |
262 | Standard_EXPORT virtual void SetTextureEnv (const Handle(Graphic3d_TextureEnv)& theTextureEnv) Standard_OVERRIDE; | |
263 | ||
7c3ef2f7 | 264 | //! Returns local camera origin currently set for rendering, might be modified during rendering. |
265 | const gp_XYZ& LocalOrigin() const { return myLocalOrigin; } | |
266 | ||
267 | //! Setup local camera origin currently set for rendering. | |
268 | Standard_EXPORT void SetLocalOrigin (const gp_XYZ& theOrigin); | |
269 | ||
c357e426 | 270 | //! Returns list of lights of the view. |
992ed6b3 | 271 | virtual const Handle(Graphic3d_LightSet)& Lights() const Standard_OVERRIDE { return myLights; } |
c357e426 | 272 | |
273 | //! Sets list of lights for the view. | |
992ed6b3 | 274 | virtual void SetLights (const Handle(Graphic3d_LightSet)& theLights) Standard_OVERRIDE |
c357e426 | 275 | { |
276 | myLights = theLights; | |
277 | myCurrLightSourceState = myStateCounter->Increment(); | |
278 | } | |
279 | ||
280 | //! Returns list of clip planes set for the view. | |
3202bf1e | 281 | virtual const Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const Standard_OVERRIDE { return myClipPlanes; } |
c357e426 | 282 | |
283 | //! Sets list of clip planes for the view. | |
3202bf1e | 284 | virtual void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes) Standard_OVERRIDE { myClipPlanes = thePlanes; } |
c357e426 | 285 | |
26d9c835 | 286 | //! Fill in the dictionary with diagnostic info. |
287 | //! Should be called within rendering thread. | |
288 | //! | |
289 | //! This API should be used only for user output or for creating automated reports. | |
290 | //! The format of returned information (e.g. key-value layout) | |
291 | //! is NOT part of this API and can be changed at any time. | |
292 | //! Thus application should not parse returned information to weed out specific parameters. | |
293 | Standard_EXPORT virtual void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict, | |
294 | Graphic3d_DiagnosticInfo theFlags) const Standard_OVERRIDE; | |
295 | ||
79b544e6 | 296 | //! Returns string with statistic performance info. |
297 | Standard_EXPORT virtual TCollection_AsciiString StatisticInformation() const Standard_OVERRIDE; | |
298 | ||
299 | //! Fills in the dictionary with statistic performance info. | |
300 | Standard_EXPORT virtual void StatisticInformation (TColStd_IndexedDataMapOfStringString& theDict) const Standard_OVERRIDE; | |
301 | ||
c357e426 | 302 | public: |
303 | ||
304 | //! Returns background color. | |
b6472664 | 305 | const Quantity_ColorRGBA& BackgroundColor() const { return myBgColor; } |
c357e426 | 306 | |
c357e426 | 307 | //! Change graduated trihedron. |
308 | OpenGl_GraduatedTrihedron& ChangeGraduatedTrihedron() { return myGraduatedTrihedron; } | |
309 | ||
310 | void SetTextureEnv (const Handle(OpenGl_Context)& theCtx, | |
311 | const Handle(Graphic3d_TextureEnv)& theTexture); | |
312 | ||
2166f0fa | 313 | void SetBackgroundTextureStyle (const Aspect_FillMethod FillStyle); |
c357e426 | 314 | |
2166f0fa | 315 | void SetBackgroundGradient (const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AType); |
2166f0fa | 316 | |
c357e426 | 317 | void SetBackgroundGradientType (const Aspect_GradientFillMethod AType); |
2166f0fa | 318 | |
e276548b | 319 | //! Returns list of OpenGL Z-layers. |
320 | const OpenGl_LayerList& LayerList() const { return myZLayers; } | |
321 | ||
c357e426 | 322 | //! Returns OpenGL window implementation. |
5e30547b | 323 | const Handle(OpenGl_Window)& GlWindow() const { return myWindow; } |
e276548b | 324 | |
c357e426 | 325 | //! Returns OpenGL environment map. |
cc8cbabe | 326 | const Handle(OpenGl_TextureSet)& GlTextureEnv() const { return myTextureEnv; } |
e276548b | 327 | |
b7cd4ba7 | 328 | //! Returns selector for BVH tree, providing a possibility to store information |
329 | //! about current view volume and to detect which objects are overlapping it. | |
d325cb7f | 330 | const Graphic3d_CullingTool& BVHTreeSelector() const { return myBVHSelector; } |
b7cd4ba7 | 331 | |
a1954302 | 332 | //! Returns true if there are immediate structures to display |
333 | bool HasImmediateStructures() const | |
334 | { | |
c3282ec1 | 335 | return myZLayers.NbImmediateStructures() != 0; |
a1954302 | 336 | } |
337 | ||
d325cb7f | 338 | public: //! @name obsolete Graduated Trihedron functionality |
339 | ||
340 | //! Displays Graduated Trihedron. | |
341 | Standard_EXPORT virtual void GraduatedTrihedronDisplay (const Graphic3d_GraduatedTrihedron& theTrihedronData) Standard_OVERRIDE; | |
342 | ||
343 | //! Erases Graduated Trihedron. | |
344 | Standard_EXPORT virtual void GraduatedTrihedronErase() Standard_OVERRIDE; | |
345 | ||
346 | //! Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object. | |
347 | //! @param theMin [in] the minimum point of scene. | |
348 | //! @param theMax [in] the maximum point of scene. | |
349 | Standard_EXPORT virtual void GraduatedTrihedronMinMaxValues (const Graphic3d_Vec3 theMin, const Graphic3d_Vec3 theMax) Standard_OVERRIDE; | |
350 | ||
c357e426 | 351 | protected: //! @name Internal methods for managing GL resources |
352 | ||
353 | //! Initializes OpenGl resource for environment texture. | |
354 | void initTextureEnv (const Handle(OpenGl_Context)& theContext); | |
355 | ||
a521d90d | 356 | protected: //! @name low-level redrawing sub-routines |
c357e426 | 357 | |
4b7fee8f | 358 | //! Prepare frame buffers for rendering. |
359 | Standard_EXPORT virtual bool prepareFrameBuffers (Graphic3d_Camera::Projection& theProj); | |
360 | ||
c357e426 | 361 | //! Redraws view for the given monographic camera projection, or left/right eye. |
a521d90d | 362 | Standard_EXPORT virtual void redraw (const Graphic3d_Camera::Projection theProjection, |
a1073ae2 | 363 | OpenGl_FrameBuffer* theReadDrawFbo, |
364 | OpenGl_FrameBuffer* theOitAccumFbo); | |
2166f0fa | 365 | |
c357e426 | 366 | //! Redraws view for the given monographic camera projection, or left/right eye. |
367 | //! | |
368 | //! Method will blit snapshot containing main scene (myMainSceneFbos or BackBuffer) | |
369 | //! into presentation buffer (myMainSceneFbos -> offscreen FBO or | |
370 | //! myMainSceneFbos -> BackBuffer or BackBuffer -> FrontBuffer), | |
371 | //! and redraw immediate structures on top. | |
372 | //! | |
373 | //! When scene caching is disabled (myTransientDrawToFront, no double buffer in window, etc.), | |
374 | //! the first step (blitting) will be skipped. | |
375 | //! | |
376 | //! @return false if immediate structures has been rendered directly into FrontBuffer | |
377 | //! and Buffer Swap should not be called. | |
a521d90d | 378 | Standard_EXPORT virtual bool redrawImmediate (const Graphic3d_Camera::Projection theProjection, |
379 | OpenGl_FrameBuffer* theReadFbo, | |
380 | OpenGl_FrameBuffer* theDrawFbo, | |
a1073ae2 | 381 | OpenGl_FrameBuffer* theOitAccumFbo, |
a521d90d | 382 | const Standard_Boolean theIsPartialUpdate = Standard_False); |
b5ac8292 | 383 | |
c357e426 | 384 | //! Blit image from/to specified buffers. |
a521d90d | 385 | Standard_EXPORT bool blitBuffers (OpenGl_FrameBuffer* theReadFbo, |
386 | OpenGl_FrameBuffer* theDrawFbo, | |
387 | const Standard_Boolean theToFlip = Standard_False); | |
2166f0fa | 388 | |
c357e426 | 389 | //! Setup default FBO. |
a521d90d | 390 | Standard_EXPORT void bindDefaultFbo (OpenGl_FrameBuffer* theCustomFbo = NULL); |
2166f0fa | 391 | |
c357e426 | 392 | protected: //! @name Rendering of GL graphics (with prepared drawing buffer). |
2166f0fa | 393 | |
d84e8669 | 394 | //! Renders the graphical contents of the view into the preprepared shadowmap framebuffer. |
395 | //! @param theShadowMap [in] the framebuffer for rendering shadowmap. | |
396 | Standard_EXPORT virtual void renderShadowMap (const Handle(OpenGl_ShadowMap)& theShadowMap); | |
397 | ||
c357e426 | 398 | //! Renders the graphical contents of the view into the preprepared window or framebuffer. |
399 | //! @param theProjection [in] the projection that should be used for rendering. | |
400 | //! @param theReadDrawFbo [in] the framebuffer for rendering graphics. | |
a1073ae2 | 401 | //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process. |
c357e426 | 402 | //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode. |
a521d90d | 403 | Standard_EXPORT virtual void render (Graphic3d_Camera::Projection theProjection, |
404 | OpenGl_FrameBuffer* theReadDrawFbo, | |
a1073ae2 | 405 | OpenGl_FrameBuffer* theOitAccumFbo, |
a521d90d | 406 | const Standard_Boolean theToDrawImmediate); |
2166f0fa | 407 | |
c357e426 | 408 | //! Renders the graphical scene. |
bf02aa7d | 409 | //! @param theProjection [in] the projection that is used for rendering. |
c357e426 | 410 | //! @param theReadDrawFbo [in] the framebuffer for rendering graphics. |
a1073ae2 | 411 | //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process. |
c357e426 | 412 | //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode. |
bf02aa7d | 413 | Standard_EXPORT virtual void renderScene (Graphic3d_Camera::Projection theProjection, |
414 | OpenGl_FrameBuffer* theReadDrawFbo, | |
a1073ae2 | 415 | OpenGl_FrameBuffer* theOitAccumFbo, |
a521d90d | 416 | const Standard_Boolean theToDrawImmediate); |
417 | ||
418 | //! Draw background (gradient / image) | |
cdc54fb0 | 419 | Standard_EXPORT virtual void drawBackground (const Handle(OpenGl_Workspace)& theWorkspace, |
420 | Graphic3d_Camera::Projection theProjection); | |
2166f0fa | 421 | |
c357e426 | 422 | //! Render set of structures presented in the view. |
bf02aa7d | 423 | //! @param theProjection [in] the projection that is used for rendering. |
c357e426 | 424 | //! @param theReadDrawFbo [in] the framebuffer for rendering graphics. |
a1073ae2 | 425 | //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process. |
c357e426 | 426 | //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode. |
bf02aa7d | 427 | Standard_EXPORT virtual void renderStructs (Graphic3d_Camera::Projection theProjection, |
428 | OpenGl_FrameBuffer* theReadDrawFbo, | |
a1073ae2 | 429 | OpenGl_FrameBuffer* theOitAccumFbo, |
a521d90d | 430 | const Standard_Boolean theToDrawImmediate); |
2166f0fa | 431 | |
c357e426 | 432 | //! Renders trihedron. |
433 | void renderTrihedron (const Handle(OpenGl_Workspace) &theWorkspace); | |
2166f0fa | 434 | |
15669413 | 435 | //! Renders frame statistics. |
436 | void renderFrameStats(); | |
437 | ||
c357e426 | 438 | private: |
392ac980 | 439 | |
c357e426 | 440 | //! Adds the structure to display lists of the view. |
441 | Standard_EXPORT virtual void displayStructure (const Handle(Graphic3d_CStructure)& theStructure, | |
442 | const Standard_Integer thePriority) Standard_OVERRIDE; | |
443 | ||
444 | //! Erases the structure from display lists of the view. | |
445 | Standard_EXPORT virtual void eraseStructure (const Handle(Graphic3d_CStructure)& theStructure) Standard_OVERRIDE; | |
446 | ||
447 | //! Change Z layer of a structure already presented in view. | |
448 | Standard_EXPORT virtual void changeZLayer (const Handle(Graphic3d_CStructure)& theCStructure, | |
449 | const Graphic3d_ZLayerId theNewLayerId) Standard_OVERRIDE; | |
450 | ||
451 | //! Changes the priority of a structure within its Z layer in the specified view. | |
452 | Standard_EXPORT virtual void changePriority (const Handle(Graphic3d_CStructure)& theCStructure, | |
453 | const Standard_Integer theNewPriority) Standard_OVERRIDE; | |
454 | ||
a521d90d | 455 | private: |
456 | ||
ba00aab7 | 457 | //! Release sRGB resources (frame-buffers, textures, etc.). |
458 | void releaseSrgbResources (const Handle(OpenGl_Context)& theCtx); | |
459 | ||
a521d90d | 460 | //! Copy content of Back buffer to the Front buffer. |
a0b49de4 | 461 | bool copyBackToFront(); |
a521d90d | 462 | |
463 | //! Initialize blit quad. | |
464 | OpenGl_VertexBuffer* initBlitQuad (const Standard_Boolean theToFlip); | |
465 | ||
466 | //! Blend together views pair into stereo image. | |
3c4b62a4 | 467 | void drawStereoPair (OpenGl_FrameBuffer* theDrawFbo); |
a521d90d | 468 | |
a1073ae2 | 469 | //! Check and update OIT compatibility with current OpenGL context's state. |
470 | bool checkOitCompatibility (const Handle(OpenGl_Context)& theGlContext, | |
471 | const Standard_Boolean theMSAA); | |
472 | ||
473 | //! Chooses compatible internal color format for OIT frame buffer. | |
474 | bool chooseOitColorConfiguration (const Handle(OpenGl_Context)& theGlContext, | |
475 | const Standard_Integer theConfigIndex, | |
476 | OpenGl_ColorFormats& theFormats); | |
477 | ||
c357e426 | 478 | protected: |
479 | ||
480 | OpenGl_GraphicDriver* myDriver; | |
481 | Handle(OpenGl_Window) myWindow; | |
482 | Handle(OpenGl_Workspace) myWorkspace; | |
483 | Handle(OpenGl_Caps) myCaps; | |
c357e426 | 484 | Standard_Boolean myWasRedrawnGL; |
485 | ||
3202bf1e | 486 | Handle(Graphic3d_SequenceOfHClipPlane) myClipPlanes; |
7c3ef2f7 | 487 | gp_XYZ myLocalOrigin; |
b128c892 | 488 | Handle(OpenGl_FrameBuffer) myFBO; |
c357e426 | 489 | Standard_Boolean myToShowGradTrihedron; |
99289bed | 490 | Handle(Graphic3d_TextureMap) myBackgroundImage; |
c357e426 | 491 | Handle(Graphic3d_TextureEnv) myTextureEnvData; |
492 | Graphic3d_GraduatedTrihedron myGTrihedronData; | |
493 | ||
992ed6b3 | 494 | Handle(Graphic3d_LightSet) myNoShadingLight; |
495 | Handle(Graphic3d_LightSet) myLights; | |
c357e426 | 496 | OpenGl_LayerList myZLayers; //!< main list of displayed structure, sorted by layers |
497 | ||
498 | Graphic3d_WorldViewProjState myWorldViewProjState; //!< camera modification state | |
499 | OpenGl_StateCounter* myStateCounter; | |
500 | Standard_Size myCurrLightSourceState; | |
992ed6b3 | 501 | Standard_Size myLightsRevision; |
392ac980 | 502 | |
503 | typedef std::pair<Standard_Size, Standard_Size> StateInfo; | |
504 | ||
505 | StateInfo myLastOrientationState; | |
506 | StateInfo myLastViewMappingState; | |
507 | StateInfo myLastLightSourceState; | |
30f0ad28 | 508 | |
b7cd4ba7 | 509 | //! Is needed for selection of overlapping objects and storage of the current view volume |
d325cb7f | 510 | Graphic3d_CullingTool myBVHSelector; |
b7cd4ba7 | 511 | |
c357e426 | 512 | OpenGl_GraduatedTrihedron myGraduatedTrihedron; |
15669413 | 513 | OpenGl_FrameStatsPrs myFrameStatsPrs; |
c357e426 | 514 | |
cc8cbabe | 515 | Handle(OpenGl_TextureSet) myTextureEnv; |
c357e426 | 516 | |
3a9b5dc8 | 517 | //! Framebuffers for OpenGL output. |
518 | Handle(OpenGl_FrameBuffer) myOpenGlFBO; | |
519 | Handle(OpenGl_FrameBuffer) myOpenGlFBO2; | |
520 | ||
c357e426 | 521 | protected: //! @name Rendering properties |
522 | ||
523 | //! Two framebuffers (left and right views) store cached main presentation | |
524 | //! of the view (without presentation of immediate layers). | |
ba00aab7 | 525 | Standard_Integer mySRgbState; //!< track sRGB state |
3c4b62a4 | 526 | GLint myFboColorFormat; //!< sized format for color attachments |
527 | GLint myFboDepthFormat; //!< sized format for depth-stencil attachments | |
a1073ae2 | 528 | OpenGl_ColorFormats myFboOitColorConfig; //!< selected color format configuration for OIT color attachments |
c357e426 | 529 | Handle(OpenGl_FrameBuffer) myMainSceneFbos[2]; |
a1073ae2 | 530 | Handle(OpenGl_FrameBuffer) myMainSceneFbosOit[2]; //!< Additional buffers for transparent draw of main layer. |
531 | Handle(OpenGl_FrameBuffer) myImmediateSceneFbos[2]; //!< Additional buffers for immediate layer in stereo mode. | |
532 | Handle(OpenGl_FrameBuffer) myImmediateSceneFbosOit[2]; //!< Additional buffers for transparency draw of immediate layer. | |
78c4e836 | 533 | Handle(OpenGl_FrameBuffer) myXrSceneFbo; //!< additional FBO (without MSAA) for submitting to XR |
534 | Handle(OpenGl_DepthPeeling) myDepthPeelingFbos; //!< additional buffers for depth peeling | |
d84e8669 | 535 | Handle(OpenGl_ShadowMapArray) myShadowMaps; //!< additional FBOs for shadow map rendering |
c357e426 | 536 | OpenGl_VertexBuffer myFullScreenQuad; //!< Vertices for full-screen quad rendering. |
537 | OpenGl_VertexBuffer myFullScreenQuadFlip; | |
538 | Standard_Boolean myToFlipOutput; //!< Flag to draw result image upside-down | |
539 | unsigned int myFrameCounter; //!< redraw counter, for debugging | |
7ccf8676 | 540 | Standard_Boolean myHasFboBlit; //!< disable FBOs on failure |
a1073ae2 | 541 | Standard_Boolean myToDisableOIT; //!< disable OIT on failure |
542 | Standard_Boolean myToDisableOITMSAA; //!< disable OIT with MSAA on failure | |
7ccf8676 | 543 | Standard_Boolean myToDisableMSAA; //!< disable MSAA after failure |
c357e426 | 544 | Standard_Boolean myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer) |
545 | Standard_Boolean myBackBufferRestored; | |
546 | Standard_Boolean myIsImmediateDrawn; //!< flag indicates that immediate mode buffer contains some data | |
547 | ||
0b0320e7 | 548 | protected: //! @name Background parameters |
549 | ||
077a220c | 550 | OpenGl_Aspects* myTextureParams; //!< Stores texture and its parameters for textured background |
551 | OpenGl_Aspects* myCubeMapParams; //!< Stores cubemap and its parameters for cubemap background | |
67312b79 | 552 | Handle(Graphic3d_CubeMap) myBackgroundCubeMap; //!< Cubemap has been set as background |
553 | Graphic3d_TypeOfBackground myBackgroundType; //!< Current type of background | |
077a220c | 554 | OpenGl_BackgroundArray* myBackgrounds[Graphic3d_TypeOfBackground_NB]; //!< Array of primitive arrays of different background types |
0b0320e7 | 555 | |
67312b79 | 556 | protected: //! @name methods related to PBR |
557 | ||
558 | //! Checks whether PBR is available. | |
559 | Standard_EXPORT Standard_Boolean checkPBRAvailability() const; | |
560 | ||
561 | //! Generates IBL maps used in PBR pipeline. | |
562 | //! If background cubemap is not set clears all IBL maps. | |
563 | Standard_EXPORT void bakePBREnvironment (const Handle(OpenGl_Context)& theCtx); | |
564 | ||
565 | //! Fills all IBL maps with white color. | |
566 | //! So that environment lighting is considered to be constant and is completely controls by ambient light sources. | |
567 | Standard_EXPORT void clearPBREnvironment (const Handle(OpenGl_Context)& theCtx); | |
568 | ||
569 | //! Process requests to generate or to clear PBR environment. | |
570 | Standard_EXPORT void processPBREnvRequest (const Handle(OpenGl_Context)& theCtx); | |
571 | ||
572 | protected: //! @name fields and types related to PBR | |
573 | ||
574 | //! State of PBR environment. | |
575 | enum PBREnvironmentState | |
576 | { | |
577 | OpenGl_PBREnvState_NONEXISTENT, | |
578 | OpenGl_PBREnvState_UNAVAILABLE, // indicates failed try to create PBR environment | |
579 | OpenGl_PBREnvState_CREATED | |
580 | }; | |
581 | ||
582 | //! Type of action which can be done with PBR environment. | |
583 | enum PBREnvironmentRequest | |
584 | { | |
585 | OpenGl_PBREnvRequest_NONE, | |
586 | OpenGl_PBREnvRequest_BAKE, | |
587 | OpenGl_PBREnvRequest_CLEAR | |
588 | }; | |
589 | ||
590 | Handle(OpenGl_PBREnvironment) myPBREnvironment; //!< manager of IBL maps used in PBR pipeline | |
591 | PBREnvironmentState myPBREnvState; //!< state of PBR environment | |
592 | PBREnvironmentRequest myPBREnvRequest; //!< type of action is requested to be done with PBR environment | |
593 | ||
91c60b57 | 594 | protected: //! @name data types related to ray-tracing |
595 | ||
596 | //! Result of OpenGL shaders initialization. | |
597 | enum RaytraceInitStatus | |
598 | { | |
599 | OpenGl_RT_NONE, | |
600 | OpenGl_RT_INIT, | |
601 | OpenGl_RT_FAIL | |
602 | }; | |
603 | ||
604 | //! Describes update mode (state). | |
605 | enum RaytraceUpdateMode | |
606 | { | |
607 | OpenGl_GUM_CHECK, //!< check geometry state | |
608 | OpenGl_GUM_PREPARE, //!< collect unchanged objects | |
609 | OpenGl_GUM_REBUILD //!< rebuild changed and new objects | |
610 | }; | |
611 | ||
612 | //! Defines frequently used shader variables. | |
613 | enum ShaderVariableIndex | |
614 | { | |
615 | OpenGl_RT_aPosition, | |
616 | ||
189f85a3 | 617 | // camera position |
91c60b57 | 618 | OpenGl_RT_uOriginLT, |
619 | OpenGl_RT_uOriginLB, | |
620 | OpenGl_RT_uOriginRT, | |
621 | OpenGl_RT_uOriginRB, | |
622 | OpenGl_RT_uDirectLT, | |
623 | OpenGl_RT_uDirectLB, | |
624 | OpenGl_RT_uDirectRT, | |
625 | OpenGl_RT_uDirectRB, | |
3a9b5dc8 | 626 | OpenGl_RT_uViewPrMat, |
91c60b57 | 627 | OpenGl_RT_uUnviewMat, |
628 | ||
189f85a3 | 629 | // 3D scene params |
91c60b57 | 630 | OpenGl_RT_uSceneRad, |
631 | OpenGl_RT_uSceneEps, | |
632 | OpenGl_RT_uLightAmbnt, | |
633 | OpenGl_RT_uLightCount, | |
634 | ||
189f85a3 | 635 | // background params |
636 | OpenGl_RT_uBackColorTop, | |
637 | OpenGl_RT_uBackColorBot, | |
91c60b57 | 638 | |
189f85a3 | 639 | // ray-tracing params |
640 | OpenGl_RT_uShadowsEnabled, | |
641 | OpenGl_RT_uReflectEnabled, | |
89d855ba | 642 | OpenGl_RT_uEnvMapEnabled, |
643 | OpenGl_RT_uEnvMapForBack, | |
189f85a3 | 644 | OpenGl_RT_uTexSamplersArray, |
8c820969 | 645 | OpenGl_RT_uBlockedRngEnabled, |
189f85a3 | 646 | |
3a9b5dc8 | 647 | // size of render window |
648 | OpenGl_RT_uWinSizeX, | |
649 | OpenGl_RT_uWinSizeY, | |
650 | ||
189f85a3 | 651 | // sampled frame params |
383c6c9f | 652 | OpenGl_RT_uAccumSamples, |
189f85a3 | 653 | OpenGl_RT_uFrameRndSeed, |
654 | ||
655 | // adaptive FSAA params | |
93cdaa76 | 656 | OpenGl_RT_uFsaaOffset, |
91c60b57 | 657 | OpenGl_RT_uSamples, |
91c60b57 | 658 | |
b09447ed | 659 | // images used by ISS mode |
3a9b5dc8 | 660 | OpenGl_RT_uRenderImage, |
e084dbbc | 661 | OpenGl_RT_uTilesImage, |
3a9b5dc8 | 662 | OpenGl_RT_uOffsetImage, |
66d1cdc6 | 663 | OpenGl_RT_uTileSize, |
664 | OpenGl_RT_uVarianceScaleFactor, | |
3a9b5dc8 | 665 | |
b09447ed | 666 | // maximum radiance value |
667 | OpenGl_RT_uMaxRadiance, | |
668 | ||
91c60b57 | 669 | OpenGl_RT_NbVariables // special field |
670 | }; | |
671 | ||
3a9b5dc8 | 672 | //! Defines OpenGL image samplers. |
673 | enum ShaderImageNames | |
674 | { | |
66d1cdc6 | 675 | OpenGl_RT_OutputImage = 0, |
676 | OpenGl_RT_VisualErrorImage = 1, | |
677 | OpenGl_RT_TileOffsetsImage = 2, | |
e084dbbc | 678 | OpenGl_RT_TileSamplesImage = 3 |
91c60b57 | 679 | }; |
680 | ||
681 | //! Tool class for management of shader sources. | |
682 | class ShaderSource | |
683 | { | |
684 | public: | |
685 | ||
189f85a3 | 686 | //! Default shader prefix - empty string. |
687 | static const TCollection_AsciiString EMPTY_PREFIX; | |
688 | ||
91c60b57 | 689 | //! Creates new uninitialized shader source. |
690 | ShaderSource() | |
691 | { | |
692 | // | |
693 | } | |
694 | ||
73722cc9 | 695 | public: |
189f85a3 | 696 | |
73722cc9 | 697 | //! Returns error description in case of load fail. |
698 | const TCollection_AsciiString& ErrorDescription() const | |
699 | { | |
700 | return myError; | |
91c60b57 | 701 | } |
702 | ||
91c60b57 | 703 | //! Returns prefix to insert before the source. |
704 | const TCollection_AsciiString& Prefix() const | |
705 | { | |
706 | return myPrefix; | |
707 | } | |
708 | ||
709 | //! Sets prefix to insert before the source. | |
710 | void SetPrefix (const TCollection_AsciiString& thePrefix) | |
711 | { | |
712 | myPrefix = thePrefix; | |
713 | } | |
714 | ||
715 | //! Returns shader source combined with prefix. | |
93cdaa76 | 716 | TCollection_AsciiString Source (const Handle(OpenGl_Context)& theCtx, |
717 | const GLenum theType) const; | |
91c60b57 | 718 | |
719 | //! Loads shader source from specified files. | |
ee5befae | 720 | Standard_Boolean LoadFromFiles (const TCollection_AsciiString* theFileNames, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX); |
721 | ||
722 | //! Loads shader source from specified strings. | |
723 | Standard_Boolean LoadFromStrings (const TCollection_AsciiString* theStrings, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX); | |
91c60b57 | 724 | |
725 | private: | |
726 | ||
727 | TCollection_AsciiString mySource; //!< Source string of the shader object | |
728 | TCollection_AsciiString myPrefix; //!< Prefix to insert before the source | |
73722cc9 | 729 | TCollection_AsciiString myError; //!< error state |
91c60b57 | 730 | |
731 | }; | |
732 | ||
733 | //! Default ray-tracing depth. | |
734 | static const Standard_Integer THE_DEFAULT_NB_BOUNCES = 3; | |
735 | ||
736 | //! Default size of traversal stack. | |
f2474958 | 737 | static const Standard_Integer THE_DEFAULT_STACK_SIZE = 10; |
91c60b57 | 738 | |
739 | //! Compile-time ray-tracing parameters. | |
740 | struct RaytracingParams | |
741 | { | |
742 | //! Actual size of traversal stack in shader program. | |
743 | Standard_Integer StackSize; | |
744 | ||
745 | //! Actual ray-tracing depth (number of ray bounces). | |
746 | Standard_Integer NbBounces; | |
747 | ||
e70625d6 | 748 | //! Define depth computation |
749 | Standard_Boolean IsZeroToOneDepth; | |
750 | ||
f483f2ed | 751 | //! Enables/disables light propagation through transparent media. |
91c60b57 | 752 | Standard_Boolean TransparentShadows; |
753 | ||
189f85a3 | 754 | //! Enables/disables global illumination (GI) effects. |
755 | Standard_Boolean GlobalIllumination; | |
756 | ||
f483f2ed | 757 | //! Enables/disables the use of OpenGL bindless textures. |
758 | Standard_Boolean UseBindlessTextures; | |
759 | ||
b4327ba8 | 760 | //! Enables/disables two-sided BSDF models instead of one-sided. |
761 | Standard_Boolean TwoSidedBsdfModels; | |
762 | ||
3a9b5dc8 | 763 | //! Enables/disables adaptive screen sampling for path tracing. |
764 | Standard_Boolean AdaptiveScreenSampling; | |
765 | ||
e084dbbc | 766 | //! Enables/disables 1-pass atomic mode for AdaptiveScreenSampling. |
767 | Standard_Boolean AdaptiveScreenSamplingAtomic; | |
768 | ||
b09447ed | 769 | //! Enables/disables environment map for background. |
770 | Standard_Boolean UseEnvMapForBackground; | |
771 | ||
78607702 | 772 | //! Enables/disables normal map ignoring during path tracing. |
773 | Standard_Boolean ToIgnoreNormalMap; | |
774 | ||
b09447ed | 775 | //! Maximum radiance value used for clamping radiance estimation. |
776 | Standard_ShortReal RadianceClampingValue; | |
eb85ed36 | 777 | |
b27ab03d | 778 | //! Enables/disables depth-of-field effect (path tracing, perspective camera). |
779 | Standard_Boolean DepthOfField; | |
780 | ||
89d855ba | 781 | //! Enables/disables cubemap backgraund. |
782 | Standard_Boolean CubemapForBack; | |
783 | ||
eb85ed36 | 784 | //! Tone mapping method for path tracing. |
785 | Graphic3d_ToneMappingMethod ToneMappingMethod; | |
4eaaf9d8 | 786 | |
91c60b57 | 787 | //! Creates default compile-time ray-tracing parameters. |
788 | RaytracingParams() | |
b09447ed | 789 | : StackSize (THE_DEFAULT_STACK_SIZE), |
790 | NbBounces (THE_DEFAULT_NB_BOUNCES), | |
e70625d6 | 791 | IsZeroToOneDepth (Standard_False), |
b4327ba8 | 792 | TransparentShadows (Standard_False), |
793 | GlobalIllumination (Standard_False), | |
794 | UseBindlessTextures (Standard_False), | |
795 | TwoSidedBsdfModels (Standard_False), | |
b09447ed | 796 | AdaptiveScreenSampling (Standard_False), |
e084dbbc | 797 | AdaptiveScreenSamplingAtomic (Standard_False), |
b09447ed | 798 | UseEnvMapForBackground (Standard_False), |
78607702 | 799 | ToIgnoreNormalMap (Standard_False), |
4eaaf9d8 | 800 | RadianceClampingValue (30.0), |
b27ab03d | 801 | DepthOfField (Standard_False), |
89d855ba | 802 | CubemapForBack (Standard_False), |
eb85ed36 | 803 | ToneMappingMethod (Graphic3d_ToneMappingMethod_Disabled) { } |
91c60b57 | 804 | }; |
805 | ||
d4aaad5b | 806 | //! Describes state of OpenGL structure. |
807 | struct StructState | |
808 | { | |
809 | Standard_Size StructureState; | |
810 | Standard_Size InstancedState; | |
811 | ||
812 | //! Creates new structure state. | |
813 | StructState (const Standard_Size theStructureState = 0, | |
814 | const Standard_Size theInstancedState = 0) | |
815 | : StructureState (theStructureState), | |
816 | InstancedState (theInstancedState) | |
817 | { | |
818 | // | |
819 | } | |
820 | ||
821 | //! Creates new structure state. | |
822 | StructState (const OpenGl_Structure* theStructure) | |
823 | { | |
824 | StructureState = theStructure->ModificationState(); | |
825 | ||
826 | InstancedState = theStructure->InstancedStructure() != NULL ? | |
827 | theStructure->InstancedStructure()->ModificationState() : 0; | |
828 | } | |
829 | }; | |
830 | ||
91c60b57 | 831 | protected: //! @name methods related to ray-tracing |
832 | ||
833 | //! Updates 3D scene geometry for ray-tracing. | |
834 | Standard_Boolean updateRaytraceGeometry (const RaytraceUpdateMode theMode, | |
835 | const Standard_Integer theViewId, | |
836 | const Handle(OpenGl_Context)& theGlContext); | |
837 | ||
838 | //! Updates 3D scene light sources for ray-tracing. | |
839 | Standard_Boolean updateRaytraceLightSources (const OpenGl_Mat4& theInvModelView, const Handle(OpenGl_Context)& theGlContext); | |
840 | ||
91c60b57 | 841 | //! Checks to see if the OpenGL structure is modified. |
842 | Standard_Boolean toUpdateStructure (const OpenGl_Structure* theStructure); | |
843 | ||
844 | //! Adds OpenGL structure to ray-traced scene geometry. | |
845 | Standard_Boolean addRaytraceStructure (const OpenGl_Structure* theStructure, | |
846 | const Handle(OpenGl_Context)& theGlContext); | |
847 | ||
848 | //! Adds OpenGL groups to ray-traced scene geometry. | |
8c820969 | 849 | Standard_Boolean addRaytraceGroups (const OpenGl_Structure* theStructure, |
850 | const OpenGl_RaytraceMaterial& theStructMat, | |
7f24b768 | 851 | const Handle(TopLoc_Datum3D)& theTrsf, |
8c820969 | 852 | const Handle(OpenGl_Context)& theGlContext); |
91c60b57 | 853 | |
854 | //! Creates ray-tracing material properties. | |
bf5f0ca2 | 855 | OpenGl_RaytraceMaterial convertMaterial (const OpenGl_Aspects* theAspect, |
91c60b57 | 856 | const Handle(OpenGl_Context)& theGlContext); |
857 | ||
858 | //! Adds OpenGL primitive array to ray-traced scene geometry. | |
f5b72419 | 859 | Handle(OpenGl_TriangleSet) addRaytracePrimitiveArray (const OpenGl_PrimitiveArray* theArray, |
860 | const Standard_Integer theMatID, | |
861 | const OpenGl_Mat4* theTrans); | |
91c60b57 | 862 | |
863 | //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry. | |
864 | Standard_Boolean addRaytraceVertexIndices (OpenGl_TriangleSet& theSet, | |
865 | const Standard_Integer theMatID, | |
866 | const Standard_Integer theCount, | |
867 | const Standard_Integer theOffset, | |
868 | const OpenGl_PrimitiveArray& theArray); | |
869 | ||
870 | //! Adds OpenGL triangle array to ray-traced scene geometry. | |
871 | Standard_Boolean addRaytraceTriangleArray (OpenGl_TriangleSet& theSet, | |
872 | const Standard_Integer theMatID, | |
873 | const Standard_Integer theCount, | |
874 | const Standard_Integer theOffset, | |
875 | const Handle(Graphic3d_IndexBuffer)& theIndices); | |
876 | ||
877 | //! Adds OpenGL triangle fan array to ray-traced scene geometry. | |
878 | Standard_Boolean addRaytraceTriangleFanArray (OpenGl_TriangleSet& theSet, | |
879 | const Standard_Integer theMatID, | |
880 | const Standard_Integer theCount, | |
881 | const Standard_Integer theOffset, | |
882 | const Handle(Graphic3d_IndexBuffer)& theIndices); | |
883 | ||
884 | //! Adds OpenGL triangle strip array to ray-traced scene geometry. | |
885 | Standard_Boolean addRaytraceTriangleStripArray (OpenGl_TriangleSet& theSet, | |
886 | const Standard_Integer theMatID, | |
887 | const Standard_Integer theCount, | |
888 | const Standard_Integer theOffset, | |
889 | const Handle(Graphic3d_IndexBuffer)& theIndices); | |
890 | ||
891 | //! Adds OpenGL quadrangle array to ray-traced scene geometry. | |
892 | Standard_Boolean addRaytraceQuadrangleArray (OpenGl_TriangleSet& theSet, | |
893 | const Standard_Integer theMatID, | |
894 | const Standard_Integer theCount, | |
895 | const Standard_Integer theOffset, | |
896 | const Handle(Graphic3d_IndexBuffer)& theIndices); | |
897 | ||
898 | //! Adds OpenGL quadrangle strip array to ray-traced scene geometry. | |
899 | Standard_Boolean addRaytraceQuadrangleStripArray (OpenGl_TriangleSet& theSet, | |
900 | const Standard_Integer theMatID, | |
901 | const Standard_Integer theCount, | |
902 | const Standard_Integer theOffset, | |
903 | const Handle(Graphic3d_IndexBuffer)& theIndices); | |
904 | ||
905 | //! Adds OpenGL polygon array to ray-traced scene geometry. | |
906 | Standard_Boolean addRaytracePolygonArray (OpenGl_TriangleSet& theSet, | |
907 | const Standard_Integer theMatID, | |
908 | const Standard_Integer theCount, | |
909 | const Standard_Integer theOffset, | |
910 | const Handle(Graphic3d_IndexBuffer)& theIndices); | |
911 | ||
912 | //! Uploads ray-trace data to the GPU. | |
913 | Standard_Boolean uploadRaytraceData (const Handle(OpenGl_Context)& theGlContext); | |
914 | ||
915 | //! Generates shader prefix based on current ray-tracing options. | |
916 | TCollection_AsciiString generateShaderPrefix (const Handle(OpenGl_Context)& theGlContext) const; | |
917 | ||
918 | //! Performs safe exit when shaders initialization fails. | |
919 | Standard_Boolean safeFailBack (const TCollection_ExtendedString& theMessage, | |
920 | const Handle(OpenGl_Context)& theGlContext); | |
921 | ||
922 | //! Loads and compiles shader object from specified source. | |
923 | Handle(OpenGl_ShaderObject) initShader (const GLenum theType, | |
924 | const ShaderSource& theSource, | |
925 | const Handle(OpenGl_Context)& theGlContext); | |
926 | ||
189f85a3 | 927 | //! Creates shader program from the given vertex and fragment shaders. |
928 | Handle(OpenGl_ShaderProgram) initProgram (const Handle(OpenGl_Context)& theGlContext, | |
929 | const Handle(OpenGl_ShaderObject)& theVertShader, | |
d95f5ce1 | 930 | const Handle(OpenGl_ShaderObject)& theFragShader, |
931 | const TCollection_AsciiString& theName); | |
189f85a3 | 932 | |
91c60b57 | 933 | //! Initializes OpenGL/GLSL shader programs. |
66d1cdc6 | 934 | Standard_Boolean initRaytraceResources (const Standard_Integer theSizeX, |
935 | const Standard_Integer theSizeY, | |
936 | const Handle(OpenGl_Context)& theGlContext); | |
91c60b57 | 937 | |
938 | //! Releases OpenGL/GLSL shader programs. | |
d877e610 | 939 | void releaseRaytraceResources (const Handle(OpenGl_Context)& theGlContext, |
940 | const Standard_Boolean theToRebuild = Standard_False); | |
91c60b57 | 941 | |
bf02aa7d | 942 | //! Updates auxiliary OpenGL frame buffers. |
943 | Standard_Boolean updateRaytraceBuffers (const Standard_Integer theSizeX, | |
91c60b57 | 944 | const Standard_Integer theSizeY, |
945 | const Handle(OpenGl_Context)& theGlContext); | |
946 | ||
947 | //! Generates viewing rays for corners of screen quad. | |
b27ab03d | 948 | //! (ray tracing; path tracing for orthographic camera) |
91c60b57 | 949 | void updateCamera (const OpenGl_Mat4& theOrientation, |
950 | const OpenGl_Mat4& theViewMapping, | |
951 | OpenGl_Vec3* theOrigins, | |
952 | OpenGl_Vec3* theDirects, | |
1d865689 | 953 | OpenGl_Mat4& theView, |
91c60b57 | 954 | OpenGl_Mat4& theUnView); |
955 | ||
b27ab03d | 956 | //! Generate viewing rays (path tracing, perspective camera). |
957 | void updatePerspCameraPT(const OpenGl_Mat4& theOrientation, | |
958 | const OpenGl_Mat4& theViewMapping, | |
959 | Graphic3d_Camera::Projection theProjection, | |
960 | OpenGl_Mat4& theViewPr, | |
961 | OpenGl_Mat4& theUnview, | |
962 | const int theWinSizeX, | |
963 | const int theWinSizeY); | |
964 | ||
91c60b57 | 965 | //! Binds ray-trace textures to corresponding texture units. |
66d1cdc6 | 966 | void bindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext, |
967 | int theStereoView); | |
91c60b57 | 968 | |
969 | //! Unbinds ray-trace textures from corresponding texture unit. | |
970 | void unbindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext); | |
971 | ||
972 | //! Sets uniform state for the given ray-tracing shader program. | |
3a9b5dc8 | 973 | Standard_Boolean setUniformState (const Standard_Integer theProgramId, |
974 | const Standard_Integer theSizeX, | |
975 | const Standard_Integer theSizeY, | |
b27ab03d | 976 | Graphic3d_Camera::Projection theProjection, |
91c60b57 | 977 | const Handle(OpenGl_Context)& theGlContext); |
978 | ||
979 | //! Runs ray-tracing shader programs. | |
c357e426 | 980 | Standard_Boolean runRaytraceShaders (const Standard_Integer theSizeX, |
91c60b57 | 981 | const Standard_Integer theSizeY, |
bf02aa7d | 982 | Graphic3d_Camera::Projection theProjection, |
38a0206f | 983 | OpenGl_FrameBuffer* theReadDrawFbo, |
91c60b57 | 984 | const Handle(OpenGl_Context)& theGlContext); |
985 | ||
3a9b5dc8 | 986 | //! Runs classical (Whitted-style) ray-tracing kernel. |
987 | Standard_Boolean runRaytrace (const Standard_Integer theSizeX, | |
988 | const Standard_Integer theSizeY, | |
989 | Graphic3d_Camera::Projection theProjection, | |
990 | OpenGl_FrameBuffer* theReadDrawFbo, | |
991 | const Handle(OpenGl_Context)& theGlContext); | |
992 | ||
993 | //! Runs path tracing (global illumination) kernel. | |
4eaaf9d8 | 994 | Standard_Boolean runPathtrace (const Standard_Integer theSizeX, |
995 | const Standard_Integer theSizeY, | |
996 | Graphic3d_Camera::Projection theProjection, | |
4eaaf9d8 | 997 | const Handle(OpenGl_Context)& theGlContext); |
3a9b5dc8 | 998 | |
66d1cdc6 | 999 | //! Runs path tracing (global illumination) kernel. |
1000 | Standard_Boolean runPathtraceOut (Graphic3d_Camera::Projection theProjection, | |
1001 | OpenGl_FrameBuffer* theReadDrawFbo, | |
1002 | const Handle(OpenGl_Context)& theGlContext); | |
1003 | ||
3a9b5dc8 | 1004 | //! Redraws the window using OpenGL/GLSL ray-tracing or path tracing. |
c357e426 | 1005 | Standard_Boolean raytrace (const Standard_Integer theSizeX, |
91c60b57 | 1006 | const Standard_Integer theSizeY, |
bf02aa7d | 1007 | Graphic3d_Camera::Projection theProjection, |
38a0206f | 1008 | OpenGl_FrameBuffer* theReadDrawFbo, |
91c60b57 | 1009 | const Handle(OpenGl_Context)& theGlContext); |
1010 | ||
1011 | protected: //! @name fields related to ray-tracing | |
1012 | ||
3a9b5dc8 | 1013 | //! Result of RT/PT shaders initialization. |
91c60b57 | 1014 | RaytraceInitStatus myRaytraceInitStatus; |
1015 | ||
3a9b5dc8 | 1016 | //! Is ray-tracing geometry data valid? |
91c60b57 | 1017 | Standard_Boolean myIsRaytraceDataValid; |
1018 | ||
3a9b5dc8 | 1019 | //! True if warning about missing extension GL_ARB_bindless_texture has been displayed. |
91c60b57 | 1020 | Standard_Boolean myIsRaytraceWarnTextures; |
1021 | ||
1022 | //! 3D scene geometry data for ray-tracing. | |
1023 | OpenGl_RaytraceGeometry myRaytraceGeometry; | |
1024 | ||
f5b72419 | 1025 | //! Builder for triangle set. |
1026 | opencascade::handle<BVH_Builder<Standard_ShortReal, 3> > myRaytraceBVHBuilder; | |
1027 | ||
91c60b57 | 1028 | //! Compile-time ray-tracing parameters. |
1029 | RaytracingParams myRaytraceParameters; | |
1030 | ||
1031 | //! Radius of bounding sphere of the scene. | |
1032 | Standard_ShortReal myRaytraceSceneRadius; | |
1033 | //! Scene epsilon to prevent self-intersections. | |
1034 | Standard_ShortReal myRaytraceSceneEpsilon; | |
1035 | ||
1036 | //! OpenGL/GLSL source of ray-tracing fragment shader. | |
1037 | ShaderSource myRaytraceShaderSource; | |
1038 | //! OpenGL/GLSL source of adaptive-AA fragment shader. | |
1039 | ShaderSource myPostFSAAShaderSource; | |
3a9b5dc8 | 1040 | //! OpenGL/GLSL source of RT/PT display fragment shader. |
1041 | ShaderSource myOutImageShaderSource; | |
91c60b57 | 1042 | |
1043 | //! OpenGL/GLSL ray-tracing fragment shader. | |
1044 | Handle(OpenGl_ShaderObject) myRaytraceShader; | |
1045 | //! OpenGL/GLSL adaptive-AA fragment shader. | |
1046 | Handle(OpenGl_ShaderObject) myPostFSAAShader; | |
3a9b5dc8 | 1047 | //! OpenGL/GLSL ray-tracing display fragment shader. |
1048 | Handle(OpenGl_ShaderObject) myOutImageShader; | |
91c60b57 | 1049 | |
1050 | //! OpenGL/GLSL ray-tracing shader program. | |
1051 | Handle(OpenGl_ShaderProgram) myRaytraceProgram; | |
1052 | //! OpenGL/GLSL adaptive-AA shader program. | |
1053 | Handle(OpenGl_ShaderProgram) myPostFSAAProgram; | |
189f85a3 | 1054 | //! OpenGL/GLSL program for displaying texture. |
1055 | Handle(OpenGl_ShaderProgram) myOutImageProgram; | |
91c60b57 | 1056 | |
1057 | //! Texture buffer of data records of bottom-level BVH nodes. | |
1058 | Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture; | |
1059 | //! Texture buffer of minimum points of bottom-level BVH nodes. | |
1060 | Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture; | |
1061 | //! Texture buffer of maximum points of bottom-level BVH nodes. | |
1062 | Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture; | |
1063 | //! Texture buffer of transformations of high-level BVH nodes. | |
1064 | Handle(OpenGl_TextureBufferArb) mySceneTransformTexture; | |
1065 | ||
1066 | //! Texture buffer of vertex coords. | |
1067 | Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture; | |
1068 | //! Texture buffer of vertex normals. | |
1069 | Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture; | |
1070 | //! Texture buffer of vertex UV coords. | |
1071 | Handle(OpenGl_TextureBufferArb) myGeometryTexCrdTexture; | |
1072 | //! Texture buffer of triangle indices. | |
1073 | Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture; | |
1074 | ||
1075 | //! Texture buffer of material properties. | |
1076 | Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture; | |
1077 | //! Texture buffer of light source properties. | |
1078 | Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture; | |
1079 | ||
1080 | //! 1st framebuffer (FBO) to perform adaptive FSAA. | |
3a9b5dc8 | 1081 | //! Used in compatibility mode (no adaptive sampling). |
bf02aa7d | 1082 | Handle(OpenGl_FrameBuffer) myRaytraceFBO1[2]; |
91c60b57 | 1083 | //! 2nd framebuffer (FBO) to perform adaptive FSAA. |
3a9b5dc8 | 1084 | //! Used in compatibility mode (no adaptive sampling). |
bf02aa7d | 1085 | Handle(OpenGl_FrameBuffer) myRaytraceFBO2[2]; |
3a9b5dc8 | 1086 | |
1087 | //! Output textures (2 textures are used in stereo mode). | |
1088 | //! Used if adaptive screen sampling is activated. | |
1089 | Handle(OpenGl_Texture) myRaytraceOutputTexture[2]; | |
1090 | ||
b27ab03d | 1091 | //! Texture containing per-tile visual error estimation (2 textures are used in stereo mode). |
3a9b5dc8 | 1092 | //! Used if adaptive screen sampling is activated. |
b27ab03d | 1093 | Handle(OpenGl_Texture) myRaytraceVisualErrorTexture[2]; |
1094 | //! Texture containing offsets of sampled screen tiles (2 textures are used in stereo mode). | |
3a9b5dc8 | 1095 | //! Used if adaptive screen sampling is activated. |
b27ab03d | 1096 | Handle(OpenGl_Texture) myRaytraceTileOffsetsTexture[2]; |
e084dbbc | 1097 | //! Texture containing amount of extra per-tile samples (2 textures are used in stereo mode). |
1098 | //! Used if adaptive screen sampling is activated. | |
1099 | Handle(OpenGl_Texture) myRaytraceTileSamplesTexture[2]; | |
91c60b57 | 1100 | |
1101 | //! Vertex buffer (VBO) for drawing dummy quad. | |
1102 | OpenGl_VertexBuffer myRaytraceScreenQuad; | |
1103 | ||
1104 | //! Cached locations of frequently used uniform variables. | |
1105 | Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables]; | |
1106 | ||
1107 | //! State of OpenGL structures reflected to ray-tracing. | |
d4aaad5b | 1108 | std::map<const OpenGl_Structure*, StructState> myStructureStates; |
91c60b57 | 1109 | |
1110 | //! PrimitiveArray to TriangleSet map for scene partial update. | |
1111 | std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap; | |
1112 | ||
189f85a3 | 1113 | //! Set of IDs of non-raytracable elements (to detect updates). |
1114 | std::set<Standard_Integer> myNonRaytraceStructureIDs; | |
1115 | ||
91c60b57 | 1116 | //! Marks if environment map should be updated. |
1117 | Standard_Boolean myToUpdateEnvironmentMap; | |
1118 | ||
1119 | //! State of OpenGL layer list. | |
bd6a8454 | 1120 | Standard_Size myRaytraceLayerListState; |
189f85a3 | 1121 | |
1122 | //! Number of accumulated frames (for progressive rendering). | |
1123 | Standard_Integer myAccumFrames; | |
1124 | ||
1125 | //! Stored ray origins used for detection of camera movements. | |
1126 | OpenGl_Vec3 myPreviousOrigins[3]; | |
1127 | ||
1128 | //! Bullard RNG to produce random sequence. | |
1129 | math_BullardGenerator myRNG; | |
91c60b57 | 1130 | |
3a9b5dc8 | 1131 | //! Tool object for sampling screen tiles in PT mode. |
1132 | OpenGl_TileSampler myTileSampler; | |
1133 | ||
b27ab03d | 1134 | //! Camera position used for projective mode |
1135 | OpenGl_Vec3 myEyeOrig; | |
1136 | ||
1137 | //! Camera view direction used for projective mode | |
1138 | OpenGl_Vec3 myEyeView; | |
1139 | ||
1140 | //! Camera's screen vertical direction used for projective mode | |
1141 | OpenGl_Vec3 myEyeVert; | |
1142 | ||
1143 | //! Camera's screen horizontal direction used for projective mode | |
1144 | OpenGl_Vec3 myEyeSide; | |
1145 | ||
1146 | //! Camera's screen size used for projective mode | |
1147 | OpenGl_Vec2 myEyeSize; | |
1148 | ||
1149 | //! Aperture radius of camera on previous frame used for depth-of-field (path tracing) | |
1150 | float myPrevCameraApertureRadius; | |
1151 | ||
1152 | //! Focal distance of camera on previous frame used for depth-of-field (path tracing) | |
1153 | float myPrevCameraFocalPlaneDist; | |
1154 | ||
679ecdee | 1155 | public: |
1156 | ||
1c35b92f | 1157 | DEFINE_STANDARD_ALLOC |
92efcf78 | 1158 | DEFINE_STANDARD_RTTIEXT(OpenGl_View,Graphic3d_CView) // Type definition |
679ecdee | 1159 | |
c357e426 | 1160 | friend class OpenGl_GraphicDriver; |
a89742cf | 1161 | friend class OpenGl_Workspace; |
a1073ae2 | 1162 | friend class OpenGl_LayerList; |
15669413 | 1163 | friend class OpenGl_FrameStats; |
2166f0fa SK |
1164 | }; |
1165 | ||
679ecdee | 1166 | #endif // _OpenGl_View_Header |