dac1880ea3287e20f204b9b39139d02fae70988a
[occt.git] / src / OpenGl / OpenGl_Workspace.hxx
1 // Created on: 2011-09-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2013 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_Workspace_Header
17 #define _OpenGl_Workspace_Header
18
19 #ifdef HAVE_OPENCL
20   #include <map>
21   #include <set>
22
23   #include <OpenGl_Cl.hxx>
24 #endif
25
26 #include <Handle_OpenGl_Workspace.hxx>
27 #include <OpenGl_Window.hxx>
28
29 #include <TColStd_Array2OfReal.hxx>
30 #include <Quantity_Color.hxx>
31 #include <Graphic3d_CView.hxx>
32 #include <Graphic3d_TypeOfComposition.hxx>
33 #include <Graphic3d_TypeOfTexture.hxx>
34 #include <Graphic3d_PtrFrameBuffer.hxx>
35 #include <Graphic3d_BufferType.hxx>
36 #include <Handle_Graphic3d_TextureParams.hxx>
37
38 #include <Aspect_CLayer2d.hxx>
39 #include <Aspect_Handle.hxx>
40 #include <Aspect_PrintAlgo.hxx>
41
42 #include <InterfaceGraphic_Graphic3d.hxx>
43 #include <InterfaceGraphic_Visual3d.hxx>
44
45 #include <NCollection_Sequence.hxx>
46
47 #include <OpenGl_AspectFace.hxx>
48 #include <OpenGl_Display.hxx>
49 #include <OpenGl_Matrix.hxx>
50 #include <OpenGl_NamedStatus.hxx>
51 #include <OpenGl_PrinterContext.hxx>
52 #ifdef HAVE_OPENCL
53   #include <OpenGl_SceneGeometry.hxx>
54 #endif
55 #include <OpenGl_TextParam.hxx>
56 #include <OpenGl_RenderFilter.hxx>
57 #include <OpenGl_Vec.hxx>
58
59 #include <Handle_OpenGl_View.hxx>
60 #include <Handle_OpenGl_Texture.hxx>
61
62 class OpenGl_AspectLine;
63 class OpenGl_AspectMarker;
64 class OpenGl_AspectText;
65 class OpenGl_FrameBuffer;
66 class OpenGl_Structure;
67 class OpenGl_Element;
68 class Image_PixMap;
69
70 //! OpenGL material definition
71 struct OpenGl_Material
72 {
73
74   OpenGl_Vec4 Ambient;  //!< ambient reflection coefficient
75   OpenGl_Vec4 Diffuse;  //!< diffuse reflection coefficient
76   OpenGl_Vec4 Specular; //!< glossy  reflection coefficient
77   OpenGl_Vec4 Emission; //!< material emission
78   OpenGl_Vec4 Params;   //!< extra packed parameters
79
80   Standard_ShortReal  Shine()              const { return Params.x(); }
81   Standard_ShortReal& ChangeShine()              { return Params.x(); }
82
83   Standard_ShortReal  Transparency()       const { return Params.y(); }
84   Standard_ShortReal& ChangeTransparency()       { return Params.y(); }
85
86   //! Initialize material
87   void Init (const OPENGL_SURF_PROP& theProps);
88
89   //! Returns packed (serialized) representation of material properties
90   const OpenGl_Vec4* Packed() const { return reinterpret_cast<const OpenGl_Vec4*> (this); }
91   static Standard_Integer NbOfVec4() { return 5; }
92
93 };
94
95 //! Represents window with GL context.
96 //! Provides methods to render primitives and maintain GL state.
97 class OpenGl_Workspace : public OpenGl_Window
98 {
99 public:
100
101   //! Main constructor - prepare GL context for specified window.
102   OpenGl_Workspace (const Handle(OpenGl_Display)& theDisplay,
103                     const CALL_DEF_WINDOW&        theCWindow,
104                     Aspect_RenderingContext       theGContext,
105                     const Handle(OpenGl_Caps)&    theCaps,
106                     const Handle(OpenGl_Context)& theShareCtx);
107
108   //! Destructor
109   virtual ~OpenGl_Workspace();
110
111   void SetActiveView (const Handle(OpenGl_View)& theView) { myView = theView; }
112   const Handle(OpenGl_View)& ActiveView () const { return myView; }
113
114   //! Redraw the window.
115   void Redraw (const Graphic3d_CView& theCView,
116                const Aspect_CLayer2d& theCUnderLayer,
117                const Aspect_CLayer2d& theCOverLayer);
118
119   Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer);
120   void RedrawImmediate (const Graphic3d_CView& theCView,
121                         const Aspect_CLayer2d& theCUnderLayer,
122                         const Aspect_CLayer2d& theCOverLayer,
123                         const Standard_Boolean theToForce = Standard_False);
124
125   void Invalidate (const Graphic3d_CView& /*theCView*/)
126   {
127     myBackBufferRestored = Standard_False;
128   }
129
130   //! Special method to perform printing.
131   //! System-specific and currently only Win platform implemented.
132   Standard_Boolean Print (const Handle(OpenGl_PrinterContext)& thePrintContext,
133                           const Graphic3d_CView& theCView,
134                           const Aspect_CLayer2d& theCUnderLayer,
135                           const Aspect_CLayer2d& theCOverLayer,
136                           const Aspect_Handle    theHPrintDC,
137                           const Standard_Boolean theToShowBackground,
138                           const Standard_CString theFileName,
139                           const Aspect_PrintAlgo thePrintAlgorithm,
140                           const Standard_Real    theScaleFactor);
141
142   const Handle(OpenGl_PrinterContext)& PrinterContext() const
143   {
144     return myPrintContext;
145   }
146
147   void DisplayCallback (const Graphic3d_CView& theCView, int theReason);
148
149   Graphic3d_PtrFrameBuffer FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight);
150   void FBORelease (Graphic3d_PtrFrameBuffer theFBOPtr);
151   Standard_Boolean BufferDump (OpenGl_FrameBuffer*         theFBOPtr,
152                                Image_PixMap&               theImage,
153                                const Graphic3d_BufferType& theBufferType);
154
155   void UseTransparency (const Standard_Boolean theFlag);
156   Standard_Boolean& UseZBuffer()   { return myUseZBuffer; }
157   Standard_Boolean& UseDepthTest() { return myUseDepthTest; }
158   Standard_Boolean& UseGLLight()   { return myUseGLLight; }
159
160   //// RELATED TO STATUS ////
161
162   Standard_Integer   NamedStatus;
163
164   const TEL_COLOUR* HighlightColor;
165
166   const OpenGl_Matrix* SetViewMatrix (const OpenGl_Matrix* );
167   const OpenGl_Matrix* SetStructureMatrix (const OpenGl_Matrix*, bool aRevert = false);
168
169   //! Updates current model-view matrix
170   //! replacing it with StructureMatrixT*ViewMatrix from the workspace.
171   const void UpdateModelViewMatrix();
172
173   const OpenGl_AspectLine*   SetAspectLine   (const OpenGl_AspectLine*   theAspect);
174   const OpenGl_AspectFace*   SetAspectFace   (const OpenGl_AspectFace*   theAspect);
175   const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
176   const OpenGl_AspectText*   SetAspectText   (const OpenGl_AspectText*   theAspect);
177
178   void SetTextParam (const OpenGl_TextParam* theParam) { TextParam_set = theParam; }
179
180   //// THESE METHODS ARE EXPORTED AS THEY PROVIDE STATE INFO TO USERDRAW
181   Standard_EXPORT const OpenGl_AspectLine*   AspectLine   (const Standard_Boolean theWithApply);
182   Standard_EXPORT const OpenGl_AspectFace*   AspectFace   (const Standard_Boolean theWithApply);
183   Standard_EXPORT const OpenGl_AspectMarker* AspectMarker (const Standard_Boolean theWithApply);
184   Standard_EXPORT const OpenGl_AspectText*   AspectText   (const Standard_Boolean theWithApply);
185   inline const OpenGl_TextParam* AspectTextParams() const
186   {
187     return TextParam_applied;
188   }
189
190   //! Clear the applied aspect state.
191   void ResetAppliedAspect();
192
193   Standard_EXPORT Handle(OpenGl_Texture) DisableTexture();
194   Standard_EXPORT Handle(OpenGl_Texture) EnableTexture (const Handle(OpenGl_Texture)&          theTexture,
195                                                         const Handle(Graphic3d_TextureParams)& theParams = NULL);
196
197   //! Set filter for restricting rendering of particular elements.
198   //! Filter can be applied for rendering passes used by recursive
199   //! rendering algorithms for rendering elements of groups.
200   //! @param theFilter [in] the filter instance.
201   inline void SetRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
202   {
203     myRenderFilter = theFilter;
204   }
205
206   //! Get rendering filter.
207   //! @return filter instance.
208   inline const Handle(OpenGl_RenderFilter)& GetRenderFilter() const
209   {
210     return myRenderFilter;
211   }
212
213   //! @return applied view matrix.
214   inline const OpenGl_Matrix* ViewMatrix() const { return ViewMatrix_applied; }
215
216   //! @return applied model structure matrix.
217   inline const OpenGl_Matrix* ModelMatrix() const { return StructureMatrix_applied; }
218
219 protected:
220
221   //! Copy content of Back buffer to the Front buffer
222   void copyBackToFront();
223
224   virtual Standard_Boolean Activate();
225
226   void redraw1 (const Graphic3d_CView& theCView,
227                 const Aspect_CLayer2d& theCUnderLayer,
228                 const Aspect_CLayer2d& theCOverLayer,
229                 const int              theToSwap);
230
231   void updateMaterial (const int theFlag);
232
233   void setTextureParams (Handle(OpenGl_Texture)&                theTexture,
234                          const Handle(Graphic3d_TextureParams)& theParams);
235
236 #ifdef HAVE_OPENCL
237
238 public:
239
240   //! Returns information about OpenCL device used for computations.
241   Standard_Boolean GetOpenClDeviceInfo (
242     NCollection_DataMap<TCollection_AsciiString, TCollection_AsciiString>& theInfo) const;
243
244 protected:
245
246   //! Describes result of OpenCL initializing.
247   enum OpenClInitStatus
248   {
249     OpenGl_CLIS_NONE,
250     OpenGl_CLIS_INIT,
251     OpenGl_CLIS_FAIL
252   };
253
254 protected: //! @name methods related to ray-tracing
255
256   //! Updates 3D scene geometry for ray-tracing.
257   Standard_Boolean UpdateRaytraceGeometry (Standard_Boolean theCheck);
258
259   //! Checks to see if the structure is modified.
260   Standard_Boolean CheckRaytraceStructure (const OpenGl_Structure* theStructure);
261
262   //! Updates 3D scene light sources for ray-tracing.
263   Standard_Boolean UpdateRaytraceLightSources (const GLdouble theInvModelView[16]);
264
265   //! Updates environment map for ray-tracing.
266   Standard_Boolean UpdateRaytraceEnvironmentMap();
267
268   //! Adds OpenGL structure to ray-traced scene geometry.
269   Standard_Boolean AddRaytraceStructure (const OpenGl_Structure* theStructure,
270     const Standard_ShortReal* theTransform, std::set<const OpenGl_Structure*>& theElements);
271
272   //! Adds OpenGL primitive array to ray-traced scene geometry.
273   OpenGl_TriangleSet* AddRaytracePrimitiveArray (
274     const CALL_DEF_PARRAY* theArray, int theMatID, const Standard_ShortReal* theTrans);
275
276   //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
277   Standard_Boolean AddRaytraceVertexIndices (OpenGl_TriangleSet* theSet,
278     const CALL_DEF_PARRAY* theArray, Standard_Integer theOffset, Standard_Integer theCount, Standard_Integer theMatID);
279
280   //! Adds OpenGL triangle array to ray-traced scene geometry.
281   Standard_Boolean AddRaytraceTriangleArray (OpenGl_TriangleSet* theSet,
282     const CALL_DEF_PARRAY* theArray, Standard_Integer theOffset, Standard_Integer theCount, Standard_Integer theMatID);
283
284   //! Adds OpenGL triangle fan array to ray-traced scene geometry.
285   Standard_Boolean AddRaytraceTriangleFanArray (OpenGl_TriangleSet* theSet,
286     const CALL_DEF_PARRAY* theArray, Standard_Integer theOffset, Standard_Integer theCount, Standard_Integer theMatID);
287
288   //! Adds OpenGL triangle strip array to ray-traced scene geometry.
289   Standard_Boolean AddRaytraceTriangleStripArray (OpenGl_TriangleSet* theSet,
290     const CALL_DEF_PARRAY* theArray, Standard_Integer theOffset, Standard_Integer theCount, Standard_Integer theMatID);
291
292   //! Adds OpenGL quadrangle array to ray-traced scene geometry.
293   Standard_Boolean AddRaytraceQuadrangleArray (OpenGl_TriangleSet* theSet,
294     const CALL_DEF_PARRAY* theArray, Standard_Integer theOffset, Standard_Integer theCount, Standard_Integer theMatID);
295
296   //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
297   Standard_Boolean AddRaytraceQuadrangleStripArray (OpenGl_TriangleSet* theSet,
298     const CALL_DEF_PARRAY* theArray, Standard_Integer theOffset, Standard_Integer theCount, Standard_Integer theMatID);
299
300   //! Adds OpenGL polygon array to ray-traced scene geometry.
301   Standard_Boolean AddRaytracePolygonArray (OpenGl_TriangleSet* theSet,
302     const CALL_DEF_PARRAY* theArray, Standard_Integer theOffset, Standard_Integer theCount, Standard_Integer theMatID);
303
304   //! Initializes OpenCL resources.
305   Standard_Boolean InitOpenCL();
306
307   //! Releases OpenCL resources.
308   void ReleaseOpenCL();
309
310   //! Resizes OpenCL output image.
311   Standard_Boolean ResizeRaytraceOutputBuffer (const cl_int theSizeX, const cl_int theSizeY);
312
313   //! Writes scene geometry to OpenCl device.
314   Standard_Boolean WriteRaytraceSceneToDevice();
315
316   //! Runs OpenCL ray-tracing kernels.
317   Standard_Boolean RunRaytraceOpenCLKernelsOld (const Graphic3d_CView& theCView,
318                                              const GLfloat theOrigins[16],
319                                              const GLfloat theDirects[16],
320                                              const int theSizeX,
321                                              const int theSizeY);
322
323   //! Launches OpenCL ray-tracing kernels.
324   Standard_Boolean RunRaytraceOpenCLKernels (const Graphic3d_CView&   theCView,
325                                              const Standard_ShortReal theOrigins[16],
326                                              const Standard_ShortReal theDirects[16],
327                                              const Standard_Integer   theSizeX,
328                                              const Standard_Integer   theSizeY);
329
330   //! Redraws the window using OpenCL ray tracing.
331   Standard_Boolean Raytrace (const Graphic3d_CView& theCView,
332               const int theSizeX, const int theSizeY, const Tint theToSwap);
333
334 protected: //! @name fields related to ray-tracing
335
336   //! Result of OpenCL initialization.
337   OpenClInitStatus myComputeInitStatus;
338   //! Is ATI/AMD OpenCL platform used?
339   Standard_Boolean myIsAmdComputePlatform;
340
341   //! Is geometry data valid?
342   Standard_Boolean myIsRaytraceDataValid;
343   //! Is geometry data musty be updated?
344   Standard_Boolean myToUpdateRaytraceData;
345
346   //! 3D scene geometry data for ray-tracing.
347   OpenGl_RaytraceGeometry myRaytraceGeometry;
348
349   //! Radius of bounding sphere of the scene.
350   Standard_ShortReal myRaytraceSceneRadius;
351   //! Scene epsilon to prevent self-intersections.
352   Standard_ShortReal myRaytraceSceneEpsilon;
353
354   //! OpenCL context.
355   cl_context myComputeContext;
356   //! OpenCL command queue.
357   cl_command_queue myComputeQueue;
358   //! OpenCL computing program.
359   cl_program myRaytraceProgram;
360   //! OpenCL ray-tracing render kernel.
361   cl_kernel myRaytraceRenderKernel;
362   //! OpenCL adaptive anti-aliasing kernel.
363   cl_kernel myRaytraceSmoothKernel;
364
365   //! OpenCL image to store environment map.
366   cl_mem myRaytraceEnvironment;
367   //! OpenCL image to store rendering result.
368   cl_mem myRaytraceOutputImage;
369   //! OpenCL image to store anti-aliasing result.
370   cl_mem myRaytraceOutputImageAA;
371
372   //! OpenGL texture to store rendering result.
373   Handle(OpenGl_Texture) myRaytraceOutputTexture;
374   //! OpenGL texture to store anti-aliasing result.
375   Handle(OpenGl_Texture) myRaytraceOutputTextureAA;
376
377   //! OpenCL buffer of material properties.
378   cl_mem myRaytraceMaterialBuffer;
379   //! OpenCL buffer of light source properties.
380   cl_mem myRaytraceLightSourceBuffer;
381
382   //! OpenCL buffer of vertex coords.
383   cl_mem myGeometryVertexBuffer;
384   //! OpenCL buffer of vertex normals.
385   cl_mem myGeometryNormalBuffer;
386   //! OpenCL buffer of triangle indices.
387   cl_mem myGeometryTriangBuffer;
388
389   //! OpenCL buffer of data records of high-level BVH nodes.
390   cl_mem mySceneNodeInfoBuffer;
391   //! OpenCL buffer of minimum points of high-level BVH nodes.
392   cl_mem mySceneMinPointBuffer;
393   //! OpenCL buffer of maximum points of high-level BVH nodes.
394   cl_mem mySceneMaxPointBuffer;
395
396   //! OpenCL buffer of data records of bottom-level BVH nodes.
397   cl_mem myObjectNodeInfoBuffer;
398   //! OpenCL buffer of minimum points of bottom-level BVH nodes.
399   cl_mem myObjectMinPointBuffer;
400   //! OpenCL buffer of maximum points of bottom-level BVH nodes.
401   cl_mem myObjectMaxPointBuffer;
402
403   //! State of OpenGL view.
404   Standard_Size myViewModificationStatus;
405   //! State of OpenGL layer list.
406   Standard_Size myLayersModificationStatus;
407
408   //! State of OpenGL structures reflected to ray-tracing.
409   std::map<const OpenGl_Structure*, Standard_Size> myStructureStates;
410
411 #endif // HAVE_OPENCL
412
413 protected: //! @name protected fields
414
415   Handle(OpenGl_PrinterContext) myPrintContext;
416   Handle(OpenGl_View)    myView;            // WSViews - now just one view is supported
417   Standard_Boolean       myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
418   Standard_Boolean       myBackBufferRestored;
419   Standard_Boolean       myIsImmediateDrawn;     //!< flag indicates that immediate mode buffer contains some data
420   Standard_Boolean       myUseTransparency;
421   Standard_Boolean       myUseZBuffer;
422   Standard_Boolean       myUseDepthTest;
423   Standard_Boolean       myUseGLLight;
424
425 protected: //! @name fields related to status
426
427   Handle(OpenGl_RenderFilter) myRenderFilter;
428   Handle(OpenGl_Texture) myTextureBound;    //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
429   const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
430   const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
431   const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
432   const OpenGl_AspectText *AspectText_set, *AspectText_applied;
433
434   const OpenGl_TextParam *TextParam_set, *TextParam_applied;
435
436   const OpenGl_Matrix* ViewMatrix_applied;
437   const OpenGl_Matrix* StructureMatrix_applied;
438
439   OpenGl_Material myMatFront;    //!< current front material state (cached to reduce GL context updates)
440   OpenGl_Material myMatBack;     //!< current back  material state
441   OpenGl_Material myMatTmp;      //!< temporary variable
442   TelCullMode     myCullingMode; //!< back face culling mode, applied from face aspect
443
444   //! Model matrix with applied structure transformations
445   OpenGl_Matrix myModelViewMatrix;
446
447   const TEL_POFFSET_PARAM* PolygonOffset_applied;
448
449   OpenGl_AspectFace myAspectFaceHl; // Hiddenline aspect
450
451 public: //! @name type definition
452
453   DEFINE_STANDARD_RTTI(OpenGl_Workspace)
454   DEFINE_STANDARD_ALLOC
455
456 };
457
458 #endif // _OpenGl_Workspace_Header