src/OpenGl/OpenGl_View.hxx

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