src/OpenGl/OpenGl_Workspace.hxx

   1 // Created on: 2011-09-20
   2 // Created by: Sergey ZERCHANINOV
   3 // Copyright (c) 2011-2013 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_Workspace_Header
  17 #define _OpenGl_Workspace_Header
  18
  19 #include <map>
  20 #include <set>
  21
  22 #include <Handle_OpenGl_Workspace.hxx>
  23 #include <OpenGl_Window.hxx>
  24
  25 #include <TColStd_Array2OfReal.hxx>
  26 #include <Quantity_Color.hxx>
  27 #include <Graphic3d_CView.hxx>
  28 #include <Graphic3d_TypeOfComposition.hxx>
  29 #include <Graphic3d_TypeOfTexture.hxx>
  30 #include <Graphic3d_PtrFrameBuffer.hxx>
  31 #include <Graphic3d_BufferType.hxx>
  32 #include <Handle_Graphic3d_TextureParams.hxx>
  33
  34 #include <Aspect_CLayer2d.hxx>
  35 #include <Aspect_Handle.hxx>
  36 #include <Aspect_PrintAlgo.hxx>
  37 #include <Aspect_PolygonOffsetMode.hxx>
  38
  39 #include <InterfaceGraphic_Graphic3d.hxx>
  40 #include <InterfaceGraphic_Visual3d.hxx>
  41
  42 #include <NCollection_Sequence.hxx>
  43
  44 #include <OpenGl_AspectFace.hxx>
  45 #include <OpenGl_FrameBuffer.hxx>
  46 #include <OpenGl_Matrix.hxx>
  47 #include <OpenGl_NamedStatus.hxx>
  48 #include <OpenGl_PrinterContext.hxx>
  49 #include <OpenGl_SceneGeometry.hxx>
  50 #include <OpenGl_TextParam.hxx>
  51 #include <OpenGl_RenderFilter.hxx>
  52 #include <OpenGl_Vec.hxx>
  53 #include <OpenGl_LineAttributes.hxx>
  54
  55 #include <Handle_OpenGl_View.hxx>
  56 #include <Handle_OpenGl_Texture.hxx>
  57
  58 #include <OpenGl_ShaderObject.hxx>
  59 #include <OpenGl_ShaderProgram.hxx>
  60 #include <OpenGl_TextureBufferArb.hxx>
  61
  62 class OpenGl_AspectLine;
  63 class OpenGl_AspectMarker;
  64 class OpenGl_AspectText;
  65 class OpenGl_FrameBuffer;
  66 class OpenGl_Structure;
  67 class OpenGl_TriangleSet;
  68 class OpenGl_Element;
  69 class Image_PixMap;
  70
  71 //! OpenGL material definition
  72 struct OpenGl_Material
  73 {
  74
  75   OpenGl_Vec4 Ambient;  //!< ambient reflection coefficient
  76   OpenGl_Vec4 Diffuse;  //!< diffuse reflection coefficient
  77   OpenGl_Vec4 Specular; //!< glossy  reflection coefficient
  78   OpenGl_Vec4 Emission; //!< material emission
  79   OpenGl_Vec4 Params;   //!< extra packed parameters
  80
  81   Standard_ShortReal  Shine()              const { return Params.x(); }
  82   Standard_ShortReal& ChangeShine()              { return Params.x(); }
  83
  84   Standard_ShortReal  Transparency()       const { return Params.y(); }
  85   Standard_ShortReal& ChangeTransparency()       { return Params.y(); }
  86
  87   //! Initialize material
  88   void Init (const OPENGL_SURF_PROP& theProps);
  89
  90   //! Returns packed (serialized) representation of material properties
  91   const OpenGl_Vec4* Packed() const { return reinterpret_cast<const OpenGl_Vec4*> (this); }
  92   static Standard_Integer NbOfVec4() { return 5; }
  93
  94 };
  95
  96 DEFINE_STANDARD_HANDLE (OpenGl_RaytraceFilter, OpenGl_RenderFilter)
  97
  98 //! Graphical ray-tracing filter.
  99 //! Filters out all raytracable structures.
 100 class OpenGl_RaytraceFilter : public OpenGl_RenderFilter
 101 {
 102 public:
 103
 104   //! Default constructor.
 105   OpenGl_RaytraceFilter() {}
 106
 107   //! Remembers the previously set filter.
 108   inline void SetPrevRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
 109   {
 110     myPrevRenderFilter = theFilter;
 111   }
 112
 113   //! Checks whether the element can be rendered or not.
 114   //! @param theElement [in] the element to check.
 115   //! @return True if element can be rendered.
 116   virtual Standard_Boolean CanRender (const OpenGl_Element* theElement);
 117
 118 private:
 119
 120   Handle(OpenGl_RenderFilter) myPrevRenderFilter;
 121
 122 public:
 123
 124   DEFINE_STANDARD_RTTI(OpenGl_RaytraceFilter)
 125 };
 126
 127 //! Represents window with GL context.
 128 //! Provides methods to render primitives and maintain GL state.
 129 class OpenGl_Workspace : public OpenGl_Window
 130 {
 131 public:
 132
 133   //! Main constructor - prepare GL context for specified window.
 134   OpenGl_Workspace (const Handle(OpenGl_GraphicDriver)& theDriver,
 135                     const CALL_DEF_WINDOW&        theCWindow,
 136                     Aspect_RenderingContext       theGContext,
 137                     const Handle(OpenGl_Caps)&    theCaps,
 138                     const Handle(OpenGl_Context)& theShareCtx);
 139
 140   //! Destructor
 141   virtual ~OpenGl_Workspace();
 142
 143   void SetActiveView (const Handle(OpenGl_View)& theView) { myView = theView; }
 144   const Handle(OpenGl_View)& ActiveView () const { return myView; }
 145
 146   //! Redraw the window.
 147   void Redraw (const Graphic3d_CView& theCView,
 148                const Aspect_CLayer2d& theCUnderLayer,
 149                const Aspect_CLayer2d& theCOverLayer);
 150
 151   Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer);
 152   void RedrawImmediate (const Graphic3d_CView& theCView,
 153                         const Aspect_CLayer2d& theCUnderLayer,
 154                         const Aspect_CLayer2d& theCOverLayer,
 155                         const Standard_Boolean theToForce = Standard_False);
 156
 157   void Invalidate (const Graphic3d_CView& /*theCView*/)
 158   {
 159     myBackBufferRestored = Standard_False;
 160   }
 161
 162   //! Special method to perform printing.
 163   //! System-specific and currently only Win platform implemented.
 164   Standard_Boolean Print (const Handle(OpenGl_PrinterContext)& thePrintContext,
 165                           const Graphic3d_CView& theCView,
 166                           const Aspect_CLayer2d& theCUnderLayer,
 167                           const Aspect_CLayer2d& theCOverLayer,
 168                           const Aspect_Handle    theHPrintDC,
 169                           const Standard_Boolean theToShowBackground,
 170                           const Standard_CString theFileName,
 171                           const Aspect_PrintAlgo thePrintAlgorithm,
 172                           const Standard_Real    theScaleFactor);
 173
 174   const Handle(OpenGl_PrinterContext)& PrinterContext() const
 175   {
 176     return myPrintContext;
 177   }
 178
 179   void DisplayCallback (const Graphic3d_CView& theCView, int theReason);
 180
 181   Graphic3d_PtrFrameBuffer FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight);
 182   void FBORelease (Graphic3d_PtrFrameBuffer theFBOPtr);
 183   Standard_Boolean BufferDump (OpenGl_FrameBuffer*         theFBOPtr,
 184                                Image_PixMap&               theImage,
 185                                const Graphic3d_BufferType& theBufferType);
 186
 187   Standard_Boolean& UseZBuffer()   { return myUseZBuffer; }
 188   Standard_Boolean& UseDepthTest() { return myUseDepthTest; }
 189   Standard_Boolean& UseGLLight()   { return myUseGLLight; }
 190
 191   Standard_Integer AntiAliasingMode() const { return myAntiAliasingMode; }
 192
 193   //// RELATED TO STATUS ////
 194
 195   Standard_Integer   NamedStatus;
 196
 197   const TEL_COLOUR* HighlightColor;
 198
 199   const OpenGl_AspectLine*   SetAspectLine   (const OpenGl_AspectLine*   theAspect);
 200   const OpenGl_AspectFace*   SetAspectFace   (const OpenGl_AspectFace*   theAspect);
 201   const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
 202   const OpenGl_AspectText*   SetAspectText   (const OpenGl_AspectText*   theAspect);
 203
 204   void SetTextParam (const OpenGl_TextParam* theParam) { TextParam_set = theParam; }
 205
 206   //// THESE METHODS ARE EXPORTED AS THEY PROVIDE STATE INFO TO USERDRAW
 207   Standard_EXPORT const OpenGl_AspectLine*   AspectLine   (const Standard_Boolean theWithApply);
 208   Standard_EXPORT const OpenGl_AspectFace*   AspectFace   (const Standard_Boolean theWithApply);
 209   Standard_EXPORT const OpenGl_AspectMarker* AspectMarker (const Standard_Boolean theWithApply);
 210   Standard_EXPORT const OpenGl_AspectText*   AspectText   (const Standard_Boolean theWithApply);
 211   inline const OpenGl_TextParam* AspectTextParams() const
 212   {
 213     return TextParam_applied;
 214   }
 215
 216   //! Clear the applied aspect state.
 217   void ResetAppliedAspect();
 218
 219   Standard_EXPORT Handle(OpenGl_Texture) DisableTexture();
 220   Standard_EXPORT Handle(OpenGl_Texture) EnableTexture (const Handle(OpenGl_Texture)&          theTexture,
 221                                                         const Handle(Graphic3d_TextureParams)& theParams = NULL);
 222   const Handle(OpenGl_Texture)& ActiveTexture() const { return myTextureBound; }
 223
 224   //! Set filter for restricting rendering of particular elements.
 225   //! Filter can be applied for rendering passes used by recursive
 226   //! rendering algorithms for rendering elements of groups.
 227   //! @param theFilter [in] the filter instance.
 228   inline void SetRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
 229   {
 230     myRenderFilter = theFilter;
 231   }
 232
 233   //! Get rendering filter.
 234   //! @return filter instance.
 235   inline const Handle(OpenGl_RenderFilter)& GetRenderFilter() const
 236   {
 237     return myRenderFilter;
 238   }
 239
 240   //! @return applied view matrix.
 241   inline const OpenGl_Matrix* ViewMatrix() const { return ViewMatrix_applied; }
 242
 243   //! @return applied model structure matrix.
 244   inline const OpenGl_Matrix* ModelMatrix() const { return StructureMatrix_applied; }
 245
 246   //! Sets and applies current polygon offset.
 247   void SetPolygonOffset (int theMode, Standard_ShortReal theFactor, Standard_ShortReal theUnits);
 248
 249   //! Returns currently applied polygon offset params.
 250   const TEL_POFFSET_PARAM& AppliedPolygonOffset() { return PolygonOffset_applied; }
 251
 252   //! @return true if clipping algorithm enabled
 253   inline Standard_Boolean IsCullingEnabled() const { return myIsCullingEnabled; }
 254
 255   //! Returns a flag whether to redraw the scene using OpenGL rasterization
 256   Standard_Boolean ToRedrawGL() const { return myToRedrawGL; }
 257
 258 protected:
 259
 260   //! Copy content of Back buffer to the Front buffer
 261   void copyBackToFront();
 262
 263   virtual Standard_Boolean Activate();
 264
 265   void redraw1 (const Graphic3d_CView& theCView,
 266                 const Aspect_CLayer2d& theCUnderLayer,
 267                 const Aspect_CLayer2d& theCOverLayer,
 268                 const int              theToSwap);
 269
 270   void updateMaterial (const int theFlag);
 271
 272   void setTextureParams (Handle(OpenGl_Texture)&                theTexture,
 273                          const Handle(Graphic3d_TextureParams)& theParams);
 274
 275 protected:
 276
 277   //! Result of OpenGL shaders initialization.
 278   enum RaytraceInitStatus
 279   {
 280     OpenGl_RT_NONE,
 281     OpenGl_RT_INIT,
 282     OpenGl_RT_FAIL
 283   };
 284
 285   //! Describes update mode (state).
 286   enum GeomUpdateMode
 287   {
 288     OpenGl_GUM_CHECK,   //!< check if geometry update is necessary
 289     OpenGl_GUM_PREPARE, //!< collect unchanged objects
 290     OpenGl_GUM_UPDATE   //!< update raytracing data, rebuild changed objects
 291   };
 292
 293   //! Defines frequently used shader variables.
 294   enum ShaderVariableIndex
 295   {
 296     OpenGl_RT_aPosition,
 297
 298     OpenGl_RT_uOriginLT,
 299     OpenGl_RT_uOriginLB,
 300     OpenGl_RT_uOriginRT,
 301     OpenGl_RT_uOriginRB,
 302     OpenGl_RT_uDirectLT,
 303     OpenGl_RT_uDirectLB,
 304     OpenGl_RT_uDirectRT,
 305     OpenGl_RT_uDirectRB,
 306     OpenGl_RT_uUnviewMat,
 307
 308     OpenGl_RT_uSceneRad,
 309     OpenGl_RT_uSceneEps,
 310     OpenGl_RT_uLightAmbnt,
 311     OpenGl_RT_uLightCount,
 312
 313     OpenGl_RT_uShadEnabled,
 314     OpenGl_RT_uReflEnabled,
 315     OpenGl_RT_uEnvMapEnable,
 316
 317     OpenGl_RT_uOffsetX,
 318     OpenGl_RT_uOffsetY,
 319     OpenGl_RT_uSamples,
 320     OpenGl_RT_uWinSizeX,
 321     OpenGl_RT_uWinSizeY,
 322
 323     OpenGl_RT_uTextures,
 324
 325     OpenGl_RT_NbVariables // special field
 326   };
 327
 328   //! Defines texture samplers.
 329   enum ShaderSamplerNames
 330   {
 331     OpenGl_RT_SceneNodeInfoTexture  = 0,
 332     OpenGl_RT_SceneMinPointTexture  = 1,
 333     OpenGl_RT_SceneMaxPointTexture  = 2,
 334     OpenGl_RT_SceneTransformTexture = 3,
 335
 336     OpenGl_RT_GeometryVertexTexture = 4,
 337     OpenGl_RT_GeometryNormalTexture = 5,
 338     OpenGl_RT_GeometryTexCrdTexture = 6,
 339     OpenGl_RT_GeometryTriangTexture = 7,
 340
 341     OpenGl_RT_EnvironmentMapTexture = 8,
 342
 343     OpenGl_RT_RaytraceMaterialTexture = 9,
 344     OpenGl_RT_RaytraceLightSrcTexture = 10,
 345
 346     OpenGl_RT_FSAAInputTexture = 11,
 347
 348     OpenGl_RT_OpenGlColorTexture = 12,
 349     OpenGl_RT_OpenGlDepthTexture = 13
 350   };
 351
 352   //! Tool class for management of shader sources.
 353   class ShaderSource
 354   {
 355   public:
 356
 357     //! Creates new uninitialized shader source.
 358     ShaderSource()
 359     {
 360       //
 361     }
 362
 363     //! Creates new shader source from specified file.
 364     ShaderSource (const TCollection_AsciiString& theFileName)
 365     {
 366       Load (&theFileName, 1);
 367     }
 368
 369   public:
 370
 371     //! Returns prefix to insert before the source.
 372     const TCollection_AsciiString& Prefix() const
 373     {
 374       return myPrefix;
 375     }
 376
 377     //! Sets prefix to insert before the source.
 378     void SetPrefix (const TCollection_AsciiString& thePrefix)
 379     {
 380       myPrefix = thePrefix;
 381     }
 382
 383     //! Returns shader source combined with prefix.
 384     TCollection_AsciiString Source() const;
 385
 386     //! Loads shader source from specified files.
 387     void Load (const TCollection_AsciiString* theFileNames, const Standard_Integer theCount);
 388
 389   private:
 390
 391     TCollection_AsciiString mySource; //!< Source string of the shader object
 392     TCollection_AsciiString myPrefix; //!< Prefix to insert before the source
 393
 394   };
 395
 396   //! Default ray-tracing depth.
 397   static const Standard_Integer THE_DEFAULT_NB_BOUNCES = 3;
 398
 399   //! Default size of traversal stack.
 400   static const Standard_Integer THE_DEFAULT_STACK_SIZE = 24;
 401
 402   //! Compile-time ray-tracing parameters.
 403   struct RaytracingParams
 404   {
 405     //! Actual size of traversal stack in shader program.
 406     Standard_Integer StackSize;
 407
 408     //! Actual ray-tracing depth (number of ray bounces).
 409     Standard_Integer NbBounces;
 410
 411     //! Sets light propagation through transparent media.
 412     Standard_Boolean TransparentShadows;
 413
 414     //! Creates default compile-time ray-tracing parameters.
 415     RaytracingParams()
 416     : StackSize (THE_DEFAULT_STACK_SIZE),
 417       NbBounces (THE_DEFAULT_NB_BOUNCES),
 418       TransparentShadows (Standard_False)
 419     {
 420       //
 421     }
 422   };
 423
 424 protected: //! @name methods related to ray-tracing
 425
 426   //! Updates 3D scene geometry for ray-tracing.
 427   Standard_Boolean UpdateRaytraceGeometry (GeomUpdateMode theMode);
 428
 429   //! Checks to see if the structure is modified.
 430   Standard_Boolean CheckRaytraceStructure (const OpenGl_Structure* theStructure);
 431
 432   //! Creates ray-tracing material properties.
 433   Standard_Boolean CreateMaterial (const OpenGl_AspectFace* theAspect, OpenGl_RaytraceMaterial& theMaterial);
 434
 435   //! Updates 3D scene light sources for ray-tracing.
 436   Standard_Boolean UpdateRaytraceLightSources (const OpenGl_Mat4& theInvModelView);
 437
 438   //! Updates environment map for ray-tracing.
 439   Standard_Boolean UpdateRaytraceEnvironmentMap();
 440
 441   //! Adds OpenGL structure to ray-traced scene geometry.
 442   Standard_Boolean AddRaytraceStructure (const OpenGl_Structure* theStructure, std::set<const OpenGl_Structure*>& theElements);
 443
 444   //! Adds OpenGL groups to ray-traced scene geometry.
 445   Standard_Boolean AddRaytraceGroups (const OpenGl_Structure*   theStructure,
 446                                       const Standard_Integer    theStructMatId,
 447                                       const Standard_ShortReal* theTransform);
 448
 449   //! Adds OpenGL primitive array to ray-traced scene geometry.
 450   OpenGl_TriangleSet* AddRaytracePrimitiveArray (
 451     const OpenGl_PrimitiveArray* theArray, int theMatID, const OpenGl_Mat4* theTrans);
 452
 453   //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
 454   Standard_Boolean AddRaytraceVertexIndices (OpenGl_TriangleSet&          theSet,
 455                                              const OpenGl_PrimitiveArray& theArray,
 456                                              Standard_Integer             theOffset,
 457                                              Standard_Integer             theCount,
 458                                              Standard_Integer             theMatID);
 459
 460   //! Adds OpenGL triangle array to ray-traced scene geometry.
 461   Standard_Boolean AddRaytraceTriangleArray (OpenGl_TriangleSet&                  theSet,
 462                                              const Handle(Graphic3d_IndexBuffer)& theIndices,
 463                                              Standard_Integer                     theOffset,
 464                                              Standard_Integer                     theCount,
 465                                              Standard_Integer                     theMatID);
 466
 467   //! Adds OpenGL triangle fan array to ray-traced scene geometry.
 468   Standard_Boolean AddRaytraceTriangleFanArray (OpenGl_TriangleSet&                  theSet,
 469                                                 const Handle(Graphic3d_IndexBuffer)& theIndices,
 470                                                 Standard_Integer                     theOffset,
 471                                                 Standard_Integer                     theCount,
 472                                                 Standard_Integer                     theMatID);
 473
 474   //! Adds OpenGL triangle strip array to ray-traced scene geometry.
 475   Standard_Boolean AddRaytraceTriangleStripArray (OpenGl_TriangleSet&                  theSet,
 476                                                   const Handle(Graphic3d_IndexBuffer)& theIndices,
 477                                                   Standard_Integer                     theOffset,
 478                                                   Standard_Integer                     theCount,
 479                                                   Standard_Integer                     theMatID);
 480
 481   //! Adds OpenGL quadrangle array to ray-traced scene geometry.
 482   Standard_Boolean AddRaytraceQuadrangleArray (OpenGl_TriangleSet&                  theSet,
 483                                                const Handle(Graphic3d_IndexBuffer)& theIndices,
 484                                                Standard_Integer                     theOffset,
 485                                                Standard_Integer                     theCount,
 486                                                Standard_Integer                     theMatID);
 487
 488   //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
 489   Standard_Boolean AddRaytraceQuadrangleStripArray (OpenGl_TriangleSet&                  theSet,
 490                                                     const Handle(Graphic3d_IndexBuffer)& theIndices,
 491                                                     Standard_Integer                     theOffset,
 492                                                     Standard_Integer                     theCount,
 493                                                     Standard_Integer                     theMatID);
 494
 495   //! Adds OpenGL polygon array to ray-traced scene geometry.
 496   Standard_Boolean AddRaytracePolygonArray (OpenGl_TriangleSet&                  theSet,
 497                                             const Handle(Graphic3d_IndexBuffer)& theIndices,
 498                                             Standard_Integer                     theOffset,
 499                                             Standard_Integer                     theCount,
 500                                             Standard_Integer                     theMatID);
 501
 502   //! Loads and compiles shader object from specified source.
 503   Handle(OpenGl_ShaderObject) LoadShader (const ShaderSource& theSource, GLenum theType);
 504
 505   //! Performs safe exit when shaders initialization fails.
 506   Standard_Boolean SafeFailBack (const TCollection_ExtendedString& theMessage);
 507
 508   //! Generates shader prefix based on current ray-tracing options.
 509   TCollection_AsciiString GenerateShaderPrefix();
 510
 511   //! Initializes OpenGL/GLSL shader programs.
 512   Standard_Boolean InitRaytraceResources (const Graphic3d_CView& theCView);
 513
 514   //! Releases OpenGL/GLSL shader programs.
 515   void ReleaseRaytraceResources();
 516
 517   //! Uploads ray-trace data to the GPU.
 518   Standard_Boolean UploadRaytraceData();
 519
 520   //! Resizes OpenGL frame buffers.
 521   Standard_Boolean ResizeRaytraceBuffers (const Standard_Integer theSizeX,
 522                                           const Standard_Integer theSizeY);
 523
 524   //! Generates viewing rays for corners of screen quad.
 525   void UpdateCamera (const OpenGl_Mat4& theOrientation,
 526                      const OpenGl_Mat4& theViewMapping,
 527                      OpenGl_Vec3        theOrigins[4],
 528                      OpenGl_Vec3        theDirects[4],
 529                      OpenGl_Mat4&       theInvModelProj);
 530
 531   //! Sets uniform state for the given ray-tracing shader program.
 532   Standard_Boolean SetUniformState (const Graphic3d_CView&        theCView,
 533                                     const Standard_Integer        theSizeX,
 534                                     const Standard_Integer        theSizeY,
 535                                     const OpenGl_Vec3*            theOrigins,
 536                                     const OpenGl_Vec3*            theDirects,
 537                                     const OpenGl_Mat4&            theUnviewMat,
 538                                     const Standard_Integer        theProgramIndex,
 539                                     Handle(OpenGl_ShaderProgram)& theRaytraceProgram);
 540
 541   //! Runs ray-tracing shader programs.
 542   Standard_Boolean RunRaytraceShaders (const Graphic3d_CView& theCView,
 543                                        const Standard_Integer theSizeX,
 544                                        const Standard_Integer theSizeY,
 545                                        const OpenGl_Vec3      theOrigins[4],
 546                                        const OpenGl_Vec3      theDirects[4],
 547                                        const OpenGl_Mat4&     theUnviewMat,
 548                                        OpenGl_FrameBuffer*    theFrameBuffer);
 549
 550   //! Redraws the window using OpenGL/GLSL ray-tracing.
 551   Standard_Boolean Raytrace (const Graphic3d_CView& theCView,
 552                              const Standard_Integer theSizeX,
 553                              const Standard_Integer theSizeY,
 554                              const Standard_Boolean theToSwap,
 555                              const Aspect_CLayer2d& theCOverLayer,
 556                              const Aspect_CLayer2d& theCUnderLayer,
 557                              OpenGl_FrameBuffer*    theFrameBuffer);
 558
 559 protected: //! @name fields related to ray-tracing
 560
 561   //! Result of shaders initialization.
 562   RaytraceInitStatus myComputeInitStatus;
 563
 564   //! Is geometry data valid?
 565   Standard_Boolean myIsRaytraceDataValid;
 566
 567   //! Warning about missing extension GL_ARB_bindless_texture has been displayed?
 568   Standard_Boolean myIsRaytraceWarnTextures;
 569
 570   //! 3D scene geometry data for ray-tracing.
 571   OpenGl_RaytraceGeometry myRaytraceGeometry;
 572
 573   //! Radius of bounding sphere of the scene.
 574   Standard_ShortReal myRaytraceSceneRadius;
 575   //! Scene epsilon to prevent self-intersections.
 576   Standard_ShortReal myRaytraceSceneEpsilon;
 577
 578   //! Compile-time ray-tracing parameters.
 579   RaytracingParams myRaytraceParameters;
 580
 581   //! OpenGL/GLSL source of ray-tracing fragment shader.
 582   ShaderSource myRaytraceShaderSource;
 583   //! OpenGL/GLSL source of adaptive-AA fragment shader.
 584   ShaderSource myPostFSAAShaderSource;
 585
 586   //! OpenGL/GLSL ray-tracing fragment shader.
 587   Handle(OpenGl_ShaderObject) myRaytraceShader;
 588   //! OpenGL/GLSL adaptive-AA fragment shader.
 589   Handle(OpenGl_ShaderObject) myPostFSAAShader;
 590
 591   //! OpenGL/GLSL ray-tracing shader program.
 592   Handle(OpenGl_ShaderProgram) myRaytraceProgram;
 593   //! OpenGL/GLSL adaptive-AA shader program.
 594   Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
 595
 596   //! Texture buffer of data records of bottom-level BVH nodes.
 597   Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
 598   //! Texture buffer of minimum points of bottom-level BVH nodes.
 599   Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
 600   //! Texture buffer of maximum points of bottom-level BVH nodes.
 601   Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
 602   //! Texture buffer of transformations of high-level BVH nodes.
 603   Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
 604
 605   //! Texture buffer of vertex coords.
 606   Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture;
 607   //! Texture buffer of vertex normals.
 608   Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture;
 609   //! Texture buffer of vertex UV coords.
 610   Handle(OpenGl_TextureBufferArb) myGeometryTexCrdTexture;
 611   //! Texture buffer of triangle indices.
 612   Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
 613
 614   //! Texture buffer of material properties.
 615   Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
 616   //! Texture buffer of light source properties.
 617   Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
 618
 619   //! Vertex buffer (VBO) for drawing dummy quad.
 620   OpenGl_VertexBuffer myRaytraceScreenQuad;
 621
 622   //! Framebuffer (FBO) to perform adaptive FSAA.
 623   Handle(OpenGl_FrameBuffer) myRaytraceFBO1;
 624   //! Framebuffer (FBO) to perform adaptive FSAA.
 625   Handle(OpenGl_FrameBuffer) myRaytraceFBO2;
 626   //! Framebuffer (FBO) for pre-raytrace rendering by OpenGL.
 627   Handle(OpenGl_FrameBuffer) myOpenGlFBO;
 628
 629   //! State of OpenGL view.
 630   Standard_Size myViewModificationStatus;
 631   //! State of OpenGL layer list.
 632   Standard_Size myLayersModificationStatus;
 633
 634   //! State of OpenGL structures reflected to ray-tracing.
 635   std::map<const OpenGl_Structure*, Standard_Size> myStructureStates;
 636
 637   //! PrimitiveArray to TriangleSet map for scene partial update.
 638   std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
 639
 640   //! Cached locations of frequently used uniform variables.
 641   Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
 642
 643   //! Graphical ray-tracing filter to filter out all raytracable structures.
 644   Handle(OpenGl_RaytraceFilter) myRaytraceFilter;
 645
 646   //! Redraw the scene using OpenGL rasterization or ray-tracing?
 647   Standard_Boolean myToRedrawGL;
 648
 649 protected: //! @name protected fields
 650
 651   Handle(OpenGl_PrinterContext) myPrintContext;
 652   Handle(OpenGl_View)           myView;
 653   Handle(OpenGl_LineAttributes) myLineAttribs;
 654   Standard_Integer       myAntiAliasingMode;
 655   Standard_Boolean       myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
 656   Standard_Boolean       myBackBufferRestored;
 657   Standard_Boolean       myIsImmediateDrawn;     //!< flag indicates that immediate mode buffer contains some data
 658   Standard_Boolean       myUseZBuffer;
 659   Standard_Boolean       myUseDepthTest;
 660   Standard_Boolean       myUseGLLight;
 661   Standard_Boolean       myIsCullingEnabled;     //!< frustum culling flag
 662
 663   unsigned int           myFrameCounter;         //!< redraw counter, for debugging
 664
 665 protected: //! @name fields related to status
 666
 667   Handle(OpenGl_RenderFilter) myRenderFilter;
 668   Handle(OpenGl_Texture) myTextureBound;    //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
 669   const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
 670   const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
 671   const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
 672   const OpenGl_AspectText *AspectText_set, *AspectText_applied;
 673
 674   const OpenGl_TextParam *TextParam_set, *TextParam_applied;
 675
 676   const OpenGl_Matrix* ViewMatrix_applied;
 677   const OpenGl_Matrix* StructureMatrix_applied;
 678
 679   OpenGl_Material myMatFront;    //!< current front material state (cached to reduce GL context updates)
 680   OpenGl_Material myMatBack;     //!< current back  material state
 681   OpenGl_Material myMatTmp;      //!< temporary variable
 682   TelCullMode     myCullingMode; //!< back face culling mode, applied from face aspect
 683
 684   OpenGl_Matrix myModelViewMatrix; //!< Model matrix with applied structure transformations
 685
 686   TEL_POFFSET_PARAM PolygonOffset_applied; //!< Currently applied polygon offset.
 687
 688   OpenGl_AspectFace myAspectFaceHl; //!< Hiddenline aspect
 689
 690 public: //! @name type definition
 691
 692   DEFINE_STANDARD_RTTI(OpenGl_Workspace)
 693   DEFINE_STANDARD_ALLOC
 694
 695 };
 696
 697 #endif // _OpenGl_Workspace_Header