d122e43e340198651dbb0ee74d7ece7240ef93d8
[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 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(Aspect_DisplayConnection)& theDisplayConnection,
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,
452     const Standard_ShortReal* theTransform, std::set<const OpenGl_Structure*>& theElements);
453
454   //! Adds OpenGL primitive array to ray-traced scene geometry.
455   OpenGl_TriangleSet* AddRaytracePrimitiveArray (
456     const OpenGl_PrimitiveArray* theArray, int theMatID, const Standard_ShortReal* theTrans);
457
458   //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
459   Standard_Boolean AddRaytraceVertexIndices (OpenGl_TriangleSet&          theSet,
460                                              const OpenGl_PrimitiveArray& theArray,
461                                              Standard_Integer             theOffset,
462                                              Standard_Integer             theCount,
463                                              Standard_Integer             theMatID);
464
465   //! Adds OpenGL triangle array to ray-traced scene geometry.
466   Standard_Boolean AddRaytraceTriangleArray (OpenGl_TriangleSet&                  theSet,
467                                              const Handle(Graphic3d_IndexBuffer)& theIndices,
468                                              Standard_Integer                     theOffset,
469                                              Standard_Integer                     theCount,
470                                              Standard_Integer                     theMatID);
471
472   //! Adds OpenGL triangle fan array to ray-traced scene geometry.
473   Standard_Boolean AddRaytraceTriangleFanArray (OpenGl_TriangleSet&                  theSet,
474                                                 const Handle(Graphic3d_IndexBuffer)& theIndices,
475                                                 Standard_Integer                     theOffset,
476                                                 Standard_Integer                     theCount,
477                                                 Standard_Integer                     theMatID);
478
479   //! Adds OpenGL triangle strip array to ray-traced scene geometry.
480   Standard_Boolean AddRaytraceTriangleStripArray (OpenGl_TriangleSet&                  theSet,
481                                                   const Handle(Graphic3d_IndexBuffer)& theIndices,
482                                                   Standard_Integer                     theOffset,
483                                                   Standard_Integer                     theCount,
484                                                   Standard_Integer                     theMatID);
485
486   //! Adds OpenGL quadrangle array to ray-traced scene geometry.
487   Standard_Boolean AddRaytraceQuadrangleArray (OpenGl_TriangleSet&                  theSet,
488                                                const Handle(Graphic3d_IndexBuffer)& theIndices,
489                                                Standard_Integer                     theOffset,
490                                                Standard_Integer                     theCount,
491                                                Standard_Integer                     theMatID);
492
493   //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
494   Standard_Boolean AddRaytraceQuadrangleStripArray (OpenGl_TriangleSet&                  theSet,
495                                                     const Handle(Graphic3d_IndexBuffer)& theIndices,
496                                                     Standard_Integer                     theOffset,
497                                                     Standard_Integer                     theCount,
498                                                     Standard_Integer                     theMatID);
499
500   //! Adds OpenGL polygon array to ray-traced scene geometry.
501   Standard_Boolean AddRaytracePolygonArray (OpenGl_TriangleSet&                  theSet,
502                                             const Handle(Graphic3d_IndexBuffer)& theIndices,
503                                             Standard_Integer                     theOffset,
504                                             Standard_Integer                     theCount,
505                                             Standard_Integer                     theMatID);
506
507   //! Loads and compiles shader object from specified source.
508   Handle(OpenGl_ShaderObject) LoadShader (const ShaderSource& theSource, GLenum theType);
509
510   //! Performs safe exit when shaders initialization fails.
511   Standard_Boolean SafeFailBack (const TCollection_ExtendedString& theMessage);
512
513   //! Initializes OpenGL/GLSL shader programs.
514   Standard_Boolean InitRaytraceResources (const Graphic3d_CView& theCView);
515
516   //! Releases OpenGL/GLSL shader programs.
517   void ReleaseRaytraceResources();
518
519   //! Uploads ray-trace data to the GPU.
520   Standard_Boolean UploadRaytraceData();
521
522   //! Resizes OpenGL frame buffers.
523   Standard_Boolean ResizeRaytraceBuffers (const Standard_Integer theSizeX,
524                                           const Standard_Integer theSizeY);
525
526   //! Generates viewing rays for corners of screen quad.
527   void UpdateCamera (const NCollection_Mat4<GLdouble>& theOrientation,
528                      const NCollection_Mat4<GLdouble>& theViewMapping,
529                      OpenGl_Vec3                       theOrigins[4],
530                      OpenGl_Vec3                       theDirects[4],
531                      NCollection_Mat4<GLdouble>&       theInvModelProj);
532
533   //! Runs ray-tracing shader programs.
534   Standard_Boolean RunRaytraceShaders (const Graphic3d_CView& theCView,
535                                        const Standard_Integer theSizeX,
536                                        const Standard_Integer theSizeY,
537                                        const OpenGl_Vec3      theOrigins[4],
538                                        const OpenGl_Vec3      theDirects[4],
539                                        const OpenGl_Matrix&   theInvModelProj,
540                                        OpenGl_FrameBuffer*    theFrameBuffer);
541
542   //! Redraws the window using OpenGL/GLSL ray-tracing.
543   Standard_Boolean Raytrace (const Graphic3d_CView& theCView,
544                              const Standard_Integer theSizeX,
545                              const Standard_Integer theSizeY,
546                              const Standard_Boolean theToSwap,
547                              const Aspect_CLayer2d& theCOverLayer,
548                              const Aspect_CLayer2d& theCUnderLayer,
549                              OpenGl_FrameBuffer*    theFrameBuffer);
550
551 protected: //! @name fields related to ray-tracing
552
553   //! Result of shaders initialization.
554   RaytraceInitStatus myComputeInitStatus;
555
556   //! Is geometry data valid?
557   Standard_Boolean myIsRaytraceDataValid;
558
559   //! 3D scene geometry data for ray-tracing.
560   OpenGl_RaytraceGeometry myRaytraceGeometry;
561
562   //! Radius of bounding sphere of the scene.
563   Standard_ShortReal myRaytraceSceneRadius;
564   //! Scene epsilon to prevent self-intersections.
565   Standard_ShortReal myRaytraceSceneEpsilon;
566
567   //! Compile-time ray-tracing parameters.
568   RaytracingParams myRaytraceParameters;
569
570   //! OpenGL/GLSL source of ray-tracing fragment shader.
571   ShaderSource myRaytraceShaderSource;
572   //! OpenGL/GLSL source of adaptive-AA fragment shader.
573   ShaderSource myPostFSAAShaderSource;
574
575   //! OpenGL/GLSL ray-tracing fragment shader.
576   Handle(OpenGl_ShaderObject) myRaytraceShader;
577   //! OpenGL/GLSL adaptive-AA fragment shader.
578   Handle(OpenGl_ShaderObject) myPostFSAAShader;
579
580   //! OpenGL/GLSL ray-tracing shader program.
581   Handle(OpenGl_ShaderProgram) myRaytraceProgram;
582   //! OpenGL/GLSL adaptive-AA shader program.
583   Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
584
585   //! Texture buffer of data records of high-level BVH nodes.
586   Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
587   //! Texture buffer of minimum points of high-level BVH nodes.
588   Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
589   //! Texture buffer of maximum points of high-level BVH nodes.
590   Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
591   //! Texture buffer of transformations of high-level BVH nodes.
592   Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
593
594   //! Texture buffer of data records of bottom-level BVH nodes.
595   Handle(OpenGl_TextureBufferArb) myObjectNodeInfoTexture;
596   //! Texture buffer of minimum points of bottom-level BVH nodes.
597   Handle(OpenGl_TextureBufferArb) myObjectMinPointTexture;
598   //! Texture buffer of maximum points of bottom-level BVH nodes.
599   Handle(OpenGl_TextureBufferArb) myObjectMaxPointTexture;
600
601   //! Texture buffer of vertex coords.
602   Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture;
603   //! Texture buffer of vertex normals.
604   Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture;
605   //! Texture buffer of triangle indices.
606   Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
607   
608   //! Texture buffer of material properties.
609   Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
610   //! Texture buffer of light source properties.
611   Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
612
613   //! Vertex buffer (VBO) for drawing dummy quad.
614   OpenGl_VertexBuffer myRaytraceScreenQuad;
615
616   //! Framebuffer (FBO) to perform adaptive FSAA.
617   Handle(OpenGl_FrameBuffer) myRaytraceFBO1;
618   //! Framebuffer (FBO) to perform adaptive FSAA.
619   Handle(OpenGl_FrameBuffer) myRaytraceFBO2;
620   //! Framebuffer (FBO) for pre-raytrace rendering by OpenGL.
621   Handle(OpenGl_FrameBuffer) myOpenGlFBO;
622
623   //! State of OpenGL view.
624   Standard_Size myViewModificationStatus;
625   //! State of OpenGL layer list.
626   Standard_Size myLayersModificationStatus;
627
628   //! State of OpenGL structures reflected to ray-tracing.
629   std::map<const OpenGl_Structure*, Standard_Size> myStructureStates;
630
631   //! PrimitiveArray to TriangleSet map for scene partial update.
632   std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
633
634   //! Cached locations of frequently used uniform variables.
635   Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
636
637   //! Graphical raytracing filter to filter out all raytracable structures.
638   Handle(OpenGl_RaytraceFilter) myRaytraceFilter;
639
640   //! Redraw the scene using OpenGL rasterization or raytracing?
641   Standard_Boolean myToRedrawGL;
642
643 protected: //! @name protected fields
644
645   Handle(OpenGl_PrinterContext) myPrintContext;
646   Handle(OpenGl_View)           myView;
647   Handle(OpenGl_LineAttributes) myLineAttribs;
648   Standard_Integer       myAntiAliasingMode;
649   Standard_Boolean       myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
650   Standard_Boolean       myBackBufferRestored;
651   Standard_Boolean       myIsImmediateDrawn;     //!< flag indicates that immediate mode buffer contains some data
652   Standard_Boolean       myUseTransparency;
653   Standard_Boolean       myUseZBuffer;
654   Standard_Boolean       myUseDepthTest;
655   Standard_Boolean       myUseGLLight;
656   Standard_Boolean       myIsCullingEnabled;     //!< frustum culling flag
657
658   unsigned int           myFrameCounter;         //!< redraw counter, for debugging
659
660 protected: //! @name fields related to status
661
662   Handle(OpenGl_RenderFilter) myRenderFilter;
663   Handle(OpenGl_Texture) myTextureBound;    //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
664   const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
665   const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
666   const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
667   const OpenGl_AspectText *AspectText_set, *AspectText_applied;
668
669   const OpenGl_TextParam *TextParam_set, *TextParam_applied;
670
671   const OpenGl_Matrix* ViewMatrix_applied;
672   const OpenGl_Matrix* StructureMatrix_applied;
673
674   OpenGl_Material myMatFront;    //!< current front material state (cached to reduce GL context updates)
675   OpenGl_Material myMatBack;     //!< current back  material state
676   OpenGl_Material myMatTmp;      //!< temporary variable
677   TelCullMode     myCullingMode; //!< back face culling mode, applied from face aspect
678
679   OpenGl_Matrix myModelViewMatrix; //!< Model matrix with applied structure transformations
680
681   TEL_POFFSET_PARAM PolygonOffset_applied; //!< Currently applied polygon offset.
682
683   OpenGl_AspectFace myAspectFaceHl; //!< Hiddenline aspect
684
685 public: //! @name type definition
686
687   DEFINE_STANDARD_RTTI(OpenGl_Workspace)
688   DEFINE_STANDARD_ALLOC
689
690 };
691
692 #endif // _OpenGl_Workspace_Header