0025351: Visualization - provide pseudo random number generator in OCCT ray-tracing...
[occt.git] / src / OpenGl / OpenGl_Workspace.hxx
CommitLineData
b311480e 1// Created on: 2011-09-20
2// Created by: Sergey ZERCHANINOV
1981cb22 3// Copyright (c) 2011-2013 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_Workspace_Header
17#define _OpenGl_Workspace_Header
18
fc73a202 19#include <map>
20#include <set>
e276548b 21
2166f0fa
SK
22#include <Handle_OpenGl_Workspace.hxx>
23#include <OpenGl_Window.hxx>
24
25#include <TColStd_Array2OfReal.hxx>
26#include <Quantity_Color.hxx>
bf75be98 27#include <Graphic3d_CView.hxx>
2166f0fa 28#include <Graphic3d_TypeOfComposition.hxx>
bf75be98 29#include <Graphic3d_TypeOfTexture.hxx>
30#include <Graphic3d_PtrFrameBuffer.hxx>
31#include <Graphic3d_BufferType.hxx>
32#include <Handle_Graphic3d_TextureParams.hxx>
2166f0fa 33
2166f0fa
SK
34#include <Aspect_CLayer2d.hxx>
35#include <Aspect_Handle.hxx>
36#include <Aspect_PrintAlgo.hxx>
550f3b8b 37#include <Aspect_PolygonOffsetMode.hxx>
2166f0fa
SK
38
39#include <InterfaceGraphic_Graphic3d.hxx>
40#include <InterfaceGraphic_Visual3d.hxx>
41
1981cb22 42#include <NCollection_Sequence.hxx>
43
bf75be98 44#include <OpenGl_AspectFace.hxx>
fc73a202 45#include <OpenGl_FrameBuffer.hxx>
2166f0fa
SK
46#include <OpenGl_Matrix.hxx>
47#include <OpenGl_NamedStatus.hxx>
a174a3c5 48#include <OpenGl_PrinterContext.hxx>
fc73a202 49#include <OpenGl_SceneGeometry.hxx>
2166f0fa 50#include <OpenGl_TextParam.hxx>
4269bd1b 51#include <OpenGl_RenderFilter.hxx>
0adbd30f 52#include <OpenGl_Vec.hxx>
73192b37 53#include <OpenGl_LineAttributes.hxx>
2166f0fa
SK
54
55#include <Handle_OpenGl_View.hxx>
bf75be98 56#include <Handle_OpenGl_Texture.hxx>
2166f0fa 57
fc73a202 58#include <OpenGl_ShaderObject.hxx>
59#include <OpenGl_ShaderProgram.hxx>
60#include <OpenGl_TextureBufferArb.hxx>
61
2166f0fa 62class OpenGl_AspectLine;
2166f0fa
SK
63class OpenGl_AspectMarker;
64class OpenGl_AspectText;
65class OpenGl_FrameBuffer;
66class OpenGl_Structure;
b7cd4ba7 67class OpenGl_TriangleSet;
4269bd1b 68class OpenGl_Element;
692613e5 69class Image_PixMap;
2166f0fa 70
0adbd30f 71//! OpenGL material definition
72struct OpenGl_Material
73{
74
75 OpenGl_Vec4 Ambient; //!< ambient reflection coefficient
76 OpenGl_Vec4 Diffuse; //!< diffuse reflection coefficient
77 OpenGl_Vec4 Specular; //!< glossy reflection coefficient
78 OpenGl_Vec4 Emission; //!< material emission
79 OpenGl_Vec4 Params; //!< extra packed parameters
80
81 Standard_ShortReal Shine() const { return Params.x(); }
82 Standard_ShortReal& ChangeShine() { return Params.x(); }
83
84 Standard_ShortReal Transparency() const { return Params.y(); }
85 Standard_ShortReal& ChangeTransparency() { return Params.y(); }
86
87 //! Initialize material
88 void Init (const OPENGL_SURF_PROP& theProps);
89
90 //! Returns packed (serialized) representation of material properties
91 const OpenGl_Vec4* Packed() const { return reinterpret_cast<const OpenGl_Vec4*> (this); }
92 static Standard_Integer NbOfVec4() { return 5; }
93
94};
95
a89742cf 96DEFINE_STANDARD_HANDLE (OpenGl_RaytraceFilter, OpenGl_RenderFilter)
97
25ef750e 98//! Graphical ray-tracing filter.
a89742cf 99//! Filters out all raytracable structures.
100class OpenGl_RaytraceFilter : public OpenGl_RenderFilter
101{
102public:
103
104 //! Default constructor.
105 OpenGl_RaytraceFilter() {}
106
107 //! Remembers the previously set filter.
108 inline void SetPrevRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
109 {
110 myPrevRenderFilter = theFilter;
111 }
112
113 //! Checks whether the element can be rendered or not.
114 //! @param theElement [in] the element to check.
115 //! @return True if element can be rendered.
116 virtual Standard_Boolean CanRender (const OpenGl_Element* theElement);
117
118private:
119
120 Handle(OpenGl_RenderFilter) myPrevRenderFilter;
121
122public:
123
124 DEFINE_STANDARD_RTTI(OpenGl_RaytraceFilter)
125};
126
e276548b 127//! Represents window with GL context.
128//! Provides methods to render primitives and maintain GL state.
2166f0fa
SK
129class OpenGl_Workspace : public OpenGl_Window
130{
131public:
132
133 //! Main constructor - prepare GL context for specified window.
25b97fac 134 OpenGl_Workspace (const Handle(OpenGl_GraphicDriver)& theDriver,
2166f0fa 135 const CALL_DEF_WINDOW& theCWindow,
5e27df78 136 Aspect_RenderingContext theGContext,
58655684 137 const Handle(OpenGl_Caps)& theCaps,
5e27df78 138 const Handle(OpenGl_Context)& theShareCtx);
2166f0fa
SK
139
140 //! Destructor
141 virtual ~OpenGl_Workspace();
142
143 void SetActiveView (const Handle(OpenGl_View)& theView) { myView = theView; }
144 const Handle(OpenGl_View)& ActiveView () const { return myView; }
145
146 //! Redraw the window.
147 void Redraw (const Graphic3d_CView& theCView,
148 const Aspect_CLayer2d& theCUnderLayer,
149 const Aspect_CLayer2d& theCOverLayer);
150
679ecdee 151 Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer);
152 void RedrawImmediate (const Graphic3d_CView& theCView,
153 const Aspect_CLayer2d& theCUnderLayer,
154 const Aspect_CLayer2d& theCOverLayer,
155 const Standard_Boolean theToForce = Standard_False);
156
157 void Invalidate (const Graphic3d_CView& /*theCView*/)
2166f0fa 158 {
679ecdee 159 myBackBufferRestored = Standard_False;
2166f0fa
SK
160 }
161
162 //! Special method to perform printing.
163 //! System-specific and currently only Win platform implemented.
a174a3c5 164 Standard_Boolean Print (const Handle(OpenGl_PrinterContext)& thePrintContext,
165 const Graphic3d_CView& theCView,
bf75be98 166 const Aspect_CLayer2d& theCUnderLayer,
2166f0fa
SK
167 const Aspect_CLayer2d& theCOverLayer,
168 const Aspect_Handle theHPrintDC,
169 const Standard_Boolean theToShowBackground,
170 const Standard_CString theFileName,
171 const Aspect_PrintAlgo thePrintAlgorithm,
172 const Standard_Real theScaleFactor);
173
a174a3c5 174 const Handle(OpenGl_PrinterContext)& PrinterContext() const
175 {
176 return myPrintContext;
177 }
178
2166f0fa
SK
179 void DisplayCallback (const Graphic3d_CView& theCView, int theReason);
180
2166f0fa
SK
181 Graphic3d_PtrFrameBuffer FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight);
182 void FBORelease (Graphic3d_PtrFrameBuffer theFBOPtr);
692613e5 183 Standard_Boolean BufferDump (OpenGl_FrameBuffer* theFBOPtr,
184 Image_PixMap& theImage,
185 const Graphic3d_BufferType& theBufferType);
2166f0fa 186
2166f0fa
SK
187 Standard_Boolean& UseZBuffer() { return myUseZBuffer; }
188 Standard_Boolean& UseDepthTest() { return myUseDepthTest; }
189 Standard_Boolean& UseGLLight() { return myUseGLLight; }
190
73192b37 191 Standard_Integer AntiAliasingMode() const { return myAntiAliasingMode; }
192
2166f0fa
SK
193 //// RELATED TO STATUS ////
194
195 Standard_Integer NamedStatus;
196
2166f0fa
SK
197 const TEL_COLOUR* HighlightColor;
198
2166f0fa
SK
199 const OpenGl_AspectLine* SetAspectLine (const OpenGl_AspectLine* theAspect);
200 const OpenGl_AspectFace* SetAspectFace (const OpenGl_AspectFace* theAspect);
201 const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
202 const OpenGl_AspectText* SetAspectText (const OpenGl_AspectText* theAspect);
203
204 void SetTextParam (const OpenGl_TextParam* theParam) { TextParam_set = theParam; }
205
3946774d 206 //// THESE METHODS ARE EXPORTED AS THEY PROVIDE STATE INFO TO USERDRAW
207 Standard_EXPORT const OpenGl_AspectLine* AspectLine (const Standard_Boolean theWithApply);
208 Standard_EXPORT const OpenGl_AspectFace* AspectFace (const Standard_Boolean theWithApply);
209 Standard_EXPORT const OpenGl_AspectMarker* AspectMarker (const Standard_Boolean theWithApply);
210 Standard_EXPORT const OpenGl_AspectText* AspectText (const Standard_Boolean theWithApply);
a174a3c5 211 inline const OpenGl_TextParam* AspectTextParams() const
212 {
213 return TextParam_applied;
214 }
2166f0fa 215
34a44cbd 216 //! Clear the applied aspect state.
217 void ResetAppliedAspect();
218
bf75be98 219 Standard_EXPORT Handle(OpenGl_Texture) DisableTexture();
220 Standard_EXPORT Handle(OpenGl_Texture) EnableTexture (const Handle(OpenGl_Texture)& theTexture,
221 const Handle(Graphic3d_TextureParams)& theParams = NULL);
8625ef7e 222 const Handle(OpenGl_Texture)& ActiveTexture() const { return myTextureBound; }
bf75be98 223
4269bd1b 224 //! Set filter for restricting rendering of particular elements.
225 //! Filter can be applied for rendering passes used by recursive
226 //! rendering algorithms for rendering elements of groups.
227 //! @param theFilter [in] the filter instance.
228 inline void SetRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
229 {
5322131b 230 myRenderFilter = theFilter;
4269bd1b 231 }
232
233 //! Get rendering filter.
234 //! @return filter instance.
5322131b 235 inline const Handle(OpenGl_RenderFilter)& GetRenderFilter() const
236 {
237 return myRenderFilter;
4269bd1b 238 }
239
240 //! @return applied view matrix.
241 inline const OpenGl_Matrix* ViewMatrix() const { return ViewMatrix_applied; }
242
243 //! @return applied model structure matrix.
244 inline const OpenGl_Matrix* ModelMatrix() const { return StructureMatrix_applied; }
245
550f3b8b 246 //! Sets and applies current polygon offset.
247 void SetPolygonOffset (int theMode, Standard_ShortReal theFactor, Standard_ShortReal theUnits);
248
249 //! Returns currently applied polygon offset params.
250 const TEL_POFFSET_PARAM& AppliedPolygonOffset() { return PolygonOffset_applied; }
251
b7cd4ba7 252 //! @return true if clipping algorithm enabled
253 inline Standard_Boolean IsCullingEnabled() const { return myIsCullingEnabled; }
254
a89742cf 255 //! Returns a flag whether to redraw the scene using OpenGL rasterization
256 Standard_Boolean ToRedrawGL() const { return myToRedrawGL; }
257
2166f0fa
SK
258protected:
259
679ecdee 260 //! Copy content of Back buffer to the Front buffer
261 void copyBackToFront();
2166f0fa
SK
262
263 virtual Standard_Boolean Activate();
264
679ecdee 265 void redraw1 (const Graphic3d_CView& theCView,
bf75be98 266 const Aspect_CLayer2d& theCUnderLayer,
2166f0fa 267 const Aspect_CLayer2d& theCOverLayer,
679ecdee 268 const int theToSwap);
2166f0fa 269
0adbd30f 270 void updateMaterial (const int theFlag);
2166f0fa 271
bf75be98 272 void setTextureParams (Handle(OpenGl_Texture)& theTexture,
273 const Handle(Graphic3d_TextureParams)& theParams);
2166f0fa 274
fc73a202 275protected:
e276548b 276
fc73a202 277 //! Result of OpenGL shaders initialization.
278 enum RaytraceInitStatus
279 {
280 OpenGl_RT_NONE,
281 OpenGl_RT_INIT,
282 OpenGl_RT_FAIL
283 };
e276548b 284
84c71f29 285 //! Describes update mode (state).
286 enum GeomUpdateMode
287 {
288 OpenGl_GUM_CHECK, //!< check if geometry update is necessary
289 OpenGl_GUM_PREPARE, //!< collect unchanged objects
290 OpenGl_GUM_UPDATE //!< update raytracing data, rebuild changed objects
291 };
292
fc73a202 293 //! Defines frequently used shader variables.
294 enum ShaderVariableIndex
295 {
296 OpenGl_RT_aPosition,
297
298 OpenGl_RT_uOriginLT,
299 OpenGl_RT_uOriginLB,
300 OpenGl_RT_uOriginRT,
301 OpenGl_RT_uOriginRB,
fc73a202 302 OpenGl_RT_uDirectLT,
303 OpenGl_RT_uDirectLB,
304 OpenGl_RT_uDirectRT,
305 OpenGl_RT_uDirectRB,
25ef750e 306 OpenGl_RT_uUnviewMat,
307
fc73a202 308 OpenGl_RT_uSceneRad,
309 OpenGl_RT_uSceneEps,
fc73a202 310 OpenGl_RT_uLightAmbnt,
311 OpenGl_RT_uLightCount,
312
313 OpenGl_RT_uShadEnabled,
314 OpenGl_RT_uReflEnabled,
25ef750e 315 OpenGl_RT_uEnvMapEnable,
fc73a202 316
317 OpenGl_RT_uOffsetX,
318 OpenGl_RT_uOffsetY,
319 OpenGl_RT_uSamples,
312a4043 320 OpenGl_RT_uWinSizeX,
321 OpenGl_RT_uWinSizeY,
fc73a202 322
25ef750e 323 OpenGl_RT_uTextures,
84c71f29 324
fc73a202 325 OpenGl_RT_NbVariables // special field
326 };
e276548b 327
fc73a202 328 //! Defines texture samplers.
329 enum ShaderSamplerNames
330 {
331 OpenGl_RT_SceneNodeInfoTexture = 0,
332 OpenGl_RT_SceneMinPointTexture = 1,
333 OpenGl_RT_SceneMaxPointTexture = 2,
334
335 OpenGl_RT_ObjectNodeInfoTexture = 3,
336 OpenGl_RT_ObjectMinPointTexture = 4,
337 OpenGl_RT_ObjectMaxPointTexture = 5,
338
339 OpenGl_RT_GeometryVertexTexture = 6,
340 OpenGl_RT_GeometryNormalTexture = 7,
25ef750e 341 OpenGl_RT_GeometryTexCrdTexture = 8,
342 OpenGl_RT_GeometryTriangTexture = 9,
e276548b 343
25ef750e 344 OpenGl_RT_EnvironmentMapTexture = 10,
fc73a202 345
25ef750e 346 OpenGl_RT_RaytraceMaterialTexture = 11,
347 OpenGl_RT_RaytraceLightSrcTexture = 12,
fc73a202 348
25ef750e 349 OpenGl_RT_FSAAInputTexture = 13,
84c71f29 350
25ef750e 351 OpenGl_RT_SceneTransformTexture = 14,
a89742cf 352
25ef750e 353 OpenGl_RT_OpenGlColorTexture = 15,
354 OpenGl_RT_OpenGlDepthTexture = 16
fc73a202 355 };
356
357 //! Tool class for management of shader sources.
358 class ShaderSource
e276548b 359 {
fc73a202 360 public:
361
362 //! Creates new uninitialized shader source.
363 ShaderSource()
364 {
365 //
366 }
367
368 //! Creates new shader source from specified file.
369 ShaderSource (const TCollection_AsciiString& theFileName)
370 {
371 Load (&theFileName, 1);
372 }
373
374 public:
375
376 //! Returns prefix to insert before the source.
377 const TCollection_AsciiString& Prefix() const
378 {
379 return myPrefix;
380 }
381
382 //! Sets prefix to insert before the source.
383 void SetPrefix (const TCollection_AsciiString& thePrefix)
384 {
385 myPrefix = thePrefix;
386 }
387
388 //! Returns shader source combined with prefix.
389 TCollection_AsciiString Source() const;
390
391 //! Loads shader source from specified files.
392 void Load (const TCollection_AsciiString* theFileNames, const Standard_Integer theCount);
393
394 private:
395
396 TCollection_AsciiString mySource; //!< Source string of the shader object
397 TCollection_AsciiString myPrefix; //!< Prefix to insert before the source
398
e276548b 399 };
400
bc8c79bb 401 //! Default ray-tracing depth.
25ef750e 402 static const Standard_Integer THE_DEFAULT_NB_BOUNCES = 3;
bc8c79bb 403
fc73a202 404 //! Default size of traversal stack.
405 static const Standard_Integer THE_DEFAULT_STACK_SIZE = 24;
406
bc8c79bb 407 //! Compile-time ray-tracing parameters.
408 struct RaytracingParams
409 {
410 //! Actual size of traversal stack in shader program.
411 Standard_Integer StackSize;
412
413 //! Actual ray-tracing depth (number of ray bounces).
25ef750e 414 Standard_Integer NbBounces;
bc8c79bb 415
416 //! Sets light propagation through transparent media.
417 Standard_Boolean TransparentShadows;
418
419 //! Creates default compile-time ray-tracing parameters.
420 RaytracingParams()
421 : StackSize (THE_DEFAULT_STACK_SIZE),
25ef750e 422 NbBounces (THE_DEFAULT_NB_BOUNCES),
bc8c79bb 423 TransparentShadows (Standard_False)
424 {
425 //
426 }
427 };
428
e276548b 429protected: //! @name methods related to ray-tracing
430
431 //! Updates 3D scene geometry for ray-tracing.
84c71f29 432 Standard_Boolean UpdateRaytraceGeometry (GeomUpdateMode theMode);
e276548b 433
434 //! Checks to see if the structure is modified.
435 Standard_Boolean CheckRaytraceStructure (const OpenGl_Structure* theStructure);
436
25ef750e 437 //! Creates ray-tracing material properties.
438 Standard_Boolean CreateMaterial (const OpenGl_AspectFace* theAspect, OpenGl_RaytraceMaterial& theMaterial);
439
e276548b 440 //! Updates 3D scene light sources for ray-tracing.
25ef750e 441 Standard_Boolean UpdateRaytraceLightSources (const OpenGl_Mat4& theInvModelView);
e276548b 442
443 //! Updates environment map for ray-tracing.
444 Standard_Boolean UpdateRaytraceEnvironmentMap();
5322131b 445
e276548b 446 //! Adds OpenGL structure to ray-traced scene geometry.
0717ddc1 447 Standard_Boolean AddRaytraceStructure (const OpenGl_Structure* theStructure, std::set<const OpenGl_Structure*>& theElements);
448
449 //! Adds OpenGL groups to ray-traced scene geometry.
450 Standard_Boolean AddRaytraceGroups (const OpenGl_Structure* theStructure,
451 const Standard_Integer theStructMatId,
452 const Standard_ShortReal* theTransform);
e276548b 453
454 //! Adds OpenGL primitive array to ray-traced scene geometry.
265d4508 455 OpenGl_TriangleSet* AddRaytracePrimitiveArray (
25ef750e 456 const OpenGl_PrimitiveArray* theArray, int theMatID, const OpenGl_Mat4* theTrans);
e276548b 457
458 //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
871fa103 459 Standard_Boolean AddRaytraceVertexIndices (OpenGl_TriangleSet& theSet,
460 const OpenGl_PrimitiveArray& theArray,
461 Standard_Integer theOffset,
462 Standard_Integer theCount,
463 Standard_Integer theMatID);
e276548b 464
465 //! Adds OpenGL triangle array to ray-traced scene geometry.
871fa103 466 Standard_Boolean AddRaytraceTriangleArray (OpenGl_TriangleSet& theSet,
467 const Handle(Graphic3d_IndexBuffer)& theIndices,
468 Standard_Integer theOffset,
469 Standard_Integer theCount,
470 Standard_Integer theMatID);
e276548b 471
472 //! Adds OpenGL triangle fan array to ray-traced scene geometry.
871fa103 473 Standard_Boolean AddRaytraceTriangleFanArray (OpenGl_TriangleSet& theSet,
474 const Handle(Graphic3d_IndexBuffer)& theIndices,
475 Standard_Integer theOffset,
476 Standard_Integer theCount,
477 Standard_Integer theMatID);
e276548b 478
265d4508 479 //! Adds OpenGL triangle strip array to ray-traced scene geometry.
871fa103 480 Standard_Boolean AddRaytraceTriangleStripArray (OpenGl_TriangleSet& theSet,
481 const Handle(Graphic3d_IndexBuffer)& theIndices,
482 Standard_Integer theOffset,
483 Standard_Integer theCount,
484 Standard_Integer theMatID);
e276548b 485
486 //! Adds OpenGL quadrangle array to ray-traced scene geometry.
871fa103 487 Standard_Boolean AddRaytraceQuadrangleArray (OpenGl_TriangleSet& theSet,
488 const Handle(Graphic3d_IndexBuffer)& theIndices,
489 Standard_Integer theOffset,
490 Standard_Integer theCount,
491 Standard_Integer theMatID);
e276548b 492
493 //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
871fa103 494 Standard_Boolean AddRaytraceQuadrangleStripArray (OpenGl_TriangleSet& theSet,
495 const Handle(Graphic3d_IndexBuffer)& theIndices,
496 Standard_Integer theOffset,
497 Standard_Integer theCount,
498 Standard_Integer theMatID);
e276548b 499
500 //! Adds OpenGL polygon array to ray-traced scene geometry.
871fa103 501 Standard_Boolean AddRaytracePolygonArray (OpenGl_TriangleSet& theSet,
502 const Handle(Graphic3d_IndexBuffer)& theIndices,
503 Standard_Integer theOffset,
504 Standard_Integer theCount,
505 Standard_Integer theMatID);
e276548b 506
fc73a202 507 //! Loads and compiles shader object from specified source.
508 Handle(OpenGl_ShaderObject) LoadShader (const ShaderSource& theSource, GLenum theType);
509
510 //! Performs safe exit when shaders initialization fails.
511 Standard_Boolean SafeFailBack (const TCollection_ExtendedString& theMessage);
512
25ef750e 513 //! Generates shader prefix based on current ray-tracing options.
514 TCollection_AsciiString GenerateShaderPrefix();
515
fc73a202 516 //! Initializes OpenGL/GLSL shader programs.
bc8c79bb 517 Standard_Boolean InitRaytraceResources (const Graphic3d_CView& theCView);
5322131b 518
fc73a202 519 //! Releases OpenGL/GLSL shader programs.
520 void ReleaseRaytraceResources();
e276548b 521
fc73a202 522 //! Uploads ray-trace data to the GPU.
523 Standard_Boolean UploadRaytraceData();
e276548b 524
fc73a202 525 //! Resizes OpenGL frame buffers.
526 Standard_Boolean ResizeRaytraceBuffers (const Standard_Integer theSizeX,
527 const Standard_Integer theSizeY);
e276548b 528
fc73a202 529 //! Generates viewing rays for corners of screen quad.
25ef750e 530 void UpdateCamera (const OpenGl_Mat4& theOrientation,
531 const OpenGl_Mat4& theViewMapping,
532 OpenGl_Vec3 theOrigins[4],
533 OpenGl_Vec3 theDirects[4],
534 OpenGl_Mat4& theInvModelProj);
535
536 //! Sets uniform state for the given ray-tracing shader program.
537 Standard_Boolean SetUniformState (const Graphic3d_CView& theCView,
312a4043 538 const Standard_Integer theSizeX,
539 const Standard_Integer theSizeY,
25ef750e 540 const OpenGl_Vec3* theOrigins,
541 const OpenGl_Vec3* theDirects,
542 const OpenGl_Mat4& theUnviewMat,
543 const Standard_Integer theProgramIndex,
544 Handle(OpenGl_ShaderProgram)& theRaytraceProgram);
e276548b 545
fc73a202 546 //! Runs ray-tracing shader programs.
547 Standard_Boolean RunRaytraceShaders (const Graphic3d_CView& theCView,
548 const Standard_Integer theSizeX,
549 const Standard_Integer theSizeY,
550 const OpenGl_Vec3 theOrigins[4],
551 const OpenGl_Vec3 theDirects[4],
25ef750e 552 const OpenGl_Mat4& theUnviewMat,
fc73a202 553 OpenGl_FrameBuffer* theFrameBuffer);
265d4508 554
fc73a202 555 //! Redraws the window using OpenGL/GLSL ray-tracing.
e276548b 556 Standard_Boolean Raytrace (const Graphic3d_CView& theCView,
fc73a202 557 const Standard_Integer theSizeX,
558 const Standard_Integer theSizeY,
559 const Standard_Boolean theToSwap,
a89742cf 560 const Aspect_CLayer2d& theCOverLayer,
561 const Aspect_CLayer2d& theCUnderLayer,
fc73a202 562 OpenGl_FrameBuffer* theFrameBuffer);
e276548b 563
564protected: //! @name fields related to ray-tracing
565
fc73a202 566 //! Result of shaders initialization.
567 RaytraceInitStatus myComputeInitStatus;
e276548b 568
569 //! Is geometry data valid?
570 Standard_Boolean myIsRaytraceDataValid;
5322131b 571
25ef750e 572 //! Warning about missing extension GL_ARB_bindless_texture has been displayed?
573 Standard_Boolean myIsRaytraceWarnTextures;
574
e276548b 575 //! 3D scene geometry data for ray-tracing.
265d4508 576 OpenGl_RaytraceGeometry myRaytraceGeometry;
e276548b 577
578 //! Radius of bounding sphere of the scene.
265d4508 579 Standard_ShortReal myRaytraceSceneRadius;
e276548b 580 //! Scene epsilon to prevent self-intersections.
265d4508 581 Standard_ShortReal myRaytraceSceneEpsilon;
e276548b 582
bc8c79bb 583 //! Compile-time ray-tracing parameters.
584 RaytracingParams myRaytraceParameters;
fc73a202 585
586 //! OpenGL/GLSL source of ray-tracing fragment shader.
587 ShaderSource myRaytraceShaderSource;
588 //! OpenGL/GLSL source of adaptive-AA fragment shader.
589 ShaderSource myPostFSAAShaderSource;
590
591 //! OpenGL/GLSL ray-tracing fragment shader.
592 Handle(OpenGl_ShaderObject) myRaytraceShader;
593 //! OpenGL/GLSL adaptive-AA fragment shader.
594 Handle(OpenGl_ShaderObject) myPostFSAAShader;
595
596 //! OpenGL/GLSL ray-tracing shader program.
597 Handle(OpenGl_ShaderProgram) myRaytraceProgram;
598 //! OpenGL/GLSL adaptive-AA shader program.
599 Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
600
601 //! Texture buffer of data records of high-level BVH nodes.
602 Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
603 //! Texture buffer of minimum points of high-level BVH nodes.
604 Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
605 //! Texture buffer of maximum points of high-level BVH nodes.
606 Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
84c71f29 607 //! Texture buffer of transformations of high-level BVH nodes.
608 Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
fc73a202 609
610 //! Texture buffer of data records of bottom-level BVH nodes.
611 Handle(OpenGl_TextureBufferArb) myObjectNodeInfoTexture;
612 //! Texture buffer of minimum points of bottom-level BVH nodes.
613 Handle(OpenGl_TextureBufferArb) myObjectMinPointTexture;
614 //! Texture buffer of maximum points of bottom-level BVH nodes.
615 Handle(OpenGl_TextureBufferArb) myObjectMaxPointTexture;
616
617 //! Texture buffer of vertex coords.
618 Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture;
619 //! Texture buffer of vertex normals.
620 Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture;
25ef750e 621 //! Texture buffer of vertex UV coords.
622 Handle(OpenGl_TextureBufferArb) myGeometryTexCrdTexture;
fc73a202 623 //! Texture buffer of triangle indices.
624 Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
25ef750e 625
fc73a202 626 //! Texture buffer of material properties.
627 Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
628 //! Texture buffer of light source properties.
629 Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
630
631 //! Vertex buffer (VBO) for drawing dummy quad.
632 OpenGl_VertexBuffer myRaytraceScreenQuad;
633
634 //! Framebuffer (FBO) to perform adaptive FSAA.
635 Handle(OpenGl_FrameBuffer) myRaytraceFBO1;
636 //! Framebuffer (FBO) to perform adaptive FSAA.
637 Handle(OpenGl_FrameBuffer) myRaytraceFBO2;
a89742cf 638 //! Framebuffer (FBO) for pre-raytrace rendering by OpenGL.
639 Handle(OpenGl_FrameBuffer) myOpenGlFBO;
265d4508 640
e276548b 641 //! State of OpenGL view.
642 Standard_Size myViewModificationStatus;
e276548b 643 //! State of OpenGL layer list.
644 Standard_Size myLayersModificationStatus;
645
265d4508 646 //! State of OpenGL structures reflected to ray-tracing.
e276548b 647 std::map<const OpenGl_Structure*, Standard_Size> myStructureStates;
648
84c71f29 649 //! PrimitiveArray to TriangleSet map for scene partial update.
8d3f219f 650 std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
84c71f29 651
fc73a202 652 //! Cached locations of frequently used uniform variables.
653 Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
e276548b 654
25ef750e 655 //! Graphical ray-tracing filter to filter out all raytracable structures.
a89742cf 656 Handle(OpenGl_RaytraceFilter) myRaytraceFilter;
657
25ef750e 658 //! Redraw the scene using OpenGL rasterization or ray-tracing?
a89742cf 659 Standard_Boolean myToRedrawGL;
660
bf75be98 661protected: //! @name protected fields
2166f0fa 662
a174a3c5 663 Handle(OpenGl_PrinterContext) myPrintContext;
73192b37 664 Handle(OpenGl_View) myView;
665 Handle(OpenGl_LineAttributes) myLineAttribs;
666 Standard_Integer myAntiAliasingMode;
1981cb22 667 Standard_Boolean myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
679ecdee 668 Standard_Boolean myBackBufferRestored;
669 Standard_Boolean myIsImmediateDrawn; //!< flag indicates that immediate mode buffer contains some data
bf75be98 670 Standard_Boolean myUseZBuffer;
671 Standard_Boolean myUseDepthTest;
672 Standard_Boolean myUseGLLight;
b7cd4ba7 673 Standard_Boolean myIsCullingEnabled; //!< frustum culling flag
2166f0fa 674
a89742cf 675 unsigned int myFrameCounter; //!< redraw counter, for debugging
676
bf75be98 677protected: //! @name fields related to status
678
4269bd1b 679 Handle(OpenGl_RenderFilter) myRenderFilter;
bf75be98 680 Handle(OpenGl_Texture) myTextureBound; //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
2166f0fa
SK
681 const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
682 const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
683 const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
684 const OpenGl_AspectText *AspectText_set, *AspectText_applied;
685
686 const OpenGl_TextParam *TextParam_set, *TextParam_applied;
687
688 const OpenGl_Matrix* ViewMatrix_applied;
689 const OpenGl_Matrix* StructureMatrix_applied;
690
3b1817a9 691 OpenGl_Material myMatFront; //!< current front material state (cached to reduce GL context updates)
692 OpenGl_Material myMatBack; //!< current back material state
693 OpenGl_Material myMatTmp; //!< temporary variable
694 TelCullMode myCullingMode; //!< back face culling mode, applied from face aspect
0adbd30f 695
550f3b8b 696 OpenGl_Matrix myModelViewMatrix; //!< Model matrix with applied structure transformations
0f8c0fb8 697
550f3b8b 698 TEL_POFFSET_PARAM PolygonOffset_applied; //!< Currently applied polygon offset.
2166f0fa 699
550f3b8b 700 OpenGl_AspectFace myAspectFaceHl; //!< Hiddenline aspect
bf75be98 701
702public: //! @name type definition
2166f0fa 703
bf75be98 704 DEFINE_STANDARD_RTTI(OpenGl_Workspace)
1c35b92f 705 DEFINE_STANDARD_ALLOC
2166f0fa
SK
706
707};
708
bf75be98 709#endif // _OpenGl_Workspace_Header