0029729: Visualization, Graphic3d_ClipPlane - add support of clipping plane chains
[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_Material.hxx>
25 #include <OpenGl_Matrix.hxx>
26 #include <OpenGl_RenderFilter.hxx>
27 #include <OpenGl_ShaderObject.hxx>
28 #include <OpenGl_ShaderProgram.hxx>
29 #include <OpenGl_TextParam.hxx>
30 #include <OpenGl_TextureBufferArb.hxx>
31 #include <OpenGl_Vec.hxx>
32 #include <OpenGl_Window.hxx>
33
34 class OpenGl_View;
35 class Image_PixMap;
36
37 class OpenGl_RaytraceFilter;
38 DEFINE_STANDARD_HANDLE (OpenGl_RaytraceFilter, OpenGl_RenderFilter)
39
40 //! Graphical ray-tracing filter.
41 //! Filters out all raytracable structures.
42 class OpenGl_RaytraceFilter : public OpenGl_RenderFilter
43 {
44 public:
45
46   //! Default constructor.
47   OpenGl_RaytraceFilter() {}
48
49   //! Returns the previously set filter.
50   const Handle(OpenGl_RenderFilter)& PrevRenderFilter()
51   {
52     return myPrevRenderFilter;
53   }
54
55   //! Remembers the previously set filter.
56   void SetPrevRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
57   {
58     myPrevRenderFilter = theFilter;
59   }
60
61   //! Checks whether the element can be rendered or not.
62   //! @param theElement [in] the element to check.
63   //! @return True if element can be rendered.
64   virtual Standard_Boolean ShouldRender (const Handle(OpenGl_Workspace)& theWorkspace,
65                                          const OpenGl_Element*           theElement) Standard_OVERRIDE;
66
67 private:
68
69   Handle(OpenGl_RenderFilter) myPrevRenderFilter;
70
71 public:
72
73   DEFINE_STANDARD_RTTIEXT(OpenGl_RaytraceFilter,OpenGl_RenderFilter)
74 };
75
76 class OpenGl_Workspace;
77 DEFINE_STANDARD_HANDLE(OpenGl_Workspace,Standard_Transient)
78
79 //! Rendering workspace.
80 //! Provides methods to render primitives and maintain GL state.
81 class OpenGl_Workspace : public Standard_Transient
82 {
83 public:
84
85   //! Constructor of rendering workspace.
86   Standard_EXPORT OpenGl_Workspace (OpenGl_View* theView, const Handle(OpenGl_Window)& theWindow);
87
88   //! Destructor
89   virtual ~OpenGl_Workspace() {}
90
91   //! Activate rendering context.
92   Standard_EXPORT Standard_Boolean Activate();
93
94   OpenGl_View* View() const { return myView; }
95
96   const Handle(OpenGl_Context)& GetGlContext() { return myGlContext; }
97
98   Standard_EXPORT Handle(OpenGl_FrameBuffer) FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight);
99
100   Standard_EXPORT void FBORelease (Handle(OpenGl_FrameBuffer)& theFbo);
101
102   Standard_Boolean BufferDump (const Handle(OpenGl_FrameBuffer)& theFbo,
103                                Image_PixMap&                     theImage,
104                                const Graphic3d_BufferType&       theBufferType);
105
106   Standard_EXPORT Standard_Integer Width()  const;
107
108   Standard_EXPORT Standard_Integer Height() const;
109
110   //! Setup Z-buffer usage flag (without affecting GL state!).
111   //! Returns previously set flag.
112   Standard_Boolean SetUseZBuffer (const Standard_Boolean theToUse)
113   {
114     const Standard_Boolean wasUsed = myUseZBuffer;
115     myUseZBuffer = theToUse;
116     return wasUsed;
117   }
118
119   //! @return true if usage of Z buffer is enabled.
120   Standard_Boolean& UseZBuffer() { return myUseZBuffer; }
121
122   //! @return true if depth writing is enabled.
123   Standard_Boolean& UseDepthWrite() { return myUseDepthWrite; }
124
125   //! @return true if frustum culling algorithm is enabled
126   Standard_EXPORT Standard_Boolean IsCullingEnabled() const;
127
128   //// RELATED TO STATUS ////
129
130   //! Return true if active group might activate face culling (e.g. primitives are closed).
131   bool ToAllowFaceCulling() const { return myToAllowFaceCulling; }
132
133   //! Allow or disallow face culling.
134   //! This call does NOT affect current state of back face culling;
135   //! ApplyAspectFace() should be called to update state.
136   bool SetAllowFaceCulling (bool theToAllow)
137   {
138     const bool wasAllowed = myToAllowFaceCulling;
139     myToAllowFaceCulling = theToAllow;
140     return wasAllowed;
141   }
142
143   //! Return true if following structures should apply highlight color.
144   bool ToHighlight() const { return !myHighlightStyle.IsNull(); }
145
146   //! Return highlight style.
147   const Handle(Graphic3d_PresentationAttributes)& HighlightStyle() const { return myHighlightStyle; }
148
149   //! Set highlight style.
150   void SetHighlightStyle (const Handle(Graphic3d_PresentationAttributes)& theStyle) {  myHighlightStyle = theStyle; }
151
152   //! Return line color taking into account highlight flag.
153   const OpenGl_Vec4& LineColor() const
154   {
155     return !myHighlightStyle.IsNull()
156          ?  myHighlightStyle->ColorRGBA()
157          :  myAspectLineSet->Aspect()->ColorRGBA();
158   }
159
160   //! Return edge color taking into account highlight flag.
161   const OpenGl_Vec4& EdgeColor() const
162   {
163     return !myHighlightStyle.IsNull()
164          ?  myHighlightStyle->ColorRGBA()
165          :  myAspectFaceSet->AspectEdge()->Aspect()->ColorRGBA();
166   }
167
168   //! Return marker color taking into account highlight flag.
169   const OpenGl_Vec4& MarkerColor() const
170   {
171     return !myHighlightStyle.IsNull()
172          ?  myHighlightStyle->ColorRGBA()
173          :  myAspectMarkerSet->Aspect()->ColorRGBA();
174   }
175
176   //! Return Interior color taking into account highlight flag.
177   const OpenGl_Vec4& InteriorColor() const
178   {
179     return !myHighlightStyle.IsNull()
180          ?  myHighlightStyle->ColorRGBA()
181          :  myAspectFaceSet->Aspect()->InteriorColorRGBA();
182   }
183
184   //! Return text color taking into account highlight flag.
185   const OpenGl_Vec4& TextColor() const
186   {
187     return !myHighlightStyle.IsNull()
188          ?  myHighlightStyle->ColorRGBA()
189          :  myAspectTextSet->Aspect()->ColorRGBA();
190   }
191
192   //! Return text Subtitle color taking into account highlight flag.
193   const OpenGl_Vec4& TextSubtitleColor() const
194   {
195     return !myHighlightStyle.IsNull()
196          ?  myHighlightStyle->ColorRGBA()
197          :  myAspectTextSet->Aspect()->ColorSubTitleRGBA();
198   }
199
200   //! Currently set line aspect (can differ from applied).
201   const OpenGl_AspectLine*   AspectLine()   const { return myAspectLineSet; }
202
203   //! Currently set face aspect (can differ from applied).
204   const OpenGl_AspectFace*   AspectFace()   const { return myAspectFaceSet; }
205
206   //! Currently set marker aspect (can differ from applied).
207   const OpenGl_AspectMarker* AspectMarker() const { return myAspectMarkerSet; }
208
209   //! Currently set text aspect (can differ from applied).
210   const OpenGl_AspectText*   AspectText()   const { return myAspectTextSet; }
211
212   //! Assign new line aspect (will be applied within ApplyAspectLine()).
213   Standard_EXPORT const OpenGl_AspectLine*   SetAspectLine   (const OpenGl_AspectLine*   theAspect);
214
215   //! Assign new face aspect (will be applied within ApplyAspectFace()).
216   Standard_EXPORT const OpenGl_AspectFace*   SetAspectFace   (const OpenGl_AspectFace*   theAspect);
217
218   //! Assign new marker aspect (will be applied within ApplyAspectMarker()).
219   Standard_EXPORT const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
220
221   //! Assign new text aspect (will be applied within ApplyAspectText()).
222   Standard_EXPORT const OpenGl_AspectText*   SetAspectText   (const OpenGl_AspectText*   theAspect);
223
224   //! Apply line aspect.
225   //! @return aspect set by SetAspectLine()
226   const OpenGl_AspectLine* ApplyAspectLine() { return myAspectLineSet; }
227
228   //! Apply face aspect.
229   //! @return aspect set by SetAspectFace()
230   Standard_EXPORT const OpenGl_AspectFace*   ApplyAspectFace();
231
232   //! Apply marker aspect.
233   //! @return aspect set by SetAspectMarker()
234   Standard_EXPORT const OpenGl_AspectMarker* ApplyAspectMarker();
235
236   //! Apply text aspect.
237   //! @return aspect set by SetAspectText()
238   const OpenGl_AspectText* ApplyAspectText() { return myAspectTextSet; }
239
240   //! Clear the applied aspect state to default values.
241   void ResetAppliedAspect();
242
243   //! Set filter for restricting rendering of particular elements.
244   //! Filter can be applied for rendering passes used by recursive
245   //! rendering algorithms for rendering elements of groups.
246   //! @param theFilter [in] the filter instance.
247   inline void SetRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
248   {
249     myRenderFilter = theFilter;
250   }
251
252   //! Get rendering filter.
253   //! @return filter instance.
254   inline const Handle(OpenGl_RenderFilter)& GetRenderFilter() const
255   {
256     return myRenderFilter;
257   }
258
259   //! @return applied view matrix.
260   inline const OpenGl_Matrix* ViewMatrix() const { return ViewMatrix_applied; }
261
262   //! @return applied model structure matrix.
263   inline const OpenGl_Matrix* ModelMatrix() const { return StructureMatrix_applied; }
264
265   //! Returns face aspect for textured font rendering.
266   const OpenGl_AspectFace& FontFaceAspect() const { return myFontFaceAspect; }
267
268   //! Returns capping algorithm rendering filter.
269   const Handle(OpenGl_CappingAlgoFilter)& DefaultCappingAlgoFilter() const { return myDefaultCappingAlgoFilter; }
270
271   //! Returns face aspect for none culling mode.
272   const OpenGl_AspectFace& NoneCulling() const { return myNoneCulling; }
273
274   //! Returns face aspect for front face culling mode.
275   const OpenGl_AspectFace& FrontCulling() const { return myFrontCulling; }
276
277   //! Sets a new environment texture.
278   void SetEnvironmentTexture (const Handle(OpenGl_TextureSet)& theTexture) { myEnvironmentTexture = theTexture; }
279
280   //! Returns environment texture.
281   const Handle(OpenGl_TextureSet)& EnvironmentTexture() const { return myEnvironmentTexture; }
282
283 protected: //! @name protected fields
284
285   OpenGl_View*                     myView;
286   Handle(OpenGl_Window)            myWindow;
287   Handle(OpenGl_Context)           myGlContext;
288   Standard_Boolean                 myUseZBuffer;
289   Standard_Boolean                 myUseDepthWrite;
290   Handle(OpenGl_CappingAlgoFilter) myDefaultCappingAlgoFilter;
291   OpenGl_AspectFace                myNoneCulling;
292   OpenGl_AspectFace                myFrontCulling;
293   OpenGl_AspectFace                myFontFaceAspect;
294
295 protected: //! @name fields related to status
296
297   Handle(OpenGl_RenderFilter) myRenderFilter;
298   const OpenGl_AspectLine*   myAspectLineSet;
299   const OpenGl_AspectFace*   myAspectFaceSet;
300   Handle(Graphic3d_AspectFillArea3d) myAspectFaceApplied;
301   const OpenGl_AspectMarker* myAspectMarkerSet;
302   Handle(Graphic3d_AspectMarker3d) myAspectMarkerApplied;
303   const OpenGl_AspectText*   myAspectTextSet;
304   Handle(Graphic3d_PresentationAttributes) myAspectFaceAppliedWithHL;
305
306   const OpenGl_Matrix* ViewMatrix_applied;
307   const OpenGl_Matrix* StructureMatrix_applied;
308
309   bool            myToAllowFaceCulling; //!< allow back face culling
310   Handle(Graphic3d_PresentationAttributes) myHighlightStyle; //!< active highlight style
311
312   OpenGl_Matrix myModelViewMatrix; //!< Model matrix with applied structure transformations
313
314   OpenGl_AspectFace myAspectFaceHl; //!< Hiddenline aspect
315
316   Handle(OpenGl_TextureSet) myEnvironmentTexture;
317
318 public: //! @name type definition
319
320   DEFINE_STANDARD_RTTIEXT(OpenGl_Workspace,Standard_Transient)
321   DEFINE_STANDARD_ALLOC
322
323 };
324
325 #endif // _OpenGl_Workspace_Header