1 // Created on: 2011-09-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _OpenGl_View_Header
17 #define _OpenGl_View_Header
19 #include <Standard_Transient.hxx>
20 #include <Standard_Type.hxx>
22 #include <TColStd_Array2OfReal.hxx>
23 #include <NCollection_List.hxx>
24 #include <math_BullardGenerator.hxx>
26 #include <Quantity_NameOfColor.hxx>
27 #include <Aspect_FillMethod.hxx>
28 #include <Aspect_GradientFillMethod.hxx>
30 #include <Graphic3d_CView.hxx>
31 #include <Graphic3d_GraduatedTrihedron.hxx>
32 #include <Graphic3d_SequenceOfHClipPlane.hxx>
33 #include <Graphic3d_ToneMappingMethod.hxx>
34 #include <Graphic3d_TypeOfShadingModel.hxx>
35 #include <Graphic3d_WorldViewProjState.hxx>
36 #include <Graphic3d_ZLayerSettings.hxx>
38 #include <OpenGl_AspectFace.hxx>
39 #include <OpenGl_BackgroundArray.hxx>
40 #include <OpenGl_BVHTreeSelector.hxx>
41 #include <OpenGl_Context.hxx>
42 #include <OpenGl_FrameBuffer.hxx>
43 #include <OpenGl_FrameStatsPrs.hxx>
44 #include <OpenGl_GraduatedTrihedron.hxx>
45 #include <OpenGl_LayerList.hxx>
46 #include <OpenGl_LineAttributes.hxx>
47 #include <OpenGl_SceneGeometry.hxx>
48 #include <OpenGl_Structure.hxx>
49 #include <OpenGl_Window.hxx>
50 #include <OpenGl_Workspace.hxx>
51 #include <OpenGl_TileSampler.hxx>
58 class Graphic3d_StructureManager;
59 class OpenGl_GraphicDriver;
60 class OpenGl_StateCounter;
61 class OpenGl_RaytraceMaterial;
62 class OpenGl_TriangleSet;
63 class OpenGl_Workspace;
65 DEFINE_STANDARD_HANDLE(OpenGl_View,Graphic3d_CView)
67 //! Implementation of OpenGl view.
68 class OpenGl_View : public Graphic3d_CView
74 Standard_EXPORT OpenGl_View (const Handle(Graphic3d_StructureManager)& theMgr,
75 const Handle(OpenGl_GraphicDriver)& theDriver,
76 const Handle(OpenGl_Caps)& theCaps,
77 OpenGl_StateCounter* theCounter);
79 //! Default destructor.
80 Standard_EXPORT virtual ~OpenGl_View();
82 Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theCtx);
84 //! Deletes and erases the view.
85 Standard_EXPORT virtual void Remove() Standard_OVERRIDE;
87 //! @param theDrawToFrontBuffer Advanced option to modify rendering mode:
88 //! 1. TRUE. Drawing immediate mode structures directly to the front buffer over the scene image.
89 //! Fast, so preferred for interactive work (used by default).
90 //! However these extra drawings will be missed in image dump since it is performed from back buffer.
91 //! Notice that since no pre-buffering used the V-Sync will be ignored and rendering could be seen
92 //! in run-time (in case of slow hardware) and/or tearing may appear.
93 //! So this is strongly recommended to draw only simple (fast) structures.
94 //! 2. FALSE. Drawing immediate mode structures to the back buffer.
95 //! The complete scene is redrawn first, so this mode is slower if scene contains complex data and/or V-Sync
96 //! is turned on. But it works in any case and is especially useful for view dump because the dump image is read
97 //! from the back buffer.
98 //! @return previous mode.
99 Standard_EXPORT Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer) Standard_OVERRIDE;
101 //! Creates and maps rendering window to the view.
102 //! @param theWindow [in] the window.
103 //! @param theContext [in] the rendering context. If NULL the context will be created internally.
104 Standard_EXPORT virtual void SetWindow (const Handle(Aspect_Window)& theWindow,
105 const Aspect_RenderingContext theContext) Standard_OVERRIDE;
107 //! Returns window associated with the view.
108 virtual Handle(Aspect_Window) Window() const Standard_OVERRIDE
109 { return myWindow->PlatformWindow(); }
111 //! Returns True if the window associated to the view is defined.
112 virtual Standard_Boolean IsDefined() const Standard_OVERRIDE
113 { return !myWindow.IsNull(); }
115 //! Handle changing size of the rendering window.
116 Standard_EXPORT virtual void Resized() Standard_OVERRIDE;
118 //! Redraw content of the view.
119 Standard_EXPORT virtual void Redraw() Standard_OVERRIDE;
121 //! Redraw immediate content of the view.
122 Standard_EXPORT virtual void RedrawImmediate() Standard_OVERRIDE;
124 //! Marks BVH tree for given priority list as dirty and marks primitive set for rebuild.
125 Standard_EXPORT virtual void Invalidate() Standard_OVERRIDE;
127 //! Return true if view content cache has been invalidated.
128 virtual Standard_Boolean IsInvalidated() Standard_OVERRIDE { return !myBackBufferRestored; }
130 //! Returns data of a graduated trihedron
131 const Graphic3d_GraduatedTrihedron& GetGraduatedTrihedron() Standard_OVERRIDE
132 { return myGTrihedronData; }
134 //! Displays Graduated Trihedron.
135 Standard_EXPORT virtual void GraduatedTrihedronDisplay (const Graphic3d_GraduatedTrihedron& theTrihedronData) Standard_OVERRIDE;
137 //! Erases Graduated Trihedron.
138 Standard_EXPORT virtual void GraduatedTrihedronErase() Standard_OVERRIDE;
140 //! Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object.
141 //! @param theMin [in] the minimum point of scene.
142 //! @param theMax [in] the maximum point of scene.
143 Standard_EXPORT virtual void GraduatedTrihedronMinMaxValues (const Graphic3d_Vec3 theMin, const Graphic3d_Vec3 theMax) Standard_OVERRIDE;
145 //! Dump active rendering buffer into specified memory buffer.
146 //! In Ray-Tracing allow to get a raw HDR buffer using Graphic3d_BT_RGB_RayTraceHdrLeft buffer type,
147 //! only Left view will be dumped ignoring stereoscopic parameter.
148 Standard_EXPORT virtual Standard_Boolean BufferDump (Image_PixMap& theImage,
149 const Graphic3d_BufferType& theBufferType) Standard_OVERRIDE;
151 //! Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated.
152 Standard_EXPORT virtual void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
154 //! Insert a new top-level z layer with the given ID.
155 Standard_EXPORT virtual void AddZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
157 //! Remove a z layer with the given ID.
158 Standard_EXPORT virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
160 //! Sets the settings for a single Z layer of specified view.
161 Standard_EXPORT virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId,
162 const Graphic3d_ZLayerSettings& theSettings) Standard_OVERRIDE;
164 //! Returns the maximum Z layer ID.
165 //! First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax().
166 Standard_EXPORT virtual Standard_Integer ZLayerMax() const Standard_OVERRIDE;
168 //! Returns the bounding box of all structures displayed in the Z layer.
169 //! Never fails. If Z layer does not exist nothing happens.
170 Standard_EXPORT virtual void InvalidateZLayerBoundingBox (const Graphic3d_ZLayerId theLayerId) const Standard_OVERRIDE;
172 //! Returns the bounding box of all structures displayed in the Z layer.
173 //! If Z layer does not exist the empty box is returned.
174 //! @param theLayerId layer identifier
175 //! @param theCamera camera definition
176 //! @param theWindowWidth viewport width (for applying transformation-persistence)
177 //! @param theWindowHeight viewport height (for applying transformation-persistence)
178 //! @param theToIncludeAuxiliary consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence)
179 //! @return computed bounding box
180 Standard_EXPORT virtual Bnd_Box ZLayerBoundingBox (const Graphic3d_ZLayerId theLayerId,
181 const Handle(Graphic3d_Camera)& theCamera,
182 const Standard_Integer theWindowWidth,
183 const Standard_Integer theWindowHeight,
184 const Standard_Boolean theToIncludeAuxiliary) const Standard_OVERRIDE;
186 //! Returns pointer to an assigned framebuffer object.
187 Standard_EXPORT virtual Handle(Standard_Transient) FBO() const Standard_OVERRIDE;
189 //! Sets framebuffer object for offscreen rendering.
190 Standard_EXPORT virtual void SetFBO (const Handle(Standard_Transient)& theFbo) Standard_OVERRIDE;
192 //! Generate offscreen FBO in the graphic library.
193 //! If not supported on hardware returns NULL.
194 Standard_EXPORT virtual Handle(Standard_Transient) FBOCreate (const Standard_Integer theWidth,
195 const Standard_Integer theHeight) Standard_OVERRIDE;
197 //! Remove offscreen FBO from the graphic library
198 Standard_EXPORT virtual void FBORelease (Handle(Standard_Transient)& theFbo) Standard_OVERRIDE;
200 //! Read offscreen FBO configuration.
201 Standard_EXPORT virtual void FBOGetDimensions (const Handle(Standard_Transient)& theFbo,
202 Standard_Integer& theWidth,
203 Standard_Integer& theHeight,
204 Standard_Integer& theWidthMax,
205 Standard_Integer& theHeightMax) Standard_OVERRIDE;
207 //! Change offscreen FBO viewport.
208 Standard_EXPORT virtual void FBOChangeViewport (const Handle(Standard_Transient)& theFbo,
209 const Standard_Integer theWidth,
210 const Standard_Integer theHeight) Standard_OVERRIDE;
214 //! Returns background fill color.
215 Standard_EXPORT virtual Aspect_Background Background() const Standard_OVERRIDE;
217 //! Sets background fill color.
218 Standard_EXPORT virtual void SetBackground (const Aspect_Background& theBackground) Standard_OVERRIDE;
220 //! Returns gradient background fill colors.
221 Standard_EXPORT virtual Aspect_GradientBackground GradientBackground() const Standard_OVERRIDE;
223 //! Sets gradient background fill colors.
224 Standard_EXPORT virtual void SetGradientBackground (const Aspect_GradientBackground& theBackground) Standard_OVERRIDE;
226 //! Returns background image texture file path.
227 virtual TCollection_AsciiString BackgroundImage() Standard_OVERRIDE { return myBackgroundImagePath; }
229 //! Sets background image texture file path.
230 Standard_EXPORT virtual void SetBackgroundImage (const TCollection_AsciiString& theFilePath) Standard_OVERRIDE;
232 //! Returns background image fill style.
233 Standard_EXPORT virtual Aspect_FillMethod BackgroundImageStyle() const Standard_OVERRIDE;
235 //! Sets background image fill style.
236 Standard_EXPORT virtual void SetBackgroundImageStyle (const Aspect_FillMethod theFillStyle) Standard_OVERRIDE;
238 //! Returns environment texture set for the view.
239 virtual Handle(Graphic3d_TextureEnv) TextureEnv() const Standard_OVERRIDE { return myTextureEnvData; }
241 //! Sets environment texture for the view.
242 Standard_EXPORT virtual void SetTextureEnv (const Handle(Graphic3d_TextureEnv)& theTextureEnv) Standard_OVERRIDE;
244 //! Returns the state of frustum culling optimization.
245 virtual Standard_Boolean IsCullingEnabled() const Standard_OVERRIDE { return myCulling; }
247 //! Enables or disables frustum culling optimization.
248 virtual void SetCullingEnabled (const Standard_Boolean theIsEnabled) Standard_OVERRIDE { myCulling = theIsEnabled; }
250 //! Return backfacing model used for the view.
251 virtual Graphic3d_TypeOfBackfacingModel BackfacingModel() const Standard_OVERRIDE { return myBackfacing; }
253 //! Sets backfacing model for the view.
254 virtual void SetBackfacingModel (const Graphic3d_TypeOfBackfacingModel theModel) Standard_OVERRIDE { myBackfacing = theModel; }
256 //! Returns camera object of the view.
257 virtual const Handle(Graphic3d_Camera)& Camera() const Standard_OVERRIDE { return myCamera; }
259 //! Returns local camera origin currently set for rendering, might be modified during rendering.
260 const gp_XYZ& LocalOrigin() const { return myLocalOrigin; }
262 //! Setup local camera origin currently set for rendering.
263 Standard_EXPORT void SetLocalOrigin (const gp_XYZ& theOrigin);
265 //! Sets camera used by the view.
266 Standard_EXPORT virtual void SetCamera (const Handle(Graphic3d_Camera)& theCamera) Standard_OVERRIDE;
268 //! Returns list of lights of the view.
269 virtual const Handle(Graphic3d_LightSet)& Lights() const Standard_OVERRIDE { return myLights; }
271 //! Sets list of lights for the view.
272 virtual void SetLights (const Handle(Graphic3d_LightSet)& theLights) Standard_OVERRIDE
274 myLights = theLights;
275 myCurrLightSourceState = myStateCounter->Increment();
278 //! Returns list of clip planes set for the view.
279 virtual const Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const Standard_OVERRIDE { return myClipPlanes; }
281 //! Sets list of clip planes for the view.
282 virtual void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes) Standard_OVERRIDE { myClipPlanes = thePlanes; }
284 //! Fill in the dictionary with diagnostic info.
285 //! Should be called within rendering thread.
287 //! This API should be used only for user output or for creating automated reports.
288 //! The format of returned information (e.g. key-value layout)
289 //! is NOT part of this API and can be changed at any time.
290 //! Thus application should not parse returned information to weed out specific parameters.
291 Standard_EXPORT virtual void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict,
292 Graphic3d_DiagnosticInfo theFlags) const Standard_OVERRIDE;
296 //! Returns background color.
297 const Quantity_ColorRGBA& BackgroundColor() const { return myBgColor; }
299 //! Change graduated trihedron.
300 OpenGl_GraduatedTrihedron& ChangeGraduatedTrihedron() { return myGraduatedTrihedron; }
302 void SetTextureEnv (const Handle(OpenGl_Context)& theCtx,
303 const Handle(Graphic3d_TextureEnv)& theTexture);
305 void SetBackgroundTextureStyle (const Aspect_FillMethod FillStyle);
307 void SetBackgroundGradient (const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AType);
309 void SetBackgroundGradientType (const Aspect_GradientFillMethod AType);
311 //! Returns list of OpenGL Z-layers.
312 const OpenGl_LayerList& LayerList() const { return myZLayers; }
314 //! Returns OpenGL window implementation.
315 const Handle(OpenGl_Window) GlWindow() const { return myWindow; }
317 //! Returns OpenGL environment map.
318 const Handle(OpenGl_TextureSet)& GlTextureEnv() const { return myTextureEnv; }
320 //! Returns selector for BVH tree, providing a possibility to store information
321 //! about current view volume and to detect which objects are overlapping it.
322 const OpenGl_BVHTreeSelector& BVHTreeSelector() const { return myBVHSelector; }
324 //! Returns true if there are immediate structures to display
325 bool HasImmediateStructures() const
327 return myZLayers.NbImmediateStructures() != 0;
330 protected: //! @name Internal methods for managing GL resources
332 //! Initializes OpenGl resource for environment texture.
333 void initTextureEnv (const Handle(OpenGl_Context)& theContext);
335 protected: //! @name low-level redrawing sub-routines
337 //! Redraws view for the given monographic camera projection, or left/right eye.
338 Standard_EXPORT virtual void redraw (const Graphic3d_Camera::Projection theProjection,
339 OpenGl_FrameBuffer* theReadDrawFbo,
340 OpenGl_FrameBuffer* theOitAccumFbo);
342 //! Redraws view for the given monographic camera projection, or left/right eye.
344 //! Method will blit snapshot containing main scene (myMainSceneFbos or BackBuffer)
345 //! into presentation buffer (myMainSceneFbos -> offscreen FBO or
346 //! myMainSceneFbos -> BackBuffer or BackBuffer -> FrontBuffer),
347 //! and redraw immediate structures on top.
349 //! When scene caching is disabled (myTransientDrawToFront, no double buffer in window, etc.),
350 //! the first step (blitting) will be skipped.
352 //! @return false if immediate structures has been rendered directly into FrontBuffer
353 //! and Buffer Swap should not be called.
354 Standard_EXPORT virtual bool redrawImmediate (const Graphic3d_Camera::Projection theProjection,
355 OpenGl_FrameBuffer* theReadFbo,
356 OpenGl_FrameBuffer* theDrawFbo,
357 OpenGl_FrameBuffer* theOitAccumFbo,
358 const Standard_Boolean theIsPartialUpdate = Standard_False);
360 //! Blit image from/to specified buffers.
361 Standard_EXPORT bool blitBuffers (OpenGl_FrameBuffer* theReadFbo,
362 OpenGl_FrameBuffer* theDrawFbo,
363 const Standard_Boolean theToFlip = Standard_False);
365 //! Setup default FBO.
366 Standard_EXPORT void bindDefaultFbo (OpenGl_FrameBuffer* theCustomFbo = NULL);
368 protected: //! @name Rendering of GL graphics (with prepared drawing buffer).
370 //! Renders the graphical contents of the view into the preprepared window or framebuffer.
371 //! @param theProjection [in] the projection that should be used for rendering.
372 //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
373 //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
374 //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
375 Standard_EXPORT virtual void render (Graphic3d_Camera::Projection theProjection,
376 OpenGl_FrameBuffer* theReadDrawFbo,
377 OpenGl_FrameBuffer* theOitAccumFbo,
378 const Standard_Boolean theToDrawImmediate);
380 //! Renders the graphical scene.
381 //! @param theProjection [in] the projection that is used for rendering.
382 //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
383 //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
384 //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
385 Standard_EXPORT virtual void renderScene (Graphic3d_Camera::Projection theProjection,
386 OpenGl_FrameBuffer* theReadDrawFbo,
387 OpenGl_FrameBuffer* theOitAccumFbo,
388 const Standard_Boolean theToDrawImmediate);
390 //! Draw background (gradient / image)
391 Standard_EXPORT virtual void drawBackground (const Handle(OpenGl_Workspace)& theWorkspace);
393 //! Render set of structures presented in the view.
394 //! @param theProjection [in] the projection that is used for rendering.
395 //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
396 //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
397 //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
398 Standard_EXPORT virtual void renderStructs (Graphic3d_Camera::Projection theProjection,
399 OpenGl_FrameBuffer* theReadDrawFbo,
400 OpenGl_FrameBuffer* theOitAccumFbo,
401 const Standard_Boolean theToDrawImmediate);
403 //! Renders trihedron.
404 void renderTrihedron (const Handle(OpenGl_Workspace) &theWorkspace);
406 //! Renders frame statistics.
407 void renderFrameStats();
411 //! Adds the structure to display lists of the view.
412 Standard_EXPORT virtual void displayStructure (const Handle(Graphic3d_CStructure)& theStructure,
413 const Standard_Integer thePriority) Standard_OVERRIDE;
415 //! Erases the structure from display lists of the view.
416 Standard_EXPORT virtual void eraseStructure (const Handle(Graphic3d_CStructure)& theStructure) Standard_OVERRIDE;
418 //! Change Z layer of a structure already presented in view.
419 Standard_EXPORT virtual void changeZLayer (const Handle(Graphic3d_CStructure)& theCStructure,
420 const Graphic3d_ZLayerId theNewLayerId) Standard_OVERRIDE;
422 //! Changes the priority of a structure within its Z layer in the specified view.
423 Standard_EXPORT virtual void changePriority (const Handle(Graphic3d_CStructure)& theCStructure,
424 const Standard_Integer theNewPriority) Standard_OVERRIDE;
426 //! Returns zoom-scale factor.
427 Standard_EXPORT virtual Standard_Real considerZoomPersistenceObjects (const Graphic3d_ZLayerId theLayerId,
428 const Handle(Graphic3d_Camera)& theCamera,
429 const Standard_Integer theWindowWidth,
430 const Standard_Integer theWindowHeight) const Standard_OVERRIDE;
434 //! Copy content of Back buffer to the Front buffer.
435 bool copyBackToFront();
437 //! Initialize blit quad.
438 OpenGl_VertexBuffer* initBlitQuad (const Standard_Boolean theToFlip);
440 //! Blend together views pair into stereo image.
441 void drawStereoPair (OpenGl_FrameBuffer* theDrawFbo);
443 //! Check and update OIT compatibility with current OpenGL context's state.
444 bool checkOitCompatibility (const Handle(OpenGl_Context)& theGlContext,
445 const Standard_Boolean theMSAA);
447 //! Chooses compatible internal color format for OIT frame buffer.
448 bool chooseOitColorConfiguration (const Handle(OpenGl_Context)& theGlContext,
449 const Standard_Integer theConfigIndex,
450 OpenGl_ColorFormats& theFormats);
454 OpenGl_GraphicDriver* myDriver;
455 Handle(OpenGl_Window) myWindow;
456 Handle(OpenGl_Workspace) myWorkspace;
457 Handle(OpenGl_Caps) myCaps;
458 Standard_Boolean myWasRedrawnGL;
460 Standard_Boolean myCulling;
461 Graphic3d_TypeOfBackfacingModel myBackfacing;
462 Quantity_ColorRGBA myBgColor;
463 Handle(Graphic3d_SequenceOfHClipPlane) myClipPlanes;
464 Handle(Graphic3d_Camera) myCamera;
465 gp_XYZ myLocalOrigin;
466 Handle(OpenGl_FrameBuffer) myFBO;
467 Standard_Boolean myToShowGradTrihedron;
468 TCollection_AsciiString myBackgroundImagePath;
469 Handle(Graphic3d_TextureEnv) myTextureEnvData;
470 Graphic3d_GraduatedTrihedron myGTrihedronData;
472 Handle(Graphic3d_LightSet) myNoShadingLight;
473 Handle(Graphic3d_LightSet) myLights;
474 OpenGl_LayerList myZLayers; //!< main list of displayed structure, sorted by layers
476 Graphic3d_WorldViewProjState myWorldViewProjState; //!< camera modification state
477 OpenGl_StateCounter* myStateCounter;
478 Standard_Size myCurrLightSourceState;
479 Standard_Size myLightsRevision;
481 typedef std::pair<Standard_Size, Standard_Size> StateInfo;
483 StateInfo myLastOrientationState;
484 StateInfo myLastViewMappingState;
485 StateInfo myLastLightSourceState;
487 //! Is needed for selection of overlapping objects and storage of the current view volume
488 OpenGl_BVHTreeSelector myBVHSelector;
490 OpenGl_GraduatedTrihedron myGraduatedTrihedron;
491 OpenGl_FrameStatsPrs myFrameStatsPrs;
493 Handle(OpenGl_TextureSet) myTextureEnv;
495 //! Framebuffers for OpenGL output.
496 Handle(OpenGl_FrameBuffer) myOpenGlFBO;
497 Handle(OpenGl_FrameBuffer) myOpenGlFBO2;
499 protected: //! @name Rendering properties
501 //! Two framebuffers (left and right views) store cached main presentation
502 //! of the view (without presentation of immediate layers).
503 GLint myFboColorFormat; //!< sized format for color attachments
504 GLint myFboDepthFormat; //!< sized format for depth-stencil attachments
505 OpenGl_ColorFormats myFboOitColorConfig; //!< selected color format configuration for OIT color attachments
506 Handle(OpenGl_FrameBuffer) myMainSceneFbos[2];
507 Handle(OpenGl_FrameBuffer) myMainSceneFbosOit[2]; //!< Additional buffers for transparent draw of main layer.
508 Handle(OpenGl_FrameBuffer) myImmediateSceneFbos[2]; //!< Additional buffers for immediate layer in stereo mode.
509 Handle(OpenGl_FrameBuffer) myImmediateSceneFbosOit[2]; //!< Additional buffers for transparency draw of immediate layer.
510 OpenGl_VertexBuffer myFullScreenQuad; //!< Vertices for full-screen quad rendering.
511 OpenGl_VertexBuffer myFullScreenQuadFlip;
512 Standard_Boolean myToFlipOutput; //!< Flag to draw result image upside-down
513 unsigned int myFrameCounter; //!< redraw counter, for debugging
514 Standard_Boolean myHasFboBlit; //!< disable FBOs on failure
515 Standard_Boolean myToDisableOIT; //!< disable OIT on failure
516 Standard_Boolean myToDisableOITMSAA; //!< disable OIT with MSAA on failure
517 Standard_Boolean myToDisableMSAA; //!< disable MSAA after failure
518 Standard_Boolean myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
519 Standard_Boolean myBackBufferRestored;
520 Standard_Boolean myIsImmediateDrawn; //!< flag indicates that immediate mode buffer contains some data
522 protected: //! @name Background parameters
524 OpenGl_AspectFace* myTextureParams; //!< Stores texture and its parameters for textured background
525 OpenGl_BackgroundArray* myBgGradientArray; //!< Primitive array for gradient background
526 OpenGl_BackgroundArray* myBgTextureArray; //!< Primitive array for texture background
528 protected: //! @name data types related to ray-tracing
530 //! Result of OpenGL shaders initialization.
531 enum RaytraceInitStatus
538 //! Describes update mode (state).
539 enum RaytraceUpdateMode
541 OpenGl_GUM_CHECK, //!< check geometry state
542 OpenGl_GUM_PREPARE, //!< collect unchanged objects
543 OpenGl_GUM_REBUILD //!< rebuild changed and new objects
546 //! Defines frequently used shader variables.
547 enum ShaderVariableIndex
560 OpenGl_RT_uViewPrMat,
561 OpenGl_RT_uUnviewMat,
566 OpenGl_RT_uLightAmbnt,
567 OpenGl_RT_uLightCount,
570 OpenGl_RT_uBackColorTop,
571 OpenGl_RT_uBackColorBot,
573 // ray-tracing params
574 OpenGl_RT_uShadowsEnabled,
575 OpenGl_RT_uReflectEnabled,
576 OpenGl_RT_uSphereMapEnabled,
577 OpenGl_RT_uSphereMapForBack,
578 OpenGl_RT_uTexSamplersArray,
579 OpenGl_RT_uBlockedRngEnabled,
581 // size of render window
585 // sampled frame params
586 OpenGl_RT_uAccumSamples,
587 OpenGl_RT_uFrameRndSeed,
589 // adaptive FSAA params
594 // images used by ISS mode
595 OpenGl_RT_uRenderImage,
596 OpenGl_RT_uOffsetImage,
598 // maximum radiance value
599 OpenGl_RT_uMaxRadiance,
601 OpenGl_RT_NbVariables // special field
604 //! Defines OpenGL image samplers.
605 enum ShaderImageNames
607 OpenGl_RT_OutputImageLft = 0,
608 OpenGl_RT_OutputImageRgh = 1,
609 OpenGl_RT_VisualErrorImageLft = 2,
610 OpenGl_RT_VisualErrorImageRgh = 3,
611 OpenGl_RT_TileOffsetsImageLft = 4,
612 OpenGl_RT_TileOffsetsImageRgh = 5
615 //! Tool class for management of shader sources.
620 //! Default shader prefix - empty string.
621 static const TCollection_AsciiString EMPTY_PREFIX;
623 //! Creates new uninitialized shader source.
631 //! Returns error description in case of load fail.
632 const TCollection_AsciiString& ErrorDescription() const
637 //! Returns prefix to insert before the source.
638 const TCollection_AsciiString& Prefix() const
643 //! Sets prefix to insert before the source.
644 void SetPrefix (const TCollection_AsciiString& thePrefix)
646 myPrefix = thePrefix;
649 //! Returns shader source combined with prefix.
650 TCollection_AsciiString Source() const;
652 //! Loads shader source from specified files.
653 Standard_Boolean LoadFromFiles (const TCollection_AsciiString* theFileNames, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX);
655 //! Loads shader source from specified strings.
656 Standard_Boolean LoadFromStrings (const TCollection_AsciiString* theStrings, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX);
660 TCollection_AsciiString mySource; //!< Source string of the shader object
661 TCollection_AsciiString myPrefix; //!< Prefix to insert before the source
662 TCollection_AsciiString myError; //!< error state
666 //! Default ray-tracing depth.
667 static const Standard_Integer THE_DEFAULT_NB_BOUNCES = 3;
669 //! Default size of traversal stack.
670 static const Standard_Integer THE_DEFAULT_STACK_SIZE = 10;
672 //! Compile-time ray-tracing parameters.
673 struct RaytracingParams
675 //! Actual size of traversal stack in shader program.
676 Standard_Integer StackSize;
678 //! Actual ray-tracing depth (number of ray bounces).
679 Standard_Integer NbBounces;
681 //! Enables/disables light propagation through transparent media.
682 Standard_Boolean TransparentShadows;
684 //! Enables/disables global illumination (GI) effects.
685 Standard_Boolean GlobalIllumination;
687 //! Enables/disables the use of OpenGL bindless textures.
688 Standard_Boolean UseBindlessTextures;
690 //! Enables/disables two-sided BSDF models instead of one-sided.
691 Standard_Boolean TwoSidedBsdfModels;
693 //! Enables/disables adaptive screen sampling for path tracing.
694 Standard_Boolean AdaptiveScreenSampling;
696 //! Enables/disables environment map for background.
697 Standard_Boolean UseEnvMapForBackground;
699 //! Maximum radiance value used for clamping radiance estimation.
700 Standard_ShortReal RadianceClampingValue;
702 //! Number of tiles in X dimension (in adaptive sampling mode).
703 Standard_Integer NbTilesX;
705 //! Number of tiles in Y dimension (in adaptive sampling mode).
706 Standard_Integer NbTilesY;
708 //! Enables/disables depth-of-field effect (path tracing, perspective camera).
709 Standard_Boolean DepthOfField;
711 //! Tone mapping method for path tracing.
712 Graphic3d_ToneMappingMethod ToneMappingMethod;
714 //! Creates default compile-time ray-tracing parameters.
716 : StackSize (THE_DEFAULT_STACK_SIZE),
717 NbBounces (THE_DEFAULT_NB_BOUNCES),
718 TransparentShadows (Standard_False),
719 GlobalIllumination (Standard_False),
720 UseBindlessTextures (Standard_False),
721 TwoSidedBsdfModels (Standard_False),
722 AdaptiveScreenSampling (Standard_False),
723 UseEnvMapForBackground (Standard_False),
724 RadianceClampingValue (30.0),
727 DepthOfField (Standard_False),
728 ToneMappingMethod (Graphic3d_ToneMappingMethod_Disabled) { }
731 //! Describes state of OpenGL structure.
734 Standard_Size StructureState;
735 Standard_Size InstancedState;
737 //! Creates new structure state.
738 StructState (const Standard_Size theStructureState = 0,
739 const Standard_Size theInstancedState = 0)
740 : StructureState (theStructureState),
741 InstancedState (theInstancedState)
746 //! Creates new structure state.
747 StructState (const OpenGl_Structure* theStructure)
749 StructureState = theStructure->ModificationState();
751 InstancedState = theStructure->InstancedStructure() != NULL ?
752 theStructure->InstancedStructure()->ModificationState() : 0;
756 protected: //! @name methods related to ray-tracing
758 //! Updates 3D scene geometry for ray-tracing.
759 Standard_Boolean updateRaytraceGeometry (const RaytraceUpdateMode theMode,
760 const Standard_Integer theViewId,
761 const Handle(OpenGl_Context)& theGlContext);
763 //! Updates 3D scene light sources for ray-tracing.
764 Standard_Boolean updateRaytraceLightSources (const OpenGl_Mat4& theInvModelView, const Handle(OpenGl_Context)& theGlContext);
766 //! Checks to see if the OpenGL structure is modified.
767 Standard_Boolean toUpdateStructure (const OpenGl_Structure* theStructure);
769 //! Adds OpenGL structure to ray-traced scene geometry.
770 Standard_Boolean addRaytraceStructure (const OpenGl_Structure* theStructure,
771 const Handle(OpenGl_Context)& theGlContext);
773 //! Adds OpenGL groups to ray-traced scene geometry.
774 Standard_Boolean addRaytraceGroups (const OpenGl_Structure* theStructure,
775 const OpenGl_RaytraceMaterial& theStructMat,
776 const Handle(Geom_Transformation)& theTrsf,
777 const Handle(OpenGl_Context)& theGlContext);
779 //! Creates ray-tracing material properties.
780 OpenGl_RaytraceMaterial convertMaterial (const OpenGl_AspectFace* theAspect,
781 const Handle(OpenGl_Context)& theGlContext);
783 //! Adds OpenGL primitive array to ray-traced scene geometry.
784 Handle(OpenGl_TriangleSet) addRaytracePrimitiveArray (const OpenGl_PrimitiveArray* theArray,
785 const Standard_Integer theMatID,
786 const OpenGl_Mat4* theTrans);
788 //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
789 Standard_Boolean addRaytraceVertexIndices (OpenGl_TriangleSet& theSet,
790 const Standard_Integer theMatID,
791 const Standard_Integer theCount,
792 const Standard_Integer theOffset,
793 const OpenGl_PrimitiveArray& theArray);
795 //! Adds OpenGL triangle array to ray-traced scene geometry.
796 Standard_Boolean addRaytraceTriangleArray (OpenGl_TriangleSet& theSet,
797 const Standard_Integer theMatID,
798 const Standard_Integer theCount,
799 const Standard_Integer theOffset,
800 const Handle(Graphic3d_IndexBuffer)& theIndices);
802 //! Adds OpenGL triangle fan array to ray-traced scene geometry.
803 Standard_Boolean addRaytraceTriangleFanArray (OpenGl_TriangleSet& theSet,
804 const Standard_Integer theMatID,
805 const Standard_Integer theCount,
806 const Standard_Integer theOffset,
807 const Handle(Graphic3d_IndexBuffer)& theIndices);
809 //! Adds OpenGL triangle strip array to ray-traced scene geometry.
810 Standard_Boolean addRaytraceTriangleStripArray (OpenGl_TriangleSet& theSet,
811 const Standard_Integer theMatID,
812 const Standard_Integer theCount,
813 const Standard_Integer theOffset,
814 const Handle(Graphic3d_IndexBuffer)& theIndices);
816 //! Adds OpenGL quadrangle array to ray-traced scene geometry.
817 Standard_Boolean addRaytraceQuadrangleArray (OpenGl_TriangleSet& theSet,
818 const Standard_Integer theMatID,
819 const Standard_Integer theCount,
820 const Standard_Integer theOffset,
821 const Handle(Graphic3d_IndexBuffer)& theIndices);
823 //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
824 Standard_Boolean addRaytraceQuadrangleStripArray (OpenGl_TriangleSet& theSet,
825 const Standard_Integer theMatID,
826 const Standard_Integer theCount,
827 const Standard_Integer theOffset,
828 const Handle(Graphic3d_IndexBuffer)& theIndices);
830 //! Adds OpenGL polygon array to ray-traced scene geometry.
831 Standard_Boolean addRaytracePolygonArray (OpenGl_TriangleSet& theSet,
832 const Standard_Integer theMatID,
833 const Standard_Integer theCount,
834 const Standard_Integer theOffset,
835 const Handle(Graphic3d_IndexBuffer)& theIndices);
837 //! Uploads ray-trace data to the GPU.
838 Standard_Boolean uploadRaytraceData (const Handle(OpenGl_Context)& theGlContext);
840 //! Generates shader prefix based on current ray-tracing options.
841 TCollection_AsciiString generateShaderPrefix (const Handle(OpenGl_Context)& theGlContext) const;
843 //! Performs safe exit when shaders initialization fails.
844 Standard_Boolean safeFailBack (const TCollection_ExtendedString& theMessage,
845 const Handle(OpenGl_Context)& theGlContext);
847 //! Loads and compiles shader object from specified source.
848 Handle(OpenGl_ShaderObject) initShader (const GLenum theType,
849 const ShaderSource& theSource,
850 const Handle(OpenGl_Context)& theGlContext);
852 //! Creates shader program from the given vertex and fragment shaders.
853 Handle(OpenGl_ShaderProgram) initProgram (const Handle(OpenGl_Context)& theGlContext,
854 const Handle(OpenGl_ShaderObject)& theVertShader,
855 const Handle(OpenGl_ShaderObject)& theFragShader);
857 //! Initializes OpenGL/GLSL shader programs.
858 Standard_Boolean initRaytraceResources (const Handle(OpenGl_Context)& theGlContext);
860 //! Releases OpenGL/GLSL shader programs.
861 void releaseRaytraceResources (const Handle(OpenGl_Context)& theGlContext,
862 const Standard_Boolean theToRebuild = Standard_False);
864 //! Updates auxiliary OpenGL frame buffers.
865 Standard_Boolean updateRaytraceBuffers (const Standard_Integer theSizeX,
866 const Standard_Integer theSizeY,
867 const Handle(OpenGl_Context)& theGlContext);
869 //! Generates viewing rays for corners of screen quad.
870 //! (ray tracing; path tracing for orthographic camera)
871 void updateCamera (const OpenGl_Mat4& theOrientation,
872 const OpenGl_Mat4& theViewMapping,
873 OpenGl_Vec3* theOrigins,
874 OpenGl_Vec3* theDirects,
875 OpenGl_Mat4& theView,
876 OpenGl_Mat4& theUnView);
878 //! Generate viewing rays (path tracing, perspective camera).
879 void updatePerspCameraPT(const OpenGl_Mat4& theOrientation,
880 const OpenGl_Mat4& theViewMapping,
881 Graphic3d_Camera::Projection theProjection,
882 OpenGl_Mat4& theViewPr,
883 OpenGl_Mat4& theUnview,
884 const int theWinSizeX,
885 const int theWinSizeY);
887 //! Binds ray-trace textures to corresponding texture units.
888 void bindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext);
890 //! Unbinds ray-trace textures from corresponding texture unit.
891 void unbindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext);
893 //! Sets uniform state for the given ray-tracing shader program.
894 Standard_Boolean setUniformState (const Standard_Integer theProgramId,
895 const Standard_Integer theSizeX,
896 const Standard_Integer theSizeY,
897 Graphic3d_Camera::Projection theProjection,
898 const Handle(OpenGl_Context)& theGlContext);
900 //! Runs ray-tracing shader programs.
901 Standard_Boolean runRaytraceShaders (const Standard_Integer theSizeX,
902 const Standard_Integer theSizeY,
903 Graphic3d_Camera::Projection theProjection,
904 OpenGl_FrameBuffer* theReadDrawFbo,
905 const Handle(OpenGl_Context)& theGlContext);
907 //! Runs classical (Whitted-style) ray-tracing kernel.
908 Standard_Boolean runRaytrace (const Standard_Integer theSizeX,
909 const Standard_Integer theSizeY,
910 Graphic3d_Camera::Projection theProjection,
911 OpenGl_FrameBuffer* theReadDrawFbo,
912 const Handle(OpenGl_Context)& theGlContext);
914 //! Runs path tracing (global illumination) kernel.
915 Standard_Boolean runPathtrace (const Standard_Integer theSizeX,
916 const Standard_Integer theSizeY,
917 Graphic3d_Camera::Projection theProjection,
918 OpenGl_FrameBuffer* theReadDrawFbo,
919 const Handle(OpenGl_Context)& theGlContext);
921 //! Redraws the window using OpenGL/GLSL ray-tracing or path tracing.
922 Standard_Boolean raytrace (const Standard_Integer theSizeX,
923 const Standard_Integer theSizeY,
924 Graphic3d_Camera::Projection theProjection,
925 OpenGl_FrameBuffer* theReadDrawFbo,
926 const Handle(OpenGl_Context)& theGlContext);
928 protected: //! @name fields related to ray-tracing
930 //! Result of RT/PT shaders initialization.
931 RaytraceInitStatus myRaytraceInitStatus;
933 //! Is ray-tracing geometry data valid?
934 Standard_Boolean myIsRaytraceDataValid;
936 //! True if warning about missing extension GL_ARB_bindless_texture has been displayed.
937 Standard_Boolean myIsRaytraceWarnTextures;
939 //! 3D scene geometry data for ray-tracing.
940 OpenGl_RaytraceGeometry myRaytraceGeometry;
942 //! Builder for triangle set.
943 opencascade::handle<BVH_Builder<Standard_ShortReal, 3> > myRaytraceBVHBuilder;
945 //! Compile-time ray-tracing parameters.
946 RaytracingParams myRaytraceParameters;
948 //! Radius of bounding sphere of the scene.
949 Standard_ShortReal myRaytraceSceneRadius;
950 //! Scene epsilon to prevent self-intersections.
951 Standard_ShortReal myRaytraceSceneEpsilon;
953 //! OpenGL/GLSL source of ray-tracing fragment shader.
954 ShaderSource myRaytraceShaderSource;
955 //! OpenGL/GLSL source of adaptive-AA fragment shader.
956 ShaderSource myPostFSAAShaderSource;
957 //! OpenGL/GLSL source of RT/PT display fragment shader.
958 ShaderSource myOutImageShaderSource;
960 //! OpenGL/GLSL ray-tracing fragment shader.
961 Handle(OpenGl_ShaderObject) myRaytraceShader;
962 //! OpenGL/GLSL adaptive-AA fragment shader.
963 Handle(OpenGl_ShaderObject) myPostFSAAShader;
964 //! OpenGL/GLSL ray-tracing display fragment shader.
965 Handle(OpenGl_ShaderObject) myOutImageShader;
967 //! OpenGL/GLSL ray-tracing shader program.
968 Handle(OpenGl_ShaderProgram) myRaytraceProgram;
969 //! OpenGL/GLSL adaptive-AA shader program.
970 Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
971 //! OpenGL/GLSL program for displaying texture.
972 Handle(OpenGl_ShaderProgram) myOutImageProgram;
974 //! Texture buffer of data records of bottom-level BVH nodes.
975 Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
976 //! Texture buffer of minimum points of bottom-level BVH nodes.
977 Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
978 //! Texture buffer of maximum points of bottom-level BVH nodes.
979 Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
980 //! Texture buffer of transformations of high-level BVH nodes.
981 Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
983 //! Texture buffer of vertex coords.
984 Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture;
985 //! Texture buffer of vertex normals.
986 Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture;
987 //! Texture buffer of vertex UV coords.
988 Handle(OpenGl_TextureBufferArb) myGeometryTexCrdTexture;
989 //! Texture buffer of triangle indices.
990 Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
992 //! Texture buffer of material properties.
993 Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
994 //! Texture buffer of light source properties.
995 Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
997 //! 1st framebuffer (FBO) to perform adaptive FSAA.
998 //! Used in compatibility mode (no adaptive sampling).
999 Handle(OpenGl_FrameBuffer) myRaytraceFBO1[2];
1000 //! 2nd framebuffer (FBO) to perform adaptive FSAA.
1001 //! Used in compatibility mode (no adaptive sampling).
1002 Handle(OpenGl_FrameBuffer) myRaytraceFBO2[2];
1004 //! Output textures (2 textures are used in stereo mode).
1005 //! Used if adaptive screen sampling is activated.
1006 Handle(OpenGl_Texture) myRaytraceOutputTexture[2];
1008 //! Texture containing per-tile visual error estimation (2 textures are used in stereo mode).
1009 //! Used if adaptive screen sampling is activated.
1010 Handle(OpenGl_Texture) myRaytraceVisualErrorTexture[2];
1011 //! Texture containing offsets of sampled screen tiles (2 textures are used in stereo mode).
1012 //! Used if adaptive screen sampling is activated.
1013 Handle(OpenGl_Texture) myRaytraceTileOffsetsTexture[2];
1015 //! Vertex buffer (VBO) for drawing dummy quad.
1016 OpenGl_VertexBuffer myRaytraceScreenQuad;
1018 //! Cached locations of frequently used uniform variables.
1019 Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
1021 //! State of OpenGL structures reflected to ray-tracing.
1022 std::map<const OpenGl_Structure*, StructState> myStructureStates;
1024 //! PrimitiveArray to TriangleSet map for scene partial update.
1025 std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
1027 //! Set of IDs of non-raytracable elements (to detect updates).
1028 std::set<Standard_Integer> myNonRaytraceStructureIDs;
1030 //! Render filter to filter out all raytracable structures.
1031 Handle(OpenGl_RaytraceFilter) myRaytraceFilter;
1033 //! Marks if environment map should be updated.
1034 Standard_Boolean myToUpdateEnvironmentMap;
1036 //! State of OpenGL layer list.
1037 Standard_Size myRaytraceLayerListState;
1039 //! Number of accumulated frames (for progressive rendering).
1040 Standard_Integer myAccumFrames;
1042 //! Stored ray origins used for detection of camera movements.
1043 OpenGl_Vec3 myPreviousOrigins[3];
1045 //! Bullard RNG to produce random sequence.
1046 math_BullardGenerator myRNG;
1048 //! Tool object for sampling screen tiles in PT mode.
1049 OpenGl_TileSampler myTileSampler;
1051 //! Camera position used for projective mode
1052 OpenGl_Vec3 myEyeOrig;
1054 //! Camera view direction used for projective mode
1055 OpenGl_Vec3 myEyeView;
1057 //! Camera's screen vertical direction used for projective mode
1058 OpenGl_Vec3 myEyeVert;
1060 //! Camera's screen horizontal direction used for projective mode
1061 OpenGl_Vec3 myEyeSide;
1063 //! Camera's screen size used for projective mode
1064 OpenGl_Vec2 myEyeSize;
1066 //! Aperture radius of camera on previous frame used for depth-of-field (path tracing)
1067 float myPrevCameraApertureRadius;
1069 //! Focal distance of camera on previous frame used for depth-of-field (path tracing)
1070 float myPrevCameraFocalPlaneDist;
1074 DEFINE_STANDARD_ALLOC
1075 DEFINE_STANDARD_RTTIEXT(OpenGl_View,Graphic3d_CView) // Type definition
1077 friend class OpenGl_GraphicDriver;
1078 friend class OpenGl_Workspace;
1079 friend class OpenGl_LayerList;
1080 friend class OpenGl_FrameStats;
1083 #endif // _OpenGl_View_Header