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 //! Return backfacing model used for the view.
245 virtual Graphic3d_TypeOfBackfacingModel BackfacingModel() const Standard_OVERRIDE { return myBackfacing; }
247 //! Sets backfacing model for the view.
248 virtual void SetBackfacingModel (const Graphic3d_TypeOfBackfacingModel theModel) Standard_OVERRIDE { myBackfacing = theModel; }
250 //! Returns camera object of the view.
251 virtual const Handle(Graphic3d_Camera)& Camera() const Standard_OVERRIDE { return myCamera; }
253 //! Returns local camera origin currently set for rendering, might be modified during rendering.
254 const gp_XYZ& LocalOrigin() const { return myLocalOrigin; }
256 //! Setup local camera origin currently set for rendering.
257 Standard_EXPORT void SetLocalOrigin (const gp_XYZ& theOrigin);
259 //! Sets camera used by the view.
260 Standard_EXPORT virtual void SetCamera (const Handle(Graphic3d_Camera)& theCamera) Standard_OVERRIDE;
262 //! Returns list of lights of the view.
263 virtual const Handle(Graphic3d_LightSet)& Lights() const Standard_OVERRIDE { return myLights; }
265 //! Sets list of lights for the view.
266 virtual void SetLights (const Handle(Graphic3d_LightSet)& theLights) Standard_OVERRIDE
268 myLights = theLights;
269 myCurrLightSourceState = myStateCounter->Increment();
272 //! Returns list of clip planes set for the view.
273 virtual const Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const Standard_OVERRIDE { return myClipPlanes; }
275 //! Sets list of clip planes for the view.
276 virtual void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes) Standard_OVERRIDE { myClipPlanes = thePlanes; }
278 //! Fill in the dictionary with diagnostic info.
279 //! Should be called within rendering thread.
281 //! This API should be used only for user output or for creating automated reports.
282 //! The format of returned information (e.g. key-value layout)
283 //! is NOT part of this API and can be changed at any time.
284 //! Thus application should not parse returned information to weed out specific parameters.
285 Standard_EXPORT virtual void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict,
286 Graphic3d_DiagnosticInfo theFlags) const Standard_OVERRIDE;
290 //! Returns background color.
291 const Quantity_ColorRGBA& BackgroundColor() const { return myBgColor; }
293 //! Change graduated trihedron.
294 OpenGl_GraduatedTrihedron& ChangeGraduatedTrihedron() { return myGraduatedTrihedron; }
296 void SetTextureEnv (const Handle(OpenGl_Context)& theCtx,
297 const Handle(Graphic3d_TextureEnv)& theTexture);
299 void SetBackgroundTextureStyle (const Aspect_FillMethod FillStyle);
301 void SetBackgroundGradient (const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AType);
303 void SetBackgroundGradientType (const Aspect_GradientFillMethod AType);
305 //! Returns list of OpenGL Z-layers.
306 const OpenGl_LayerList& LayerList() const { return myZLayers; }
308 //! Returns OpenGL window implementation.
309 const Handle(OpenGl_Window)& GlWindow() const { return myWindow; }
311 //! Returns OpenGL environment map.
312 const Handle(OpenGl_TextureSet)& GlTextureEnv() const { return myTextureEnv; }
314 //! Returns selector for BVH tree, providing a possibility to store information
315 //! about current view volume and to detect which objects are overlapping it.
316 const OpenGl_BVHTreeSelector& BVHTreeSelector() const { return myBVHSelector; }
318 //! Returns true if there are immediate structures to display
319 bool HasImmediateStructures() const
321 return myZLayers.NbImmediateStructures() != 0;
324 protected: //! @name Internal methods for managing GL resources
326 //! Initializes OpenGl resource for environment texture.
327 void initTextureEnv (const Handle(OpenGl_Context)& theContext);
329 protected: //! @name low-level redrawing sub-routines
331 //! Redraws view for the given monographic camera projection, or left/right eye.
332 Standard_EXPORT virtual void redraw (const Graphic3d_Camera::Projection theProjection,
333 OpenGl_FrameBuffer* theReadDrawFbo,
334 OpenGl_FrameBuffer* theOitAccumFbo);
336 //! Redraws view for the given monographic camera projection, or left/right eye.
338 //! Method will blit snapshot containing main scene (myMainSceneFbos or BackBuffer)
339 //! into presentation buffer (myMainSceneFbos -> offscreen FBO or
340 //! myMainSceneFbos -> BackBuffer or BackBuffer -> FrontBuffer),
341 //! and redraw immediate structures on top.
343 //! When scene caching is disabled (myTransientDrawToFront, no double buffer in window, etc.),
344 //! the first step (blitting) will be skipped.
346 //! @return false if immediate structures has been rendered directly into FrontBuffer
347 //! and Buffer Swap should not be called.
348 Standard_EXPORT virtual bool redrawImmediate (const Graphic3d_Camera::Projection theProjection,
349 OpenGl_FrameBuffer* theReadFbo,
350 OpenGl_FrameBuffer* theDrawFbo,
351 OpenGl_FrameBuffer* theOitAccumFbo,
352 const Standard_Boolean theIsPartialUpdate = Standard_False);
354 //! Blit image from/to specified buffers.
355 Standard_EXPORT bool blitBuffers (OpenGl_FrameBuffer* theReadFbo,
356 OpenGl_FrameBuffer* theDrawFbo,
357 const Standard_Boolean theToFlip = Standard_False);
359 //! Setup default FBO.
360 Standard_EXPORT void bindDefaultFbo (OpenGl_FrameBuffer* theCustomFbo = NULL);
362 protected: //! @name Rendering of GL graphics (with prepared drawing buffer).
364 //! Renders the graphical contents of the view into the preprepared window or framebuffer.
365 //! @param theProjection [in] the projection that should be used for rendering.
366 //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
367 //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
368 //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
369 Standard_EXPORT virtual void render (Graphic3d_Camera::Projection theProjection,
370 OpenGl_FrameBuffer* theReadDrawFbo,
371 OpenGl_FrameBuffer* theOitAccumFbo,
372 const Standard_Boolean theToDrawImmediate);
374 //! Renders the graphical scene.
375 //! @param theProjection [in] the projection that is used for rendering.
376 //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
377 //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
378 //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
379 Standard_EXPORT virtual void renderScene (Graphic3d_Camera::Projection theProjection,
380 OpenGl_FrameBuffer* theReadDrawFbo,
381 OpenGl_FrameBuffer* theOitAccumFbo,
382 const Standard_Boolean theToDrawImmediate);
384 //! Draw background (gradient / image)
385 Standard_EXPORT virtual void drawBackground (const Handle(OpenGl_Workspace)& theWorkspace);
387 //! Render set of structures presented in the view.
388 //! @param theProjection [in] the projection that is used for rendering.
389 //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
390 //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
391 //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
392 Standard_EXPORT virtual void renderStructs (Graphic3d_Camera::Projection theProjection,
393 OpenGl_FrameBuffer* theReadDrawFbo,
394 OpenGl_FrameBuffer* theOitAccumFbo,
395 const Standard_Boolean theToDrawImmediate);
397 //! Renders trihedron.
398 void renderTrihedron (const Handle(OpenGl_Workspace) &theWorkspace);
400 //! Renders frame statistics.
401 void renderFrameStats();
405 //! Adds the structure to display lists of the view.
406 Standard_EXPORT virtual void displayStructure (const Handle(Graphic3d_CStructure)& theStructure,
407 const Standard_Integer thePriority) Standard_OVERRIDE;
409 //! Erases the structure from display lists of the view.
410 Standard_EXPORT virtual void eraseStructure (const Handle(Graphic3d_CStructure)& theStructure) Standard_OVERRIDE;
412 //! Change Z layer of a structure already presented in view.
413 Standard_EXPORT virtual void changeZLayer (const Handle(Graphic3d_CStructure)& theCStructure,
414 const Graphic3d_ZLayerId theNewLayerId) Standard_OVERRIDE;
416 //! Changes the priority of a structure within its Z layer in the specified view.
417 Standard_EXPORT virtual void changePriority (const Handle(Graphic3d_CStructure)& theCStructure,
418 const Standard_Integer theNewPriority) Standard_OVERRIDE;
420 //! Returns zoom-scale factor.
421 Standard_EXPORT virtual Standard_Real considerZoomPersistenceObjects (const Graphic3d_ZLayerId theLayerId,
422 const Handle(Graphic3d_Camera)& theCamera,
423 const Standard_Integer theWindowWidth,
424 const Standard_Integer theWindowHeight) const Standard_OVERRIDE;
428 //! Copy content of Back buffer to the Front buffer.
429 bool copyBackToFront();
431 //! Initialize blit quad.
432 OpenGl_VertexBuffer* initBlitQuad (const Standard_Boolean theToFlip);
434 //! Blend together views pair into stereo image.
435 void drawStereoPair (OpenGl_FrameBuffer* theDrawFbo);
437 //! Check and update OIT compatibility with current OpenGL context's state.
438 bool checkOitCompatibility (const Handle(OpenGl_Context)& theGlContext,
439 const Standard_Boolean theMSAA);
441 //! Chooses compatible internal color format for OIT frame buffer.
442 bool chooseOitColorConfiguration (const Handle(OpenGl_Context)& theGlContext,
443 const Standard_Integer theConfigIndex,
444 OpenGl_ColorFormats& theFormats);
448 OpenGl_GraphicDriver* myDriver;
449 Handle(OpenGl_Window) myWindow;
450 Handle(OpenGl_Workspace) myWorkspace;
451 Handle(OpenGl_Caps) myCaps;
452 Standard_Boolean myWasRedrawnGL;
454 Graphic3d_TypeOfBackfacingModel myBackfacing;
455 Quantity_ColorRGBA myBgColor;
456 Handle(Graphic3d_SequenceOfHClipPlane) myClipPlanes;
457 Handle(Graphic3d_Camera) myCamera;
458 gp_XYZ myLocalOrigin;
459 Handle(OpenGl_FrameBuffer) myFBO;
460 Standard_Boolean myToShowGradTrihedron;
461 TCollection_AsciiString myBackgroundImagePath;
462 Handle(Graphic3d_TextureEnv) myTextureEnvData;
463 Graphic3d_GraduatedTrihedron myGTrihedronData;
465 Handle(Graphic3d_LightSet) myNoShadingLight;
466 Handle(Graphic3d_LightSet) myLights;
467 OpenGl_LayerList myZLayers; //!< main list of displayed structure, sorted by layers
469 Graphic3d_WorldViewProjState myWorldViewProjState; //!< camera modification state
470 OpenGl_StateCounter* myStateCounter;
471 Standard_Size myCurrLightSourceState;
472 Standard_Size myLightsRevision;
474 typedef std::pair<Standard_Size, Standard_Size> StateInfo;
476 StateInfo myLastOrientationState;
477 StateInfo myLastViewMappingState;
478 StateInfo myLastLightSourceState;
480 //! Is needed for selection of overlapping objects and storage of the current view volume
481 OpenGl_BVHTreeSelector myBVHSelector;
483 OpenGl_GraduatedTrihedron myGraduatedTrihedron;
484 OpenGl_FrameStatsPrs myFrameStatsPrs;
486 Handle(OpenGl_TextureSet) myTextureEnv;
488 //! Framebuffers for OpenGL output.
489 Handle(OpenGl_FrameBuffer) myOpenGlFBO;
490 Handle(OpenGl_FrameBuffer) myOpenGlFBO2;
492 protected: //! @name Rendering properties
494 //! Two framebuffers (left and right views) store cached main presentation
495 //! of the view (without presentation of immediate layers).
496 GLint myFboColorFormat; //!< sized format for color attachments
497 GLint myFboDepthFormat; //!< sized format for depth-stencil attachments
498 OpenGl_ColorFormats myFboOitColorConfig; //!< selected color format configuration for OIT color attachments
499 Handle(OpenGl_FrameBuffer) myMainSceneFbos[2];
500 Handle(OpenGl_FrameBuffer) myMainSceneFbosOit[2]; //!< Additional buffers for transparent draw of main layer.
501 Handle(OpenGl_FrameBuffer) myImmediateSceneFbos[2]; //!< Additional buffers for immediate layer in stereo mode.
502 Handle(OpenGl_FrameBuffer) myImmediateSceneFbosOit[2]; //!< Additional buffers for transparency draw of immediate layer.
503 OpenGl_VertexBuffer myFullScreenQuad; //!< Vertices for full-screen quad rendering.
504 OpenGl_VertexBuffer myFullScreenQuadFlip;
505 Standard_Boolean myToFlipOutput; //!< Flag to draw result image upside-down
506 unsigned int myFrameCounter; //!< redraw counter, for debugging
507 Standard_Boolean myHasFboBlit; //!< disable FBOs on failure
508 Standard_Boolean myToDisableOIT; //!< disable OIT on failure
509 Standard_Boolean myToDisableOITMSAA; //!< disable OIT with MSAA on failure
510 Standard_Boolean myToDisableMSAA; //!< disable MSAA after failure
511 Standard_Boolean myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
512 Standard_Boolean myBackBufferRestored;
513 Standard_Boolean myIsImmediateDrawn; //!< flag indicates that immediate mode buffer contains some data
515 protected: //! @name Background parameters
517 OpenGl_AspectFace* myTextureParams; //!< Stores texture and its parameters for textured background
518 OpenGl_BackgroundArray* myBgGradientArray; //!< Primitive array for gradient background
519 OpenGl_BackgroundArray* myBgTextureArray; //!< Primitive array for texture background
521 protected: //! @name data types related to ray-tracing
523 //! Result of OpenGL shaders initialization.
524 enum RaytraceInitStatus
531 //! Describes update mode (state).
532 enum RaytraceUpdateMode
534 OpenGl_GUM_CHECK, //!< check geometry state
535 OpenGl_GUM_PREPARE, //!< collect unchanged objects
536 OpenGl_GUM_REBUILD //!< rebuild changed and new objects
539 //! Defines frequently used shader variables.
540 enum ShaderVariableIndex
553 OpenGl_RT_uViewPrMat,
554 OpenGl_RT_uUnviewMat,
559 OpenGl_RT_uLightAmbnt,
560 OpenGl_RT_uLightCount,
563 OpenGl_RT_uBackColorTop,
564 OpenGl_RT_uBackColorBot,
566 // ray-tracing params
567 OpenGl_RT_uShadowsEnabled,
568 OpenGl_RT_uReflectEnabled,
569 OpenGl_RT_uSphereMapEnabled,
570 OpenGl_RT_uSphereMapForBack,
571 OpenGl_RT_uTexSamplersArray,
572 OpenGl_RT_uBlockedRngEnabled,
574 // size of render window
578 // sampled frame params
579 OpenGl_RT_uAccumSamples,
580 OpenGl_RT_uFrameRndSeed,
582 // adaptive FSAA params
587 // images used by ISS mode
588 OpenGl_RT_uRenderImage,
589 OpenGl_RT_uOffsetImage,
591 // maximum radiance value
592 OpenGl_RT_uMaxRadiance,
594 OpenGl_RT_NbVariables // special field
597 //! Defines OpenGL image samplers.
598 enum ShaderImageNames
600 OpenGl_RT_OutputImageLft = 0,
601 OpenGl_RT_OutputImageRgh = 1,
602 OpenGl_RT_VisualErrorImageLft = 2,
603 OpenGl_RT_VisualErrorImageRgh = 3,
604 OpenGl_RT_TileOffsetsImageLft = 4,
605 OpenGl_RT_TileOffsetsImageRgh = 5
608 //! Tool class for management of shader sources.
613 //! Default shader prefix - empty string.
614 static const TCollection_AsciiString EMPTY_PREFIX;
616 //! Creates new uninitialized shader source.
624 //! Returns error description in case of load fail.
625 const TCollection_AsciiString& ErrorDescription() const
630 //! Returns prefix to insert before the source.
631 const TCollection_AsciiString& Prefix() const
636 //! Sets prefix to insert before the source.
637 void SetPrefix (const TCollection_AsciiString& thePrefix)
639 myPrefix = thePrefix;
642 //! Returns shader source combined with prefix.
643 TCollection_AsciiString Source() const;
645 //! Loads shader source from specified files.
646 Standard_Boolean LoadFromFiles (const TCollection_AsciiString* theFileNames, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX);
648 //! Loads shader source from specified strings.
649 Standard_Boolean LoadFromStrings (const TCollection_AsciiString* theStrings, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX);
653 TCollection_AsciiString mySource; //!< Source string of the shader object
654 TCollection_AsciiString myPrefix; //!< Prefix to insert before the source
655 TCollection_AsciiString myError; //!< error state
659 //! Default ray-tracing depth.
660 static const Standard_Integer THE_DEFAULT_NB_BOUNCES = 3;
662 //! Default size of traversal stack.
663 static const Standard_Integer THE_DEFAULT_STACK_SIZE = 10;
665 //! Compile-time ray-tracing parameters.
666 struct RaytracingParams
668 //! Actual size of traversal stack in shader program.
669 Standard_Integer StackSize;
671 //! Actual ray-tracing depth (number of ray bounces).
672 Standard_Integer NbBounces;
674 //! Enables/disables light propagation through transparent media.
675 Standard_Boolean TransparentShadows;
677 //! Enables/disables global illumination (GI) effects.
678 Standard_Boolean GlobalIllumination;
680 //! Enables/disables the use of OpenGL bindless textures.
681 Standard_Boolean UseBindlessTextures;
683 //! Enables/disables two-sided BSDF models instead of one-sided.
684 Standard_Boolean TwoSidedBsdfModels;
686 //! Enables/disables adaptive screen sampling for path tracing.
687 Standard_Boolean AdaptiveScreenSampling;
689 //! Enables/disables environment map for background.
690 Standard_Boolean UseEnvMapForBackground;
692 //! Maximum radiance value used for clamping radiance estimation.
693 Standard_ShortReal RadianceClampingValue;
695 //! Number of tiles in X dimension (in adaptive sampling mode).
696 Standard_Integer NbTilesX;
698 //! Number of tiles in Y dimension (in adaptive sampling mode).
699 Standard_Integer NbTilesY;
701 //! Enables/disables depth-of-field effect (path tracing, perspective camera).
702 Standard_Boolean DepthOfField;
704 //! Tone mapping method for path tracing.
705 Graphic3d_ToneMappingMethod ToneMappingMethod;
707 //! Creates default compile-time ray-tracing parameters.
709 : StackSize (THE_DEFAULT_STACK_SIZE),
710 NbBounces (THE_DEFAULT_NB_BOUNCES),
711 TransparentShadows (Standard_False),
712 GlobalIllumination (Standard_False),
713 UseBindlessTextures (Standard_False),
714 TwoSidedBsdfModels (Standard_False),
715 AdaptiveScreenSampling (Standard_False),
716 UseEnvMapForBackground (Standard_False),
717 RadianceClampingValue (30.0),
720 DepthOfField (Standard_False),
721 ToneMappingMethod (Graphic3d_ToneMappingMethod_Disabled) { }
724 //! Describes state of OpenGL structure.
727 Standard_Size StructureState;
728 Standard_Size InstancedState;
730 //! Creates new structure state.
731 StructState (const Standard_Size theStructureState = 0,
732 const Standard_Size theInstancedState = 0)
733 : StructureState (theStructureState),
734 InstancedState (theInstancedState)
739 //! Creates new structure state.
740 StructState (const OpenGl_Structure* theStructure)
742 StructureState = theStructure->ModificationState();
744 InstancedState = theStructure->InstancedStructure() != NULL ?
745 theStructure->InstancedStructure()->ModificationState() : 0;
749 protected: //! @name methods related to ray-tracing
751 //! Updates 3D scene geometry for ray-tracing.
752 Standard_Boolean updateRaytraceGeometry (const RaytraceUpdateMode theMode,
753 const Standard_Integer theViewId,
754 const Handle(OpenGl_Context)& theGlContext);
756 //! Updates 3D scene light sources for ray-tracing.
757 Standard_Boolean updateRaytraceLightSources (const OpenGl_Mat4& theInvModelView, const Handle(OpenGl_Context)& theGlContext);
759 //! Checks to see if the OpenGL structure is modified.
760 Standard_Boolean toUpdateStructure (const OpenGl_Structure* theStructure);
762 //! Adds OpenGL structure to ray-traced scene geometry.
763 Standard_Boolean addRaytraceStructure (const OpenGl_Structure* theStructure,
764 const Handle(OpenGl_Context)& theGlContext);
766 //! Adds OpenGL groups to ray-traced scene geometry.
767 Standard_Boolean addRaytraceGroups (const OpenGl_Structure* theStructure,
768 const OpenGl_RaytraceMaterial& theStructMat,
769 const Handle(Geom_Transformation)& theTrsf,
770 const Handle(OpenGl_Context)& theGlContext);
772 //! Creates ray-tracing material properties.
773 OpenGl_RaytraceMaterial convertMaterial (const OpenGl_AspectFace* theAspect,
774 const Handle(OpenGl_Context)& theGlContext);
776 //! Adds OpenGL primitive array to ray-traced scene geometry.
777 Handle(OpenGl_TriangleSet) addRaytracePrimitiveArray (const OpenGl_PrimitiveArray* theArray,
778 const Standard_Integer theMatID,
779 const OpenGl_Mat4* theTrans);
781 //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
782 Standard_Boolean addRaytraceVertexIndices (OpenGl_TriangleSet& theSet,
783 const Standard_Integer theMatID,
784 const Standard_Integer theCount,
785 const Standard_Integer theOffset,
786 const OpenGl_PrimitiveArray& theArray);
788 //! Adds OpenGL triangle array to ray-traced scene geometry.
789 Standard_Boolean addRaytraceTriangleArray (OpenGl_TriangleSet& theSet,
790 const Standard_Integer theMatID,
791 const Standard_Integer theCount,
792 const Standard_Integer theOffset,
793 const Handle(Graphic3d_IndexBuffer)& theIndices);
795 //! Adds OpenGL triangle fan array to ray-traced scene geometry.
796 Standard_Boolean addRaytraceTriangleFanArray (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 strip array to ray-traced scene geometry.
803 Standard_Boolean addRaytraceTriangleStripArray (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 quadrangle array to ray-traced scene geometry.
810 Standard_Boolean addRaytraceQuadrangleArray (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 strip array to ray-traced scene geometry.
817 Standard_Boolean addRaytraceQuadrangleStripArray (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 polygon array to ray-traced scene geometry.
824 Standard_Boolean addRaytracePolygonArray (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 //! Uploads ray-trace data to the GPU.
831 Standard_Boolean uploadRaytraceData (const Handle(OpenGl_Context)& theGlContext);
833 //! Generates shader prefix based on current ray-tracing options.
834 TCollection_AsciiString generateShaderPrefix (const Handle(OpenGl_Context)& theGlContext) const;
836 //! Performs safe exit when shaders initialization fails.
837 Standard_Boolean safeFailBack (const TCollection_ExtendedString& theMessage,
838 const Handle(OpenGl_Context)& theGlContext);
840 //! Loads and compiles shader object from specified source.
841 Handle(OpenGl_ShaderObject) initShader (const GLenum theType,
842 const ShaderSource& theSource,
843 const Handle(OpenGl_Context)& theGlContext);
845 //! Creates shader program from the given vertex and fragment shaders.
846 Handle(OpenGl_ShaderProgram) initProgram (const Handle(OpenGl_Context)& theGlContext,
847 const Handle(OpenGl_ShaderObject)& theVertShader,
848 const Handle(OpenGl_ShaderObject)& theFragShader);
850 //! Initializes OpenGL/GLSL shader programs.
851 Standard_Boolean initRaytraceResources (const Handle(OpenGl_Context)& theGlContext);
853 //! Releases OpenGL/GLSL shader programs.
854 void releaseRaytraceResources (const Handle(OpenGl_Context)& theGlContext,
855 const Standard_Boolean theToRebuild = Standard_False);
857 //! Updates auxiliary OpenGL frame buffers.
858 Standard_Boolean updateRaytraceBuffers (const Standard_Integer theSizeX,
859 const Standard_Integer theSizeY,
860 const Handle(OpenGl_Context)& theGlContext);
862 //! Generates viewing rays for corners of screen quad.
863 //! (ray tracing; path tracing for orthographic camera)
864 void updateCamera (const OpenGl_Mat4& theOrientation,
865 const OpenGl_Mat4& theViewMapping,
866 OpenGl_Vec3* theOrigins,
867 OpenGl_Vec3* theDirects,
868 OpenGl_Mat4& theView,
869 OpenGl_Mat4& theUnView);
871 //! Generate viewing rays (path tracing, perspective camera).
872 void updatePerspCameraPT(const OpenGl_Mat4& theOrientation,
873 const OpenGl_Mat4& theViewMapping,
874 Graphic3d_Camera::Projection theProjection,
875 OpenGl_Mat4& theViewPr,
876 OpenGl_Mat4& theUnview,
877 const int theWinSizeX,
878 const int theWinSizeY);
880 //! Binds ray-trace textures to corresponding texture units.
881 void bindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext);
883 //! Unbinds ray-trace textures from corresponding texture unit.
884 void unbindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext);
886 //! Sets uniform state for the given ray-tracing shader program.
887 Standard_Boolean setUniformState (const Standard_Integer theProgramId,
888 const Standard_Integer theSizeX,
889 const Standard_Integer theSizeY,
890 Graphic3d_Camera::Projection theProjection,
891 const Handle(OpenGl_Context)& theGlContext);
893 //! Runs ray-tracing shader programs.
894 Standard_Boolean runRaytraceShaders (const Standard_Integer theSizeX,
895 const Standard_Integer theSizeY,
896 Graphic3d_Camera::Projection theProjection,
897 OpenGl_FrameBuffer* theReadDrawFbo,
898 const Handle(OpenGl_Context)& theGlContext);
900 //! Runs classical (Whitted-style) ray-tracing kernel.
901 Standard_Boolean runRaytrace (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 path tracing (global illumination) kernel.
908 Standard_Boolean runPathtrace (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 //! Redraws the window using OpenGL/GLSL ray-tracing or path tracing.
915 Standard_Boolean raytrace (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 protected: //! @name fields related to ray-tracing
923 //! Result of RT/PT shaders initialization.
924 RaytraceInitStatus myRaytraceInitStatus;
926 //! Is ray-tracing geometry data valid?
927 Standard_Boolean myIsRaytraceDataValid;
929 //! True if warning about missing extension GL_ARB_bindless_texture has been displayed.
930 Standard_Boolean myIsRaytraceWarnTextures;
932 //! 3D scene geometry data for ray-tracing.
933 OpenGl_RaytraceGeometry myRaytraceGeometry;
935 //! Builder for triangle set.
936 opencascade::handle<BVH_Builder<Standard_ShortReal, 3> > myRaytraceBVHBuilder;
938 //! Compile-time ray-tracing parameters.
939 RaytracingParams myRaytraceParameters;
941 //! Radius of bounding sphere of the scene.
942 Standard_ShortReal myRaytraceSceneRadius;
943 //! Scene epsilon to prevent self-intersections.
944 Standard_ShortReal myRaytraceSceneEpsilon;
946 //! OpenGL/GLSL source of ray-tracing fragment shader.
947 ShaderSource myRaytraceShaderSource;
948 //! OpenGL/GLSL source of adaptive-AA fragment shader.
949 ShaderSource myPostFSAAShaderSource;
950 //! OpenGL/GLSL source of RT/PT display fragment shader.
951 ShaderSource myOutImageShaderSource;
953 //! OpenGL/GLSL ray-tracing fragment shader.
954 Handle(OpenGl_ShaderObject) myRaytraceShader;
955 //! OpenGL/GLSL adaptive-AA fragment shader.
956 Handle(OpenGl_ShaderObject) myPostFSAAShader;
957 //! OpenGL/GLSL ray-tracing display fragment shader.
958 Handle(OpenGl_ShaderObject) myOutImageShader;
960 //! OpenGL/GLSL ray-tracing shader program.
961 Handle(OpenGl_ShaderProgram) myRaytraceProgram;
962 //! OpenGL/GLSL adaptive-AA shader program.
963 Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
964 //! OpenGL/GLSL program for displaying texture.
965 Handle(OpenGl_ShaderProgram) myOutImageProgram;
967 //! Texture buffer of data records of bottom-level BVH nodes.
968 Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
969 //! Texture buffer of minimum points of bottom-level BVH nodes.
970 Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
971 //! Texture buffer of maximum points of bottom-level BVH nodes.
972 Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
973 //! Texture buffer of transformations of high-level BVH nodes.
974 Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
976 //! Texture buffer of vertex coords.
977 Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture;
978 //! Texture buffer of vertex normals.
979 Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture;
980 //! Texture buffer of vertex UV coords.
981 Handle(OpenGl_TextureBufferArb) myGeometryTexCrdTexture;
982 //! Texture buffer of triangle indices.
983 Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
985 //! Texture buffer of material properties.
986 Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
987 //! Texture buffer of light source properties.
988 Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
990 //! 1st framebuffer (FBO) to perform adaptive FSAA.
991 //! Used in compatibility mode (no adaptive sampling).
992 Handle(OpenGl_FrameBuffer) myRaytraceFBO1[2];
993 //! 2nd framebuffer (FBO) to perform adaptive FSAA.
994 //! Used in compatibility mode (no adaptive sampling).
995 Handle(OpenGl_FrameBuffer) myRaytraceFBO2[2];
997 //! Output textures (2 textures are used in stereo mode).
998 //! Used if adaptive screen sampling is activated.
999 Handle(OpenGl_Texture) myRaytraceOutputTexture[2];
1001 //! Texture containing per-tile visual error estimation (2 textures are used in stereo mode).
1002 //! Used if adaptive screen sampling is activated.
1003 Handle(OpenGl_Texture) myRaytraceVisualErrorTexture[2];
1004 //! Texture containing offsets of sampled screen tiles (2 textures are used in stereo mode).
1005 //! Used if adaptive screen sampling is activated.
1006 Handle(OpenGl_Texture) myRaytraceTileOffsetsTexture[2];
1008 //! Vertex buffer (VBO) for drawing dummy quad.
1009 OpenGl_VertexBuffer myRaytraceScreenQuad;
1011 //! Cached locations of frequently used uniform variables.
1012 Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
1014 //! State of OpenGL structures reflected to ray-tracing.
1015 std::map<const OpenGl_Structure*, StructState> myStructureStates;
1017 //! PrimitiveArray to TriangleSet map for scene partial update.
1018 std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
1020 //! Set of IDs of non-raytracable elements (to detect updates).
1021 std::set<Standard_Integer> myNonRaytraceStructureIDs;
1023 //! Marks if environment map should be updated.
1024 Standard_Boolean myToUpdateEnvironmentMap;
1026 //! State of OpenGL layer list.
1027 Standard_Size myRaytraceLayerListState;
1029 //! Number of accumulated frames (for progressive rendering).
1030 Standard_Integer myAccumFrames;
1032 //! Stored ray origins used for detection of camera movements.
1033 OpenGl_Vec3 myPreviousOrigins[3];
1035 //! Bullard RNG to produce random sequence.
1036 math_BullardGenerator myRNG;
1038 //! Tool object for sampling screen tiles in PT mode.
1039 OpenGl_TileSampler myTileSampler;
1041 //! Camera position used for projective mode
1042 OpenGl_Vec3 myEyeOrig;
1044 //! Camera view direction used for projective mode
1045 OpenGl_Vec3 myEyeView;
1047 //! Camera's screen vertical direction used for projective mode
1048 OpenGl_Vec3 myEyeVert;
1050 //! Camera's screen horizontal direction used for projective mode
1051 OpenGl_Vec3 myEyeSide;
1053 //! Camera's screen size used for projective mode
1054 OpenGl_Vec2 myEyeSize;
1056 //! Aperture radius of camera on previous frame used for depth-of-field (path tracing)
1057 float myPrevCameraApertureRadius;
1059 //! Focal distance of camera on previous frame used for depth-of-field (path tracing)
1060 float myPrevCameraFocalPlaneDist;
1064 DEFINE_STANDARD_ALLOC
1065 DEFINE_STANDARD_RTTIEXT(OpenGl_View,Graphic3d_CView) // Type definition
1067 friend class OpenGl_GraphicDriver;
1068 friend class OpenGl_Workspace;
1069 friend class OpenGl_LayerList;
1070 friend class OpenGl_FrameStats;
1073 #endif // _OpenGl_View_Header