0025964: Visualization, TKOpenGl - compile RayTracing shader without texturing when...
[occt.git] / src / OpenGl / OpenGl_View.hxx
1 // Created on: 2011-09-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 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_View_Header
17 #define _OpenGl_View_Header
18
19 #include <MMgt_TShared.hxx>
20 #include <Standard_DefineHandle.hxx>
21
22 #include <TColStd_Array2OfReal.hxx>
23 #include <NCollection_List.hxx>
24
25 #include <Quantity_NameOfColor.hxx>
26 #include <Aspect_FillMethod.hxx>
27 #include <Aspect_GradientFillMethod.hxx>
28 #include <Aspect_TypeOfTriedronPosition.hxx>
29 #include <Aspect_CLayer2d.hxx>
30
31 #include <InterfaceGraphic_Graphic3d.hxx>
32 #include <InterfaceGraphic_Visual3d.hxx>
33
34 #include <Graphic3d_CView.hxx>
35 #include <Graphic3d_GraduatedTrihedron.hxx>
36 #include <Graphic3d_SequenceOfHClipPlane.hxx>
37 #include <Graphic3d_ZLayerSettings.hxx>
38 #include <Visual3d_TypeOfSurfaceDetail.hxx>
39 #include <Visual3d_TypeOfModel.hxx>
40
41 #include <OpenGl_AspectFace.hxx>
42 #include <OpenGl_BackgroundArray.hxx>
43 #include <OpenGl_BVHTreeSelector.hxx>
44 #include <OpenGl_LayerList.hxx>
45 #include <OpenGl_Light.hxx>
46 #include <OpenGl_LineAttributes.hxx>
47 #include <OpenGl_Trihedron.hxx>
48 #include <OpenGl_GraduatedTrihedron.hxx>
49
50 #include <Handle_OpenGl_Context.hxx>
51 #include <Handle_OpenGl_GraphicDriver.hxx>
52 #include <Handle_OpenGl_Workspace.hxx>
53 #include <Handle_OpenGl_View.hxx>
54 #include <Handle_OpenGl_Texture.hxx>
55
56 struct OPENGL_ZCLIP
57 {
58   struct {
59     Standard_Boolean   IsOn;
60     Standard_ShortReal Limit; /* in the range [0., 1.] */
61   } Back;
62   struct {
63     Standard_Boolean   IsOn;
64     Standard_ShortReal Limit; /* in the range [0., 1.] */
65   } Front;
66 };
67
68 struct OPENGL_FOG
69 {
70   Standard_Boolean   IsOn;
71   Standard_ShortReal Front; /* in the range [0., 1.] */
72   Standard_ShortReal Back; /* in the range [0., 1.] */
73   TEL_COLOUR         Color;
74 };
75
76 struct OpenGl_Matrix;
77 class OpenGl_Structure;
78 class Handle(OpenGl_PrinterContext);
79 class OpenGl_StateCounter;
80
81 class OpenGl_View : public MMgt_TShared
82 {
83  public:
84   OpenGl_View (const CALL_DEF_VIEWCONTEXT &AContext, OpenGl_StateCounter* theCounter);
85   virtual ~OpenGl_View ();
86
87   void ReleaseGlResources (const Handle(OpenGl_Context)& theCtx);
88
89   void SetTextureEnv (const Handle(OpenGl_Context)&       theCtx,
90                       const Handle(Graphic3d_TextureEnv)& theTexture);
91   void SetSurfaceDetail (const Visual3d_TypeOfSurfaceDetail AMode);
92   void SetBackfacing (const Standard_Integer AMode);
93   void SetLights (const CALL_DEF_VIEWCONTEXT &AContext);
94   void SetAntiAliasing (const Standard_Boolean AMode) { myAntiAliasing = AMode; }
95   void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane &thePlanes) { myClipPlanes = thePlanes; }
96   void SetVisualisation (const CALL_DEF_VIEWCONTEXT &AContext);
97
98   const Handle(Graphic3d_Camera)& Camera() { return myCamera; }
99   void SetCamera (const Handle(Graphic3d_Camera)& theCamera) { myCamera = theCamera; }
100
101   void SetClipLimit (const Graphic3d_CView& theCView);
102
103   void SetFog (const Graphic3d_CView& theCView, const Standard_Boolean theFlag);
104
105   OpenGl_Trihedron& ChangeTrihedron() { return myTrihedron; }
106   void TriedronDisplay (const Aspect_TypeOfTriedronPosition thePosition,
107                         const Quantity_NameOfColor          theColor,
108                         const Standard_Real                 theScale,
109                         const Standard_Boolean              theAsWireframe);
110   void TriedronErase (const Handle(OpenGl_Context)& theCtx);
111
112   OpenGl_GraduatedTrihedron& ChangeGraduatedTrihedron() { return myGraduatedTrihedron; }
113   void GraduatedTrihedronDisplay (const Handle(OpenGl_Context)&        theCtx,
114                                   const Graphic3d_GraduatedTrihedron& theCubic);
115   void GraduatedTrihedronErase (const Handle(OpenGl_Context)& theCtx);
116
117   Standard_Real Height () const { return myCamera->ViewDimensions().X(); }
118   Standard_Real Width () const { return myCamera->ViewDimensions().Y(); }
119
120   Standard_Integer Backfacing () const { return myBackfacing; }
121
122   const TEL_TRANSFORM_PERSISTENCE * BeginTransformPersistence (const Handle(OpenGl_Context)& theCtx,
123                                                                const TEL_TRANSFORM_PERSISTENCE *theTransPers);
124   void EndTransformPersistence (const Handle(OpenGl_Context)& theCtx);
125
126   //! Add structure to display list with specified priority.
127   //! The structure will be added to associated with it z layer.
128   //! If the z layer is not presented in the view, the structure will
129   //! be displayed in default bottom-level z layer.
130   void DisplayStructure (const Handle(Graphic3d_Structure)& theStructure,
131                          const Standard_Integer             thePriority);
132
133   //! Erase structure from display list.
134   void EraseStructure (const Handle(Graphic3d_Structure)& theStructure);
135
136   //! Add structure to the list of immediate structures.
137   void DisplayImmediateStructure (const Handle(Graphic3d_Structure)& theStructure);
138
139   //! Erase structure from display list.
140   void EraseImmediateStructure (const OpenGl_Structure* theStructure);
141
142   //! Insert a new top-level z layer with ID <theLayerId>
143   void AddZLayer (const Graphic3d_ZLayerId theLayerId);
144
145   //! Remove a z layer with ID <theLayerId>
146   void RemoveZLayer (const Graphic3d_ZLayerId theLayerId);
147
148   //! Display structure in z layer with ID <theNewLayerId>
149   //! If the layer with ID <theNewLayerId> is not presented in the view,
150   //! the structure will be displayed in default bottom-level layer.
151   void ChangeZLayer (const OpenGl_Structure*  theStructure,
152                      const Graphic3d_ZLayerId theNewLayerId);
153
154   //! Sets the settings for a single Z layer of specified view.
155   void SetZLayerSettings (const Graphic3d_ZLayerId        theLayerId,
156                           const Graphic3d_ZLayerSettings& theSettings);
157
158   //! Changes the priority of a structure within its ZLayer
159   void ChangePriority (const OpenGl_Structure* theStructure,
160                        const Standard_Integer  theNewPriority);
161
162   void CreateBackgroundTexture (const Standard_CString AFileName,
163                                 const Aspect_FillMethod AFillStyle);
164
165   void SetBackgroundTextureStyle (const Aspect_FillMethod FillStyle);
166   void SetBackgroundGradient (const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AType);
167   void SetBackgroundGradientType (const Aspect_GradientFillMethod AType);
168
169   void Render (const Handle(OpenGl_PrinterContext)& thePrintContext,
170                const Handle(OpenGl_Workspace)&      theWorkspace,
171                const Graphic3d_CView&               theCView,
172                const Aspect_CLayer2d&               theCUnderLayer,
173                const Aspect_CLayer2d&               theCOverLayer,
174                const Standard_Boolean               theToDrawImmediate);
175
176
177   void DrawBackground (const Handle(OpenGl_Workspace)& theWorkspace);
178
179   //! Returns list of OpenGL Z-layers.
180   const OpenGl_LayerList& LayerList() const { return myZLayers; }
181
182   //! Returns list of openGL light sources.
183   const OpenGl_ListOfLight& LightList() const { return myLights; }
184
185   //! Returns OpenGL environment map.
186   const Handle(OpenGl_Texture)& TextureEnv() const { return myTextureEnv; }
187
188   //! Returns visualization mode for objects in the view.
189   Visual3d_TypeOfSurfaceDetail SurfaceDetail() const { return mySurfaceDetail; }
190
191   //! Returns selector for BVH tree, providing a possibility to store information
192   //! about current view volume and to detect which objects are overlapping it.
193   OpenGl_BVHTreeSelector& BVHTreeSelector() { return myBVHSelector; }
194
195   //! Marks BVH tree for given priority list as dirty and
196   //! marks primitive set for rebuild.
197   void InvalidateBVHData (const Standard_Integer theLayerId);
198
199   //! Returns view-mapping and orientation matrices.
200   void GetMatrices (OpenGl_Mat4& theOrientation,
201                     OpenGl_Mat4& theViewMapping) const;
202
203   //! Returns list of immediate structures rendered on top of main presentation
204   const OpenGl_SequenceOfStructure& ImmediateStructures() const
205   {
206     return myImmediateList;
207   }
208
209   //! Returns true if there are immediate structures to display
210   bool HasImmediateStructures() const
211   {
212     return !myImmediateList.IsEmpty()
213          || myZLayers.NbImmediateStructures() != 0;
214   }
215
216 protected:
217
218   void RenderStructs (const Handle(OpenGl_Workspace)& theWorkspace,
219                       const Graphic3d_CView&          theCView,
220                       const Standard_Boolean          theToDrawImmediate);
221
222   void RedrawLayer2d (const Handle(OpenGl_PrinterContext)& thePrintContext,
223                       const Handle(OpenGl_Workspace)&      theWorkspace,
224                       const Graphic3d_CView&               theCView,
225                       const Aspect_CLayer2d&               theCLayer);
226
227   void RedrawTrihedron (const Handle(OpenGl_Workspace) &theWorkspace);
228
229   //! Redraw contents of model scene: clipping planes,
230   //! lights, structures. The peculiar properties of "scene" is that
231   //! it requires empty Z-Buffer and uses projection and orientation
232   //! matrices supplied by 3d view.
233   void RedrawScene (const Handle(OpenGl_PrinterContext)& thePrintContext,
234                     const Handle(OpenGl_Workspace)&      theWorkspace,
235                     const Graphic3d_CView&               theCView,
236                     const Standard_Boolean               theToDrawImmediate);
237
238   Handle(OpenGl_LineAttributes) myLineAttribs;
239   Handle(OpenGl_Texture)        myTextureEnv;
240   Visual3d_TypeOfSurfaceDetail  mySurfaceDetail;
241   Standard_Integer              myBackfacing;
242
243   OPENGL_ZCLIP   myZClip;
244
245   Graphic3d_SequenceOfHClipPlane myClipPlanes;
246   
247   Handle(Graphic3d_Camera) myCamera;
248
249   OPENGL_FOG myFog;
250   OpenGl_Trihedron           myTrihedron;
251   OpenGl_GraduatedTrihedron  myGraduatedTrihedron;
252   bool                       myToShowTrihedron;
253   bool                       myToShowGradTrihedron;
254
255   //View_LABViewContext
256   int myVisualization;
257   Visual3d_TypeOfModel       myShadingModel;  //!< lighting shading model
258
259   //View_LABLight
260   OpenGl_ListOfLight myLights;
261
262   //View_LABPlane
263   //View_LABAliasing
264   Standard_Boolean myAntiAliasing;
265
266   //View_LABDepthCueing - fixed index used
267
268   OpenGl_LayerList           myZLayers;       //!< main list of displayed structure, sorted by layers
269   OpenGl_SequenceOfStructure myImmediateList; //!< list of immediate structures rendered on top of main presentation
270
271   const TEL_TRANSFORM_PERSISTENCE *myTransPers;
272   Standard_Boolean myIsTransPers;
273
274   //! Modification state
275   Standard_Size myProjectionState;
276   Standard_Size myModelViewState;
277   OpenGl_StateCounter* myStateCounter;
278
279   Standard_Size myCurrLightSourceState;
280
281   typedef std::pair<Standard_Size, Standard_Size> StateInfo;
282
283   StateInfo myLastOrientationState;
284   StateInfo myLastViewMappingState;
285   StateInfo myLastLightSourceState;
286
287   //! Is needed for selection of overlapping objects and storage of the current view volume
288   OpenGl_BVHTreeSelector myBVHSelector;
289
290 protected: //! @name Background parameters
291
292   OpenGl_AspectFace*      myTextureParams;   //!< Stores texture and its parameters for textured background
293   OpenGl_BackgroundArray* myBgGradientArray; //!< Primitive array for gradient background
294   OpenGl_BackgroundArray* myBgTextureArray;  //!< Primitive array for texture  background
295
296 protected: //! @name data types related to ray-tracing
297
298   //! Result of OpenGL shaders initialization.
299   enum RaytraceInitStatus
300   {
301     OpenGl_RT_NONE,
302     OpenGl_RT_INIT,
303     OpenGl_RT_FAIL
304   };
305
306   //! Describes update mode (state).
307   enum RaytraceUpdateMode
308   {
309     OpenGl_GUM_CHECK,   //!< check geometry state
310     OpenGl_GUM_PREPARE, //!< collect unchanged objects
311     OpenGl_GUM_REBUILD  //!< rebuild changed and new objects
312   };
313
314   //! Defines frequently used shader variables.
315   enum ShaderVariableIndex
316   {
317     OpenGl_RT_aPosition,
318
319     OpenGl_RT_uOriginLT,
320     OpenGl_RT_uOriginLB,
321     OpenGl_RT_uOriginRT,
322     OpenGl_RT_uOriginRB,
323     OpenGl_RT_uDirectLT,
324     OpenGl_RT_uDirectLB,
325     OpenGl_RT_uDirectRT,
326     OpenGl_RT_uDirectRB,
327     OpenGl_RT_uUnviewMat,
328
329     OpenGl_RT_uSceneRad,
330     OpenGl_RT_uSceneEps,
331     OpenGl_RT_uLightAmbnt,
332     OpenGl_RT_uLightCount,
333
334     OpenGl_RT_uShadEnabled,
335     OpenGl_RT_uReflEnabled,
336     OpenGl_RT_uEnvMapEnable,
337
338     OpenGl_RT_uOffsetX,
339     OpenGl_RT_uOffsetY,
340     OpenGl_RT_uSamples,
341     OpenGl_RT_uWinSizeX,
342     OpenGl_RT_uWinSizeY,
343
344     OpenGl_RT_uTextures,
345
346     OpenGl_RT_NbVariables // special field
347   };
348
349   //! Defines texture samplers.
350   enum ShaderSamplerNames
351   {
352     OpenGl_RT_SceneNodeInfoTexture  = 0,
353     OpenGl_RT_SceneMinPointTexture  = 1,
354     OpenGl_RT_SceneMaxPointTexture  = 2,
355     OpenGl_RT_SceneTransformTexture = 3,
356
357     OpenGl_RT_GeometryVertexTexture = 4,
358     OpenGl_RT_GeometryNormalTexture = 5,
359     OpenGl_RT_GeometryTexCrdTexture = 6,
360     OpenGl_RT_GeometryTriangTexture = 7,
361
362     OpenGl_RT_EnvironmentMapTexture = 8,
363
364     OpenGl_RT_RaytraceMaterialTexture = 9,
365     OpenGl_RT_RaytraceLightSrcTexture = 10,
366
367     OpenGl_RT_FSAAInputTexture = 11,
368
369     OpenGl_RT_OpenGlColorTexture = 12,
370     OpenGl_RT_OpenGlDepthTexture = 13
371   };
372
373   //! Tool class for management of shader sources.
374   class ShaderSource
375   {
376   public:
377
378     //! Creates new uninitialized shader source.
379     ShaderSource()
380     {
381       //
382     }
383
384     //! Creates new shader source from specified file.
385     ShaderSource (const TCollection_AsciiString& theFileName)
386     {
387       Load (&theFileName, 1);
388     }
389
390   public:
391
392     //! Returns prefix to insert before the source.
393     const TCollection_AsciiString& Prefix() const
394     {
395       return myPrefix;
396     }
397
398     //! Sets prefix to insert before the source.
399     void SetPrefix (const TCollection_AsciiString& thePrefix)
400     {
401       myPrefix = thePrefix;
402     }
403
404     //! Returns shader source combined with prefix.
405     TCollection_AsciiString Source() const;
406
407     //! Loads shader source from specified files.
408     void Load (const TCollection_AsciiString* theFileNames, const Standard_Integer theCount);
409
410   private:
411
412     TCollection_AsciiString mySource; //!< Source string of the shader object
413     TCollection_AsciiString myPrefix; //!< Prefix to insert before the source
414
415   };
416
417   //! Default ray-tracing depth.
418   static const Standard_Integer THE_DEFAULT_NB_BOUNCES = 3;
419
420   //! Default size of traversal stack.
421   static const Standard_Integer THE_DEFAULT_STACK_SIZE = 24;
422
423   //! Compile-time ray-tracing parameters.
424   struct RaytracingParams
425   {
426     //! Actual size of traversal stack in shader program.
427     Standard_Integer StackSize;
428
429     //! Actual ray-tracing depth (number of ray bounces).
430     Standard_Integer NbBounces;
431
432     //! Enables/disables light propagation through transparent media.
433     Standard_Boolean TransparentShadows;
434
435     //! Enables/disables the use of OpenGL bindless textures.
436     Standard_Boolean UseBindlessTextures;
437
438     //! Creates default compile-time ray-tracing parameters.
439     RaytracingParams()
440     : StackSize (THE_DEFAULT_STACK_SIZE),
441       NbBounces (THE_DEFAULT_NB_BOUNCES),
442       TransparentShadows (Standard_False),
443       UseBindlessTextures (Standard_False)
444     {
445       //
446     }
447   };
448
449 protected: //! @name methods related to ray-tracing
450
451   //! Updates 3D scene geometry for ray-tracing.
452   Standard_Boolean updateRaytraceGeometry (const RaytraceUpdateMode      theMode,
453                                            const Standard_Integer        theViewId,
454                                            const Handle(OpenGl_Context)& theGlContext);
455
456   //! Updates 3D scene light sources for ray-tracing.
457   Standard_Boolean updateRaytraceLightSources (const OpenGl_Mat4& theInvModelView, const Handle(OpenGl_Context)& theGlContext);
458
459   //! Updates environment map for ray-tracing.
460   Standard_Boolean updateRaytraceEnvironmentMap (const Handle(OpenGl_Context)& theGlContext);
461
462   //! Checks to see if the OpenGL structure is modified.
463   Standard_Boolean toUpdateStructure (const OpenGl_Structure* theStructure);
464
465   //! Adds OpenGL structure to ray-traced scene geometry.
466   Standard_Boolean addRaytraceStructure (const OpenGl_Structure*       theStructure,
467                                          const Handle(OpenGl_Context)& theGlContext);
468
469   //! Adds OpenGL groups to ray-traced scene geometry.
470   Standard_Boolean addRaytraceGroups (const OpenGl_Structure*       theStructure,
471                                       const Standard_Integer        theStructMat,
472                                       const Standard_ShortReal*     theTransform,
473                                       const Handle(OpenGl_Context)& theGlContext);
474
475   //! Creates ray-tracing material properties.
476   OpenGl_RaytraceMaterial convertMaterial (const OpenGl_AspectFace*      theAspect,
477                                            const Handle(OpenGl_Context)& theGlContext);
478
479   //! Adds OpenGL primitive array to ray-traced scene geometry.
480   OpenGl_TriangleSet* addRaytracePrimitiveArray (const OpenGl_PrimitiveArray* theArray,
481                                                  const Standard_Integer       theMatID,
482                                                  const OpenGl_Mat4*           theTrans);
483
484   //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
485   Standard_Boolean addRaytraceVertexIndices (OpenGl_TriangleSet&                  theSet,
486                                              const Standard_Integer               theMatID,
487                                              const Standard_Integer               theCount,
488                                              const Standard_Integer               theOffset,
489                                              const OpenGl_PrimitiveArray&         theArray);
490
491   //! Adds OpenGL triangle array to ray-traced scene geometry.
492   Standard_Boolean addRaytraceTriangleArray (OpenGl_TriangleSet&                  theSet,
493                                              const Standard_Integer               theMatID,
494                                              const Standard_Integer               theCount,
495                                              const Standard_Integer               theOffset,
496                                              const Handle(Graphic3d_IndexBuffer)& theIndices);
497
498   //! Adds OpenGL triangle fan array to ray-traced scene geometry.
499   Standard_Boolean addRaytraceTriangleFanArray (OpenGl_TriangleSet&                  theSet,
500                                                 const Standard_Integer               theMatID,
501                                                 const Standard_Integer               theCount,
502                                                 const Standard_Integer               theOffset,
503                                                 const Handle(Graphic3d_IndexBuffer)& theIndices);
504
505   //! Adds OpenGL triangle strip array to ray-traced scene geometry.
506   Standard_Boolean addRaytraceTriangleStripArray (OpenGl_TriangleSet&                  theSet,
507                                                   const Standard_Integer               theMatID,
508                                                   const Standard_Integer               theCount,
509                                                   const Standard_Integer               theOffset,
510                                                   const Handle(Graphic3d_IndexBuffer)& theIndices);
511
512   //! Adds OpenGL quadrangle array to ray-traced scene geometry.
513   Standard_Boolean addRaytraceQuadrangleArray (OpenGl_TriangleSet&                  theSet,
514                                                const Standard_Integer               theMatID,
515                                                const Standard_Integer               theCount,
516                                                const Standard_Integer               theOffset,
517                                                const Handle(Graphic3d_IndexBuffer)& theIndices);
518
519   //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
520   Standard_Boolean addRaytraceQuadrangleStripArray (OpenGl_TriangleSet&                  theSet,
521                                                     const Standard_Integer               theMatID,
522                                                     const Standard_Integer               theCount,
523                                                     const Standard_Integer               theOffset,
524                                                     const Handle(Graphic3d_IndexBuffer)& theIndices);
525
526   //! Adds OpenGL polygon array to ray-traced scene geometry.
527   Standard_Boolean addRaytracePolygonArray (OpenGl_TriangleSet&                  theSet,
528                                             const Standard_Integer               theMatID,
529                                             const Standard_Integer               theCount,
530                                             const Standard_Integer               theOffset,
531                                             const Handle(Graphic3d_IndexBuffer)& theIndices);
532
533   //! Uploads ray-trace data to the GPU.
534   Standard_Boolean uploadRaytraceData (const Handle(OpenGl_Context)& theGlContext);
535
536   //! Generates shader prefix based on current ray-tracing options.
537   TCollection_AsciiString generateShaderPrefix (const Handle(OpenGl_Context)& theGlContext) const;
538
539   //! Performs safe exit when shaders initialization fails.
540   Standard_Boolean safeFailBack (const TCollection_ExtendedString& theMessage,
541                                  const Handle(OpenGl_Context)&     theGlContext);
542
543   //! Loads and compiles shader object from specified source.
544   Handle(OpenGl_ShaderObject) initShader (const GLenum                  theType,
545                                           const ShaderSource&           theSource,
546                                           const Handle(OpenGl_Context)& theGlContext);
547
548   //! Initializes OpenGL/GLSL shader programs.
549   Standard_Boolean initRaytraceResources (const Graphic3d_CView&        theCView,
550                                           const Handle(OpenGl_Context)& theGlContext);
551
552   //! Releases OpenGL/GLSL shader programs.
553   void releaseRaytraceResources (const Handle(OpenGl_Context)& theGlContext);
554
555   //! Resizes OpenGL frame buffers.
556   Standard_Boolean resizeRaytraceBuffers (const Standard_Integer        theSizeX,
557                                           const Standard_Integer        theSizeY,
558                                           const Handle(OpenGl_Context)& theGlContext);
559
560   //! Generates viewing rays for corners of screen quad.
561   void updateCamera (const OpenGl_Mat4& theOrientation,
562                      const OpenGl_Mat4& theViewMapping,
563                      OpenGl_Vec3*       theOrigins,
564                      OpenGl_Vec3*       theDirects,
565                      OpenGl_Mat4&       theUnView);
566
567   //! Binds ray-trace textures to corresponding texture units.
568   void bindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext);
569
570   //! Unbinds ray-trace textures from corresponding texture unit.
571   void unbindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext);
572
573   //! Sets uniform state for the given ray-tracing shader program.
574   Standard_Boolean setUniformState (const Graphic3d_CView&        theCView,
575                                     const OpenGl_Vec3*            theOrigins,
576                                     const OpenGl_Vec3*            theDirects,
577                                     const OpenGl_Mat4&            theUnviewMat,
578                                     const Standard_Integer        theProgramId,
579                                     const Handle(OpenGl_Context)& theGlContext);
580
581   //! Runs ray-tracing shader programs.
582   Standard_Boolean runRaytraceShaders (const Graphic3d_CView&        theCView,
583                                        const Standard_Integer        theSizeX,
584                                        const Standard_Integer        theSizeY,
585                                        const OpenGl_Vec3*            theOrigins,
586                                        const OpenGl_Vec3*            theDirects,
587                                        const OpenGl_Mat4&            theUnviewMat,
588                                        OpenGl_FrameBuffer*           theOutputFBO,
589                                        const Handle(OpenGl_Context)& theGlContext);
590
591   //! Redraws the window using OpenGL/GLSL ray-tracing.
592   Standard_Boolean raytrace (const Graphic3d_CView&        theCView,
593                              const Standard_Integer        theSizeX,
594                              const Standard_Integer        theSizeY,
595                              OpenGl_FrameBuffer*           theOutputFBO,
596                              const Handle(OpenGl_Context)& theGlContext);
597
598 protected: //! @name fields related to ray-tracing
599
600   //! Result of shaders initialization.
601   RaytraceInitStatus myRaytraceInitStatus;
602
603   //! Is geometry data valid?
604   Standard_Boolean myIsRaytraceDataValid;
605
606   //! Warning about missing extension GL_ARB_bindless_texture has been displayed?
607   Standard_Boolean myIsRaytraceWarnTextures;
608
609   //! 3D scene geometry data for ray-tracing.
610   OpenGl_RaytraceGeometry myRaytraceGeometry;
611
612   //! Compile-time ray-tracing parameters.
613   RaytracingParams myRaytraceParameters;
614
615   //! Radius of bounding sphere of the scene.
616   Standard_ShortReal myRaytraceSceneRadius;
617   //! Scene epsilon to prevent self-intersections.
618   Standard_ShortReal myRaytraceSceneEpsilon;
619
620   //! OpenGL/GLSL source of ray-tracing fragment shader.
621   ShaderSource myRaytraceShaderSource;
622   //! OpenGL/GLSL source of adaptive-AA fragment shader.
623   ShaderSource myPostFSAAShaderSource;
624
625   //! OpenGL/GLSL ray-tracing fragment shader.
626   Handle(OpenGl_ShaderObject) myRaytraceShader;
627   //! OpenGL/GLSL adaptive-AA fragment shader.
628   Handle(OpenGl_ShaderObject) myPostFSAAShader;
629
630   //! OpenGL/GLSL ray-tracing shader program.
631   Handle(OpenGl_ShaderProgram) myRaytraceProgram;
632   //! OpenGL/GLSL adaptive-AA shader program.
633   Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
634
635   //! Texture buffer of data records of bottom-level BVH nodes.
636   Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
637   //! Texture buffer of minimum points of bottom-level BVH nodes.
638   Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
639   //! Texture buffer of maximum points of bottom-level BVH nodes.
640   Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
641   //! Texture buffer of transformations of high-level BVH nodes.
642   Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
643
644   //! Texture buffer of vertex coords.
645   Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture;
646   //! Texture buffer of vertex normals.
647   Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture;
648   //! Texture buffer of vertex UV coords.
649   Handle(OpenGl_TextureBufferArb) myGeometryTexCrdTexture;
650   //! Texture buffer of triangle indices.
651   Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
652
653   //! Texture buffer of material properties.
654   Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
655   //! Texture buffer of light source properties.
656   Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
657
658   //! 1st framebuffer (FBO) to perform adaptive FSAA.
659   Handle(OpenGl_FrameBuffer) myRaytraceFBO1;
660   //! 2nd framebuffer (FBO) to perform adaptive FSAA.
661   Handle(OpenGl_FrameBuffer) myRaytraceFBO2;
662   //! Framebuffer (FBO) for preliminary OpenGL output.
663   Handle(OpenGl_FrameBuffer) myOpenGlFBO;
664
665   //! Vertex buffer (VBO) for drawing dummy quad.
666   OpenGl_VertexBuffer myRaytraceScreenQuad;
667
668   //! Cached locations of frequently used uniform variables.
669   Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
670
671   //! State of OpenGL structures reflected to ray-tracing.
672   std::map<const OpenGl_Structure*, Standard_Size> myStructureStates;
673
674   //! PrimitiveArray to TriangleSet map for scene partial update.
675   std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
676
677   //! Graphical ray-tracing filter to filter out all raytracable structures.
678   Handle(OpenGl_RaytraceFilter) myRaytraceFilter;
679
680   //! Marks if environment map should be updated.
681   Standard_Boolean myToUpdateEnvironmentMap;
682
683   //! State of OpenGL layer list.
684   Standard_Size myLayersModificationStatus;
685
686 public:
687
688   DEFINE_STANDARD_ALLOC
689   DEFINE_STANDARD_RTTI(OpenGl_View) // Type definition
690
691   friend class OpenGl_Workspace;
692
693 };
694
695 #endif // _OpenGl_View_Header