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
 321     OpenGl_RT_uTextures,
 322
 323     OpenGl_RT_NbVariables // special field
 324   };
 325
 326   //! Defines texture samplers.
 327   enum ShaderSamplerNames
 328   {
 329     OpenGl_RT_SceneNodeInfoTexture = 0,
 330     OpenGl_RT_SceneMinPointTexture = 1,
 331     OpenGl_RT_SceneMaxPointTexture = 2,
 332
 333     OpenGl_RT_ObjectNodeInfoTexture = 3,
 334     OpenGl_RT_ObjectMinPointTexture = 4,
 335     OpenGl_RT_ObjectMaxPointTexture = 5,
 336
 337     OpenGl_RT_GeometryVertexTexture = 6,
 338     OpenGl_RT_GeometryNormalTexture = 7,
 339     OpenGl_RT_GeometryTexCrdTexture = 8,
 340     OpenGl_RT_GeometryTriangTexture = 9,
 341
 342     OpenGl_RT_EnvironmentMapTexture = 10,
 343
 344     OpenGl_RT_RaytraceMaterialTexture = 11,
 345     OpenGl_RT_RaytraceLightSrcTexture = 12,
 346
 347     OpenGl_RT_FSAAInputTexture = 13,
 348
 349     OpenGl_RT_SceneTransformTexture = 14,
 350
 351     OpenGl_RT_OpenGlColorTexture = 15,
 352     OpenGl_RT_OpenGlDepthTexture = 16
 353   };
 354
 355   //! Tool class for management of shader sources.
 356   class ShaderSource
 357   {
 358   public:
 359
 360     //! Creates new uninitialized shader source.
 361     ShaderSource()
 362     {
 363       //
 364     }
 365
 366     //! Creates new shader source from specified file.
 367     ShaderSource (const TCollection_AsciiString& theFileName)
 368     {
 369       Load (&theFileName, 1);
 370     }
 371
 372   public:
 373
 374     //! Returns prefix to insert before the source.
 375     const TCollection_AsciiString& Prefix() const
 376     {
 377       return myPrefix;
 378     }
 379
 380     //! Sets prefix to insert before the source.
 381     void SetPrefix (const TCollection_AsciiString& thePrefix)
 382     {
 383       myPrefix = thePrefix;
 384     }
 385
 386     //! Returns shader source combined with prefix.
 387     TCollection_AsciiString Source() const;
 388
 389     //! Loads shader source from specified files.
 390     void Load (const TCollection_AsciiString* theFileNames, const Standard_Integer theCount);
 391
 392   private:
 393
 394     TCollection_AsciiString mySource; //!< Source string of the shader object
 395     TCollection_AsciiString myPrefix; //!< Prefix to insert before the source
 396
 397   };
 398
 399   //! Default ray-tracing depth.
 400   static const Standard_Integer THE_DEFAULT_NB_BOUNCES = 3;
 401
 402   //! Default size of traversal stack.
 403   static const Standard_Integer THE_DEFAULT_STACK_SIZE = 24;
 404
 405   //! Compile-time ray-tracing parameters.
 406   struct RaytracingParams
 407   {
 408     //! Actual size of traversal stack in shader program.
 409     Standard_Integer StackSize;
 410
 411     //! Actual ray-tracing depth (number of ray bounces).
 412     Standard_Integer NbBounces;
 413
 414     //! Sets light propagation through transparent media.
 415     Standard_Boolean TransparentShadows;
 416
 417     //! Creates default compile-time ray-tracing parameters.
 418     RaytracingParams()
 419     : StackSize (THE_DEFAULT_STACK_SIZE),
 420       NbBounces (THE_DEFAULT_NB_BOUNCES),
 421       TransparentShadows (Standard_False)
 422     {
 423       //
 424     }
 425   };
 426
 427 protected: //! @name methods related to ray-tracing
 428
 429   //! Updates 3D scene geometry for ray-tracing.
 430   Standard_Boolean UpdateRaytraceGeometry (GeomUpdateMode theMode);
 431
 432   //! Checks to see if the structure is modified.
 433   Standard_Boolean CheckRaytraceStructure (const OpenGl_Structure* theStructure);
 434
 435   //! Creates ray-tracing material properties.
 436   Standard_Boolean CreateMaterial (const OpenGl_AspectFace* theAspect, OpenGl_RaytraceMaterial& theMaterial);
 437
 438   //! Updates 3D scene light sources for ray-tracing.
 439   Standard_Boolean UpdateRaytraceLightSources (const OpenGl_Mat4& theInvModelView);
 440
 441   //! Updates environment map for ray-tracing.
 442   Standard_Boolean UpdateRaytraceEnvironmentMap();
 443
 444   //! Adds OpenGL structure to ray-traced scene geometry.
 445   Standard_Boolean AddRaytraceStructure (const OpenGl_Structure* theStructure, std::set<const OpenGl_Structure*>& theElements);
 446
 447   //! Adds OpenGL groups to ray-traced scene geometry.
 448   Standard_Boolean AddRaytraceGroups (const OpenGl_Structure*   theStructure,
 449                                       const Standard_Integer    theStructMatId,
 450                                       const Standard_ShortReal* theTransform);
 451
 452   //! Adds OpenGL primitive array to ray-traced scene geometry.
 453   OpenGl_TriangleSet* AddRaytracePrimitiveArray (
 454     const OpenGl_PrimitiveArray* theArray, int theMatID, const OpenGl_Mat4* theTrans);
 455
 456   //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
 457   Standard_Boolean AddRaytraceVertexIndices (OpenGl_TriangleSet&          theSet,
 458                                              const OpenGl_PrimitiveArray& theArray,
 459                                              Standard_Integer             theOffset,
 460                                              Standard_Integer             theCount,
 461                                              Standard_Integer             theMatID);
 462
 463   //! Adds OpenGL triangle array to ray-traced scene geometry.
 464   Standard_Boolean AddRaytraceTriangleArray (OpenGl_TriangleSet&                  theSet,
 465                                              const Handle(Graphic3d_IndexBuffer)& theIndices,
 466                                              Standard_Integer                     theOffset,
 467                                              Standard_Integer                     theCount,
 468                                              Standard_Integer                     theMatID);
 469
 470   //! Adds OpenGL triangle fan array to ray-traced scene geometry.
 471   Standard_Boolean AddRaytraceTriangleFanArray (OpenGl_TriangleSet&                  theSet,
 472                                                 const Handle(Graphic3d_IndexBuffer)& theIndices,
 473                                                 Standard_Integer                     theOffset,
 474                                                 Standard_Integer                     theCount,
 475                                                 Standard_Integer                     theMatID);
 476
 477   //! Adds OpenGL triangle strip array to ray-traced scene geometry.
 478   Standard_Boolean AddRaytraceTriangleStripArray (OpenGl_TriangleSet&                  theSet,
 479                                                   const Handle(Graphic3d_IndexBuffer)& theIndices,
 480                                                   Standard_Integer                     theOffset,
 481                                                   Standard_Integer                     theCount,
 482                                                   Standard_Integer                     theMatID);
 483
 484   //! Adds OpenGL quadrangle array to ray-traced scene geometry.
 485   Standard_Boolean AddRaytraceQuadrangleArray (OpenGl_TriangleSet&                  theSet,
 486                                                const Handle(Graphic3d_IndexBuffer)& theIndices,
 487                                                Standard_Integer                     theOffset,
 488                                                Standard_Integer                     theCount,
 489                                                Standard_Integer                     theMatID);
 490
 491   //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
 492   Standard_Boolean AddRaytraceQuadrangleStripArray (OpenGl_TriangleSet&                  theSet,
 493                                                     const Handle(Graphic3d_IndexBuffer)& theIndices,
 494                                                     Standard_Integer                     theOffset,
 495                                                     Standard_Integer                     theCount,
 496                                                     Standard_Integer                     theMatID);
 497
 498   //! Adds OpenGL polygon array to ray-traced scene geometry.
 499   Standard_Boolean AddRaytracePolygonArray (OpenGl_TriangleSet&                  theSet,
 500                                             const Handle(Graphic3d_IndexBuffer)& theIndices,
 501                                             Standard_Integer                     theOffset,
 502                                             Standard_Integer                     theCount,
 503                                             Standard_Integer                     theMatID);
 504
 505   //! Loads and compiles shader object from specified source.
 506   Handle(OpenGl_ShaderObject) LoadShader (const ShaderSource& theSource, GLenum theType);
 507
 508   //! Performs safe exit when shaders initialization fails.
 509   Standard_Boolean SafeFailBack (const TCollection_ExtendedString& theMessage);
 510
 511   //! Generates shader prefix based on current ray-tracing options.
 512   TCollection_AsciiString GenerateShaderPrefix();
 513
 514   //! Initializes OpenGL/GLSL shader programs.
 515   Standard_Boolean InitRaytraceResources (const Graphic3d_CView& theCView);
 516
 517   //! Releases OpenGL/GLSL shader programs.
 518   void ReleaseRaytraceResources();
 519
 520   //! Uploads ray-trace data to the GPU.
 521   Standard_Boolean UploadRaytraceData();
 522
 523   //! Resizes OpenGL frame buffers.
 524   Standard_Boolean ResizeRaytraceBuffers (const Standard_Integer theSizeX,
 525                                           const Standard_Integer theSizeY);
 526
 527   //! Generates viewing rays for corners of screen quad.
 528   void UpdateCamera (const OpenGl_Mat4& theOrientation,
 529                      const OpenGl_Mat4& theViewMapping,
 530                      OpenGl_Vec3        theOrigins[4],
 531                      OpenGl_Vec3        theDirects[4],
 532                      OpenGl_Mat4&       theInvModelProj);
 533
 534   //! Sets uniform state for the given ray-tracing shader program.
 535   Standard_Boolean SetUniformState (const Graphic3d_CView&        theCView,
 536                                     const OpenGl_Vec3*            theOrigins,
 537                                     const OpenGl_Vec3*            theDirects,
 538                                     const OpenGl_Mat4&            theUnviewMat,
 539                                     const Standard_Integer        theProgramIndex,
 540                                     Handle(OpenGl_ShaderProgram)& theRaytraceProgram);
 541
 542   //! Runs ray-tracing shader programs.
 543   Standard_Boolean RunRaytraceShaders (const Graphic3d_CView& theCView,
 544                                        const Standard_Integer theSizeX,
 545                                        const Standard_Integer theSizeY,
 546                                        const OpenGl_Vec3      theOrigins[4],
 547                                        const OpenGl_Vec3      theDirects[4],
 548                                        const OpenGl_Mat4&     theUnviewMat,
 549                                        OpenGl_FrameBuffer*    theFrameBuffer);
 550
 551   //! Redraws the window using OpenGL/GLSL ray-tracing.
 552   Standard_Boolean Raytrace (const Graphic3d_CView& theCView,
 553                              const Standard_Integer theSizeX,
 554                              const Standard_Integer theSizeY,
 555                              const Standard_Boolean theToSwap,
 556                              const Aspect_CLayer2d& theCOverLayer,
 557                              const Aspect_CLayer2d& theCUnderLayer,
 558                              OpenGl_FrameBuffer*    theFrameBuffer);
 559
 560 protected: //! @name fields related to ray-tracing
 561
 562   //! Result of shaders initialization.
 563   RaytraceInitStatus myComputeInitStatus;
 564
 565   //! Is geometry data valid?
 566   Standard_Boolean myIsRaytraceDataValid;
 567
 568   //! Warning about missing extension GL_ARB_bindless_texture has been displayed?
 569   Standard_Boolean myIsRaytraceWarnTextures;
 570
 571   //! 3D scene geometry data for ray-tracing.
 572   OpenGl_RaytraceGeometry myRaytraceGeometry;
 573
 574   //! Radius of bounding sphere of the scene.
 575   Standard_ShortReal myRaytraceSceneRadius;
 576   //! Scene epsilon to prevent self-intersections.
 577   Standard_ShortReal myRaytraceSceneEpsilon;
 578
 579   //! Compile-time ray-tracing parameters.
 580   RaytracingParams myRaytraceParameters;
 581
 582   //! OpenGL/GLSL source of ray-tracing fragment shader.
 583   ShaderSource myRaytraceShaderSource;
 584   //! OpenGL/GLSL source of adaptive-AA fragment shader.
 585   ShaderSource myPostFSAAShaderSource;
 586
 587   //! OpenGL/GLSL ray-tracing fragment shader.
 588   Handle(OpenGl_ShaderObject) myRaytraceShader;
 589   //! OpenGL/GLSL adaptive-AA fragment shader.
 590   Handle(OpenGl_ShaderObject) myPostFSAAShader;
 591
 592   //! OpenGL/GLSL ray-tracing shader program.
 593   Handle(OpenGl_ShaderProgram) myRaytraceProgram;
 594   //! OpenGL/GLSL adaptive-AA shader program.
 595   Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
 596
 597   //! Texture buffer of data records of high-level BVH nodes.
 598   Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
 599   //! Texture buffer of minimum points of high-level BVH nodes.
 600   Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
 601   //! Texture buffer of maximum points of high-level BVH nodes.
 602   Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
 603   //! Texture buffer of transformations of high-level BVH nodes.
 604   Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
 605
 606   //! Texture buffer of data records of bottom-level BVH nodes.
 607   Handle(OpenGl_TextureBufferArb) myObjectNodeInfoTexture;
 608   //! Texture buffer of minimum points of bottom-level BVH nodes.
 609   Handle(OpenGl_TextureBufferArb) myObjectMinPointTexture;
 610   //! Texture buffer of maximum points of bottom-level BVH nodes.
 611   Handle(OpenGl_TextureBufferArb) myObjectMaxPointTexture;
 612
 613   //! Texture buffer of vertex coords.
 614   Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture;
 615   //! Texture buffer of vertex normals.
 616   Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture;
 617   //! Texture buffer of vertex UV coords.
 618   Handle(OpenGl_TextureBufferArb) myGeometryTexCrdTexture;
 619   //! Texture buffer of triangle indices.
 620   Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
 621
 622   //! Texture buffer of material properties.
 623   Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
 624   //! Texture buffer of light source properties.
 625   Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
 626
 627   //! Vertex buffer (VBO) for drawing dummy quad.
 628   OpenGl_VertexBuffer myRaytraceScreenQuad;
 629
 630   //! Framebuffer (FBO) to perform adaptive FSAA.
 631   Handle(OpenGl_FrameBuffer) myRaytraceFBO1;
 632   //! Framebuffer (FBO) to perform adaptive FSAA.
 633   Handle(OpenGl_FrameBuffer) myRaytraceFBO2;
 634   //! Framebuffer (FBO) for pre-raytrace rendering by OpenGL.
 635   Handle(OpenGl_FrameBuffer) myOpenGlFBO;
 636
 637   //! State of OpenGL view.
 638   Standard_Size myViewModificationStatus;
 639   //! State of OpenGL layer list.
 640   Standard_Size myLayersModificationStatus;
 641
 642   //! State of OpenGL structures reflected to ray-tracing.
 643   std::map<const OpenGl_Structure*, Standard_Size> myStructureStates;
 644
 645   //! PrimitiveArray to TriangleSet map for scene partial update.
 646   std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
 647
 648   //! Cached locations of frequently used uniform variables.
 649   Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
 650
 651   //! Graphical ray-tracing filter to filter out all raytracable structures.
 652   Handle(OpenGl_RaytraceFilter) myRaytraceFilter;
 653
 654   //! Redraw the scene using OpenGL rasterization or ray-tracing?
 655   Standard_Boolean myToRedrawGL;
 656
 657 protected: //! @name protected fields
 658
 659   Handle(OpenGl_PrinterContext) myPrintContext;
 660   Handle(OpenGl_View)           myView;
 661   Handle(OpenGl_LineAttributes) myLineAttribs;
 662   Standard_Integer       myAntiAliasingMode;
 663   Standard_Boolean       myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
 664   Standard_Boolean       myBackBufferRestored;
 665   Standard_Boolean       myIsImmediateDrawn;     //!< flag indicates that immediate mode buffer contains some data
 666   Standard_Boolean       myUseZBuffer;
 667   Standard_Boolean       myUseDepthTest;
 668   Standard_Boolean       myUseGLLight;
 669   Standard_Boolean       myIsCullingEnabled;     //!< frustum culling flag
 670
 671   unsigned int           myFrameCounter;         //!< redraw counter, for debugging
 672
 673 protected: //! @name fields related to status
 674
 675   Handle(OpenGl_RenderFilter) myRenderFilter;
 676   Handle(OpenGl_Texture) myTextureBound;    //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
 677   const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
 678   const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
 679   const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
 680   const OpenGl_AspectText *AspectText_set, *AspectText_applied;
 681
 682   const OpenGl_TextParam *TextParam_set, *TextParam_applied;
 683
 684   const OpenGl_Matrix* ViewMatrix_applied;
 685   const OpenGl_Matrix* StructureMatrix_applied;
 686
 687   OpenGl_Material myMatFront;    //!< current front material state (cached to reduce GL context updates)
 688   OpenGl_Material myMatBack;     //!< current back  material state
 689   OpenGl_Material myMatTmp;      //!< temporary variable
 690   TelCullMode     myCullingMode; //!< back face culling mode, applied from face aspect
 691
 692   OpenGl_Matrix myModelViewMatrix; //!< Model matrix with applied structure transformations
 693
 694   TEL_POFFSET_PARAM PolygonOffset_applied; //!< Currently applied polygon offset.
 695
 696   OpenGl_AspectFace myAspectFaceHl; //!< Hiddenline aspect
 697
 698 public: //! @name type definition
 699
 700   DEFINE_STANDARD_RTTI(OpenGl_Workspace)
 701   DEFINE_STANDARD_ALLOC
 702
 703 };
 704
 705 #endif // _OpenGl_Workspace_Header