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