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