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