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