0029516: Visualization - eliminate redundant property Graphic3d_MaterialAspect::Refle...
[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 <Standard_Transient.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TColStd_Array2OfReal.hxx>
23 #include <NCollection_List.hxx>
24 #include <math_BullardGenerator.hxx>
25
26 #include <Quantity_NameOfColor.hxx>
27 #include <Aspect_FillMethod.hxx>
28 #include <Aspect_GradientFillMethod.hxx>
29
30 #include <Graphic3d_CView.hxx>
31 #include <Graphic3d_CullingTool.hxx>
32 #include <Graphic3d_GraduatedTrihedron.hxx>
33 #include <Graphic3d_SequenceOfHClipPlane.hxx>
34 #include <Graphic3d_ToneMappingMethod.hxx>
35 #include <Graphic3d_TypeOfShadingModel.hxx>
36 #include <Graphic3d_WorldViewProjState.hxx>
37 #include <Graphic3d_ZLayerSettings.hxx>
38
39 #include <OpenGl_Aspects.hxx>
40 #include <OpenGl_BackgroundArray.hxx>
41 #include <OpenGl_Context.hxx>
42 #include <OpenGl_FrameBuffer.hxx>
43 #include <OpenGl_FrameStatsPrs.hxx>
44 #include <OpenGl_GraduatedTrihedron.hxx>
45 #include <OpenGl_LayerList.hxx>
46 #include <OpenGl_LineAttributes.hxx>
47 #include <OpenGl_SceneGeometry.hxx>
48 #include <OpenGl_Structure.hxx>
49 #include <OpenGl_Window.hxx>
50 #include <OpenGl_Workspace.hxx>
51 #include <OpenGl_TileSampler.hxx>
52
53 #include <map>
54 #include <set>
55
56 struct OpenGl_Matrix;
57
58 class Graphic3d_StructureManager;
59 class OpenGl_GraphicDriver;
60 class OpenGl_StateCounter;
61 class OpenGl_TriangleSet;
62 class OpenGl_Workspace;
63 class OpenGl_View;
64 DEFINE_STANDARD_HANDLE(OpenGl_View,Graphic3d_CView)
65
66 //! Implementation of OpenGl view.
67 class OpenGl_View : public Graphic3d_CView
68 {
69
70 public:
71
72   //! Constructor.
73   Standard_EXPORT OpenGl_View (const Handle(Graphic3d_StructureManager)& theMgr,
74                                const Handle(OpenGl_GraphicDriver)& theDriver,
75                                const Handle(OpenGl_Caps)& theCaps,
76                                OpenGl_StateCounter* theCounter);
77
78   //! Default destructor.
79   Standard_EXPORT virtual ~OpenGl_View();
80
81   Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theCtx);
82
83   //! Deletes and erases the view.
84   Standard_EXPORT virtual void Remove() Standard_OVERRIDE;
85
86   //! @param theDrawToFrontBuffer Advanced option to modify rendering mode:
87   //! 1. TRUE.  Drawing immediate mode structures directly to the front buffer over the scene image.
88   //! Fast, so preferred for interactive work (used by default).
89   //! However these extra drawings will be missed in image dump since it is performed from back buffer.
90   //! Notice that since no pre-buffering used the V-Sync will be ignored and rendering could be seen
91   //! in run-time (in case of slow hardware) and/or tearing may appear.
92   //! So this is strongly recommended to draw only simple (fast) structures.
93   //! 2. FALSE. Drawing immediate mode structures to the back buffer.
94   //! The complete scene is redrawn first, so this mode is slower if scene contains complex data and/or V-Sync
95   //! is turned on. But it works in any case and is especially useful for view dump because the dump image is read
96   //! from the back buffer.
97   //! @return previous mode.
98   Standard_EXPORT Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer) Standard_OVERRIDE;
99
100   //! Creates and maps rendering window to the view.
101   //! @param theWindow [in] the window.
102   //! @param theContext [in] the rendering context. If NULL the context will be created internally.
103   Standard_EXPORT virtual void SetWindow (const Handle(Aspect_Window)&  theWindow,
104                                           const Aspect_RenderingContext theContext) Standard_OVERRIDE;
105
106   //! Returns window associated with the view.
107   virtual Handle(Aspect_Window) Window() const Standard_OVERRIDE
108   { return myWindow->PlatformWindow(); }
109
110   //! Returns True if the window associated to the view is defined.
111   virtual Standard_Boolean IsDefined() const Standard_OVERRIDE
112   { return !myWindow.IsNull(); }
113
114   //! Handle changing size of the rendering window.
115   Standard_EXPORT virtual void Resized() Standard_OVERRIDE;
116
117   //! Redraw content of the view.
118   Standard_EXPORT virtual void Redraw() Standard_OVERRIDE;
119
120   //! Redraw immediate content of the view.
121   Standard_EXPORT virtual void RedrawImmediate() Standard_OVERRIDE;
122
123   //! Marks BVH tree for given priority list as dirty and marks primitive set for rebuild.
124   Standard_EXPORT virtual void Invalidate() Standard_OVERRIDE;
125
126   //! Return true if view content cache has been invalidated.
127   virtual Standard_Boolean IsInvalidated() Standard_OVERRIDE { return !myBackBufferRestored; }
128
129   //! Dump active rendering buffer into specified memory buffer.
130   //! In Ray-Tracing allow to get a raw HDR buffer using Graphic3d_BT_RGB_RayTraceHdrLeft buffer type,
131   //! only Left view will be dumped ignoring stereoscopic parameter.
132   Standard_EXPORT virtual Standard_Boolean BufferDump (Image_PixMap& theImage,
133                                                        const Graphic3d_BufferType& theBufferType) Standard_OVERRIDE;
134
135   //! Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated.
136   Standard_EXPORT virtual void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
137
138   //! Add a layer to the view.
139   //! @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers).
140   //! @param theSettings   [in] new layer settings
141   //! @param theLayerAfter [in] id of layer to append new layer before
142   Standard_EXPORT virtual void InsertLayerBefore (const Graphic3d_ZLayerId theLayerId,
143                                                   const Graphic3d_ZLayerSettings& theSettings,
144                                                   const Graphic3d_ZLayerId theLayerAfter) Standard_OVERRIDE;
145
146   //! Add a layer to the view.
147   //! @param theNewLayerId  [in] id of new layer, should be > 0 (negative values are reserved for default layers).
148   //! @param theSettings    [in] new layer settings
149   //! @param theLayerBefore [in] id of layer to append new layer after
150   Standard_EXPORT virtual void InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId,
151                                                  const Graphic3d_ZLayerSettings& theSettings,
152                                                  const Graphic3d_ZLayerId theLayerBefore) Standard_OVERRIDE;
153
154   //! Remove a z layer with the given ID.
155   Standard_EXPORT virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
156
157   //! Sets the settings for a single Z layer of specified view.
158   Standard_EXPORT virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId,
159                                                   const Graphic3d_ZLayerSettings& theSettings) Standard_OVERRIDE;
160
161   //! Returns the maximum Z layer ID.
162   //! First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax().
163   Standard_EXPORT virtual Standard_Integer ZLayerMax() const Standard_OVERRIDE;
164
165   //! Returns the list of layers.
166   Standard_EXPORT virtual const NCollection_List<Handle(Graphic3d_Layer)>& Layers() const Standard_OVERRIDE;
167
168   //! Returns layer with given ID or NULL if undefined.
169   Standard_EXPORT virtual Handle(Graphic3d_Layer) Layer (const Graphic3d_ZLayerId theLayerId) const Standard_OVERRIDE;
170
171   //! Returns the bounding box of all structures displayed in the view.
172   //! If theToIncludeAuxiliary is TRUE, then the boundary box also includes minimum and maximum limits
173   //! of graphical elements forming parts of infinite and other auxiliary structures.
174   //! @param theToIncludeAuxiliary consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence)
175   //! @return computed bounding box
176   Standard_EXPORT virtual Bnd_Box MinMaxValues (const Standard_Boolean theToIncludeAuxiliary) const Standard_OVERRIDE;
177
178   //! Returns pointer to an assigned framebuffer object.
179   Standard_EXPORT virtual Handle(Standard_Transient) FBO() const Standard_OVERRIDE;
180
181   //! Sets framebuffer object for offscreen rendering.
182   Standard_EXPORT virtual void SetFBO (const Handle(Standard_Transient)& theFbo) Standard_OVERRIDE;
183
184   //! Generate offscreen FBO in the graphic library.
185   //! If not supported on hardware returns NULL.
186   Standard_EXPORT virtual Handle(Standard_Transient) FBOCreate (const Standard_Integer theWidth,
187                                                                 const Standard_Integer theHeight) Standard_OVERRIDE;
188
189   //! Remove offscreen FBO from the graphic library
190   Standard_EXPORT virtual void FBORelease (Handle(Standard_Transient)& theFbo) Standard_OVERRIDE;
191
192   //! Read offscreen FBO configuration.
193   Standard_EXPORT virtual void FBOGetDimensions (const Handle(Standard_Transient)& theFbo,
194                                                  Standard_Integer& theWidth,
195                                                  Standard_Integer& theHeight,
196                                                  Standard_Integer& theWidthMax,
197                                                  Standard_Integer& theHeightMax) Standard_OVERRIDE;
198
199   //! Change offscreen FBO viewport.
200   Standard_EXPORT virtual void FBOChangeViewport (const Handle(Standard_Transient)& theFbo,
201                                                   const Standard_Integer theWidth,
202                                                   const Standard_Integer theHeight) Standard_OVERRIDE;
203
204 public:
205
206   //! Returns gradient background fill colors.
207   Standard_EXPORT virtual Aspect_GradientBackground GradientBackground() const Standard_OVERRIDE;
208
209   //! Sets gradient background fill colors.
210   Standard_EXPORT virtual void SetGradientBackground (const Aspect_GradientBackground& theBackground) Standard_OVERRIDE;
211
212   //! Returns background image texture file path.
213   virtual TCollection_AsciiString BackgroundImage() Standard_OVERRIDE { return myBackgroundImagePath; }
214
215   //! Sets background image texture file path.
216   Standard_EXPORT virtual void SetBackgroundImage (const TCollection_AsciiString& theFilePath) Standard_OVERRIDE;
217
218   //! Returns background image fill style.
219   Standard_EXPORT virtual Aspect_FillMethod BackgroundImageStyle() const Standard_OVERRIDE;
220
221   //! Sets background image fill style.
222   Standard_EXPORT virtual void SetBackgroundImageStyle (const Aspect_FillMethod theFillStyle) Standard_OVERRIDE;
223
224   //! Returns cubemap being set last time on background.
225   Standard_EXPORT Handle(Graphic3d_CubeMap) BackgroundCubeMap() const Standard_OVERRIDE;
226
227   //! Sets environment cubemap as background.
228   Standard_EXPORT virtual void SetBackgroundCubeMap (const Handle(Graphic3d_CubeMap)& theCubeMap) Standard_OVERRIDE;
229
230   //! Returns environment texture set for the view.
231   virtual Handle(Graphic3d_TextureEnv) TextureEnv() const Standard_OVERRIDE { return myTextureEnvData; }
232
233   //! Sets environment texture for the view.
234   Standard_EXPORT virtual void SetTextureEnv (const Handle(Graphic3d_TextureEnv)& theTextureEnv) Standard_OVERRIDE;
235
236   //! Return backfacing model used for the view.
237   virtual Graphic3d_TypeOfBackfacingModel BackfacingModel() const Standard_OVERRIDE { return myBackfacing; }
238
239   //! Sets backfacing model for the view.
240   virtual void SetBackfacingModel (const Graphic3d_TypeOfBackfacingModel theModel) Standard_OVERRIDE { myBackfacing = theModel; }
241
242   //! Returns local camera origin currently set for rendering, might be modified during rendering.
243   const gp_XYZ& LocalOrigin() const { return myLocalOrigin; }
244
245   //! Setup local camera origin currently set for rendering.
246   Standard_EXPORT void SetLocalOrigin (const gp_XYZ& theOrigin);
247
248   //! Returns list of lights of the view.
249   virtual const Handle(Graphic3d_LightSet)& Lights() const Standard_OVERRIDE { return myLights; }
250
251   //! Sets list of lights for the view.
252   virtual void SetLights (const Handle(Graphic3d_LightSet)& theLights) Standard_OVERRIDE
253   {
254     myLights = theLights;
255     myCurrLightSourceState = myStateCounter->Increment();
256   }
257
258   //! Returns list of clip planes set for the view.
259   virtual const Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const Standard_OVERRIDE { return myClipPlanes; }
260
261   //! Sets list of clip planes for the view.
262   virtual void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes) Standard_OVERRIDE { myClipPlanes = thePlanes; }
263
264   //! Fill in the dictionary with diagnostic info.
265   //! Should be called within rendering thread.
266   //!
267   //! This API should be used only for user output or for creating automated reports.
268   //! The format of returned information (e.g. key-value layout)
269   //! is NOT part of this API and can be changed at any time.
270   //! Thus application should not parse returned information to weed out specific parameters.
271   Standard_EXPORT virtual void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict,
272                                                       Graphic3d_DiagnosticInfo theFlags) const Standard_OVERRIDE;
273
274   //! Returns string with statistic performance info.
275   Standard_EXPORT virtual TCollection_AsciiString StatisticInformation() const Standard_OVERRIDE;
276
277   //! Fills in the dictionary with statistic performance info.
278   Standard_EXPORT virtual void StatisticInformation (TColStd_IndexedDataMapOfStringString& theDict) const Standard_OVERRIDE;
279
280 public:
281
282   //! Returns background color.
283   const Quantity_ColorRGBA& BackgroundColor() const { return myBgColor; }
284
285   //! Change graduated trihedron.
286   OpenGl_GraduatedTrihedron& ChangeGraduatedTrihedron() { return myGraduatedTrihedron; }
287
288   void SetTextureEnv (const Handle(OpenGl_Context)&       theCtx,
289                       const Handle(Graphic3d_TextureEnv)& theTexture);
290
291   void SetBackgroundTextureStyle (const Aspect_FillMethod FillStyle);
292
293   void SetBackgroundGradient (const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AType);
294
295   void SetBackgroundGradientType (const Aspect_GradientFillMethod AType);
296
297   //! Returns list of OpenGL Z-layers.
298   const OpenGl_LayerList& LayerList() const { return myZLayers; }
299
300   //! Returns OpenGL window implementation.
301   const Handle(OpenGl_Window)& GlWindow() const { return myWindow; }
302
303   //! Returns OpenGL environment map.
304   const Handle(OpenGl_TextureSet)& GlTextureEnv() const { return myTextureEnv; }
305
306   //! Returns selector for BVH tree, providing a possibility to store information
307   //! about current view volume and to detect which objects are overlapping it.
308   const Graphic3d_CullingTool& BVHTreeSelector() const { return myBVHSelector; }
309
310   //! Returns true if there are immediate structures to display
311   bool HasImmediateStructures() const
312   {
313     return myZLayers.NbImmediateStructures() != 0;
314   }
315
316 public: //! @name obsolete Graduated Trihedron functionality
317
318   //! Displays Graduated Trihedron.
319   Standard_EXPORT virtual void GraduatedTrihedronDisplay (const Graphic3d_GraduatedTrihedron& theTrihedronData) Standard_OVERRIDE;
320
321   //! Erases Graduated Trihedron.
322   Standard_EXPORT virtual void GraduatedTrihedronErase() Standard_OVERRIDE;
323
324   //! Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object.
325   //! @param theMin [in] the minimum point of scene.
326   //! @param theMax [in] the maximum point of scene.
327   Standard_EXPORT virtual void GraduatedTrihedronMinMaxValues (const Graphic3d_Vec3 theMin, const Graphic3d_Vec3 theMax) Standard_OVERRIDE;
328
329 protected: //! @name Internal methods for managing GL resources
330
331   //! Initializes OpenGl resource for environment texture.
332   void initTextureEnv (const Handle(OpenGl_Context)& theContext);
333
334 protected: //! @name low-level redrawing sub-routines
335
336   //! Redraws view for the given monographic camera projection, or left/right eye.
337   Standard_EXPORT virtual void redraw (const Graphic3d_Camera::Projection theProjection,
338                                        OpenGl_FrameBuffer*                theReadDrawFbo,
339                                        OpenGl_FrameBuffer*                theOitAccumFbo);
340
341   //! Redraws view for the given monographic camera projection, or left/right eye.
342   //!
343   //! Method will blit snapshot containing main scene (myMainSceneFbos or BackBuffer)
344   //! into presentation buffer (myMainSceneFbos -> offscreen FBO or
345   //! myMainSceneFbos -> BackBuffer or BackBuffer -> FrontBuffer),
346   //! and redraw immediate structures on top.
347   //!
348   //! When scene caching is disabled (myTransientDrawToFront, no double buffer in window, etc.),
349   //! the first step (blitting) will be skipped.
350   //!
351   //! @return false if immediate structures has been rendered directly into FrontBuffer
352   //! and Buffer Swap should not be called.
353   Standard_EXPORT virtual bool redrawImmediate (const Graphic3d_Camera::Projection theProjection,
354                                                 OpenGl_FrameBuffer* theReadFbo,
355                                                 OpenGl_FrameBuffer* theDrawFbo,
356                                                 OpenGl_FrameBuffer* theOitAccumFbo,
357                                                 const Standard_Boolean theIsPartialUpdate = Standard_False);
358
359   //! Blit image from/to specified buffers.
360   Standard_EXPORT bool blitBuffers (OpenGl_FrameBuffer*    theReadFbo,
361                                     OpenGl_FrameBuffer*    theDrawFbo,
362                                     const Standard_Boolean theToFlip = Standard_False);
363
364   //! Setup default FBO.
365   Standard_EXPORT void bindDefaultFbo (OpenGl_FrameBuffer* theCustomFbo = NULL);
366
367 protected: //! @name Rendering of GL graphics (with prepared drawing buffer).
368
369   //! Renders the graphical contents of the view into the preprepared window or framebuffer.
370   //! @param theProjection [in] the projection that should be used for rendering.
371   //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
372   //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
373   //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
374   Standard_EXPORT virtual void render (Graphic3d_Camera::Projection theProjection,
375                                        OpenGl_FrameBuffer*          theReadDrawFbo,
376                                        OpenGl_FrameBuffer*          theOitAccumFbo,
377                                        const Standard_Boolean       theToDrawImmediate);
378
379   //! Renders the graphical scene.
380   //! @param theProjection [in] the projection that is used for rendering.
381   //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
382   //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
383   //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
384   Standard_EXPORT virtual void renderScene (Graphic3d_Camera::Projection theProjection,
385                                             OpenGl_FrameBuffer*    theReadDrawFbo,
386                                             OpenGl_FrameBuffer*    theOitAccumFbo,
387                                             const Standard_Boolean theToDrawImmediate);
388
389   //! Draw background (gradient / image)
390   Standard_EXPORT virtual void drawBackground (const Handle(OpenGl_Workspace)& theWorkspace);
391
392   //! Render set of structures presented in the view.
393   //! @param theProjection [in] the projection that is used for rendering.
394   //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
395   //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
396   //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
397   Standard_EXPORT virtual void renderStructs (Graphic3d_Camera::Projection theProjection,
398                                               OpenGl_FrameBuffer*    theReadDrawFbo,
399                                               OpenGl_FrameBuffer*    theOitAccumFbo,
400                                               const Standard_Boolean theToDrawImmediate);
401
402   //! Renders trihedron.
403   void renderTrihedron (const Handle(OpenGl_Workspace) &theWorkspace);
404
405   //! Renders frame statistics.
406   void renderFrameStats();
407
408 private:
409
410   //! Adds the structure to display lists of the view.
411   Standard_EXPORT virtual void displayStructure (const Handle(Graphic3d_CStructure)& theStructure,
412                                                  const Standard_Integer thePriority) Standard_OVERRIDE;
413
414   //! Erases the structure from display lists of the view.
415   Standard_EXPORT virtual void eraseStructure (const Handle(Graphic3d_CStructure)& theStructure) Standard_OVERRIDE;
416
417   //! Change Z layer of a structure already presented in view.
418   Standard_EXPORT virtual void changeZLayer (const Handle(Graphic3d_CStructure)& theCStructure,
419                                              const Graphic3d_ZLayerId theNewLayerId) Standard_OVERRIDE;
420
421   //! Changes the priority of a structure within its Z layer in the specified view.
422   Standard_EXPORT virtual void changePriority (const Handle(Graphic3d_CStructure)& theCStructure,
423                                                const Standard_Integer theNewPriority) Standard_OVERRIDE;
424
425 private:
426
427   //! Copy content of Back buffer to the Front buffer.
428   bool copyBackToFront();
429
430   //! Initialize blit quad.
431   OpenGl_VertexBuffer* initBlitQuad (const Standard_Boolean theToFlip);
432
433   //! Blend together views pair into stereo image.
434   void drawStereoPair (OpenGl_FrameBuffer* theDrawFbo);
435
436   //! Check and update OIT compatibility with current OpenGL context's state.
437   bool checkOitCompatibility (const Handle(OpenGl_Context)& theGlContext,
438                               const Standard_Boolean theMSAA);
439
440   //! Chooses compatible internal color format for OIT frame buffer.
441   bool chooseOitColorConfiguration (const Handle(OpenGl_Context)& theGlContext,
442                                     const Standard_Integer theConfigIndex,
443                                     OpenGl_ColorFormats& theFormats);
444
445 protected:
446
447   OpenGl_GraphicDriver*    myDriver;
448   Handle(OpenGl_Window)    myWindow;
449   Handle(OpenGl_Workspace) myWorkspace;
450   Handle(OpenGl_Caps)      myCaps;
451   Standard_Boolean         myWasRedrawnGL;
452
453   Graphic3d_TypeOfBackfacingModel myBackfacing;
454   Handle(Graphic3d_SequenceOfHClipPlane) myClipPlanes;
455   gp_XYZ                          myLocalOrigin;
456   Handle(OpenGl_FrameBuffer)      myFBO;
457   Standard_Boolean                myToShowGradTrihedron;
458   TCollection_AsciiString         myBackgroundImagePath;
459   Handle(Graphic3d_TextureEnv)    myTextureEnvData;
460   Graphic3d_GraduatedTrihedron    myGTrihedronData;
461
462   Handle(Graphic3d_LightSet)      myNoShadingLight;
463   Handle(Graphic3d_LightSet)      myLights;
464   OpenGl_LayerList                myZLayers; //!< main list of displayed structure, sorted by layers
465
466   Graphic3d_WorldViewProjState    myWorldViewProjState; //!< camera modification state
467   OpenGl_StateCounter*            myStateCounter;
468   Standard_Size                   myCurrLightSourceState;
469   Standard_Size                   myLightsRevision;
470
471   typedef std::pair<Standard_Size, Standard_Size> StateInfo;
472
473   StateInfo myLastOrientationState;
474   StateInfo myLastViewMappingState;
475   StateInfo myLastLightSourceState;
476
477   //! Is needed for selection of overlapping objects and storage of the current view volume
478   Graphic3d_CullingTool myBVHSelector;
479
480   OpenGl_GraduatedTrihedron myGraduatedTrihedron;
481   OpenGl_FrameStatsPrs      myFrameStatsPrs;
482
483   Handle(OpenGl_TextureSet) myTextureEnv;
484
485   //! Framebuffers for OpenGL output.
486   Handle(OpenGl_FrameBuffer) myOpenGlFBO;
487   Handle(OpenGl_FrameBuffer) myOpenGlFBO2;
488
489 protected: //! @name Rendering properties
490
491   //! Two framebuffers (left and right views) store cached main presentation
492   //! of the view (without presentation of immediate layers).
493   GLint                      myFboColorFormat;        //!< sized format for color attachments
494   GLint                      myFboDepthFormat;        //!< sized format for depth-stencil attachments
495   OpenGl_ColorFormats        myFboOitColorConfig;     //!< selected color format configuration for OIT color attachments
496   Handle(OpenGl_FrameBuffer) myMainSceneFbos[2];
497   Handle(OpenGl_FrameBuffer) myMainSceneFbosOit[2];      //!< Additional buffers for transparent draw of main layer.
498   Handle(OpenGl_FrameBuffer) myImmediateSceneFbos[2];    //!< Additional buffers for immediate layer in stereo mode.
499   Handle(OpenGl_FrameBuffer) myImmediateSceneFbosOit[2]; //!< Additional buffers for transparency draw of immediate layer.
500   OpenGl_VertexBuffer        myFullScreenQuad;        //!< Vertices for full-screen quad rendering.
501   OpenGl_VertexBuffer        myFullScreenQuadFlip;
502   Standard_Boolean           myToFlipOutput;          //!< Flag to draw result image upside-down
503   unsigned int               myFrameCounter;          //!< redraw counter, for debugging
504   Standard_Boolean           myHasFboBlit;            //!< disable FBOs on failure
505   Standard_Boolean           myToDisableOIT;          //!< disable OIT on failure
506   Standard_Boolean           myToDisableOITMSAA;      //!< disable OIT with MSAA on failure
507   Standard_Boolean           myToDisableMSAA;         //!< disable MSAA after failure
508   Standard_Boolean           myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
509   Standard_Boolean           myBackBufferRestored;
510   Standard_Boolean           myIsImmediateDrawn;     //!< flag indicates that immediate mode buffer contains some data
511
512 protected: //! @name Background parameters
513
514   OpenGl_Aspects*            myTextureParams;                     //!< Stores texture and its parameters for textured background
515   OpenGl_Aspects*            myCubeMapParams;                     //!< Stores cubemap and its parameters for cubemap background
516   Handle(Graphic3d_CubeMap)  myBackgroundCubeMap;                 //!< Cubemap has been setted as background
517   Graphic3d_TypeOfBackground myBackgroundType;                    //!< Current typy of background
518   OpenGl_BackgroundArray*    myBackgrounds[Graphic3d_TypeOfBackground_NB]; //!< Array of primitive arrays of different background types
519
520 protected: //! @name data types related to ray-tracing
521
522   //! Result of OpenGL shaders initialization.
523   enum RaytraceInitStatus
524   {
525     OpenGl_RT_NONE,
526     OpenGl_RT_INIT,
527     OpenGl_RT_FAIL
528   };
529
530   //! Describes update mode (state).
531   enum RaytraceUpdateMode
532   {
533     OpenGl_GUM_CHECK,   //!< check geometry state
534     OpenGl_GUM_PREPARE, //!< collect unchanged objects
535     OpenGl_GUM_REBUILD  //!< rebuild changed and new objects
536   };
537
538   //! Defines frequently used shader variables.
539   enum ShaderVariableIndex
540   {
541     OpenGl_RT_aPosition,
542
543     // camera position
544     OpenGl_RT_uOriginLT,
545     OpenGl_RT_uOriginLB,
546     OpenGl_RT_uOriginRT,
547     OpenGl_RT_uOriginRB,
548     OpenGl_RT_uDirectLT,
549     OpenGl_RT_uDirectLB,
550     OpenGl_RT_uDirectRT,
551     OpenGl_RT_uDirectRB,
552     OpenGl_RT_uViewPrMat,
553     OpenGl_RT_uUnviewMat,
554
555     // 3D scene params
556     OpenGl_RT_uSceneRad,
557     OpenGl_RT_uSceneEps,
558     OpenGl_RT_uLightAmbnt,
559     OpenGl_RT_uLightCount,
560
561     // background params
562     OpenGl_RT_uBackColorTop,
563     OpenGl_RT_uBackColorBot,
564
565     // ray-tracing params
566     OpenGl_RT_uShadowsEnabled,
567     OpenGl_RT_uReflectEnabled,
568     OpenGl_RT_uSphereMapEnabled,
569     OpenGl_RT_uSphereMapForBack,
570     OpenGl_RT_uTexSamplersArray,
571     OpenGl_RT_uBlockedRngEnabled,
572
573     // size of render window
574     OpenGl_RT_uWinSizeX,
575     OpenGl_RT_uWinSizeY,
576
577     // sampled frame params
578     OpenGl_RT_uAccumSamples,
579     OpenGl_RT_uFrameRndSeed,
580
581     // adaptive FSAA params
582     OpenGl_RT_uOffsetX,
583     OpenGl_RT_uOffsetY,
584     OpenGl_RT_uSamples,
585
586     // images used by ISS mode
587     OpenGl_RT_uRenderImage,
588     OpenGl_RT_uTilesImage,
589     OpenGl_RT_uOffsetImage,
590     OpenGl_RT_uTileSize,
591     OpenGl_RT_uVarianceScaleFactor,
592
593     // maximum radiance value
594     OpenGl_RT_uMaxRadiance,
595
596     OpenGl_RT_NbVariables // special field
597   };
598
599   //! Defines OpenGL image samplers.
600   enum ShaderImageNames
601   {
602     OpenGl_RT_OutputImage = 0,
603     OpenGl_RT_VisualErrorImage = 1,
604     OpenGl_RT_TileOffsetsImage = 2,
605     OpenGl_RT_TileSamplesImage = 3
606   };
607
608   //! Tool class for management of shader sources.
609   class ShaderSource
610   {
611   public:
612
613     //! Default shader prefix - empty string.
614     static const TCollection_AsciiString EMPTY_PREFIX;
615
616     //! Creates new uninitialized shader source.
617     ShaderSource()
618     {
619       //
620     }
621
622   public:
623
624     //! Returns error description in case of load fail.
625     const TCollection_AsciiString& ErrorDescription() const
626     {
627       return myError;
628     }
629
630     //! Returns prefix to insert before the source.
631     const TCollection_AsciiString& Prefix() const
632     {
633       return myPrefix;
634     }
635
636     //! Sets prefix to insert before the source.
637     void SetPrefix (const TCollection_AsciiString& thePrefix)
638     {
639       myPrefix = thePrefix;
640     }
641
642     //! Returns shader source combined with prefix.
643     TCollection_AsciiString Source() const;
644
645     //! Loads shader source from specified files.
646     Standard_Boolean LoadFromFiles (const TCollection_AsciiString* theFileNames, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX);
647
648     //! Loads shader source from specified strings.
649     Standard_Boolean LoadFromStrings (const TCollection_AsciiString* theStrings, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX);
650
651   private:
652
653     TCollection_AsciiString mySource; //!< Source string of the shader object
654     TCollection_AsciiString myPrefix; //!< Prefix to insert before the source
655     TCollection_AsciiString myError;  //!< error state
656
657   };
658
659   //! Default ray-tracing depth.
660   static const Standard_Integer THE_DEFAULT_NB_BOUNCES = 3;
661
662   //! Default size of traversal stack.
663   static const Standard_Integer THE_DEFAULT_STACK_SIZE = 10;
664
665   //! Compile-time ray-tracing parameters.
666   struct RaytracingParams
667   {
668     //! Actual size of traversal stack in shader program.
669     Standard_Integer StackSize;
670
671     //! Actual ray-tracing depth (number of ray bounces).
672     Standard_Integer NbBounces;
673
674     //! Enables/disables light propagation through transparent media.
675     Standard_Boolean TransparentShadows;
676
677     //! Enables/disables global illumination (GI) effects.
678     Standard_Boolean GlobalIllumination;
679
680     //! Enables/disables the use of OpenGL bindless textures.
681     Standard_Boolean UseBindlessTextures;
682
683     //! Enables/disables two-sided BSDF models instead of one-sided.
684     Standard_Boolean TwoSidedBsdfModels;
685
686     //! Enables/disables adaptive screen sampling for path tracing.
687     Standard_Boolean AdaptiveScreenSampling;
688
689     //! Enables/disables 1-pass atomic mode for AdaptiveScreenSampling.
690     Standard_Boolean AdaptiveScreenSamplingAtomic;
691
692     //! Enables/disables environment map for background.
693     Standard_Boolean UseEnvMapForBackground;
694
695     //! Maximum radiance value used for clamping radiance estimation.
696     Standard_ShortReal RadianceClampingValue;
697     
698     //! Enables/disables depth-of-field effect (path tracing, perspective camera).
699     Standard_Boolean DepthOfField;
700
701     //! Tone mapping method for path tracing.
702     Graphic3d_ToneMappingMethod ToneMappingMethod;
703
704     //! Creates default compile-time ray-tracing parameters.
705     RaytracingParams()
706     : StackSize              (THE_DEFAULT_STACK_SIZE),
707       NbBounces              (THE_DEFAULT_NB_BOUNCES),
708       TransparentShadows     (Standard_False),
709       GlobalIllumination     (Standard_False),
710       UseBindlessTextures    (Standard_False),
711       TwoSidedBsdfModels     (Standard_False),
712       AdaptiveScreenSampling (Standard_False),
713       AdaptiveScreenSamplingAtomic (Standard_False),
714       UseEnvMapForBackground (Standard_False),
715       RadianceClampingValue  (30.0),
716       DepthOfField           (Standard_False),
717       ToneMappingMethod      (Graphic3d_ToneMappingMethod_Disabled) { }
718   };
719
720   //! Describes state of OpenGL structure.
721   struct StructState
722   {
723     Standard_Size StructureState;
724     Standard_Size InstancedState;
725
726     //! Creates new structure state.
727     StructState (const Standard_Size theStructureState = 0,
728                  const Standard_Size theInstancedState = 0)
729     : StructureState (theStructureState),
730       InstancedState (theInstancedState)
731     {
732       //
733     }
734
735     //! Creates new structure state.
736     StructState (const OpenGl_Structure* theStructure)
737     {
738       StructureState = theStructure->ModificationState();
739
740       InstancedState = theStructure->InstancedStructure() != NULL ?
741         theStructure->InstancedStructure()->ModificationState() : 0;
742     }
743   };
744
745 protected: //! @name methods related to ray-tracing
746
747   //! Updates 3D scene geometry for ray-tracing.
748   Standard_Boolean updateRaytraceGeometry (const RaytraceUpdateMode      theMode,
749                                            const Standard_Integer        theViewId,
750                                            const Handle(OpenGl_Context)& theGlContext);
751
752   //! Updates 3D scene light sources for ray-tracing.
753   Standard_Boolean updateRaytraceLightSources (const OpenGl_Mat4& theInvModelView, const Handle(OpenGl_Context)& theGlContext);
754
755   //! Checks to see if the OpenGL structure is modified.
756   Standard_Boolean toUpdateStructure (const OpenGl_Structure* theStructure);
757
758   //! Adds OpenGL structure to ray-traced scene geometry.
759   Standard_Boolean addRaytraceStructure (const OpenGl_Structure*       theStructure,
760                                          const Handle(OpenGl_Context)& theGlContext);
761
762   //! Adds OpenGL groups to ray-traced scene geometry.
763   Standard_Boolean addRaytraceGroups (const OpenGl_Structure*        theStructure,
764                                       const OpenGl_RaytraceMaterial& theStructMat,
765                                       const Handle(Geom_Transformation)& theTrsf,
766                                       const Handle(OpenGl_Context)&  theGlContext);
767
768   //! Creates ray-tracing material properties.
769   OpenGl_RaytraceMaterial convertMaterial (const OpenGl_Aspects* theAspect,
770                                            const Handle(OpenGl_Context)& theGlContext);
771
772   //! Adds OpenGL primitive array to ray-traced scene geometry.
773   Handle(OpenGl_TriangleSet) addRaytracePrimitiveArray (const OpenGl_PrimitiveArray* theArray,
774                                                         const Standard_Integer       theMatID,
775                                                         const OpenGl_Mat4*           theTrans);
776
777   //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
778   Standard_Boolean addRaytraceVertexIndices (OpenGl_TriangleSet&                  theSet,
779                                              const Standard_Integer               theMatID,
780                                              const Standard_Integer               theCount,
781                                              const Standard_Integer               theOffset,
782                                              const OpenGl_PrimitiveArray&         theArray);
783
784   //! Adds OpenGL triangle array to ray-traced scene geometry.
785   Standard_Boolean addRaytraceTriangleArray (OpenGl_TriangleSet&                  theSet,
786                                              const Standard_Integer               theMatID,
787                                              const Standard_Integer               theCount,
788                                              const Standard_Integer               theOffset,
789                                              const Handle(Graphic3d_IndexBuffer)& theIndices);
790
791   //! Adds OpenGL triangle fan array to ray-traced scene geometry.
792   Standard_Boolean addRaytraceTriangleFanArray (OpenGl_TriangleSet&                  theSet,
793                                                 const Standard_Integer               theMatID,
794                                                 const Standard_Integer               theCount,
795                                                 const Standard_Integer               theOffset,
796                                                 const Handle(Graphic3d_IndexBuffer)& theIndices);
797
798   //! Adds OpenGL triangle strip array to ray-traced scene geometry.
799   Standard_Boolean addRaytraceTriangleStripArray (OpenGl_TriangleSet&                  theSet,
800                                                   const Standard_Integer               theMatID,
801                                                   const Standard_Integer               theCount,
802                                                   const Standard_Integer               theOffset,
803                                                   const Handle(Graphic3d_IndexBuffer)& theIndices);
804
805   //! Adds OpenGL quadrangle array to ray-traced scene geometry.
806   Standard_Boolean addRaytraceQuadrangleArray (OpenGl_TriangleSet&                  theSet,
807                                                const Standard_Integer               theMatID,
808                                                const Standard_Integer               theCount,
809                                                const Standard_Integer               theOffset,
810                                                const Handle(Graphic3d_IndexBuffer)& theIndices);
811
812   //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
813   Standard_Boolean addRaytraceQuadrangleStripArray (OpenGl_TriangleSet&                  theSet,
814                                                     const Standard_Integer               theMatID,
815                                                     const Standard_Integer               theCount,
816                                                     const Standard_Integer               theOffset,
817                                                     const Handle(Graphic3d_IndexBuffer)& theIndices);
818
819   //! Adds OpenGL polygon array to ray-traced scene geometry.
820   Standard_Boolean addRaytracePolygonArray (OpenGl_TriangleSet&                  theSet,
821                                             const Standard_Integer               theMatID,
822                                             const Standard_Integer               theCount,
823                                             const Standard_Integer               theOffset,
824                                             const Handle(Graphic3d_IndexBuffer)& theIndices);
825
826   //! Uploads ray-trace data to the GPU.
827   Standard_Boolean uploadRaytraceData (const Handle(OpenGl_Context)& theGlContext);
828
829   //! Generates shader prefix based on current ray-tracing options.
830   TCollection_AsciiString generateShaderPrefix (const Handle(OpenGl_Context)& theGlContext) const;
831
832   //! Performs safe exit when shaders initialization fails.
833   Standard_Boolean safeFailBack (const TCollection_ExtendedString& theMessage,
834                                  const Handle(OpenGl_Context)&     theGlContext);
835
836   //! Loads and compiles shader object from specified source.
837   Handle(OpenGl_ShaderObject) initShader (const GLenum                  theType,
838                                           const ShaderSource&           theSource,
839                                           const Handle(OpenGl_Context)& theGlContext);
840
841   //! Creates shader program from the given vertex and fragment shaders.
842   Handle(OpenGl_ShaderProgram) initProgram (const Handle(OpenGl_Context)&      theGlContext,
843                                             const Handle(OpenGl_ShaderObject)& theVertShader,
844                                             const Handle(OpenGl_ShaderObject)& theFragShader,
845                                             const TCollection_AsciiString& theName);
846
847   //! Initializes OpenGL/GLSL shader programs.
848   Standard_Boolean initRaytraceResources (const Standard_Integer theSizeX,
849                                           const Standard_Integer theSizeY,
850                                           const Handle(OpenGl_Context)& theGlContext);
851
852   //! Releases OpenGL/GLSL shader programs.
853   void releaseRaytraceResources (const Handle(OpenGl_Context)& theGlContext,
854                                  const Standard_Boolean        theToRebuild = Standard_False);
855
856   //! Updates auxiliary OpenGL frame buffers.
857   Standard_Boolean updateRaytraceBuffers (const Standard_Integer        theSizeX,
858                                           const Standard_Integer        theSizeY,
859                                           const Handle(OpenGl_Context)& theGlContext);
860
861   //! Generates viewing rays for corners of screen quad.
862   //! (ray tracing; path tracing for orthographic camera)
863   void updateCamera (const OpenGl_Mat4& theOrientation,
864                      const OpenGl_Mat4& theViewMapping,
865                      OpenGl_Vec3*       theOrigins,
866                      OpenGl_Vec3*       theDirects,
867                      OpenGl_Mat4&       theView,
868                      OpenGl_Mat4&       theUnView);
869
870   //! Generate viewing rays (path tracing, perspective camera).
871   void updatePerspCameraPT(const OpenGl_Mat4&           theOrientation,
872                            const OpenGl_Mat4&           theViewMapping,
873                            Graphic3d_Camera::Projection theProjection,
874                            OpenGl_Mat4&                 theViewPr,
875                            OpenGl_Mat4&                 theUnview,
876                            const int                    theWinSizeX,
877                            const int                    theWinSizeY);
878
879   //! Binds ray-trace textures to corresponding texture units.
880   void bindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext,
881                              int theStereoView);
882
883   //! Unbinds ray-trace textures from corresponding texture unit.
884   void unbindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext);
885
886   //! Sets uniform state for the given ray-tracing shader program.
887   Standard_Boolean setUniformState (const Standard_Integer        theProgramId,
888                                     const Standard_Integer        theSizeX,
889                                     const Standard_Integer        theSizeY,
890                                     Graphic3d_Camera::Projection  theProjection,
891                                     const Handle(OpenGl_Context)& theGlContext);
892
893   //! Runs ray-tracing shader programs.
894   Standard_Boolean runRaytraceShaders (const Standard_Integer        theSizeX,
895                                        const Standard_Integer        theSizeY,
896                                        Graphic3d_Camera::Projection  theProjection,
897                                        OpenGl_FrameBuffer*           theReadDrawFbo,
898                                        const Handle(OpenGl_Context)& theGlContext);
899
900   //! Runs classical (Whitted-style) ray-tracing kernel.
901   Standard_Boolean runRaytrace (const Standard_Integer        theSizeX,
902                                 const Standard_Integer        theSizeY,
903                                 Graphic3d_Camera::Projection  theProjection,
904                                 OpenGl_FrameBuffer*           theReadDrawFbo,
905                                 const Handle(OpenGl_Context)& theGlContext);
906
907   //! Runs path tracing (global illumination) kernel.
908   Standard_Boolean runPathtrace (const Standard_Integer        theSizeX,
909                                  const Standard_Integer        theSizeY,
910                                  Graphic3d_Camera::Projection  theProjection,
911                                  const Handle(OpenGl_Context)& theGlContext);
912
913   //! Runs path tracing (global illumination) kernel.
914   Standard_Boolean runPathtraceOut (Graphic3d_Camera::Projection  theProjection,
915                                     OpenGl_FrameBuffer*           theReadDrawFbo,
916                                     const Handle(OpenGl_Context)& theGlContext);
917
918   //! Redraws the window using OpenGL/GLSL ray-tracing or path tracing.
919   Standard_Boolean raytrace (const Standard_Integer        theSizeX,
920                              const Standard_Integer        theSizeY,
921                              Graphic3d_Camera::Projection  theProjection,
922                              OpenGl_FrameBuffer*           theReadDrawFbo,
923                              const Handle(OpenGl_Context)& theGlContext);
924
925 protected: //! @name fields related to ray-tracing
926
927   //! Result of RT/PT shaders initialization.
928   RaytraceInitStatus myRaytraceInitStatus;
929
930   //! Is ray-tracing geometry data valid?
931   Standard_Boolean myIsRaytraceDataValid;
932
933   //! True if warning about missing extension GL_ARB_bindless_texture has been displayed.
934   Standard_Boolean myIsRaytraceWarnTextures;
935
936   //! 3D scene geometry data for ray-tracing.
937   OpenGl_RaytraceGeometry myRaytraceGeometry;
938
939   //! Builder for triangle set.
940   opencascade::handle<BVH_Builder<Standard_ShortReal, 3> > myRaytraceBVHBuilder;
941
942   //! Compile-time ray-tracing parameters.
943   RaytracingParams myRaytraceParameters;
944
945   //! Radius of bounding sphere of the scene.
946   Standard_ShortReal myRaytraceSceneRadius;
947   //! Scene epsilon to prevent self-intersections.
948   Standard_ShortReal myRaytraceSceneEpsilon;
949
950   //! OpenGL/GLSL source of ray-tracing fragment shader.
951   ShaderSource myRaytraceShaderSource;
952   //! OpenGL/GLSL source of adaptive-AA fragment shader.
953   ShaderSource myPostFSAAShaderSource;
954   //! OpenGL/GLSL source of RT/PT display fragment shader.
955   ShaderSource myOutImageShaderSource;
956
957   //! OpenGL/GLSL ray-tracing fragment shader.
958   Handle(OpenGl_ShaderObject) myRaytraceShader;
959   //! OpenGL/GLSL adaptive-AA fragment shader.
960   Handle(OpenGl_ShaderObject) myPostFSAAShader;
961   //! OpenGL/GLSL ray-tracing display fragment shader.
962   Handle(OpenGl_ShaderObject) myOutImageShader;
963
964   //! OpenGL/GLSL ray-tracing shader program.
965   Handle(OpenGl_ShaderProgram) myRaytraceProgram;
966   //! OpenGL/GLSL adaptive-AA shader program.
967   Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
968   //! OpenGL/GLSL program for displaying texture.
969   Handle(OpenGl_ShaderProgram) myOutImageProgram;
970
971   //! Texture buffer of data records of bottom-level BVH nodes.
972   Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
973   //! Texture buffer of minimum points of bottom-level BVH nodes.
974   Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
975   //! Texture buffer of maximum points of bottom-level BVH nodes.
976   Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
977   //! Texture buffer of transformations of high-level BVH nodes.
978   Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
979
980   //! Texture buffer of vertex coords.
981   Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture;
982   //! Texture buffer of vertex normals.
983   Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture;
984   //! Texture buffer of vertex UV coords.
985   Handle(OpenGl_TextureBufferArb) myGeometryTexCrdTexture;
986   //! Texture buffer of triangle indices.
987   Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
988
989   //! Texture buffer of material properties.
990   Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
991   //! Texture buffer of light source properties.
992   Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
993
994   //! 1st framebuffer (FBO) to perform adaptive FSAA.
995   //! Used in compatibility mode (no adaptive sampling).
996   Handle(OpenGl_FrameBuffer) myRaytraceFBO1[2];
997   //! 2nd framebuffer (FBO) to perform adaptive FSAA.
998   //! Used in compatibility mode (no adaptive sampling).
999   Handle(OpenGl_FrameBuffer) myRaytraceFBO2[2];
1000
1001   //! Output textures (2 textures are used in stereo mode).
1002   //! Used if adaptive screen sampling is activated.
1003   Handle(OpenGl_Texture) myRaytraceOutputTexture[2];
1004
1005   //! Texture containing per-tile visual error estimation (2 textures are used in stereo mode).
1006   //! Used if adaptive screen sampling is activated.
1007   Handle(OpenGl_Texture) myRaytraceVisualErrorTexture[2];
1008   //! Texture containing offsets of sampled screen tiles (2 textures are used in stereo mode).
1009   //! Used if adaptive screen sampling is activated.
1010   Handle(OpenGl_Texture) myRaytraceTileOffsetsTexture[2];
1011   //! Texture containing amount of extra per-tile samples (2 textures are used in stereo mode).
1012   //! Used if adaptive screen sampling is activated.
1013   Handle(OpenGl_Texture) myRaytraceTileSamplesTexture[2];
1014
1015   //! Vertex buffer (VBO) for drawing dummy quad.
1016   OpenGl_VertexBuffer myRaytraceScreenQuad;
1017
1018   //! Cached locations of frequently used uniform variables.
1019   Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
1020
1021   //! State of OpenGL structures reflected to ray-tracing.
1022   std::map<const OpenGl_Structure*, StructState> myStructureStates;
1023
1024   //! PrimitiveArray to TriangleSet map for scene partial update.
1025   std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
1026
1027   //! Set of IDs of non-raytracable elements (to detect updates).
1028   std::set<Standard_Integer> myNonRaytraceStructureIDs;
1029
1030   //! Marks if environment map should be updated.
1031   Standard_Boolean myToUpdateEnvironmentMap;
1032
1033   //! State of OpenGL layer list.
1034   Standard_Size myRaytraceLayerListState;
1035
1036   //! Number of accumulated frames (for progressive rendering).
1037   Standard_Integer myAccumFrames;
1038
1039   //! Stored ray origins used for detection of camera movements.
1040   OpenGl_Vec3 myPreviousOrigins[3];
1041
1042   //! Bullard RNG to produce random sequence.
1043   math_BullardGenerator myRNG;
1044
1045   //! Tool object for sampling screen tiles in PT mode.
1046   OpenGl_TileSampler myTileSampler;
1047
1048   //! Camera position used for projective mode
1049   OpenGl_Vec3 myEyeOrig;
1050
1051   //! Camera view direction used for projective mode
1052   OpenGl_Vec3 myEyeView;
1053
1054   //! Camera's screen vertical direction used for projective mode
1055   OpenGl_Vec3 myEyeVert;
1056
1057   //! Camera's screen horizontal direction used for projective mode
1058   OpenGl_Vec3 myEyeSide;
1059
1060   //! Camera's screen size used for projective mode
1061   OpenGl_Vec2 myEyeSize;
1062
1063   //! Aperture radius of camera on previous frame used for depth-of-field (path tracing)
1064   float myPrevCameraApertureRadius;
1065
1066   //! Focal distance of camera on previous frame used for depth-of-field (path tracing)
1067   float myPrevCameraFocalPlaneDist;
1068
1069 public:
1070
1071   DEFINE_STANDARD_ALLOC
1072   DEFINE_STANDARD_RTTIEXT(OpenGl_View,Graphic3d_CView) // Type definition
1073
1074   friend class OpenGl_GraphicDriver;
1075   friend class OpenGl_Workspace;
1076   friend class OpenGl_LayerList;
1077   friend class OpenGl_FrameStats;
1078 };
1079
1080 #endif // _OpenGl_View_Header