0027670: Visualization - avoid duplication of structures defining primitive array...
[occt.git] / src / OpenGl / OpenGl_View.hxx
1 // Created on: 2011-09-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _OpenGl_View_Header
17 #define _OpenGl_View_Header
18
19 #include <MMgt_TShared.hxx>
20 #include <Standard_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 #include <Aspect_TypeOfTriedronPosition.hxx>
30
31 #include <Graphic3d_CView.hxx>
32 #include <Graphic3d_GraduatedTrihedron.hxx>
33 #include <Graphic3d_SequenceOfHClipPlane.hxx>
34 #include <Graphic3d_TypeOfShadingModel.hxx>
35 #include <Graphic3d_WorldViewProjState.hxx>
36 #include <Graphic3d_ZLayerSettings.hxx>
37
38 #include <OpenGl_AspectFace.hxx>
39 #include <OpenGl_BackgroundArray.hxx>
40 #include <OpenGl_BVHTreeSelector.hxx>
41 #include <OpenGl_Context.hxx>
42 #include <OpenGl_FrameBuffer.hxx>
43 #include <OpenGl_GraduatedTrihedron.hxx>
44 #include <OpenGl_LayerList.hxx>
45 #include <OpenGl_Light.hxx>
46 #include <OpenGl_LineAttributes.hxx>
47 #include <OpenGl_SceneGeometry.hxx>
48 #include <OpenGl_Structure.hxx>
49 #include <OpenGl_Trihedron.hxx>
50 #include <OpenGl_Window.hxx>
51 #include <OpenGl_Workspace.hxx>
52
53 #include <map>
54 #include <set>
55
56 struct OPENGL_ZCLIP
57 {
58   struct {
59     Standard_Boolean   IsOn;
60     Standard_ShortReal Limit; /* in the range [0., 1.] */
61   } Back;
62   struct {
63     Standard_Boolean   IsOn;
64     Standard_ShortReal Limit; /* in the range [0., 1.] */
65   } Front;
66 };
67
68 struct OPENGL_FOG
69 {
70   Standard_Boolean   IsOn;
71   Standard_ShortReal Front; /* in the range [0., 1.] */
72   Standard_ShortReal Back; /* in the range [0., 1.] */
73   OpenGl_Vec4        Color;
74 };
75
76 struct OpenGl_Matrix;
77
78 class Graphic3d_StructureManager;
79 class OpenGl_GraphicDriver;
80 class OpenGl_StateCounter;
81 class OpenGl_RaytraceMaterial;
82 class OpenGl_TriangleSet;
83 class OpenGl_Workspace;
84 class OpenGl_View;
85 DEFINE_STANDARD_HANDLE(OpenGl_View,Graphic3d_CView)
86
87 //! Implementation of OpenGl view.
88 class OpenGl_View : public Graphic3d_CView
89 {
90
91 public:
92
93   //! Constructor.
94   Standard_EXPORT OpenGl_View (const Handle(Graphic3d_StructureManager)& theMgr,
95                                const Handle(OpenGl_GraphicDriver)& theDriver,
96                                const Handle(OpenGl_Caps)& theCaps,
97                                Standard_Boolean& theDeviceLostFlag,
98                                OpenGl_StateCounter* theCounter);
99
100   //! Default destructor.
101   Standard_EXPORT virtual ~OpenGl_View();
102
103   Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theCtx);
104
105   //! Deletes and erases the view.
106   Standard_EXPORT virtual void Remove() Standard_OVERRIDE;
107
108   //! @param theDrawToFrontBuffer Advanced option to modify rendering mode:
109   //! 1. TRUE.  Drawing immediate mode structures directly to the front buffer over the scene image.
110   //! Fast, so preferred for interactive work (used by default).
111   //! However these extra drawings will be missed in image dump since it is performed from back buffer.
112   //! Notice that since no pre-buffering used the V-Sync will be ignored and rendering could be seen
113   //! in run-time (in case of slow hardware) and/or tearing may appear.
114   //! So this is strongly recommended to draw only simple (fast) structures.
115   //! 2. FALSE. Drawing immediate mode structures to the back buffer.
116   //! The complete scene is redrawn first, so this mode is slower if scene contains complex data and/or V-Sync
117   //! is turned on. But it works in any case and is especially useful for view dump because the dump image is read
118   //! from the back buffer.
119   //! @return previous mode.
120   Standard_EXPORT Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer) Standard_OVERRIDE;
121
122   //! Creates and maps rendering window to the view.
123   //! @param theWindow [in] the window.
124   //! @param theContext [in] the rendering context. If NULL the context will be created internally.
125   Standard_EXPORT virtual void SetWindow (const Handle(Aspect_Window)&  theWindow,
126                                           const Aspect_RenderingContext theContext) Standard_OVERRIDE;
127
128   //! Returns window associated with the view.
129   virtual Handle(Aspect_Window) Window() const Standard_OVERRIDE
130   { return myWindow->PlatformWindow(); }
131
132   //! Returns True if the window associated to the view is defined.
133   virtual Standard_Boolean IsDefined() const Standard_OVERRIDE
134   { return !myWindow.IsNull(); }
135
136   //! Handle changing size of the rendering window.
137   Standard_EXPORT virtual void Resized() Standard_OVERRIDE;
138
139   //! Redraw content of the view.
140   Standard_EXPORT virtual void Redraw() Standard_OVERRIDE;
141
142   //! Redraw immediate content of the view.
143   Standard_EXPORT virtual void RedrawImmediate() Standard_OVERRIDE;
144
145   //! Marks BVH tree for given priority list as dirty and marks primitive set for rebuild.
146   Standard_EXPORT virtual void Invalidate() Standard_OVERRIDE;
147
148   //! Return true if view content cache has been invalidated.
149   virtual Standard_Boolean IsInvalidated() Standard_OVERRIDE { return !myBackBufferRestored; }
150
151   //! Displays z-buffer trihedron.
152   Standard_EXPORT virtual void TriedronDisplay (const Aspect_TypeOfTriedronPosition thePosition = Aspect_TOTP_CENTER,
153                                                 const Quantity_NameOfColor theColor = Quantity_NOC_WHITE,
154                                                 const Standard_Real theScale = 0.02,
155                                                 const Standard_Boolean theAsWireframe = Standard_True) Standard_OVERRIDE;
156
157   //! Erases z-buffer trihedron.
158   Standard_EXPORT virtual void TriedronErase() Standard_OVERRIDE;
159
160   //! Setup parameters of z-buffer trihedron.
161   Standard_EXPORT virtual void ZBufferTriedronSetup (const Quantity_NameOfColor theXColor = Quantity_NOC_RED,
162                                                      const Quantity_NameOfColor theYColor = Quantity_NOC_GREEN,
163                                                      const Quantity_NameOfColor theZColor = Quantity_NOC_BLUE1,
164                                                      const Standard_Real theSizeRatio = 0.8,
165                                                      const Standard_Real theAxisDiametr = 0.05,
166                                                      const Standard_Integer theNbFacettes = 12) Standard_OVERRIDE;
167
168   //! Displays trihedron echo.
169   Standard_EXPORT virtual void TriedronEcho (const Aspect_TypeOfTriedronEcho theType = Aspect_TOTE_NONE) Standard_OVERRIDE;
170
171   //! Returns data of a graduated trihedron
172   const Graphic3d_GraduatedTrihedron& GetGraduatedTrihedron() Standard_OVERRIDE
173   { return myGTrihedronData; }
174
175   //! Displays Graduated Trihedron.
176   Standard_EXPORT virtual void GraduatedTrihedronDisplay (const Graphic3d_GraduatedTrihedron& theTrihedronData) Standard_OVERRIDE;
177
178   //! Erases Graduated Trihedron.
179   Standard_EXPORT virtual void GraduatedTrihedronErase() Standard_OVERRIDE;
180
181   //! Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object.
182   //! @param theMin [in] the minimum point of scene.
183   //! @param theMax [in] the maximum point of scene.
184   Standard_EXPORT virtual void GraduatedTrihedronMinMaxValues (const Graphic3d_Vec3 theMin, const Graphic3d_Vec3 theMax) Standard_OVERRIDE;
185
186   //! Dump active rendering buffer into specified memory buffer.
187   Standard_EXPORT virtual Standard_Boolean BufferDump (Image_PixMap& theImage,
188                                                        const Graphic3d_BufferType& theBufferType) Standard_OVERRIDE;
189
190   //! Print the contents of the view to the printer.
191   //! @param thePrinterDC        pass the PrinterDeviceContext (HDC)
192   //! @param theToShowBackground when set to FALSE then print the view without background
193   //!                            color (background is white) else set to TRUE for printing
194   //!                            with current background color
195   //! @param theFileName         if != NULL, then the view will be printed to a file
196   //! @param thePrintAlgorithm   select print algorithm: stretch, tile
197   //! @param theScaleFactor      scaling coefficient, used internally to scale the printings
198   //!                            accordingly to the scale factor selected in the printer properties dialog
199   //! @return Standard_True if the data is passed to the printer, otherwise Standard_False if
200   //! the print operation failed due to the printer errors, or lack of system memory. This might be related
201   //! to insufficient memory or some internal errors.
202   //! All this errors are indicated by the message boxes (on level of OpenGl_GraphicDriver).
203   //! Warning: This function can reuse FBO assigned to the view, please take it into account
204   //! if you use it for your purposes.
205   Standard_EXPORT virtual Standard_Boolean Print (const Aspect_Handle    thePrinterDC,
206                                                   const Standard_Boolean theToShowBackground,
207                                                   const Standard_CString theFileName,
208                                                   const Aspect_PrintAlgo thePrintAlgorithm = Aspect_PA_STRETCH,
209                                                   const Standard_Real    theScaleFactor = 1.0) Standard_OVERRIDE;
210
211   //! Export scene into the one of the Vector graphics formats (SVG, PS, PDF...).
212   //! In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits
213   //! on printing to laser printer). Notice however that results may differ a lot and
214   //! do not contain some elements.
215   Standard_EXPORT virtual Standard_Boolean Export (const Standard_CString theFileName,
216                                                    const Graphic3d_ExportFormat theFormat,
217                                                    const Graphic3d_SortType theSortType = Graphic3d_ST_BSP_Tree) Standard_OVERRIDE;
218
219   //! Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated.
220   Standard_EXPORT virtual void InvalidateBVHData (const Standard_Integer theLayerId) Standard_OVERRIDE;
221
222   //! Insert a new top-level z layer with the given ID.
223   Standard_EXPORT virtual void AddZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
224
225   //! Remove a z layer with the given ID.
226   Standard_EXPORT virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
227
228   //! Sets the settings for a single Z layer of specified view.
229   Standard_EXPORT virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId,
230                                                   const Graphic3d_ZLayerSettings& theSettings) Standard_OVERRIDE;
231
232   //! Returns the maximum Z layer ID.
233   //! First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax().
234   Standard_EXPORT virtual Standard_Integer ZLayerMax() const Standard_OVERRIDE;
235
236   //! Returns the bounding box of all structures displayed in the Z layer.
237   //! Never fails. If Z layer does not exist nothing happens.
238   Standard_EXPORT virtual void InvalidateZLayerBoundingBox (const Graphic3d_ZLayerId theLayerId) const Standard_OVERRIDE;
239
240   //! Returns the bounding box of all structures displayed in the Z layer.
241   //! Never fails. If Z layer does not exist the empty box is returned.
242   Standard_EXPORT virtual Graphic3d_BndBox4f ZLayerBoundingBox (const Graphic3d_ZLayerId        theLayerId,
243                                                                 const Handle(Graphic3d_Camera)& theCamera,
244                                                                 const Standard_Integer          theWindowWidth,
245                                                                 const Standard_Integer          theWindowHeight,
246                                                                 const Standard_Boolean          theToIgnoreInfiniteFlag) const Standard_OVERRIDE;
247
248   //! Returns pointer to an assigned framebuffer object.
249   Standard_EXPORT virtual Handle(Standard_Transient) FBO() const Standard_OVERRIDE;
250
251   //! Sets framebuffer object for offscreen rendering.
252   Standard_EXPORT virtual void SetFBO (const Handle(Standard_Transient)& theFbo) Standard_OVERRIDE;
253
254   //! Generate offscreen FBO in the graphic library.
255   //! If not supported on hardware returns NULL.
256   Standard_EXPORT virtual Handle(Standard_Transient) FBOCreate (const Standard_Integer theWidth,
257                                                                 const Standard_Integer theHeight) Standard_OVERRIDE;
258
259   //! Remove offscreen FBO from the graphic library
260   Standard_EXPORT virtual void FBORelease (Handle(Standard_Transient)& theFbo) Standard_OVERRIDE;
261
262   //! Read offscreen FBO configuration.
263   Standard_EXPORT virtual void FBOGetDimensions (const Handle(Standard_Transient)& theFbo,
264                                                  Standard_Integer& theWidth,
265                                                  Standard_Integer& theHeight,
266                                                  Standard_Integer& theWidthMax,
267                                                  Standard_Integer& theHeightMax) Standard_OVERRIDE;
268
269   //! Change offscreen FBO viewport.
270   Standard_EXPORT virtual void FBOChangeViewport (const Handle(Standard_Transient)& theFbo,
271                                                   const Standard_Integer theWidth,
272                                                   const Standard_Integer theHeight) Standard_OVERRIDE;
273
274 public:
275
276   //! Returns true if anti-aliasing is enabled for the view.
277   Standard_Boolean virtual IsAntialiasingEnabled() const Standard_OVERRIDE { return myAntiAliasing; }
278
279   //! Enable or disable anti-aliasing in the view.
280   virtual void SetAntialiasingEnabled (const Standard_Boolean theIsEnabled) Standard_OVERRIDE { myAntiAliasing = theIsEnabled; }
281
282   //! Returns background  fill color.
283   Standard_EXPORT virtual Aspect_Background Background() const Standard_OVERRIDE;
284
285   //! Sets background fill color.
286   Standard_EXPORT virtual void SetBackground (const Aspect_Background& theBackground) Standard_OVERRIDE;
287
288   //! Returns gradient background fill colors.
289   Standard_EXPORT virtual Aspect_GradientBackground GradientBackground() const Standard_OVERRIDE;
290
291   //! Sets gradient background fill colors.
292   Standard_EXPORT virtual void SetGradientBackground (const Aspect_GradientBackground& theBackground) Standard_OVERRIDE;
293
294   //! Returns background image texture file path.
295   Standard_EXPORT virtual TCollection_AsciiString BackgroundImage() Standard_OVERRIDE { return myBackgroundImagePath; }
296
297   //! Sets background image texture file path.
298   Standard_EXPORT virtual void SetBackgroundImage (const TCollection_AsciiString& theFilePath) Standard_OVERRIDE;
299
300   //! Returns background image fill style.
301   Standard_EXPORT virtual Aspect_FillMethod BackgroundImageStyle() const Standard_OVERRIDE;
302
303   //! Sets background image fill style.
304   Standard_EXPORT virtual void SetBackgroundImageStyle (const Aspect_FillMethod theFillStyle) Standard_OVERRIDE;
305
306   //! Returns environment texture set for the view.
307   Standard_EXPORT virtual Handle(Graphic3d_TextureEnv) TextureEnv() const Standard_OVERRIDE { return myTextureEnvData; }
308
309   //! Sets environment texture for the view.
310   Standard_EXPORT virtual void SetTextureEnv (const Handle(Graphic3d_TextureEnv)& theTextureEnv) Standard_OVERRIDE;
311
312   //! Returns the state of frustum culling optimization.
313   virtual Standard_Boolean IsCullingEnabled() const Standard_OVERRIDE { return myCulling; }
314
315   //! Enables or disables frustum culling optimization.
316   virtual void SetCullingEnabled (const Standard_Boolean theIsEnabled) Standard_OVERRIDE { myCulling = theIsEnabled; }
317
318   //! Returns shading model of the view.
319   virtual Graphic3d_TypeOfShadingModel ShadingModel() const Standard_OVERRIDE { return myShadingModel; }
320
321   //! Sets shading model of the view.
322   virtual void SetShadingModel (const Graphic3d_TypeOfShadingModel theModel) Standard_OVERRIDE { myShadingModel = theModel; }
323
324   //! Return backfacing model used for the view.
325   virtual Graphic3d_TypeOfBackfacingModel BackfacingModel() const Standard_OVERRIDE { return myBackfacing; }
326
327   //! Sets backfacing model for the view.
328   virtual void SetBackfacingModel (const Graphic3d_TypeOfBackfacingModel theModel) Standard_OVERRIDE { myBackfacing = theModel; }
329
330   //! Returns camera object of the view.
331   virtual const Handle(Graphic3d_Camera)& Camera() const Standard_OVERRIDE { return myCamera; }
332
333   //! Sets camera used by the view.
334   virtual void SetCamera (const Handle(Graphic3d_Camera)& theCamera) Standard_OVERRIDE { myCamera = theCamera; }
335
336   //! Returns the activity of back z-clipping plane.
337   virtual Standard_Boolean BackZClippingIsOn() const Standard_OVERRIDE { return myZClip.Back.IsOn; }
338
339   //! Activates the back Z-clipping plane.
340   virtual void SetBackZClippingOn (const Standard_Boolean theIsOn) Standard_OVERRIDE { myZClip.Back.IsOn = theIsOn; }
341
342   //! Returns the definition of the back Z-clipping plane.
343   virtual Standard_Real ZClippingBackPlane() const Standard_OVERRIDE { return myZClip.Back.Limit; }
344
345   //! Sets the definition of the back Z-clipping plane.
346   virtual void SetZClippingBackPlane (const Standard_Real theValue) Standard_OVERRIDE
347   {
348     myZClip.Back.Limit = static_cast<Standard_ShortReal> (theValue);
349   }
350
351   //! Returns the activity of front z-clipping plane.
352   virtual Standard_Boolean FrontZClippingIsOn() const Standard_OVERRIDE { return myZClip.Front.IsOn; }
353
354   //! Activates the front Z-clipping plane.
355   virtual void SetFrontZClippingOn (const Standard_Boolean theIsOn) Standard_OVERRIDE{ myZClip.Front.IsOn = theIsOn; }
356
357   //! Returns the definition of the front Z-clipping plane.
358   virtual Standard_Real ZClippingFrontPlane() const Standard_OVERRIDE { return myZClip.Front.Limit; }
359
360   //! Sets the definition of the front Z-clipping plane.
361   virtual void SetZClippingFrontPlane (const Standard_Real theValue) Standard_OVERRIDE
362   {
363     myZClip.Front.Limit = static_cast<Standard_ShortReal> (theValue);
364   }
365
366   //! Returns the activity of depth cueing.
367   virtual Standard_Boolean DepthCueingIsOn() const Standard_OVERRIDE { return myFog.IsOn; }
368
369   //! Sets the activity of depth cueing.
370   virtual void SetDepthCueingOn (const Standard_Boolean theIsOn) Standard_OVERRIDE { myFog.IsOn = theIsOn; }
371
372   //! Returns the back depth cueing plane.
373   virtual Standard_Real DepthCueingBackPlane() const Standard_OVERRIDE { return myFog.Back; }
374
375   //! Set the back depth cueing plane.
376   virtual void SetDepthCueingBackPlane (const Standard_Real theValue) Standard_OVERRIDE
377   {
378     myFog.Back = static_cast<Standard_ShortReal> (theValue);
379   }
380
381   //! Returns the front depth cueing plane.
382   virtual Standard_Real DepthCueingFrontPlane() const Standard_OVERRIDE { return myFog.Front; }
383
384   //! Set the front depth cueing plane.
385   virtual void SetDepthCueingFrontPlane (const Standard_Real theValue) Standard_OVERRIDE
386   {
387     myFog.Front = static_cast<Standard_ShortReal> (theValue);
388   }
389
390   //! Returns true if GL lighting is enabled.
391   virtual Standard_Boolean IsGLLightEnabled() const Standard_OVERRIDE { return myUseGLLight; }
392
393   //! Sets GL lighting enabled or disable state.
394   virtual void SetGLLightEnabled (const Standard_Boolean theIsEnabled) Standard_OVERRIDE { myUseGLLight = theIsEnabled; }
395
396   //! Returns list of lights of the view.
397   virtual const Graphic3d_ListOfCLight& Lights() const Standard_OVERRIDE { return myLights; }
398
399   //! Sets list of lights for the view.
400   virtual void SetLights (const Graphic3d_ListOfCLight& theLights) Standard_OVERRIDE
401   {
402     myLights = theLights;
403     myCurrLightSourceState = myStateCounter->Increment();
404   }
405
406   //! Returns list of clip planes set for the view.
407   virtual const Graphic3d_SequenceOfHClipPlane& ClipPlanes() const Standard_OVERRIDE { return myClipPlanes; }
408
409   //! Sets list of clip planes for the view.
410   virtual void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane& thePlanes) Standard_OVERRIDE { myClipPlanes = thePlanes; }
411
412 public:
413
414   //! Returns background color.
415   const Quantity_ColorRGBA& BackgroundColor() const { return myBgColor; }
416
417   //! Change trihedron.
418   OpenGl_Trihedron& ChangeTrihedron() { return myTrihedron; }
419
420   //! Change graduated trihedron.
421   OpenGl_GraduatedTrihedron& ChangeGraduatedTrihedron() { return myGraduatedTrihedron; }
422
423   void SetTextureEnv (const Handle(OpenGl_Context)&       theCtx,
424                       const Handle(Graphic3d_TextureEnv)& theTexture);
425
426   void SetBackgroundTextureStyle (const Aspect_FillMethod FillStyle);
427
428   void SetBackgroundGradient (const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AType);
429
430   void SetBackgroundGradientType (const Aspect_GradientFillMethod AType);
431
432   //! Returns list of OpenGL Z-layers.
433   const OpenGl_LayerList& LayerList() const { return myZLayers; }
434
435   //! Returns list of openGL light sources.
436   const OpenGl_ListOfLight& LightList() const { return myLights; }
437
438   //! Returns OpenGL window implementation.
439   const Handle(OpenGl_Window) GlWindow() const { return myWindow; }
440
441   //! Returns OpenGL environment map.
442   const Handle(OpenGl_Texture)& GlTextureEnv() const { return myTextureEnv; }
443
444   //! Returns selector for BVH tree, providing a possibility to store information
445   //! about current view volume and to detect which objects are overlapping it.
446   OpenGl_BVHTreeSelector& BVHTreeSelector() { return myBVHSelector; }
447
448   //! Returns true if there are immediate structures to display
449   bool HasImmediateStructures() const
450   {
451     return myZLayers.NbImmediateStructures() != 0;
452   }
453
454 protected: //! @name Internal methods for managing GL resources
455
456   //! Initializes OpenGl resource for environment texture.
457   void initTextureEnv (const Handle(OpenGl_Context)& theContext);
458
459 protected: //! @name low-level redrawing sub-routines
460
461   //! Redraws view for the given monographic camera projection, or left/right eye.
462   Standard_EXPORT virtual void redraw (const Graphic3d_Camera::Projection theProjection,
463                                        OpenGl_FrameBuffer*                theReadDrawFbo);
464
465   //! Redraws view for the given monographic camera projection, or left/right eye.
466   //!
467   //! Method will blit snapshot containing main scene (myMainSceneFbos or BackBuffer)
468   //! into presentation buffer (myMainSceneFbos -> offscreen FBO or
469   //! myMainSceneFbos -> BackBuffer or BackBuffer -> FrontBuffer),
470   //! and redraw immediate structures on top.
471   //!
472   //! When scene caching is disabled (myTransientDrawToFront, no double buffer in window, etc.),
473   //! the first step (blitting) will be skipped.
474   //!
475   //! @return false if immediate structures has been rendered directly into FrontBuffer
476   //! and Buffer Swap should not be called.
477   Standard_EXPORT virtual bool redrawImmediate (const Graphic3d_Camera::Projection theProjection,
478                                                 OpenGl_FrameBuffer* theReadFbo,
479                                                 OpenGl_FrameBuffer* theDrawFbo,
480                                                 const Standard_Boolean theIsPartialUpdate = Standard_False);
481
482   //! Blit image from/to specified buffers.
483   Standard_EXPORT bool blitBuffers (OpenGl_FrameBuffer*    theReadFbo,
484                                     OpenGl_FrameBuffer*    theDrawFbo,
485                                     const Standard_Boolean theToFlip = Standard_False);
486
487   //! Setup default FBO.
488   Standard_EXPORT void bindDefaultFbo (OpenGl_FrameBuffer* theCustomFbo = NULL);
489
490 protected: //! @name Rendering of GL graphics (with prepared drawing buffer).
491
492   //! Renders the graphical contents of the view into the preprepared window or framebuffer.
493   //! @param theProjection [in] the projection that should be used for rendering.
494   //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
495   //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
496   Standard_EXPORT virtual void render (Graphic3d_Camera::Projection theProjection,
497                                        OpenGl_FrameBuffer*          theReadDrawFbo,
498                                        const Standard_Boolean       theToDrawImmediate);
499
500   //! Renders the graphical scene.
501   //! @param theProjection [in] the projection that is used for rendering.
502   //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
503   //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
504   Standard_EXPORT virtual void renderScene (Graphic3d_Camera::Projection theProjection,
505                                             OpenGl_FrameBuffer*    theReadDrawFbo,
506                                             const Standard_Boolean theToDrawImmediate);
507
508   //! Draw background (gradient / image)
509   Standard_EXPORT virtual void drawBackground (const Handle(OpenGl_Workspace)& theWorkspace);
510
511   //! Render set of structures presented in the view.
512   //! @param theProjection [in] the projection that is used for rendering.
513   //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
514   //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
515   Standard_EXPORT virtual void renderStructs (Graphic3d_Camera::Projection theProjection,
516                                               OpenGl_FrameBuffer*    theReadDrawFbo,
517                                               const Standard_Boolean theToDrawImmediate);
518
519   //! Renders trihedron.
520   void renderTrihedron (const Handle(OpenGl_Workspace) &theWorkspace);
521
522 private:
523
524   //! Adds the structure to display lists of the view.
525   Standard_EXPORT virtual void displayStructure (const Handle(Graphic3d_CStructure)& theStructure,
526                                                  const Standard_Integer thePriority) Standard_OVERRIDE;
527
528   //! Erases the structure from display lists of the view.
529   Standard_EXPORT virtual void eraseStructure (const Handle(Graphic3d_CStructure)& theStructure) Standard_OVERRIDE;
530
531   //! Change Z layer of a structure already presented in view.
532   Standard_EXPORT virtual void changeZLayer (const Handle(Graphic3d_CStructure)& theCStructure,
533                                              const Graphic3d_ZLayerId theNewLayerId) Standard_OVERRIDE;
534
535   //! Changes the priority of a structure within its Z layer in the specified view.
536   Standard_EXPORT virtual void changePriority (const Handle(Graphic3d_CStructure)& theCStructure,
537                                                const Standard_Integer theNewPriority) Standard_OVERRIDE;
538
539   //! Returns zoom-scale factor.
540   Standard_EXPORT virtual Standard_Real considerZoomPersistenceObjects (const Graphic3d_ZLayerId        theLayerId,
541                                                                         const Handle(Graphic3d_Camera)& theCamera,
542                                                                         const Standard_Integer          theWindowWidth,
543                                                                         const Standard_Integer          theWindowHeight,
544                                                                         const Standard_Boolean          theToIgnoreInfiniteFlag) const Standard_OVERRIDE;
545
546 private:
547
548   //! Copy content of Back buffer to the Front buffer.
549   void copyBackToFront();
550
551   //! Initialize blit quad.
552   OpenGl_VertexBuffer* initBlitQuad (const Standard_Boolean theToFlip);
553
554   //! Blend together views pair into stereo image.
555   void drawStereoPair (OpenGl_FrameBuffer* theDrawFbo);
556
557 protected:
558
559   OpenGl_GraphicDriver*    myDriver;
560   Handle(OpenGl_Window)    myWindow;
561   Handle(OpenGl_Workspace) myWorkspace;
562   Handle(OpenGl_Caps)      myCaps;
563   Standard_Boolean&        myDeviceLostFlag;
564   Standard_Boolean         myWasRedrawnGL;
565
566   Standard_Boolean                myAntiAliasing;
567   Standard_Boolean                myCulling;
568   Graphic3d_TypeOfShadingModel    myShadingModel;
569   Graphic3d_TypeOfBackfacingModel myBackfacing;
570   Quantity_ColorRGBA              myBgColor;
571   OPENGL_FOG                      myFog;
572   OPENGL_ZCLIP                    myZClip;
573   Graphic3d_SequenceOfHClipPlane  myClipPlanes;
574   Handle(Graphic3d_Camera)        myCamera;
575   Handle(OpenGl_FrameBuffer)      myFBO;
576   Standard_Boolean                myUseGLLight;
577   Standard_Boolean                myToShowTrihedron;
578   Standard_Boolean                myToShowGradTrihedron;
579   TCollection_AsciiString         myBackgroundImagePath;
580   Handle(Graphic3d_TextureEnv)    myTextureEnvData;
581   Graphic3d_GraduatedTrihedron    myGTrihedronData;
582
583   OpenGl_ListOfLight              myNoShadingLight;
584   OpenGl_ListOfLight              myLights;
585   OpenGl_LayerList                myZLayers; //!< main list of displayed structure, sorted by layers
586
587   Graphic3d_WorldViewProjState    myWorldViewProjState; //!< camera modification state
588   OpenGl_StateCounter*            myStateCounter;
589   Standard_Size                   myCurrLightSourceState;
590
591   typedef std::pair<Standard_Size, Standard_Size> StateInfo;
592
593   StateInfo myLastOrientationState;
594   StateInfo myLastViewMappingState;
595   StateInfo myLastLightSourceState;
596
597   //! Is needed for selection of overlapping objects and storage of the current view volume
598   OpenGl_BVHTreeSelector myBVHSelector;
599
600   OpenGl_Trihedron          myTrihedron;
601   OpenGl_GraduatedTrihedron myGraduatedTrihedron;
602
603   Handle(OpenGl_Texture) myTextureEnv;
604
605 protected: //! @name Rendering properties
606
607   //! Two framebuffers (left and right views) store cached main presentation
608   //! of the view (without presentation of immediate layers).
609   GLint                      myFboColorFormat;        //!< sized format for color attachments
610   GLint                      myFboDepthFormat;        //!< sized format for depth-stencil attachments
611   Handle(OpenGl_FrameBuffer) myMainSceneFbos[2];
612   Handle(OpenGl_FrameBuffer) myImmediateSceneFbos[2]; //!< Additional buffers for immediate layer in stereo mode.
613   OpenGl_VertexBuffer        myFullScreenQuad;        //!< Vertices for full-screen quad rendering.
614   OpenGl_VertexBuffer        myFullScreenQuadFlip;
615   Standard_Boolean           myToFlipOutput;          //!< Flag to draw result image upside-down
616   unsigned int               myFrameCounter;          //!< redraw counter, for debugging
617   Standard_Boolean           myHasFboBlit;            //!< disable FBOs on failure
618   Standard_Boolean           myToDisableMSAA;         //!< disable MSAA after failure
619   Standard_Boolean           myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
620   Standard_Boolean           myBackBufferRestored;
621   Standard_Boolean           myIsImmediateDrawn;     //!< flag indicates that immediate mode buffer contains some data
622
623 protected: //! @name Background parameters
624
625   OpenGl_AspectFace*      myTextureParams;   //!< Stores texture and its parameters for textured background
626   OpenGl_BackgroundArray* myBgGradientArray; //!< Primitive array for gradient background
627   OpenGl_BackgroundArray* myBgTextureArray;  //!< Primitive array for texture  background
628
629 protected: //! @name data types related to ray-tracing
630
631   //! Result of OpenGL shaders initialization.
632   enum RaytraceInitStatus
633   {
634     OpenGl_RT_NONE,
635     OpenGl_RT_INIT,
636     OpenGl_RT_FAIL
637   };
638
639   //! Describes update mode (state).
640   enum RaytraceUpdateMode
641   {
642     OpenGl_GUM_CHECK,   //!< check geometry state
643     OpenGl_GUM_PREPARE, //!< collect unchanged objects
644     OpenGl_GUM_REBUILD  //!< rebuild changed and new objects
645   };
646
647   //! Defines frequently used shader variables.
648   enum ShaderVariableIndex
649   {
650     OpenGl_RT_aPosition,
651
652     // camera position
653     OpenGl_RT_uOriginLT,
654     OpenGl_RT_uOriginLB,
655     OpenGl_RT_uOriginRT,
656     OpenGl_RT_uOriginRB,
657     OpenGl_RT_uDirectLT,
658     OpenGl_RT_uDirectLB,
659     OpenGl_RT_uDirectRT,
660     OpenGl_RT_uDirectRB,
661     OpenGl_RT_uViewMat,
662     OpenGl_RT_uUnviewMat,
663
664     // 3D scene params
665     OpenGl_RT_uSceneRad,
666     OpenGl_RT_uSceneEps,
667     OpenGl_RT_uLightAmbnt,
668     OpenGl_RT_uLightCount,
669
670     // background params
671     OpenGl_RT_uBackColorTop,
672     OpenGl_RT_uBackColorBot,
673
674     // ray-tracing params
675     OpenGl_RT_uShadowsEnabled,
676     OpenGl_RT_uReflectEnabled,
677     OpenGl_RT_uSphereMapEnabled,
678     OpenGl_RT_uSphereMapForBack,
679     OpenGl_RT_uTexSamplersArray,
680     OpenGl_RT_uBlockedRngEnabled,
681
682     // sampled frame params
683     OpenGl_RT_uSampleWeight,
684     OpenGl_RT_uFrameRndSeed,
685
686     // adaptive FSAA params
687     OpenGl_RT_uOffsetX,
688     OpenGl_RT_uOffsetY,
689     OpenGl_RT_uSamples,
690
691     OpenGl_RT_NbVariables // special field
692   };
693
694   //! Defines texture samplers.
695   enum ShaderSamplerNames
696   {
697     OpenGl_RT_SceneNodeInfoTexture  = 0,
698     OpenGl_RT_SceneMinPointTexture  = 1,
699     OpenGl_RT_SceneMaxPointTexture  = 2,
700     OpenGl_RT_SceneTransformTexture = 3,
701
702     OpenGl_RT_GeometryVertexTexture = 4,
703     OpenGl_RT_GeometryNormalTexture = 5,
704     OpenGl_RT_GeometryTexCrdTexture = 6,
705     OpenGl_RT_GeometryTriangTexture = 7,
706
707     OpenGl_RT_EnvironmentMapTexture = 8,
708
709     OpenGl_RT_RaytraceMaterialTexture = 9,
710     OpenGl_RT_RaytraceLightSrcTexture = 10,
711
712     OpenGl_RT_FsaaInputTexture = 11,
713     OpenGl_RT_PrevAccumTexture = 12,
714     OpenGl_RT_DepthTexture = 13,
715
716     OpenGl_RT_OpenGlColorTexture = 14,
717     OpenGl_RT_OpenGlDepthTexture = 15
718   };
719
720   //! Tool class for management of shader sources.
721   class ShaderSource
722   {
723   public:
724
725     //! Default shader prefix - empty string.
726     static const TCollection_AsciiString EMPTY_PREFIX;
727
728     //! Creates new uninitialized shader source.
729     ShaderSource()
730     {
731       //
732     }
733
734   public:
735
736     //! Returns error description in case of load fail.
737     const TCollection_AsciiString& ErrorDescription() const
738     {
739       return myError;
740     }
741
742     //! Returns prefix to insert before the source.
743     const TCollection_AsciiString& Prefix() const
744     {
745       return myPrefix;
746     }
747
748     //! Sets prefix to insert before the source.
749     void SetPrefix (const TCollection_AsciiString& thePrefix)
750     {
751       myPrefix = thePrefix;
752     }
753
754     //! Returns shader source combined with prefix.
755     TCollection_AsciiString Source() const;
756
757     //! Loads shader source from specified files.
758     Standard_Boolean Load (const TCollection_AsciiString* theFileNames, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX);
759
760   private:
761
762     TCollection_AsciiString mySource; //!< Source string of the shader object
763     TCollection_AsciiString myPrefix; //!< Prefix to insert before the source
764     TCollection_AsciiString myError;  //!< error state
765
766   };
767
768   //! Default ray-tracing depth.
769   static const Standard_Integer THE_DEFAULT_NB_BOUNCES = 3;
770
771   //! Default size of traversal stack.
772   static const Standard_Integer THE_DEFAULT_STACK_SIZE = 10;
773
774   //! Compile-time ray-tracing parameters.
775   struct RaytracingParams
776   {
777     //! Actual size of traversal stack in shader program.
778     Standard_Integer StackSize;
779
780     //! Actual ray-tracing depth (number of ray bounces).
781     Standard_Integer NbBounces;
782
783     //! Enables/disables light propagation through transparent media.
784     Standard_Boolean TransparentShadows;
785
786     //! Enables/disables global illumination (GI) effects.
787     Standard_Boolean GlobalIllumination;
788
789     //! Enables/disables the use of OpenGL bindless textures.
790     Standard_Boolean UseBindlessTextures;
791
792     //! Creates default compile-time ray-tracing parameters.
793     RaytracingParams()
794     : StackSize (THE_DEFAULT_STACK_SIZE),
795       NbBounces (THE_DEFAULT_NB_BOUNCES),
796       TransparentShadows (Standard_False),
797       GlobalIllumination  (Standard_False),
798       UseBindlessTextures (Standard_False)
799     {
800       //
801     }
802   };
803
804   //! Describes state of OpenGL structure.
805   struct StructState
806   {
807     Standard_Size StructureState;
808     Standard_Size InstancedState;
809
810     //! Creates new structure state.
811     StructState (const Standard_Size theStructureState = 0,
812                  const Standard_Size theInstancedState = 0)
813     : StructureState (theStructureState),
814       InstancedState (theInstancedState)
815     {
816       //
817     }
818
819     //! Creates new structure state.
820     StructState (const OpenGl_Structure* theStructure)
821     {
822       StructureState = theStructure->ModificationState();
823
824       InstancedState = theStructure->InstancedStructure() != NULL ?
825         theStructure->InstancedStructure()->ModificationState() : 0;
826     }
827   };
828
829 protected: //! @name methods related to ray-tracing
830
831   //! Updates 3D scene geometry for ray-tracing.
832   Standard_Boolean updateRaytraceGeometry (const RaytraceUpdateMode      theMode,
833                                            const Standard_Integer        theViewId,
834                                            const Handle(OpenGl_Context)& theGlContext);
835
836   //! Updates 3D scene light sources for ray-tracing.
837   Standard_Boolean updateRaytraceLightSources (const OpenGl_Mat4& theInvModelView, const Handle(OpenGl_Context)& theGlContext);
838
839   //! Updates environment map for ray-tracing.
840   Standard_Boolean updateRaytraceEnvironmentMap (const Handle(OpenGl_Context)& theGlContext);
841
842   //! Checks to see if the OpenGL structure is modified.
843   Standard_Boolean toUpdateStructure (const OpenGl_Structure* theStructure);
844
845   //! Adds OpenGL structure to ray-traced scene geometry.
846   Standard_Boolean addRaytraceStructure (const OpenGl_Structure*       theStructure,
847                                          const Handle(OpenGl_Context)& theGlContext);
848
849   //! Adds OpenGL groups to ray-traced scene geometry.
850   Standard_Boolean addRaytraceGroups (const OpenGl_Structure*        theStructure,
851                                       const OpenGl_RaytraceMaterial& theStructMat,
852                                       const Graphic3d_Mat4*          theTransform,
853                                       const Handle(OpenGl_Context)&  theGlContext);
854
855   //! Creates ray-tracing material properties.
856   OpenGl_RaytraceMaterial convertMaterial (const OpenGl_AspectFace*      theAspect,
857                                            const Handle(OpenGl_Context)& theGlContext);
858
859   //! Adds OpenGL primitive array to ray-traced scene geometry.
860   OpenGl_TriangleSet* addRaytracePrimitiveArray (const OpenGl_PrimitiveArray* theArray,
861                                                  const Standard_Integer       theMatID,
862                                                  const OpenGl_Mat4*           theTrans);
863
864   //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
865   Standard_Boolean addRaytraceVertexIndices (OpenGl_TriangleSet&                  theSet,
866                                              const Standard_Integer               theMatID,
867                                              const Standard_Integer               theCount,
868                                              const Standard_Integer               theOffset,
869                                              const OpenGl_PrimitiveArray&         theArray);
870
871   //! Adds OpenGL triangle array to ray-traced scene geometry.
872   Standard_Boolean addRaytraceTriangleArray (OpenGl_TriangleSet&                  theSet,
873                                              const Standard_Integer               theMatID,
874                                              const Standard_Integer               theCount,
875                                              const Standard_Integer               theOffset,
876                                              const Handle(Graphic3d_IndexBuffer)& theIndices);
877
878   //! Adds OpenGL triangle fan array to ray-traced scene geometry.
879   Standard_Boolean addRaytraceTriangleFanArray (OpenGl_TriangleSet&                  theSet,
880                                                 const Standard_Integer               theMatID,
881                                                 const Standard_Integer               theCount,
882                                                 const Standard_Integer               theOffset,
883                                                 const Handle(Graphic3d_IndexBuffer)& theIndices);
884
885   //! Adds OpenGL triangle strip array to ray-traced scene geometry.
886   Standard_Boolean addRaytraceTriangleStripArray (OpenGl_TriangleSet&                  theSet,
887                                                   const Standard_Integer               theMatID,
888                                                   const Standard_Integer               theCount,
889                                                   const Standard_Integer               theOffset,
890                                                   const Handle(Graphic3d_IndexBuffer)& theIndices);
891
892   //! Adds OpenGL quadrangle array to ray-traced scene geometry.
893   Standard_Boolean addRaytraceQuadrangleArray (OpenGl_TriangleSet&                  theSet,
894                                                const Standard_Integer               theMatID,
895                                                const Standard_Integer               theCount,
896                                                const Standard_Integer               theOffset,
897                                                const Handle(Graphic3d_IndexBuffer)& theIndices);
898
899   //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
900   Standard_Boolean addRaytraceQuadrangleStripArray (OpenGl_TriangleSet&                  theSet,
901                                                     const Standard_Integer               theMatID,
902                                                     const Standard_Integer               theCount,
903                                                     const Standard_Integer               theOffset,
904                                                     const Handle(Graphic3d_IndexBuffer)& theIndices);
905
906   //! Adds OpenGL polygon array to ray-traced scene geometry.
907   Standard_Boolean addRaytracePolygonArray (OpenGl_TriangleSet&                  theSet,
908                                             const Standard_Integer               theMatID,
909                                             const Standard_Integer               theCount,
910                                             const Standard_Integer               theOffset,
911                                             const Handle(Graphic3d_IndexBuffer)& theIndices);
912
913   //! Uploads ray-trace data to the GPU.
914   Standard_Boolean uploadRaytraceData (const Handle(OpenGl_Context)& theGlContext);
915
916   //! Generates shader prefix based on current ray-tracing options.
917   TCollection_AsciiString generateShaderPrefix (const Handle(OpenGl_Context)& theGlContext) const;
918
919   //! Performs safe exit when shaders initialization fails.
920   Standard_Boolean safeFailBack (const TCollection_ExtendedString& theMessage,
921                                  const Handle(OpenGl_Context)&     theGlContext);
922
923   //! Loads and compiles shader object from specified source.
924   Handle(OpenGl_ShaderObject) initShader (const GLenum                  theType,
925                                           const ShaderSource&           theSource,
926                                           const Handle(OpenGl_Context)& theGlContext);
927
928   //! Creates shader program from the given vertex and fragment shaders.
929   Handle(OpenGl_ShaderProgram) initProgram (const Handle(OpenGl_Context)&      theGlContext,
930                                             const Handle(OpenGl_ShaderObject)& theVertShader,
931                                             const Handle(OpenGl_ShaderObject)& theFragShader);
932
933   //! Initializes OpenGL/GLSL shader programs.
934   Standard_Boolean initRaytraceResources (const Handle(OpenGl_Context)& theGlContext);
935
936   //! Releases OpenGL/GLSL shader programs.
937   void releaseRaytraceResources (const Handle(OpenGl_Context)& theGlContext);
938
939   //! Updates auxiliary OpenGL frame buffers.
940   Standard_Boolean updateRaytraceBuffers (const Standard_Integer        theSizeX,
941                                           const Standard_Integer        theSizeY,
942                                           const Handle(OpenGl_Context)& theGlContext);
943
944   //! Generates viewing rays for corners of screen quad.
945   void updateCamera (const OpenGl_Mat4& theOrientation,
946                      const OpenGl_Mat4& theViewMapping,
947                      OpenGl_Vec3*       theOrigins,
948                      OpenGl_Vec3*       theDirects,
949                      OpenGl_Mat4&       theView,
950                      OpenGl_Mat4&       theUnView);
951
952   //! Binds ray-trace textures to corresponding texture units.
953   void bindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext);
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 OpenGl_Vec3*            theOrigins,
960                                     const OpenGl_Vec3*            theDirects,
961                                     const OpenGl_Mat4&            theViewMat,
962                                     const OpenGl_Mat4&            theUnviewMat,
963                                     const Standard_Integer        theProgramId,
964                                     const Handle(OpenGl_Context)& theGlContext);
965
966   //! Runs ray-tracing shader programs.
967   Standard_Boolean runRaytraceShaders (const Standard_Integer        theSizeX,
968                                        const Standard_Integer        theSizeY,
969                                        const OpenGl_Vec3*            theOrigins,
970                                        const OpenGl_Vec3*            theDirects,
971                                        const OpenGl_Mat4&            theViewMat,
972                                        const OpenGl_Mat4&            theUnviewMat,
973                                        Graphic3d_Camera::Projection  theProjection,
974                                        OpenGl_FrameBuffer*           theReadDrawFbo,
975                                        const Handle(OpenGl_Context)& theGlContext);
976
977   //! Redraws the window using OpenGL/GLSL ray-tracing.
978   Standard_Boolean raytrace (const Standard_Integer        theSizeX,
979                              const Standard_Integer        theSizeY,
980                              Graphic3d_Camera::Projection  theProjection,
981                              OpenGl_FrameBuffer*           theReadDrawFbo,
982                              const Handle(OpenGl_Context)& theGlContext);
983
984 protected: //! @name fields related to ray-tracing
985
986   //! Result of shaders initialization.
987   RaytraceInitStatus myRaytraceInitStatus;
988
989   //! Is geometry data valid?
990   Standard_Boolean myIsRaytraceDataValid;
991
992   //! Warning about missing extension GL_ARB_bindless_texture has been displayed?
993   Standard_Boolean myIsRaytraceWarnTextures;
994
995   //! 3D scene geometry data for ray-tracing.
996   OpenGl_RaytraceGeometry myRaytraceGeometry;
997
998   //! Compile-time ray-tracing parameters.
999   RaytracingParams myRaytraceParameters;
1000
1001   //! Radius of bounding sphere of the scene.
1002   Standard_ShortReal myRaytraceSceneRadius;
1003   //! Scene epsilon to prevent self-intersections.
1004   Standard_ShortReal myRaytraceSceneEpsilon;
1005
1006   //! OpenGL/GLSL source of ray-tracing fragment shader.
1007   ShaderSource myRaytraceShaderSource;
1008   //! OpenGL/GLSL source of adaptive-AA fragment shader.
1009   ShaderSource myPostFSAAShaderSource;
1010
1011   //! OpenGL/GLSL ray-tracing fragment shader.
1012   Handle(OpenGl_ShaderObject) myRaytraceShader;
1013   //! OpenGL/GLSL adaptive-AA fragment shader.
1014   Handle(OpenGl_ShaderObject) myPostFSAAShader;
1015
1016   //! OpenGL/GLSL ray-tracing shader program.
1017   Handle(OpenGl_ShaderProgram) myRaytraceProgram;
1018   //! OpenGL/GLSL adaptive-AA shader program.
1019   Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
1020   //! OpenGL/GLSL program for displaying texture.
1021   Handle(OpenGl_ShaderProgram) myOutImageProgram;
1022
1023   //! Texture buffer of data records of bottom-level BVH nodes.
1024   Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
1025   //! Texture buffer of minimum points of bottom-level BVH nodes.
1026   Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
1027   //! Texture buffer of maximum points of bottom-level BVH nodes.
1028   Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
1029   //! Texture buffer of transformations of high-level BVH nodes.
1030   Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
1031
1032   //! Texture buffer of vertex coords.
1033   Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture;
1034   //! Texture buffer of vertex normals.
1035   Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture;
1036   //! Texture buffer of vertex UV coords.
1037   Handle(OpenGl_TextureBufferArb) myGeometryTexCrdTexture;
1038   //! Texture buffer of triangle indices.
1039   Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
1040
1041   //! Texture buffer of material properties.
1042   Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
1043   //! Texture buffer of light source properties.
1044   Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
1045
1046   //! 1st framebuffer (FBO) to perform adaptive FSAA.
1047   Handle(OpenGl_FrameBuffer) myRaytraceFBO1[2];
1048   //! 2nd framebuffer (FBO) to perform adaptive FSAA.
1049   Handle(OpenGl_FrameBuffer) myRaytraceFBO2[2];
1050   //! Framebuffer (FBO) for preliminary OpenGL output.
1051   Handle(OpenGl_FrameBuffer) myOpenGlFBO;
1052   Handle(OpenGl_FrameBuffer) myOpenGlFBO2;
1053
1054   //! Vertex buffer (VBO) for drawing dummy quad.
1055   OpenGl_VertexBuffer myRaytraceScreenQuad;
1056
1057   //! Cached locations of frequently used uniform variables.
1058   Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
1059
1060   //! State of OpenGL structures reflected to ray-tracing.
1061   std::map<const OpenGl_Structure*, StructState> myStructureStates;
1062
1063   //! PrimitiveArray to TriangleSet map for scene partial update.
1064   std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
1065
1066   //! Set of IDs of non-raytracable elements (to detect updates).
1067   std::set<Standard_Integer> myNonRaytraceStructureIDs;
1068
1069   //! Render filter to filter out all raytracable structures.
1070   Handle(OpenGl_RaytraceFilter) myRaytraceFilter;
1071
1072   //! Marks if environment map should be updated.
1073   Standard_Boolean myToUpdateEnvironmentMap;
1074
1075   //! State of OpenGL layer list.
1076   Standard_Size myLayerListState;
1077
1078   //! Number of accumulated frames (for progressive rendering).
1079   Standard_Integer myAccumFrames;
1080
1081   //! Stored ray origins used for detection of camera movements.
1082   OpenGl_Vec3 myPreviousOrigins[3];
1083
1084   //! Bullard RNG to produce random sequence.
1085   math_BullardGenerator myRNG;
1086
1087 public:
1088
1089   DEFINE_STANDARD_ALLOC
1090   DEFINE_STANDARD_RTTIEXT(OpenGl_View,Graphic3d_CView) // Type definition
1091
1092   friend class OpenGl_GraphicDriver;
1093   friend class OpenGl_Workspace;
1094 };
1095
1096 #endif // _OpenGl_View_Header