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 raytracing 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   void UseTransparency (const Standard_Boolean theFlag);
 188   Standard_Boolean& UseZBuffer()   { return myUseZBuffer; }
 189   Standard_Boolean& UseDepthTest() { return myUseDepthTest; }
 190   Standard_Boolean& UseGLLight()   { return myUseGLLight; }
 191
 192   Standard_Integer AntiAliasingMode() const { return myAntiAliasingMode; }
 193
 194   //// RELATED TO STATUS ////
 195
 196   Standard_Integer   NamedStatus;
 197
 198   const TEL_COLOUR* HighlightColor;
 199
 200   const OpenGl_Matrix* SetViewMatrix (const OpenGl_Matrix* );
 201   const OpenGl_Matrix* SetStructureMatrix (const OpenGl_Matrix*, bool aRevert = false);
 202
 203   //! Updates current model-view matrix
 204   //! replacing it with StructureMatrixT*ViewMatrix from the workspace.
 205   const void UpdateModelViewMatrix();
 206
 207   const OpenGl_AspectLine*   SetAspectLine   (const OpenGl_AspectLine*   theAspect);
 208   const OpenGl_AspectFace*   SetAspectFace   (const OpenGl_AspectFace*   theAspect);
 209   const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
 210   const OpenGl_AspectText*   SetAspectText   (const OpenGl_AspectText*   theAspect);
 211
 212   void SetTextParam (const OpenGl_TextParam* theParam) { TextParam_set = theParam; }
 213
 214   //// THESE METHODS ARE EXPORTED AS THEY PROVIDE STATE INFO TO USERDRAW
 215   Standard_EXPORT const OpenGl_AspectLine*   AspectLine   (const Standard_Boolean theWithApply);
 216   Standard_EXPORT const OpenGl_AspectFace*   AspectFace   (const Standard_Boolean theWithApply);
 217   Standard_EXPORT const OpenGl_AspectMarker* AspectMarker (const Standard_Boolean theWithApply);
 218   Standard_EXPORT const OpenGl_AspectText*   AspectText   (const Standard_Boolean theWithApply);
 219   inline const OpenGl_TextParam* AspectTextParams() const
 220   {
 221     return TextParam_applied;
 222   }
 223
 224   //! Clear the applied aspect state.
 225   void ResetAppliedAspect();
 226
 227   Standard_EXPORT Handle(OpenGl_Texture) DisableTexture();
 228   Standard_EXPORT Handle(OpenGl_Texture) EnableTexture (const Handle(OpenGl_Texture)&          theTexture,
 229                                                         const Handle(Graphic3d_TextureParams)& theParams = NULL);
 230
 231   //! Set filter for restricting rendering of particular elements.
 232   //! Filter can be applied for rendering passes used by recursive
 233   //! rendering algorithms for rendering elements of groups.
 234   //! @param theFilter [in] the filter instance.
 235   inline void SetRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
 236   {
 237     myRenderFilter = theFilter;
 238   }
 239
 240   //! Get rendering filter.
 241   //! @return filter instance.
 242   inline const Handle(OpenGl_RenderFilter)& GetRenderFilter() const
 243   {
 244     return myRenderFilter;
 245   }
 246
 247   //! @return applied view matrix.
 248   inline const OpenGl_Matrix* ViewMatrix() const { return ViewMatrix_applied; }
 249
 250   //! @return applied model structure matrix.
 251   inline const OpenGl_Matrix* ModelMatrix() const { return StructureMatrix_applied; }
 252
 253   //! Sets and applies current polygon offset.
 254   void SetPolygonOffset (int theMode, Standard_ShortReal theFactor, Standard_ShortReal theUnits);
 255
 256   //! Returns currently applied polygon offset params.
 257   const TEL_POFFSET_PARAM& AppliedPolygonOffset() { return PolygonOffset_applied; }
 258
 259   //! @return true if clipping algorithm enabled
 260   inline Standard_Boolean IsCullingEnabled() const { return myIsCullingEnabled; }
 261
 262   //! Returns a flag whether to redraw the scene using OpenGL rasterization
 263   Standard_Boolean ToRedrawGL() const { return myToRedrawGL; }
 264
 265 protected:
 266
 267   //! Copy content of Back buffer to the Front buffer
 268   void copyBackToFront();
 269
 270   virtual Standard_Boolean Activate();
 271
 272   void redraw1 (const Graphic3d_CView& theCView,
 273                 const Aspect_CLayer2d& theCUnderLayer,
 274                 const Aspect_CLayer2d& theCOverLayer,
 275                 const int              theToSwap);
 276
 277   void updateMaterial (const int theFlag);
 278
 279   void setTextureParams (Handle(OpenGl_Texture)&                theTexture,
 280                          const Handle(Graphic3d_TextureParams)& theParams);
 281
 282 protected:
 283
 284   //! Result of OpenGL shaders initialization.
 285   enum RaytraceInitStatus
 286   {
 287     OpenGl_RT_NONE,
 288     OpenGl_RT_INIT,
 289     OpenGl_RT_FAIL
 290   };
 291
 292   //! Describes update mode (state).
 293   enum GeomUpdateMode
 294   {
 295     OpenGl_GUM_CHECK,   //!< check if geometry update is necessary
 296     OpenGl_GUM_PREPARE, //!< collect unchanged objects
 297     OpenGl_GUM_UPDATE   //!< update raytracing data, rebuild changed objects
 298   };
 299
 300   //! Defines frequently used shader variables.
 301   enum ShaderVariableIndex
 302   {
 303     OpenGl_RT_aPosition,
 304
 305     OpenGl_RT_uOriginLT,
 306     OpenGl_RT_uOriginLB,
 307     OpenGl_RT_uOriginRT,
 308     OpenGl_RT_uOriginRB,
 309
 310     OpenGl_RT_uDirectLT,
 311     OpenGl_RT_uDirectLB,
 312     OpenGl_RT_uDirectRT,
 313     OpenGl_RT_uDirectRB,
 314     OpenGl_RT_uInvModelProj,
 315
 316     OpenGl_RT_uSceneRad,
 317     OpenGl_RT_uSceneEps,
 318
 319     OpenGl_RT_uLightAmbnt,
 320     OpenGl_RT_uLightCount,
 321
 322     OpenGl_RT_uShadEnabled,
 323     OpenGl_RT_uReflEnabled,
 324
 325     OpenGl_RT_uInputTexture,
 326
 327     OpenGl_RT_uOffsetX,
 328     OpenGl_RT_uOffsetY,
 329     OpenGl_RT_uSamples,
 330
 331     OpenGl_RT_uEnvironmentEnable,
 332
 333     OpenGl_RT_NbVariables // special field
 334   };
 335
 336   //! Defines texture samplers.
 337   enum ShaderSamplerNames
 338   {
 339     OpenGl_RT_SceneNodeInfoTexture = 0,
 340     OpenGl_RT_SceneMinPointTexture = 1,
 341     OpenGl_RT_SceneMaxPointTexture = 2,
 342
 343     OpenGl_RT_ObjectNodeInfoTexture = 3,
 344     OpenGl_RT_ObjectMinPointTexture = 4,
 345     OpenGl_RT_ObjectMaxPointTexture = 5,
 346
 347     OpenGl_RT_GeometryVertexTexture = 6,
 348     OpenGl_RT_GeometryNormalTexture = 7,
 349     OpenGl_RT_GeometryTriangTexture = 8,
 350
 351     OpenGl_RT_EnvironmentMapTexture = 9,
 352
 353     OpenGl_RT_RaytraceMaterialTexture = 10,
 354     OpenGl_RT_RaytraceLightSrcTexture = 11,
 355
 356     OpenGl_RT_FSAAInputTexture = 12,
 357
 358     OpenGl_RT_SceneTransformTexture = 13,
 359
 360     OpenGl_RT_OpenGlColorTexture = 14,
 361     OpenGl_RT_OpenGlDepthTexture = 15
 362   };
 363
 364   //! Tool class for management of shader sources.
 365   class ShaderSource
 366   {
 367   public:
 368
 369     //! Creates new uninitialized shader source.
 370     ShaderSource()
 371     {
 372       //
 373     }
 374
 375     //! Creates new shader source from specified file.
 376     ShaderSource (const TCollection_AsciiString& theFileName)
 377     {
 378       Load (&theFileName, 1);
 379     }
 380
 381   public:
 382
 383     //! Returns prefix to insert before the source.
 384     const TCollection_AsciiString& Prefix() const
 385     {
 386       return myPrefix;
 387     }
 388
 389     //! Sets prefix to insert before the source.
 390     void SetPrefix (const TCollection_AsciiString& thePrefix)
 391     {
 392       myPrefix = thePrefix;
 393     }
 394
 395     //! Returns shader source combined with prefix.
 396     TCollection_AsciiString Source() const;
 397
 398     //! Loads shader source from specified files.
 399     void Load (const TCollection_AsciiString* theFileNames, const Standard_Integer theCount);
 400
 401   private:
 402
 403     TCollection_AsciiString mySource; //!< Source string of the shader object
 404     TCollection_AsciiString myPrefix; //!< Prefix to insert before the source
 405
 406   };
 407
 408   //! Default ray-tracing depth.
 409   static const Standard_Integer THE_DEFAULT_RAY_DEPTH = 3;
 410
 411   //! Default size of traversal stack.
 412   static const Standard_Integer THE_DEFAULT_STACK_SIZE = 24;
 413
 414   //! Compile-time ray-tracing parameters.
 415   struct RaytracingParams
 416   {
 417     //! Actual size of traversal stack in shader program.
 418     Standard_Integer StackSize;
 419
 420     //! Actual ray-tracing depth (number of ray bounces).
 421     Standard_Integer TraceDepth;
 422
 423     //! Sets light propagation through transparent media.
 424     Standard_Boolean TransparentShadows;
 425
 426     //! Creates default compile-time ray-tracing parameters.
 427     RaytracingParams()
 428     : StackSize (THE_DEFAULT_STACK_SIZE),
 429       TraceDepth (THE_DEFAULT_RAY_DEPTH),
 430       TransparentShadows (Standard_False)
 431     {
 432       //
 433     }
 434   };
 435
 436 protected: //! @name methods related to ray-tracing
 437
 438   //! Updates 3D scene geometry for ray-tracing.
 439   Standard_Boolean UpdateRaytraceGeometry (GeomUpdateMode theMode);
 440
 441   //! Checks to see if the structure is modified.
 442   Standard_Boolean CheckRaytraceStructure (const OpenGl_Structure* theStructure);
 443
 444   //! Updates 3D scene light sources for ray-tracing.
 445   Standard_Boolean UpdateRaytraceLightSources (const GLdouble theInvModelView[16]);
 446
 447   //! Updates environment map for ray-tracing.
 448   Standard_Boolean UpdateRaytraceEnvironmentMap();
 449
 450   //! Adds OpenGL structure to ray-traced scene geometry.
 451   Standard_Boolean AddRaytraceStructure (const OpenGl_Structure* theStructure, std::set<const OpenGl_Structure*>& theElements);
 452
 453   //! Adds OpenGL groups to ray-traced scene geometry.
 454   Standard_Boolean AddRaytraceGroups (const OpenGl_Structure*   theStructure,
 455                                       const Standard_Integer    theStructMatId,
 456                                       const Standard_ShortReal* theTransform);
 457
 458   //! Adds OpenGL primitive array to ray-traced scene geometry.
 459   OpenGl_TriangleSet* AddRaytracePrimitiveArray (
 460     const OpenGl_PrimitiveArray* theArray, int theMatID, const Standard_ShortReal* theTrans);
 461
 462   //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
 463   Standard_Boolean AddRaytraceVertexIndices (OpenGl_TriangleSet&          theSet,
 464                                              const OpenGl_PrimitiveArray& theArray,
 465                                              Standard_Integer             theOffset,
 466                                              Standard_Integer             theCount,
 467                                              Standard_Integer             theMatID);
 468
 469   //! Adds OpenGL triangle array to ray-traced scene geometry.
 470   Standard_Boolean AddRaytraceTriangleArray (OpenGl_TriangleSet&                  theSet,
 471                                              const Handle(Graphic3d_IndexBuffer)& theIndices,
 472                                              Standard_Integer                     theOffset,
 473                                              Standard_Integer                     theCount,
 474                                              Standard_Integer                     theMatID);
 475
 476   //! Adds OpenGL triangle fan array to ray-traced scene geometry.
 477   Standard_Boolean AddRaytraceTriangleFanArray (OpenGl_TriangleSet&                  theSet,
 478                                                 const Handle(Graphic3d_IndexBuffer)& theIndices,
 479                                                 Standard_Integer                     theOffset,
 480                                                 Standard_Integer                     theCount,
 481                                                 Standard_Integer                     theMatID);
 482
 483   //! Adds OpenGL triangle strip array to ray-traced scene geometry.
 484   Standard_Boolean AddRaytraceTriangleStripArray (OpenGl_TriangleSet&                  theSet,
 485                                                   const Handle(Graphic3d_IndexBuffer)& theIndices,
 486                                                   Standard_Integer                     theOffset,
 487                                                   Standard_Integer                     theCount,
 488                                                   Standard_Integer                     theMatID);
 489
 490   //! Adds OpenGL quadrangle array to ray-traced scene geometry.
 491   Standard_Boolean AddRaytraceQuadrangleArray (OpenGl_TriangleSet&                  theSet,
 492                                                const Handle(Graphic3d_IndexBuffer)& theIndices,
 493                                                Standard_Integer                     theOffset,
 494                                                Standard_Integer                     theCount,
 495                                                Standard_Integer                     theMatID);
 496
 497   //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
 498   Standard_Boolean AddRaytraceQuadrangleStripArray (OpenGl_TriangleSet&                  theSet,
 499                                                     const Handle(Graphic3d_IndexBuffer)& theIndices,
 500                                                     Standard_Integer                     theOffset,
 501                                                     Standard_Integer                     theCount,
 502                                                     Standard_Integer                     theMatID);
 503
 504   //! Adds OpenGL polygon array to ray-traced scene geometry.
 505   Standard_Boolean AddRaytracePolygonArray (OpenGl_TriangleSet&                  theSet,
 506                                             const Handle(Graphic3d_IndexBuffer)& theIndices,
 507                                             Standard_Integer                     theOffset,
 508                                             Standard_Integer                     theCount,
 509                                             Standard_Integer                     theMatID);
 510
 511   //! Loads and compiles shader object from specified source.
 512   Handle(OpenGl_ShaderObject) LoadShader (const ShaderSource& theSource, GLenum theType);
 513
 514   //! Performs safe exit when shaders initialization fails.
 515   Standard_Boolean SafeFailBack (const TCollection_ExtendedString& theMessage);
 516
 517   //! Initializes OpenGL/GLSL shader programs.
 518   Standard_Boolean InitRaytraceResources (const Graphic3d_CView& theCView);
 519
 520   //! Releases OpenGL/GLSL shader programs.
 521   void ReleaseRaytraceResources();
 522
 523   //! Uploads ray-trace data to the GPU.
 524   Standard_Boolean UploadRaytraceData();
 525
 526   //! Resizes OpenGL frame buffers.
 527   Standard_Boolean ResizeRaytraceBuffers (const Standard_Integer theSizeX,
 528                                           const Standard_Integer theSizeY);
 529
 530   //! Generates viewing rays for corners of screen quad.
 531   void UpdateCamera (const NCollection_Mat4<GLdouble>& theOrientation,
 532                      const NCollection_Mat4<GLdouble>& theViewMapping,
 533                      OpenGl_Vec3                       theOrigins[4],
 534                      OpenGl_Vec3                       theDirects[4],
 535                      NCollection_Mat4<GLdouble>&       theInvModelProj);
 536
 537   //! Runs ray-tracing shader programs.
 538   Standard_Boolean RunRaytraceShaders (const Graphic3d_CView& theCView,
 539                                        const Standard_Integer theSizeX,
 540                                        const Standard_Integer theSizeY,
 541                                        const OpenGl_Vec3      theOrigins[4],
 542                                        const OpenGl_Vec3      theDirects[4],
 543                                        const OpenGl_Matrix&   theInvModelProj,
 544                                        OpenGl_FrameBuffer*    theFrameBuffer);
 545
 546   //! Redraws the window using OpenGL/GLSL ray-tracing.
 547   Standard_Boolean Raytrace (const Graphic3d_CView& theCView,
 548                              const Standard_Integer theSizeX,
 549                              const Standard_Integer theSizeY,
 550                              const Standard_Boolean theToSwap,
 551                              const Aspect_CLayer2d& theCOverLayer,
 552                              const Aspect_CLayer2d& theCUnderLayer,
 553                              OpenGl_FrameBuffer*    theFrameBuffer);
 554
 555 protected: //! @name fields related to ray-tracing
 556
 557   //! Result of shaders initialization.
 558   RaytraceInitStatus myComputeInitStatus;
 559
 560   //! Is geometry data valid?
 561   Standard_Boolean myIsRaytraceDataValid;
 562
 563   //! 3D scene geometry data for ray-tracing.
 564   OpenGl_RaytraceGeometry myRaytraceGeometry;
 565
 566   //! Radius of bounding sphere of the scene.
 567   Standard_ShortReal myRaytraceSceneRadius;
 568   //! Scene epsilon to prevent self-intersections.
 569   Standard_ShortReal myRaytraceSceneEpsilon;
 570
 571   //! Compile-time ray-tracing parameters.
 572   RaytracingParams myRaytraceParameters;
 573
 574   //! OpenGL/GLSL source of ray-tracing fragment shader.
 575   ShaderSource myRaytraceShaderSource;
 576   //! OpenGL/GLSL source of adaptive-AA fragment shader.
 577   ShaderSource myPostFSAAShaderSource;
 578
 579   //! OpenGL/GLSL ray-tracing fragment shader.
 580   Handle(OpenGl_ShaderObject) myRaytraceShader;
 581   //! OpenGL/GLSL adaptive-AA fragment shader.
 582   Handle(OpenGl_ShaderObject) myPostFSAAShader;
 583
 584   //! OpenGL/GLSL ray-tracing shader program.
 585   Handle(OpenGl_ShaderProgram) myRaytraceProgram;
 586   //! OpenGL/GLSL adaptive-AA shader program.
 587   Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
 588
 589   //! Texture buffer of data records of high-level BVH nodes.
 590   Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
 591   //! Texture buffer of minimum points of high-level BVH nodes.
 592   Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
 593   //! Texture buffer of maximum points of high-level BVH nodes.
 594   Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
 595   //! Texture buffer of transformations of high-level BVH nodes.
 596   Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
 597
 598   //! Texture buffer of data records of bottom-level BVH nodes.
 599   Handle(OpenGl_TextureBufferArb) myObjectNodeInfoTexture;
 600   //! Texture buffer of minimum points of bottom-level BVH nodes.
 601   Handle(OpenGl_TextureBufferArb) myObjectMinPointTexture;
 602   //! Texture buffer of maximum points of bottom-level BVH nodes.
 603   Handle(OpenGl_TextureBufferArb) myObjectMaxPointTexture;
 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 triangle indices.
 610   Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
 611
 612   //! Texture buffer of material properties.
 613   Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
 614   //! Texture buffer of light source properties.
 615   Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
 616
 617   //! Vertex buffer (VBO) for drawing dummy quad.
 618   OpenGl_VertexBuffer myRaytraceScreenQuad;
 619
 620   //! Framebuffer (FBO) to perform adaptive FSAA.
 621   Handle(OpenGl_FrameBuffer) myRaytraceFBO1;
 622   //! Framebuffer (FBO) to perform adaptive FSAA.
 623   Handle(OpenGl_FrameBuffer) myRaytraceFBO2;
 624   //! Framebuffer (FBO) for pre-raytrace rendering by OpenGL.
 625   Handle(OpenGl_FrameBuffer) myOpenGlFBO;
 626
 627   //! State of OpenGL view.
 628   Standard_Size myViewModificationStatus;
 629   //! State of OpenGL layer list.
 630   Standard_Size myLayersModificationStatus;
 631
 632   //! State of OpenGL structures reflected to ray-tracing.
 633   std::map<const OpenGl_Structure*, Standard_Size> myStructureStates;
 634
 635   //! PrimitiveArray to TriangleSet map for scene partial update.
 636   std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
 637
 638   //! Cached locations of frequently used uniform variables.
 639   Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
 640
 641   //! Graphical raytracing filter to filter out all raytracable structures.
 642   Handle(OpenGl_RaytraceFilter) myRaytraceFilter;
 643
 644   //! Redraw the scene using OpenGL rasterization or raytracing?
 645   Standard_Boolean myToRedrawGL;
 646
 647 protected: //! @name protected fields
 648
 649   Handle(OpenGl_PrinterContext) myPrintContext;
 650   Handle(OpenGl_View)           myView;
 651   Handle(OpenGl_LineAttributes) myLineAttribs;
 652   Standard_Integer       myAntiAliasingMode;
 653   Standard_Boolean       myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
 654   Standard_Boolean       myBackBufferRestored;
 655   Standard_Boolean       myIsImmediateDrawn;     //!< flag indicates that immediate mode buffer contains some data
 656   Standard_Boolean       myUseTransparency;
 657   Standard_Boolean       myUseZBuffer;
 658   Standard_Boolean       myUseDepthTest;
 659   Standard_Boolean       myUseGLLight;
 660   Standard_Boolean       myIsCullingEnabled;     //!< frustum culling flag
 661
 662   unsigned int           myFrameCounter;         //!< redraw counter, for debugging
 663
 664 protected: //! @name fields related to status
 665
 666   Handle(OpenGl_RenderFilter) myRenderFilter;
 667   Handle(OpenGl_Texture) myTextureBound;    //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
 668   const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
 669   const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
 670   const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
 671   const OpenGl_AspectText *AspectText_set, *AspectText_applied;
 672
 673   const OpenGl_TextParam *TextParam_set, *TextParam_applied;
 674
 675   const OpenGl_Matrix* ViewMatrix_applied;
 676   const OpenGl_Matrix* StructureMatrix_applied;
 677
 678   OpenGl_Material myMatFront;    //!< current front material state (cached to reduce GL context updates)
 679   OpenGl_Material myMatBack;     //!< current back  material state
 680   OpenGl_Material myMatTmp;      //!< temporary variable
 681   TelCullMode     myCullingMode; //!< back face culling mode, applied from face aspect
 682
 683   OpenGl_Matrix myModelViewMatrix; //!< Model matrix with applied structure transformations
 684
 685   TEL_POFFSET_PARAM PolygonOffset_applied; //!< Currently applied polygon offset.
 686
 687   OpenGl_AspectFace myAspectFaceHl; //!< Hiddenline aspect
 688
 689 public: //! @name type definition
 690
 691   DEFINE_STANDARD_RTTI(OpenGl_Workspace)
 692   DEFINE_STANDARD_ALLOC
 693
 694 };
 695
 696 #endif // _OpenGl_Workspace_Header