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