0027670: Visualization - avoid duplication of structures defining primitive array...
[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 #include <Graphic3d_BufferType.hxx>
20
21 #include <OpenGl_AspectFace.hxx>
22 #include <OpenGl_CappingAlgo.hxx>
23 #include <OpenGl_FrameBuffer.hxx>
24 #include <OpenGl_LineAttributes.hxx>
25 #include <OpenGl_Matrix.hxx>
26 #include <OpenGl_NamedStatus.hxx>
27 #include <OpenGl_PrinterContext.hxx>
28 #include <OpenGl_RenderFilter.hxx>
29 #include <OpenGl_ShaderObject.hxx>
30 #include <OpenGl_ShaderProgram.hxx>
31 #include <OpenGl_TextParam.hxx>
32 #include <OpenGl_TextureBufferArb.hxx>
33 #include <OpenGl_Vec.hxx>
34 #include <OpenGl_Window.hxx>
35
36 class OpenGl_View;
37 class Image_PixMap;
38
39 //! OpenGL material definition
40 struct OpenGl_Material
41 {
42
43   OpenGl_Vec4 Ambient;  //!< ambient reflection coefficient
44   OpenGl_Vec4 Diffuse;  //!< diffuse reflection coefficient
45   OpenGl_Vec4 Specular; //!< glossy  reflection coefficient
46   OpenGl_Vec4 Emission; //!< material emission
47   OpenGl_Vec4 Params;   //!< extra packed parameters
48
49   Standard_ShortReal  Shine()              const { return Params.x(); }
50   Standard_ShortReal& ChangeShine()              { return Params.x(); }
51
52   Standard_ShortReal  Transparency()       const { return Params.y(); }
53   Standard_ShortReal& ChangeTransparency()       { return Params.y(); }
54
55   //! Set material color.
56   void SetColor (const OpenGl_Vec4& theColor)
57   {
58     // apply the same formula as in Graphic3d_MaterialAspect::SetColor()
59     Ambient.xyz() = theColor.rgb() * 0.25f;
60     Diffuse.xyz() = theColor.rgb();
61   }
62
63   //! Initialize material
64   void Init (const Graphic3d_MaterialAspect& theProp,
65              const Quantity_Color&           theInteriorColor);
66
67   //! Returns packed (serialized) representation of material properties
68   const OpenGl_Vec4* Packed() const { return reinterpret_cast<const OpenGl_Vec4*> (this); }
69   static Standard_Integer NbOfVec4() { return 5; }
70
71 };
72
73 class OpenGl_RaytraceFilter;
74 DEFINE_STANDARD_HANDLE (OpenGl_RaytraceFilter, OpenGl_RenderFilter)
75
76 //! Graphical ray-tracing filter.
77 //! Filters out all raytracable structures.
78 class OpenGl_RaytraceFilter : public OpenGl_RenderFilter
79 {
80 public:
81
82   //! Default constructor.
83   OpenGl_RaytraceFilter() {}
84
85   //! Returns the previously set filter.
86   const Handle(OpenGl_RenderFilter)& PrevRenderFilter()
87   {
88     return myPrevRenderFilter;
89   }
90
91   //! Remembers the previously set filter.
92   void SetPrevRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
93   {
94     myPrevRenderFilter = theFilter;
95   }
96
97   //! Checks whether the element can be rendered or not.
98   //! @param theElement [in] the element to check.
99   //! @return True if element can be rendered.
100   virtual Standard_Boolean CanRender (const OpenGl_Element* theElement) Standard_OVERRIDE;
101
102 private:
103
104   Handle(OpenGl_RenderFilter) myPrevRenderFilter;
105
106 public:
107
108   DEFINE_STANDARD_RTTIEXT(OpenGl_RaytraceFilter,OpenGl_RenderFilter)
109 };
110
111 class OpenGl_Workspace;
112 DEFINE_STANDARD_HANDLE(OpenGl_Workspace,Standard_Transient)
113
114 //! Rendering workspace.
115 //! Provides methods to render primitives and maintain GL state.
116 class OpenGl_Workspace : public Standard_Transient
117 {
118 public:
119
120   //! Constructor of rendering workspace.
121   Standard_EXPORT OpenGl_Workspace (OpenGl_View* theView, const Handle(OpenGl_Window)& theWindow);
122
123   //! Destructor
124   Standard_EXPORT virtual ~OpenGl_Workspace();
125
126   //! Activate rendering context.
127   Standard_EXPORT Standard_Boolean Activate();
128
129   OpenGl_View* View() const { return myView; }
130
131   const Handle(OpenGl_Context)& GetGlContext() { return myGlContext; }
132
133   Standard_EXPORT Handle(OpenGl_FrameBuffer) FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight);
134
135   Standard_EXPORT void FBORelease (Handle(OpenGl_FrameBuffer)& theFbo);
136
137   Standard_Boolean BufferDump (const Handle(OpenGl_FrameBuffer)& theFbo,
138                                Image_PixMap&                     theImage,
139                                const Graphic3d_BufferType&       theBufferType);
140
141   Standard_EXPORT Standard_Integer Width()  const;
142
143   Standard_EXPORT Standard_Integer Height() const;
144
145   //! Setup Z-buffer usage flag (without affecting GL state!).
146   //! Returns previously set flag.
147   Standard_Boolean SetUseZBuffer (const Standard_Boolean theToUse)
148   {
149     const Standard_Boolean wasUsed = myUseZBuffer;
150     myUseZBuffer = theToUse;
151     return wasUsed;
152   }
153
154   Handle(OpenGl_PrinterContext)& PrinterContext() { return myPrintContext; }
155
156   //! @return true if usage of Z buffer is enabled.
157   Standard_Boolean& UseZBuffer() { return myUseZBuffer; }
158
159   //! @return true if depth writing is enabled.
160   Standard_Boolean& UseDepthWrite() { return myUseDepthWrite; }
161
162   //! @return true if usage of GL light is enabled.
163   Standard_EXPORT Standard_Boolean  UseGLLight() const;
164
165   //! @return true if antialiasing is enabled.
166   Standard_EXPORT Standard_Integer AntiAliasingMode() const;
167
168   //! @return true if clipping algorithm enabled
169   Standard_EXPORT Standard_Boolean IsCullingEnabled() const;
170
171   Standard_Integer NamedStatus;
172
173   //// RELATED TO STATUS ////
174
175   const OpenGl_Vec4* HighlightColor;
176
177   //! Return true if active group might activate face culling (e.g. primitives are closed).
178   bool ToAllowFaceCulling() const { return myToAllowFaceCulling; }
179
180   //! Allow or disallow face culling.
181   //! This call does NOT affect current state of back face culling;
182   //! ApplyAspectFace() should be called to update state.
183   void SetAllowFaceCulling (bool theToAllow) { myToAllowFaceCulling = theToAllow; }
184
185   //! Return true if following structures should apply highlight color.
186   bool ToHighlight() const { return myToHighlight; }
187
188   //! Set highlight.
189   void SetHighlight (bool theToHighlight) { myToHighlight = theToHighlight; }
190
191   //! Return line color taking into account highlight flag.
192   const OpenGl_Vec4& LineColor() const
193   {
194     return myToHighlight
195          ? *HighlightColor
196          : myAspectLineSet->Aspect()->ColorRGBA();
197   }
198
199   //! Return edge color taking into account highlight flag.
200   const OpenGl_Vec4& EdgeColor() const
201   {
202     return myToHighlight
203          ? *HighlightColor
204          : myAspectFaceSet->AspectEdge()->Aspect()->ColorRGBA();
205   }
206
207   //! Return marker color taking into account highlight flag.
208   const OpenGl_Vec4& MarkerColor() const
209   {
210     return myToHighlight
211          ? *HighlightColor
212          : myAspectMarkerSet->Aspect()->ColorRGBA();
213   }
214
215   //! Return Interior color taking into account highlight flag.
216   const OpenGl_Vec4& InteriorColor() const
217   {
218     return myToHighlight
219          ? *HighlightColor
220          : myAspectFaceSet->Aspect()->InteriorColorRGBA();
221   }
222
223   //! Return text color taking into account highlight flag.
224   const OpenGl_Vec4& TextColor() const
225   {
226     return myToHighlight
227          ? *HighlightColor
228          : myAspectTextSet->Aspect()->ColorRGBA();
229   }
230
231   //! Return text Subtitle color taking into account highlight flag.
232   const OpenGl_Vec4& TextSubtitleColor() const
233   {
234     return myToHighlight
235          ? *HighlightColor
236          : myAspectTextSet->Aspect()->ColorSubTitleRGBA();
237   }
238
239   //! Currently set line aspect (can differ from applied).
240   const OpenGl_AspectLine*   AspectLine()   const { return myAspectLineSet; }
241
242   //! Currently set face aspect (can differ from applied).
243   const OpenGl_AspectFace*   AspectFace()   const { return myAspectFaceSet; }
244
245   //! Currently set marker aspect (can differ from applied).
246   const OpenGl_AspectMarker* AspectMarker() const { return myAspectMarkerSet; }
247
248   //! Currently set text aspect (can differ from applied).
249   const OpenGl_AspectText*   AspectText()   const { return myAspectTextSet; }
250
251   //! Assign new line aspect (will be applied within ApplyAspectLine()).
252   Standard_EXPORT const OpenGl_AspectLine*   SetAspectLine   (const OpenGl_AspectLine*   theAspect);
253
254   //! Assign new face aspect (will be applied within ApplyAspectFace()).
255   Standard_EXPORT const OpenGl_AspectFace*   SetAspectFace   (const OpenGl_AspectFace*   theAspect);
256
257   //! Assign new marker aspect (will be applied within ApplyAspectMarker()).
258   Standard_EXPORT const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
259
260   //! Assign new text aspect (will be applied within ApplyAspectText()).
261   Standard_EXPORT const OpenGl_AspectText*   SetAspectText   (const OpenGl_AspectText*   theAspect);
262
263   //! Apply line aspect.
264   //! @return aspect set by SetAspectLine()
265   const OpenGl_AspectLine* ApplyAspectLine() { return myAspectLineSet; }
266
267   //! Apply face aspect.
268   //! @return aspect set by SetAspectFace()
269   Standard_EXPORT const OpenGl_AspectFace*   ApplyAspectFace();
270
271   //! Apply marker aspect.
272   //! @return aspect set by SetAspectMarker()
273   Standard_EXPORT const OpenGl_AspectMarker* ApplyAspectMarker();
274
275   //! Apply text aspect.
276   //! @return aspect set by SetAspectText()
277   const OpenGl_AspectText* ApplyAspectText() { return myAspectTextSet; }
278
279   //! Clear the applied aspect state to default values.
280   void ResetAppliedAspect();
281
282   Standard_EXPORT Handle(OpenGl_Texture) DisableTexture();
283   Standard_EXPORT Handle(OpenGl_Texture) EnableTexture (const Handle(OpenGl_Texture)&          theTexture,
284                                                         const Handle(Graphic3d_TextureParams)& theParams = NULL);
285   const Handle(OpenGl_Texture)& ActiveTexture() const { return myTextureBound; }
286
287   //! Set filter for restricting rendering of particular elements.
288   //! Filter can be applied for rendering passes used by recursive
289   //! rendering algorithms for rendering elements of groups.
290   //! @param theFilter [in] the filter instance.
291   inline void SetRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
292   {
293     myRenderFilter = theFilter;
294   }
295
296   //! Get rendering filter.
297   //! @return filter instance.
298   inline const Handle(OpenGl_RenderFilter)& GetRenderFilter() const
299   {
300     return myRenderFilter;
301   }
302
303   //! @return applied view matrix.
304   inline const OpenGl_Matrix* ViewMatrix() const { return ViewMatrix_applied; }
305
306   //! @return applied model structure matrix.
307   inline const OpenGl_Matrix* ModelMatrix() const { return StructureMatrix_applied; }
308
309   //! Sets and applies current polygon offset.
310   void SetPolygonOffset (const Graphic3d_PolygonOffset& theParams);
311
312   //! Returns currently applied polygon offset params.
313   const Graphic3d_PolygonOffset& AppliedPolygonOffset() { return myPolygonOffsetApplied; }
314
315   //! Returns capping algorithm rendering filter.
316   const Handle(OpenGl_CappingAlgoFilter)& DefaultCappingAlgoFilter() const
317   {
318     return myDefaultCappingAlgoFilter;
319   }
320
321   //! Returns face aspect for none culling mode.
322   const OpenGl_AspectFace& NoneCulling() const
323   {
324     return myNoneCulling;
325   }
326
327   //! Returns face aspect for front face culling mode.
328   const OpenGl_AspectFace& FrontCulling() const
329   {
330     return myFrontCulling;
331   }
332
333   //! Sets a new environment texture.
334   void SetEnvironmentTexture (const Handle(OpenGl_Texture)& theTexture)
335   {
336     myEnvironmentTexture = theTexture;
337   }
338
339   //! Returns environment texture.
340   const Handle(OpenGl_Texture)& EnvironmentTexture() const
341   {
342     return myEnvironmentTexture;
343   }
344
345 protected:
346
347   enum
348   {
349     TEL_FRONT_MATERIAL = 1,
350     TEL_BACK_MATERIAL  = 2
351   };
352
353   void updateMaterial (const int theFlag);
354
355   void setTextureParams (Handle(OpenGl_Texture)&                theTexture,
356                          const Handle(Graphic3d_TextureParams)& theParams);
357
358 protected: //! @name protected fields
359
360   OpenGl_View*                     myView;
361   Handle(OpenGl_Window)            myWindow;
362   Handle(OpenGl_Context)           myGlContext;
363   Handle(OpenGl_PrinterContext)    myPrintContext;
364   Handle(OpenGl_LineAttributes)    myLineAttribs;
365   Standard_Integer                 myAntiAliasingMode;
366   Standard_Boolean                 myUseZBuffer;
367   Standard_Boolean                 myUseDepthWrite;
368   Standard_Boolean                 myUseGLLight;
369   Handle(OpenGl_CappingAlgoFilter) myDefaultCappingAlgoFilter;
370   OpenGl_AspectFace                myNoneCulling;
371   OpenGl_AspectFace                myFrontCulling;
372
373 protected: //! @name fields related to status
374
375   Handle(OpenGl_RenderFilter) myRenderFilter;
376   Handle(OpenGl_Texture) myTextureBound;    //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
377   const OpenGl_AspectLine*   myAspectLineSet;
378   const OpenGl_AspectFace*   myAspectFaceSet;
379   Handle(Graphic3d_AspectFillArea3d) myAspectFaceApplied;
380   const OpenGl_AspectMarker* myAspectMarkerSet;
381   Handle(Graphic3d_AspectMarker3d) myAspectMarkerApplied;
382   const OpenGl_AspectText*   myAspectTextSet;
383   bool                       myAspectFaceAppliedWithHL;
384
385   const OpenGl_Matrix* ViewMatrix_applied;
386   const OpenGl_Matrix* StructureMatrix_applied;
387
388   OpenGl_Material myMatFront;    //!< current front material state (cached to reduce GL context updates)
389   OpenGl_Material myMatBack;     //!< current back  material state
390   OpenGl_Material myMatTmp;      //!< temporary variable
391   bool            myToAllowFaceCulling; //!< allow back face culling
392   bool            myToHighlight; //!< flag indicating highlighting mode
393
394   OpenGl_Matrix myModelViewMatrix; //!< Model matrix with applied structure transformations
395
396   Graphic3d_PolygonOffset myPolygonOffsetApplied; //!< currently applied polygon offset
397
398   OpenGl_AspectFace myAspectFaceHl; //!< Hiddenline aspect
399
400   Handle(OpenGl_Texture) myEnvironmentTexture;
401
402 public: //! @name type definition
403
404   DEFINE_STANDARD_RTTIEXT(OpenGl_Workspace,Standard_Transient)
405   DEFINE_STANDARD_ALLOC
406
407 };
408
409 #endif // _OpenGl_Workspace_Header