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 <MMgt_TShared.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_TypeOfShadingModel.hxx>
34 #include <Graphic3d_WorldViewProjState.hxx>
35 #include <Graphic3d_ZLayerSettings.hxx>
37 #include <OpenGl_AspectFace.hxx>
38 #include <OpenGl_BackgroundArray.hxx>
39 #include <OpenGl_BVHTreeSelector.hxx>
40 #include <OpenGl_Context.hxx>
41 #include <OpenGl_FrameBuffer.hxx>
42 #include <OpenGl_GraduatedTrihedron.hxx>
43 #include <OpenGl_LayerList.hxx>
44 #include <OpenGl_Light.hxx>
45 #include <OpenGl_LineAttributes.hxx>
46 #include <OpenGl_SceneGeometry.hxx>
47 #include <OpenGl_Structure.hxx>
48 #include <OpenGl_Window.hxx>
49 #include <OpenGl_Workspace.hxx>
50 #include <OpenGl_TileSampler.hxx>
57 class Graphic3d_StructureManager;
58 class OpenGl_GraphicDriver;
59 class OpenGl_StateCounter;
60 class OpenGl_RaytraceMaterial;
61 class OpenGl_TriangleSet;
62 class OpenGl_Workspace;
64 DEFINE_STANDARD_HANDLE(OpenGl_View,Graphic3d_CView)
66 //! Implementation of OpenGl view.
67 class OpenGl_View : public Graphic3d_CView
73 Standard_EXPORT OpenGl_View (const Handle(Graphic3d_StructureManager)& theMgr,
74 const Handle(OpenGl_GraphicDriver)& theDriver,
75 const Handle(OpenGl_Caps)& theCaps,
76 Standard_Boolean& theDeviceLostFlag,
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 Standard_EXPORT virtual Standard_Boolean BufferDump (Image_PixMap& theImage,
147 const Graphic3d_BufferType& theBufferType) Standard_OVERRIDE;
149 //! Export scene into the one of the Vector graphics formats (SVG, PS, PDF...).
150 //! In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits
151 //! on printing to laser printer). Notice however that results may differ a lot and
152 //! do not contain some elements.
153 Standard_EXPORT virtual Standard_Boolean Export (const Standard_CString theFileName,
154 const Graphic3d_ExportFormat theFormat,
155 const Graphic3d_SortType theSortType = Graphic3d_ST_BSP_Tree) Standard_OVERRIDE;
157 //! Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated.
158 Standard_EXPORT virtual void InvalidateBVHData (const Standard_Integer theLayerId) Standard_OVERRIDE;
160 //! Insert a new top-level z layer with the given ID.
161 Standard_EXPORT virtual void AddZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
163 //! Remove a z layer with the given ID.
164 Standard_EXPORT virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
166 //! Sets the settings for a single Z layer of specified view.
167 Standard_EXPORT virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId,
168 const Graphic3d_ZLayerSettings& theSettings) Standard_OVERRIDE;
170 //! Returns the maximum Z layer ID.
171 //! First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax().
172 Standard_EXPORT virtual Standard_Integer ZLayerMax() const Standard_OVERRIDE;
174 //! Returns the bounding box of all structures displayed in the Z layer.
175 //! Never fails. If Z layer does not exist nothing happens.
176 Standard_EXPORT virtual void InvalidateZLayerBoundingBox (const Graphic3d_ZLayerId theLayerId) const Standard_OVERRIDE;
178 //! Returns the bounding box of all structures displayed in the Z layer.
179 //! If Z layer does not exist the empty box is returned.
180 //! @param theLayerId layer identifier
181 //! @param theCamera camera definition
182 //! @param theWindowWidth viewport width (for applying transformation-persistence)
183 //! @param theWindowHeight viewport height (for applying transformation-persistence)
184 //! @param theToIncludeAuxiliary consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence)
185 //! @return computed bounding box
186 Standard_EXPORT virtual Bnd_Box ZLayerBoundingBox (const Graphic3d_ZLayerId theLayerId,
187 const Handle(Graphic3d_Camera)& theCamera,
188 const Standard_Integer theWindowWidth,
189 const Standard_Integer theWindowHeight,
190 const Standard_Boolean theToIncludeAuxiliary) const Standard_OVERRIDE;
192 //! Returns pointer to an assigned framebuffer object.
193 Standard_EXPORT virtual Handle(Standard_Transient) FBO() const Standard_OVERRIDE;
195 //! Sets framebuffer object for offscreen rendering.
196 Standard_EXPORT virtual void SetFBO (const Handle(Standard_Transient)& theFbo) Standard_OVERRIDE;
198 //! Generate offscreen FBO in the graphic library.
199 //! If not supported on hardware returns NULL.
200 Standard_EXPORT virtual Handle(Standard_Transient) FBOCreate (const Standard_Integer theWidth,
201 const Standard_Integer theHeight) Standard_OVERRIDE;
203 //! Remove offscreen FBO from the graphic library
204 Standard_EXPORT virtual void FBORelease (Handle(Standard_Transient)& theFbo) Standard_OVERRIDE;
206 //! Read offscreen FBO configuration.
207 Standard_EXPORT virtual void FBOGetDimensions (const Handle(Standard_Transient)& theFbo,
208 Standard_Integer& theWidth,
209 Standard_Integer& theHeight,
210 Standard_Integer& theWidthMax,
211 Standard_Integer& theHeightMax) Standard_OVERRIDE;
213 //! Change offscreen FBO viewport.
214 Standard_EXPORT virtual void FBOChangeViewport (const Handle(Standard_Transient)& theFbo,
215 const Standard_Integer theWidth,
216 const Standard_Integer theHeight) Standard_OVERRIDE;
220 //! Returns background fill color.
221 Standard_EXPORT virtual Aspect_Background Background() const Standard_OVERRIDE;
223 //! Sets background fill color.
224 Standard_EXPORT virtual void SetBackground (const Aspect_Background& theBackground) Standard_OVERRIDE;
226 //! Returns gradient background fill colors.
227 Standard_EXPORT virtual Aspect_GradientBackground GradientBackground() const Standard_OVERRIDE;
229 //! Sets gradient background fill colors.
230 Standard_EXPORT virtual void SetGradientBackground (const Aspect_GradientBackground& theBackground) Standard_OVERRIDE;
232 //! Returns background image texture file path.
233 Standard_EXPORT virtual TCollection_AsciiString BackgroundImage() Standard_OVERRIDE { return myBackgroundImagePath; }
235 //! Sets background image texture file path.
236 Standard_EXPORT virtual void SetBackgroundImage (const TCollection_AsciiString& theFilePath) Standard_OVERRIDE;
238 //! Returns background image fill style.
239 Standard_EXPORT virtual Aspect_FillMethod BackgroundImageStyle() const Standard_OVERRIDE;
241 //! Sets background image fill style.
242 Standard_EXPORT virtual void SetBackgroundImageStyle (const Aspect_FillMethod theFillStyle) Standard_OVERRIDE;
244 //! Returns environment texture set for the view.
245 Standard_EXPORT virtual Handle(Graphic3d_TextureEnv) TextureEnv() const Standard_OVERRIDE { return myTextureEnvData; }
247 //! Sets environment texture for the view.
248 Standard_EXPORT virtual void SetTextureEnv (const Handle(Graphic3d_TextureEnv)& theTextureEnv) Standard_OVERRIDE;
250 //! Returns the state of frustum culling optimization.
251 virtual Standard_Boolean IsCullingEnabled() const Standard_OVERRIDE { return myCulling; }
253 //! Enables or disables frustum culling optimization.
254 virtual void SetCullingEnabled (const Standard_Boolean theIsEnabled) Standard_OVERRIDE { myCulling = theIsEnabled; }
256 //! Returns shading model of the view.
257 virtual Graphic3d_TypeOfShadingModel ShadingModel() const Standard_OVERRIDE { return myShadingModel; }
259 //! Sets shading model of the view.
260 virtual void SetShadingModel (const Graphic3d_TypeOfShadingModel theModel) Standard_OVERRIDE { myShadingModel = theModel; }
262 //! Return backfacing model used for the view.
263 virtual Graphic3d_TypeOfBackfacingModel BackfacingModel() const Standard_OVERRIDE { return myBackfacing; }
265 //! Sets backfacing model for the view.
266 virtual void SetBackfacingModel (const Graphic3d_TypeOfBackfacingModel theModel) Standard_OVERRIDE { myBackfacing = theModel; }
268 //! Returns camera object of the view.
269 virtual const Handle(Graphic3d_Camera)& Camera() const Standard_OVERRIDE { return myCamera; }
271 //! Returns local camera origin currently set for rendering, might be modified during rendering.
272 const gp_XYZ& LocalOrigin() const { return myLocalOrigin; }
274 //! Setup local camera origin currently set for rendering.
275 Standard_EXPORT void SetLocalOrigin (const gp_XYZ& theOrigin);
277 //! Sets camera used by the view.
278 Standard_EXPORT virtual void SetCamera (const Handle(Graphic3d_Camera)& theCamera) Standard_OVERRIDE;
280 //! Returns list of lights of the view.
281 virtual const Graphic3d_ListOfCLight& Lights() const Standard_OVERRIDE { return myLights; }
283 //! Sets list of lights for the view.
284 virtual void SetLights (const Graphic3d_ListOfCLight& theLights) Standard_OVERRIDE
286 myLights = theLights;
287 myCurrLightSourceState = myStateCounter->Increment();
290 //! Returns list of clip planes set for the view.
291 virtual const Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const Standard_OVERRIDE { return myClipPlanes; }
293 //! Sets list of clip planes for the view.
294 virtual void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes) Standard_OVERRIDE { myClipPlanes = thePlanes; }
296 //! Fill in the dictionary with diagnostic info.
297 //! Should be called within rendering thread.
299 //! This API should be used only for user output or for creating automated reports.
300 //! The format of returned information (e.g. key-value layout)
301 //! is NOT part of this API and can be changed at any time.
302 //! Thus application should not parse returned information to weed out specific parameters.
303 Standard_EXPORT virtual void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict,
304 Graphic3d_DiagnosticInfo theFlags) const Standard_OVERRIDE;
308 //! Returns background color.
309 const Quantity_ColorRGBA& BackgroundColor() const { return myBgColor; }
311 //! Change graduated trihedron.
312 OpenGl_GraduatedTrihedron& ChangeGraduatedTrihedron() { return myGraduatedTrihedron; }
314 void SetTextureEnv (const Handle(OpenGl_Context)& theCtx,
315 const Handle(Graphic3d_TextureEnv)& theTexture);
317 void SetBackgroundTextureStyle (const Aspect_FillMethod FillStyle);
319 void SetBackgroundGradient (const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AType);
321 void SetBackgroundGradientType (const Aspect_GradientFillMethod AType);
323 //! Returns list of OpenGL Z-layers.
324 const OpenGl_LayerList& LayerList() const { return myZLayers; }
326 //! Returns list of openGL light sources.
327 const OpenGl_ListOfLight& LightList() const { return myLights; }
329 //! Returns OpenGL window implementation.
330 const Handle(OpenGl_Window) GlWindow() const { return myWindow; }
332 //! Returns OpenGL environment map.
333 const Handle(OpenGl_Texture)& GlTextureEnv() const { return myTextureEnv; }
335 //! Returns selector for BVH tree, providing a possibility to store information
336 //! about current view volume and to detect which objects are overlapping it.
337 OpenGl_BVHTreeSelector& BVHTreeSelector() { return myBVHSelector; }
339 //! Returns true if there are immediate structures to display
340 bool HasImmediateStructures() const
342 return myZLayers.NbImmediateStructures() != 0;
345 protected: //! @name Internal methods for managing GL resources
347 //! Initializes OpenGl resource for environment texture.
348 void initTextureEnv (const Handle(OpenGl_Context)& theContext);
350 protected: //! @name low-level redrawing sub-routines
352 //! Redraws view for the given monographic camera projection, or left/right eye.
353 Standard_EXPORT virtual void redraw (const Graphic3d_Camera::Projection theProjection,
354 OpenGl_FrameBuffer* theReadDrawFbo);
356 //! Redraws view for the given monographic camera projection, or left/right eye.
358 //! Method will blit snapshot containing main scene (myMainSceneFbos or BackBuffer)
359 //! into presentation buffer (myMainSceneFbos -> offscreen FBO or
360 //! myMainSceneFbos -> BackBuffer or BackBuffer -> FrontBuffer),
361 //! and redraw immediate structures on top.
363 //! When scene caching is disabled (myTransientDrawToFront, no double buffer in window, etc.),
364 //! the first step (blitting) will be skipped.
366 //! @return false if immediate structures has been rendered directly into FrontBuffer
367 //! and Buffer Swap should not be called.
368 Standard_EXPORT virtual bool redrawImmediate (const Graphic3d_Camera::Projection theProjection,
369 OpenGl_FrameBuffer* theReadFbo,
370 OpenGl_FrameBuffer* theDrawFbo,
371 const Standard_Boolean theIsPartialUpdate = Standard_False);
373 //! Blit image from/to specified buffers.
374 Standard_EXPORT bool blitBuffers (OpenGl_FrameBuffer* theReadFbo,
375 OpenGl_FrameBuffer* theDrawFbo,
376 const Standard_Boolean theToFlip = Standard_False);
378 //! Setup default FBO.
379 Standard_EXPORT void bindDefaultFbo (OpenGl_FrameBuffer* theCustomFbo = NULL);
381 protected: //! @name Rendering of GL graphics (with prepared drawing buffer).
383 //! Renders the graphical contents of the view into the preprepared window or framebuffer.
384 //! @param theProjection [in] the projection that should be used for rendering.
385 //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
386 //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
387 Standard_EXPORT virtual void render (Graphic3d_Camera::Projection theProjection,
388 OpenGl_FrameBuffer* theReadDrawFbo,
389 const Standard_Boolean theToDrawImmediate);
391 //! Renders the graphical scene.
392 //! @param theProjection [in] the projection that is used for rendering.
393 //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
394 //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
395 Standard_EXPORT virtual void renderScene (Graphic3d_Camera::Projection theProjection,
396 OpenGl_FrameBuffer* theReadDrawFbo,
397 const Standard_Boolean theToDrawImmediate);
399 //! Draw background (gradient / image)
400 Standard_EXPORT virtual void drawBackground (const Handle(OpenGl_Workspace)& theWorkspace);
402 //! Render set of structures presented in the view.
403 //! @param theProjection [in] the projection that is used for rendering.
404 //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
405 //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
406 Standard_EXPORT virtual void renderStructs (Graphic3d_Camera::Projection theProjection,
407 OpenGl_FrameBuffer* theReadDrawFbo,
408 const Standard_Boolean theToDrawImmediate);
410 //! Renders trihedron.
411 void renderTrihedron (const Handle(OpenGl_Workspace) &theWorkspace);
415 //! Adds the structure to display lists of the view.
416 Standard_EXPORT virtual void displayStructure (const Handle(Graphic3d_CStructure)& theStructure,
417 const Standard_Integer thePriority) Standard_OVERRIDE;
419 //! Erases the structure from display lists of the view.
420 Standard_EXPORT virtual void eraseStructure (const Handle(Graphic3d_CStructure)& theStructure) Standard_OVERRIDE;
422 //! Change Z layer of a structure already presented in view.
423 Standard_EXPORT virtual void changeZLayer (const Handle(Graphic3d_CStructure)& theCStructure,
424 const Graphic3d_ZLayerId theNewLayerId) Standard_OVERRIDE;
426 //! Changes the priority of a structure within its Z layer in the specified view.
427 Standard_EXPORT virtual void changePriority (const Handle(Graphic3d_CStructure)& theCStructure,
428 const Standard_Integer theNewPriority) Standard_OVERRIDE;
430 //! Returns zoom-scale factor.
431 Standard_EXPORT virtual Standard_Real considerZoomPersistenceObjects (const Graphic3d_ZLayerId theLayerId,
432 const Handle(Graphic3d_Camera)& theCamera,
433 const Standard_Integer theWindowWidth,
434 const Standard_Integer theWindowHeight) const Standard_OVERRIDE;
438 //! Copy content of Back buffer to the Front buffer.
439 void copyBackToFront();
441 //! Initialize blit quad.
442 OpenGl_VertexBuffer* initBlitQuad (const Standard_Boolean theToFlip);
444 //! Blend together views pair into stereo image.
445 void drawStereoPair (OpenGl_FrameBuffer* theDrawFbo);
449 OpenGl_GraphicDriver* myDriver;
450 Handle(OpenGl_Window) myWindow;
451 Handle(OpenGl_Workspace) myWorkspace;
452 Handle(OpenGl_Caps) myCaps;
453 Standard_Boolean& myDeviceLostFlag;
454 Standard_Boolean myWasRedrawnGL;
456 Standard_Boolean myCulling;
457 Graphic3d_TypeOfShadingModel myShadingModel;
458 Graphic3d_TypeOfBackfacingModel myBackfacing;
459 Quantity_ColorRGBA myBgColor;
460 Handle(Graphic3d_SequenceOfHClipPlane) myClipPlanes;
461 Handle(Graphic3d_Camera) myCamera;
462 gp_XYZ myLocalOrigin;
463 Handle(OpenGl_FrameBuffer) myFBO;
464 Standard_Boolean myToShowGradTrihedron;
465 TCollection_AsciiString myBackgroundImagePath;
466 Handle(Graphic3d_TextureEnv) myTextureEnvData;
467 Graphic3d_GraduatedTrihedron myGTrihedronData;
469 OpenGl_ListOfLight myNoShadingLight;
470 OpenGl_ListOfLight myLights;
471 OpenGl_LayerList myZLayers; //!< main list of displayed structure, sorted by layers
473 Graphic3d_WorldViewProjState myWorldViewProjState; //!< camera modification state
474 OpenGl_StateCounter* myStateCounter;
475 Standard_Size myCurrLightSourceState;
477 typedef std::pair<Standard_Size, Standard_Size> StateInfo;
479 StateInfo myLastOrientationState;
480 StateInfo myLastViewMappingState;
481 StateInfo myLastLightSourceState;
483 //! Is needed for selection of overlapping objects and storage of the current view volume
484 OpenGl_BVHTreeSelector myBVHSelector;
486 OpenGl_GraduatedTrihedron myGraduatedTrihedron;
488 Handle(OpenGl_Texture) myTextureEnv;
490 //! Framebuffers for OpenGL output.
491 Handle(OpenGl_FrameBuffer) myOpenGlFBO;
492 Handle(OpenGl_FrameBuffer) myOpenGlFBO2;
494 protected: //! @name Rendering properties
496 //! Two framebuffers (left and right views) store cached main presentation
497 //! of the view (without presentation of immediate layers).
498 GLint myFboColorFormat; //!< sized format for color attachments
499 GLint myFboDepthFormat; //!< sized format for depth-stencil attachments
500 Handle(OpenGl_FrameBuffer) myMainSceneFbos[2];
501 Handle(OpenGl_FrameBuffer) myImmediateSceneFbos[2]; //!< Additional buffers for immediate layer in stereo mode.
502 OpenGl_VertexBuffer myFullScreenQuad; //!< Vertices for full-screen quad rendering.
503 OpenGl_VertexBuffer myFullScreenQuadFlip;
504 Standard_Boolean myToFlipOutput; //!< Flag to draw result image upside-down
505 unsigned int myFrameCounter; //!< redraw counter, for debugging
506 Standard_Boolean myHasFboBlit; //!< disable FBOs on failure
507 Standard_Boolean myToDisableMSAA; //!< disable MSAA after failure
508 Standard_Boolean myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
509 Standard_Boolean myBackBufferRestored;
510 Standard_Boolean myIsImmediateDrawn; //!< flag indicates that immediate mode buffer contains some data
512 protected: //! @name Background parameters
514 OpenGl_AspectFace* myTextureParams; //!< Stores texture and its parameters for textured background
515 OpenGl_BackgroundArray* myBgGradientArray; //!< Primitive array for gradient background
516 OpenGl_BackgroundArray* myBgTextureArray; //!< Primitive array for texture background
518 protected: //! @name data types related to ray-tracing
520 //! Result of OpenGL shaders initialization.
521 enum RaytraceInitStatus
528 //! Describes update mode (state).
529 enum RaytraceUpdateMode
531 OpenGl_GUM_CHECK, //!< check geometry state
532 OpenGl_GUM_PREPARE, //!< collect unchanged objects
533 OpenGl_GUM_REBUILD //!< rebuild changed and new objects
536 //! Defines frequently used shader variables.
537 enum ShaderVariableIndex
550 OpenGl_RT_uViewPrMat,
551 OpenGl_RT_uUnviewMat,
556 OpenGl_RT_uLightAmbnt,
557 OpenGl_RT_uLightCount,
560 OpenGl_RT_uBackColorTop,
561 OpenGl_RT_uBackColorBot,
563 // ray-tracing params
564 OpenGl_RT_uShadowsEnabled,
565 OpenGl_RT_uReflectEnabled,
566 OpenGl_RT_uSphereMapEnabled,
567 OpenGl_RT_uSphereMapForBack,
568 OpenGl_RT_uTexSamplersArray,
569 OpenGl_RT_uBlockedRngEnabled,
571 // size of render window
575 // sampled frame params
576 OpenGl_RT_uAccumSamples,
577 OpenGl_RT_uFrameRndSeed,
579 // adaptive FSAA params
584 // adaptive path tracing images
585 OpenGl_RT_uRenderImage,
586 OpenGl_RT_uOffsetImage,
588 OpenGl_RT_NbVariables // special field
591 //! Defines OpenGL texture samplers.
592 enum ShaderSamplerNames
594 OpenGl_RT_EnvironmentMapTexture = 0,
596 OpenGl_RT_SceneNodeInfoTexture = 1,
597 OpenGl_RT_SceneMinPointTexture = 2,
598 OpenGl_RT_SceneMaxPointTexture = 3,
599 OpenGl_RT_SceneTransformTexture = 4,
601 OpenGl_RT_GeometryVertexTexture = 5,
602 OpenGl_RT_GeometryNormalTexture = 6,
603 OpenGl_RT_GeometryTexCrdTexture = 7,
604 OpenGl_RT_GeometryTriangTexture = 8,
606 OpenGl_RT_RaytraceMaterialTexture = 9,
607 OpenGl_RT_RaytraceLightSrcTexture = 10,
609 OpenGl_RT_FsaaInputTexture = 11,
610 OpenGl_RT_PrevAccumTexture = 12,
612 OpenGl_RT_RaytraceDepthTexture = 13
615 //! Defines OpenGL image samplers.
616 enum ShaderImageNames
618 OpenGl_RT_OutputImageLft = 0,
619 OpenGl_RT_OutputImageRgh = 1,
620 OpenGl_RT_VisualErrorImage = 2,
621 OpenGl_RT_TileOffsetsImage = 3
624 //! Tool class for management of shader sources.
629 //! Default shader prefix - empty string.
630 static const TCollection_AsciiString EMPTY_PREFIX;
632 //! Creates new uninitialized shader source.
640 //! Returns error description in case of load fail.
641 const TCollection_AsciiString& ErrorDescription() const
646 //! Returns prefix to insert before the source.
647 const TCollection_AsciiString& Prefix() const
652 //! Sets prefix to insert before the source.
653 void SetPrefix (const TCollection_AsciiString& thePrefix)
655 myPrefix = thePrefix;
658 //! Returns shader source combined with prefix.
659 TCollection_AsciiString Source() const;
661 //! Loads shader source from specified files.
662 Standard_Boolean LoadFromFiles (const TCollection_AsciiString* theFileNames, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX);
664 //! Loads shader source from specified strings.
665 Standard_Boolean LoadFromStrings (const TCollection_AsciiString* theStrings, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX);
669 TCollection_AsciiString mySource; //!< Source string of the shader object
670 TCollection_AsciiString myPrefix; //!< Prefix to insert before the source
671 TCollection_AsciiString myError; //!< error state
675 //! Default ray-tracing depth.
676 static const Standard_Integer THE_DEFAULT_NB_BOUNCES = 3;
678 //! Default size of traversal stack.
679 static const Standard_Integer THE_DEFAULT_STACK_SIZE = 10;
681 //! Compile-time ray-tracing parameters.
682 struct RaytracingParams
684 //! Actual size of traversal stack in shader program.
685 Standard_Integer StackSize;
687 //! Actual ray-tracing depth (number of ray bounces).
688 Standard_Integer NbBounces;
690 //! Enables/disables light propagation through transparent media.
691 Standard_Boolean TransparentShadows;
693 //! Enables/disables global illumination (GI) effects.
694 Standard_Boolean GlobalIllumination;
696 //! Enables/disables the use of OpenGL bindless textures.
697 Standard_Boolean UseBindlessTextures;
699 //! Enables/disables adaptive screen sampling for path tracing.
700 Standard_Boolean AdaptiveScreenSampling;
702 //! Creates default compile-time ray-tracing parameters.
704 : StackSize (THE_DEFAULT_STACK_SIZE),
705 NbBounces (THE_DEFAULT_NB_BOUNCES),
706 TransparentShadows (Standard_False),
707 GlobalIllumination (Standard_False),
708 UseBindlessTextures (Standard_False),
709 AdaptiveScreenSampling (Standard_False)
715 //! Describes state of OpenGL structure.
718 Standard_Size StructureState;
719 Standard_Size InstancedState;
721 //! Creates new structure state.
722 StructState (const Standard_Size theStructureState = 0,
723 const Standard_Size theInstancedState = 0)
724 : StructureState (theStructureState),
725 InstancedState (theInstancedState)
730 //! Creates new structure state.
731 StructState (const OpenGl_Structure* theStructure)
733 StructureState = theStructure->ModificationState();
735 InstancedState = theStructure->InstancedStructure() != NULL ?
736 theStructure->InstancedStructure()->ModificationState() : 0;
740 protected: //! @name methods related to ray-tracing
742 //! Updates 3D scene geometry for ray-tracing.
743 Standard_Boolean updateRaytraceGeometry (const RaytraceUpdateMode theMode,
744 const Standard_Integer theViewId,
745 const Handle(OpenGl_Context)& theGlContext);
747 //! Updates 3D scene light sources for ray-tracing.
748 Standard_Boolean updateRaytraceLightSources (const OpenGl_Mat4& theInvModelView, const Handle(OpenGl_Context)& theGlContext);
750 //! Checks to see if the OpenGL structure is modified.
751 Standard_Boolean toUpdateStructure (const OpenGl_Structure* theStructure);
753 //! Adds OpenGL structure to ray-traced scene geometry.
754 Standard_Boolean addRaytraceStructure (const OpenGl_Structure* theStructure,
755 const Handle(OpenGl_Context)& theGlContext);
757 //! Adds OpenGL groups to ray-traced scene geometry.
758 Standard_Boolean addRaytraceGroups (const OpenGl_Structure* theStructure,
759 const OpenGl_RaytraceMaterial& theStructMat,
760 const Handle(Geom_Transformation)& theTrsf,
761 const Handle(OpenGl_Context)& theGlContext);
763 //! Creates ray-tracing material properties.
764 OpenGl_RaytraceMaterial convertMaterial (const OpenGl_AspectFace* theAspect,
765 const Handle(OpenGl_Context)& theGlContext);
767 //! Adds OpenGL primitive array to ray-traced scene geometry.
768 OpenGl_TriangleSet* addRaytracePrimitiveArray (const OpenGl_PrimitiveArray* theArray,
769 const Standard_Integer theMatID,
770 const OpenGl_Mat4* theTrans);
772 //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
773 Standard_Boolean addRaytraceVertexIndices (OpenGl_TriangleSet& theSet,
774 const Standard_Integer theMatID,
775 const Standard_Integer theCount,
776 const Standard_Integer theOffset,
777 const OpenGl_PrimitiveArray& theArray);
779 //! Adds OpenGL triangle array to ray-traced scene geometry.
780 Standard_Boolean addRaytraceTriangleArray (OpenGl_TriangleSet& theSet,
781 const Standard_Integer theMatID,
782 const Standard_Integer theCount,
783 const Standard_Integer theOffset,
784 const Handle(Graphic3d_IndexBuffer)& theIndices);
786 //! Adds OpenGL triangle fan array to ray-traced scene geometry.
787 Standard_Boolean addRaytraceTriangleFanArray (OpenGl_TriangleSet& theSet,
788 const Standard_Integer theMatID,
789 const Standard_Integer theCount,
790 const Standard_Integer theOffset,
791 const Handle(Graphic3d_IndexBuffer)& theIndices);
793 //! Adds OpenGL triangle strip array to ray-traced scene geometry.
794 Standard_Boolean addRaytraceTriangleStripArray (OpenGl_TriangleSet& theSet,
795 const Standard_Integer theMatID,
796 const Standard_Integer theCount,
797 const Standard_Integer theOffset,
798 const Handle(Graphic3d_IndexBuffer)& theIndices);
800 //! Adds OpenGL quadrangle array to ray-traced scene geometry.
801 Standard_Boolean addRaytraceQuadrangleArray (OpenGl_TriangleSet& theSet,
802 const Standard_Integer theMatID,
803 const Standard_Integer theCount,
804 const Standard_Integer theOffset,
805 const Handle(Graphic3d_IndexBuffer)& theIndices);
807 //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
808 Standard_Boolean addRaytraceQuadrangleStripArray (OpenGl_TriangleSet& theSet,
809 const Standard_Integer theMatID,
810 const Standard_Integer theCount,
811 const Standard_Integer theOffset,
812 const Handle(Graphic3d_IndexBuffer)& theIndices);
814 //! Adds OpenGL polygon array to ray-traced scene geometry.
815 Standard_Boolean addRaytracePolygonArray (OpenGl_TriangleSet& theSet,
816 const Standard_Integer theMatID,
817 const Standard_Integer theCount,
818 const Standard_Integer theOffset,
819 const Handle(Graphic3d_IndexBuffer)& theIndices);
821 //! Uploads ray-trace data to the GPU.
822 Standard_Boolean uploadRaytraceData (const Handle(OpenGl_Context)& theGlContext);
824 //! Generates shader prefix based on current ray-tracing options.
825 TCollection_AsciiString generateShaderPrefix (const Handle(OpenGl_Context)& theGlContext) const;
827 //! Performs safe exit when shaders initialization fails.
828 Standard_Boolean safeFailBack (const TCollection_ExtendedString& theMessage,
829 const Handle(OpenGl_Context)& theGlContext);
831 //! Loads and compiles shader object from specified source.
832 Handle(OpenGl_ShaderObject) initShader (const GLenum theType,
833 const ShaderSource& theSource,
834 const Handle(OpenGl_Context)& theGlContext);
836 //! Creates shader program from the given vertex and fragment shaders.
837 Handle(OpenGl_ShaderProgram) initProgram (const Handle(OpenGl_Context)& theGlContext,
838 const Handle(OpenGl_ShaderObject)& theVertShader,
839 const Handle(OpenGl_ShaderObject)& theFragShader);
841 //! Initializes OpenGL/GLSL shader programs.
842 Standard_Boolean initRaytraceResources (const Handle(OpenGl_Context)& theGlContext);
844 //! Releases OpenGL/GLSL shader programs.
845 void releaseRaytraceResources (const Handle(OpenGl_Context)& theGlContext,
846 const Standard_Boolean theToRebuild = Standard_False);
848 //! Updates auxiliary OpenGL frame buffers.
849 Standard_Boolean updateRaytraceBuffers (const Standard_Integer theSizeX,
850 const Standard_Integer theSizeY,
851 const Handle(OpenGl_Context)& theGlContext);
853 //! Generates viewing rays for corners of screen quad.
854 void updateCamera (const OpenGl_Mat4& theOrientation,
855 const OpenGl_Mat4& theViewMapping,
856 OpenGl_Vec3* theOrigins,
857 OpenGl_Vec3* theDirects,
858 OpenGl_Mat4& theView,
859 OpenGl_Mat4& theUnView);
861 //! Binds ray-trace textures to corresponding texture units.
862 void bindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext);
864 //! Unbinds ray-trace textures from corresponding texture unit.
865 void unbindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext);
867 //! Sets uniform state for the given ray-tracing shader program.
868 Standard_Boolean setUniformState (const Standard_Integer theProgramId,
869 const Standard_Integer theSizeX,
870 const Standard_Integer theSizeY,
871 const Handle(OpenGl_Context)& theGlContext);
873 //! Runs ray-tracing shader programs.
874 Standard_Boolean runRaytraceShaders (const Standard_Integer theSizeX,
875 const Standard_Integer theSizeY,
876 Graphic3d_Camera::Projection theProjection,
877 OpenGl_FrameBuffer* theReadDrawFbo,
878 const Handle(OpenGl_Context)& theGlContext);
880 //! Runs classical (Whitted-style) ray-tracing kernel.
881 Standard_Boolean runRaytrace (const Standard_Integer theSizeX,
882 const Standard_Integer theSizeY,
883 Graphic3d_Camera::Projection theProjection,
884 OpenGl_FrameBuffer* theReadDrawFbo,
885 const Handle(OpenGl_Context)& theGlContext);
887 //! Runs path tracing (global illumination) kernel.
888 Standard_Boolean runPathtrace (const Graphic3d_Camera::Projection theProjection,
889 OpenGl_FrameBuffer* theReadDrawFbo,
890 const Handle(OpenGl_Context)& theGlContext);
892 //! Redraws the window using OpenGL/GLSL ray-tracing or path tracing.
893 Standard_Boolean raytrace (const Standard_Integer theSizeX,
894 const Standard_Integer theSizeY,
895 Graphic3d_Camera::Projection theProjection,
896 OpenGl_FrameBuffer* theReadDrawFbo,
897 const Handle(OpenGl_Context)& theGlContext);
899 protected: //! @name fields related to ray-tracing
901 //! Result of RT/PT shaders initialization.
902 RaytraceInitStatus myRaytraceInitStatus;
904 //! Is ray-tracing geometry data valid?
905 Standard_Boolean myIsRaytraceDataValid;
907 //! True if warning about missing extension GL_ARB_bindless_texture has been displayed.
908 Standard_Boolean myIsRaytraceWarnTextures;
910 //! 3D scene geometry data for ray-tracing.
911 OpenGl_RaytraceGeometry myRaytraceGeometry;
913 //! Compile-time ray-tracing parameters.
914 RaytracingParams myRaytraceParameters;
916 //! Radius of bounding sphere of the scene.
917 Standard_ShortReal myRaytraceSceneRadius;
918 //! Scene epsilon to prevent self-intersections.
919 Standard_ShortReal myRaytraceSceneEpsilon;
921 //! OpenGL/GLSL source of ray-tracing fragment shader.
922 ShaderSource myRaytraceShaderSource;
923 //! OpenGL/GLSL source of adaptive-AA fragment shader.
924 ShaderSource myPostFSAAShaderSource;
925 //! OpenGL/GLSL source of RT/PT display fragment shader.
926 ShaderSource myOutImageShaderSource;
928 //! OpenGL/GLSL ray-tracing fragment shader.
929 Handle(OpenGl_ShaderObject) myRaytraceShader;
930 //! OpenGL/GLSL adaptive-AA fragment shader.
931 Handle(OpenGl_ShaderObject) myPostFSAAShader;
932 //! OpenGL/GLSL ray-tracing display fragment shader.
933 Handle(OpenGl_ShaderObject) myOutImageShader;
935 //! OpenGL/GLSL ray-tracing shader program.
936 Handle(OpenGl_ShaderProgram) myRaytraceProgram;
937 //! OpenGL/GLSL adaptive-AA shader program.
938 Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
939 //! OpenGL/GLSL program for displaying texture.
940 Handle(OpenGl_ShaderProgram) myOutImageProgram;
942 //! Texture buffer of data records of bottom-level BVH nodes.
943 Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
944 //! Texture buffer of minimum points of bottom-level BVH nodes.
945 Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
946 //! Texture buffer of maximum points of bottom-level BVH nodes.
947 Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
948 //! Texture buffer of transformations of high-level BVH nodes.
949 Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
951 //! Texture buffer of vertex coords.
952 Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture;
953 //! Texture buffer of vertex normals.
954 Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture;
955 //! Texture buffer of vertex UV coords.
956 Handle(OpenGl_TextureBufferArb) myGeometryTexCrdTexture;
957 //! Texture buffer of triangle indices.
958 Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
960 //! Texture buffer of material properties.
961 Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
962 //! Texture buffer of light source properties.
963 Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
965 //! 1st framebuffer (FBO) to perform adaptive FSAA.
966 //! Used in compatibility mode (no adaptive sampling).
967 Handle(OpenGl_FrameBuffer) myRaytraceFBO1[2];
968 //! 2nd framebuffer (FBO) to perform adaptive FSAA.
969 //! Used in compatibility mode (no adaptive sampling).
970 Handle(OpenGl_FrameBuffer) myRaytraceFBO2[2];
972 //! Output textures (2 textures are used in stereo mode).
973 //! Used if adaptive screen sampling is activated.
974 Handle(OpenGl_Texture) myRaytraceOutputTexture[2];
976 //! Texture containing per-tile visual error estimation.
977 //! Used if adaptive screen sampling is activated.
978 Handle(OpenGl_Texture) myRaytraceVisualErrorTexture;
979 //! Texture containing offsets of sampled screen tiles.
980 //! Used if adaptive screen sampling is activated.
981 Handle(OpenGl_Texture) myRaytraceTileOffsetsTexture;
983 //! Vertex buffer (VBO) for drawing dummy quad.
984 OpenGl_VertexBuffer myRaytraceScreenQuad;
986 //! Cached locations of frequently used uniform variables.
987 Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
989 //! State of OpenGL structures reflected to ray-tracing.
990 std::map<const OpenGl_Structure*, StructState> myStructureStates;
992 //! PrimitiveArray to TriangleSet map for scene partial update.
993 std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
995 //! Set of IDs of non-raytracable elements (to detect updates).
996 std::set<Standard_Integer> myNonRaytraceStructureIDs;
998 //! Render filter to filter out all raytracable structures.
999 Handle(OpenGl_RaytraceFilter) myRaytraceFilter;
1001 //! Marks if environment map should be updated.
1002 Standard_Boolean myToUpdateEnvironmentMap;
1004 //! State of OpenGL layer list.
1005 Standard_Size myRaytraceLayerListState;
1007 //! Number of accumulated frames (for progressive rendering).
1008 Standard_Integer myAccumFrames;
1010 //! Stored ray origins used for detection of camera movements.
1011 OpenGl_Vec3 myPreviousOrigins[3];
1013 //! Bullard RNG to produce random sequence.
1014 math_BullardGenerator myRNG;
1016 //! Tool object for sampling screen tiles in PT mode.
1017 OpenGl_TileSampler myTileSampler;
1021 DEFINE_STANDARD_ALLOC
1022 DEFINE_STANDARD_RTTIEXT(OpenGl_View,Graphic3d_CView) // Type definition
1024 friend class OpenGl_GraphicDriver;
1025 friend class OpenGl_Workspace;
1028 #endif // _OpenGl_View_Header