1 // Created on: 2011-09-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2013 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _OpenGl_Workspace_Header
17 #define _OpenGl_Workspace_Header
22 #include <Handle_OpenGl_Workspace.hxx>
23 #include <OpenGl_Window.hxx>
25 #include <TColStd_Array2OfReal.hxx>
26 #include <Quantity_Color.hxx>
27 #include <Graphic3d_CView.hxx>
28 #include <Graphic3d_TypeOfComposition.hxx>
29 #include <Graphic3d_TypeOfTexture.hxx>
30 #include <Graphic3d_PtrFrameBuffer.hxx>
31 #include <Graphic3d_BufferType.hxx>
32 #include <Handle_Graphic3d_TextureParams.hxx>
34 #include <Aspect_CLayer2d.hxx>
35 #include <Aspect_Handle.hxx>
36 #include <Aspect_PrintAlgo.hxx>
37 #include <Aspect_PolygonOffsetMode.hxx>
39 #include <InterfaceGraphic_Graphic3d.hxx>
40 #include <InterfaceGraphic_Visual3d.hxx>
42 #include <NCollection_Sequence.hxx>
44 #include <OpenGl_AspectFace.hxx>
45 #include <OpenGl_FrameBuffer.hxx>
46 #include <OpenGl_Matrix.hxx>
47 #include <OpenGl_NamedStatus.hxx>
48 #include <OpenGl_PrinterContext.hxx>
49 #include <OpenGl_SceneGeometry.hxx>
50 #include <OpenGl_TextParam.hxx>
51 #include <OpenGl_RenderFilter.hxx>
52 #include <OpenGl_Vec.hxx>
53 #include <OpenGl_LineAttributes.hxx>
54 #include <OpenGl_CappingAlgo.hxx>
56 #include <Handle_OpenGl_View.hxx>
57 #include <Handle_OpenGl_Texture.hxx>
59 #include <OpenGl_ShaderObject.hxx>
60 #include <OpenGl_ShaderProgram.hxx>
61 #include <OpenGl_TextureBufferArb.hxx>
63 class OpenGl_AspectLine;
64 class OpenGl_AspectMarker;
65 class OpenGl_AspectText;
66 class OpenGl_FrameBuffer;
67 class OpenGl_Structure;
68 class OpenGl_TriangleSet;
72 //! OpenGL material definition
73 struct OpenGl_Material
76 OpenGl_Vec4 Ambient; //!< ambient reflection coefficient
77 OpenGl_Vec4 Diffuse; //!< diffuse reflection coefficient
78 OpenGl_Vec4 Specular; //!< glossy reflection coefficient
79 OpenGl_Vec4 Emission; //!< material emission
80 OpenGl_Vec4 Params; //!< extra packed parameters
82 Standard_ShortReal Shine() const { return Params.x(); }
83 Standard_ShortReal& ChangeShine() { return Params.x(); }
85 Standard_ShortReal Transparency() const { return Params.y(); }
86 Standard_ShortReal& ChangeTransparency() { return Params.y(); }
88 //! Initialize material
89 void Init (const OPENGL_SURF_PROP& theProps);
91 //! Returns packed (serialized) representation of material properties
92 const OpenGl_Vec4* Packed() const { return reinterpret_cast<const OpenGl_Vec4*> (this); }
93 static Standard_Integer NbOfVec4() { return 5; }
97 DEFINE_STANDARD_HANDLE (OpenGl_RaytraceFilter, OpenGl_RenderFilter)
99 //! Graphical ray-tracing filter.
100 //! Filters out all raytracable structures.
101 class OpenGl_RaytraceFilter : public OpenGl_RenderFilter
105 //! Default constructor.
106 OpenGl_RaytraceFilter() {}
108 //! Returns the previously set filter.
109 const Handle(OpenGl_RenderFilter)& PrevRenderFilter()
111 return myPrevRenderFilter;
114 //! Remembers the previously set filter.
115 void SetPrevRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
117 myPrevRenderFilter = theFilter;
120 //! Checks whether the element can be rendered or not.
121 //! @param theElement [in] the element to check.
122 //! @return True if element can be rendered.
123 virtual Standard_Boolean CanRender (const OpenGl_Element* theElement);
127 Handle(OpenGl_RenderFilter) myPrevRenderFilter;
131 DEFINE_STANDARD_RTTI(OpenGl_RaytraceFilter, OpenGl_RenderFilter)
134 //! Represents window with GL context.
135 //! Provides methods to render primitives and maintain GL state.
136 class OpenGl_Workspace : public OpenGl_Window
140 //! Main constructor - prepare GL context for specified window.
141 OpenGl_Workspace (const Handle(OpenGl_GraphicDriver)& theDriver,
142 const CALL_DEF_WINDOW& theCWindow,
143 Aspect_RenderingContext theGContext,
144 const Handle(OpenGl_Caps)& theCaps,
145 const Handle(OpenGl_Context)& theShareCtx);
148 virtual ~OpenGl_Workspace();
150 void SetActiveView (const Handle(OpenGl_View)& theView,
151 const Standard_Integer theViewId)
154 myViewId = theViewId;
157 const Handle(OpenGl_View)& ActiveView() const { return myView; }
159 Standard_Integer ActiveViewId() const { return myViewId; }
161 //! Redraw the window.
162 void Redraw (const Graphic3d_CView& theCView,
163 const Aspect_CLayer2d& theCUnderLayer,
164 const Aspect_CLayer2d& theCOverLayer);
166 Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer);
167 void RedrawImmediate (const Graphic3d_CView& theCView,
168 const Aspect_CLayer2d& theCUnderLayer,
169 const Aspect_CLayer2d& theCOverLayer);
171 void Invalidate (const Graphic3d_CView& /*theCView*/)
173 myBackBufferRestored = Standard_False;
176 //! Special method to perform printing.
177 //! System-specific and currently only Win platform implemented.
178 Standard_Boolean Print (const Handle(OpenGl_PrinterContext)& thePrintContext,
179 const Graphic3d_CView& theCView,
180 const Aspect_CLayer2d& theCUnderLayer,
181 const Aspect_CLayer2d& theCOverLayer,
182 const Aspect_Handle theHPrintDC,
183 const Standard_Boolean theToShowBackground,
184 const Standard_CString theFileName,
185 const Aspect_PrintAlgo thePrintAlgorithm,
186 const Standard_Real theScaleFactor);
188 const Handle(OpenGl_PrinterContext)& PrinterContext() const
190 return myPrintContext;
193 void DisplayCallback (const Graphic3d_CView& theCView, int theReason);
195 Graphic3d_PtrFrameBuffer FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight);
196 void FBORelease (Graphic3d_PtrFrameBuffer theFBOPtr);
197 Standard_Boolean BufferDump (OpenGl_FrameBuffer* theFBOPtr,
198 Image_PixMap& theImage,
199 const Graphic3d_BufferType& theBufferType);
201 //! Setup Z-buffer usage flag (without affecting GL state!).
202 //! Returns previously set flag.
203 Standard_Boolean SetUseZBuffer (const Standard_Boolean theToUse)
205 const Standard_Boolean wasUsed = myUseZBuffer;
206 myUseZBuffer = theToUse;
210 Standard_Boolean& UseZBuffer() { return myUseZBuffer; }
211 Standard_Boolean& UseDepthWrite() { return myUseDepthWrite; }
212 Standard_Boolean& UseGLLight() { return myUseGLLight; }
214 Standard_Integer AntiAliasingMode() const { return myAntiAliasingMode; }
216 //// RELATED TO STATUS ////
218 Standard_Integer NamedStatus;
220 const TEL_COLOUR* HighlightColor;
222 const OpenGl_AspectLine* SetAspectLine (const OpenGl_AspectLine* theAspect);
223 const OpenGl_AspectFace* SetAspectFace (const OpenGl_AspectFace* theAspect);
224 const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
225 const OpenGl_AspectText* SetAspectText (const OpenGl_AspectText* theAspect);
227 void SetTextParam (const OpenGl_TextParam* theParam) { TextParam_set = theParam; }
229 //// THESE METHODS ARE EXPORTED AS THEY PROVIDE STATE INFO TO USERDRAW
230 Standard_EXPORT const OpenGl_AspectLine* AspectLine (const Standard_Boolean theWithApply);
231 Standard_EXPORT const OpenGl_AspectFace* AspectFace (const Standard_Boolean theWithApply);
232 Standard_EXPORT const OpenGl_AspectMarker* AspectMarker (const Standard_Boolean theWithApply);
233 Standard_EXPORT const OpenGl_AspectText* AspectText (const Standard_Boolean theWithApply);
234 inline const OpenGl_TextParam* AspectTextParams() const
236 return TextParam_applied;
239 //! Clear the applied aspect state.
240 void ResetAppliedAspect();
242 Standard_EXPORT Handle(OpenGl_Texture) DisableTexture();
243 Standard_EXPORT Handle(OpenGl_Texture) EnableTexture (const Handle(OpenGl_Texture)& theTexture,
244 const Handle(Graphic3d_TextureParams)& theParams = NULL);
245 const Handle(OpenGl_Texture)& ActiveTexture() const { return myTextureBound; }
247 //! Set filter for restricting rendering of particular elements.
248 //! Filter can be applied for rendering passes used by recursive
249 //! rendering algorithms for rendering elements of groups.
250 //! @param theFilter [in] the filter instance.
251 inline void SetRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
253 myRenderFilter = theFilter;
256 //! Get rendering filter.
257 //! @return filter instance.
258 inline const Handle(OpenGl_RenderFilter)& GetRenderFilter() const
260 return myRenderFilter;
263 //! @return applied view matrix.
264 inline const OpenGl_Matrix* ViewMatrix() const { return ViewMatrix_applied; }
266 //! @return applied model structure matrix.
267 inline const OpenGl_Matrix* ModelMatrix() const { return StructureMatrix_applied; }
269 //! Sets and applies current polygon offset.
270 void SetPolygonOffset (int theMode, Standard_ShortReal theFactor, Standard_ShortReal theUnits);
272 //! Returns currently applied polygon offset params.
273 const TEL_POFFSET_PARAM& AppliedPolygonOffset() { return PolygonOffset_applied; }
275 //! @return true if clipping algorithm enabled
276 inline Standard_Boolean IsCullingEnabled() const { return myIsCullingEnabled; }
278 //! Returns capping algorithm rendering filter.
279 const Handle(OpenGl_CappingAlgoFilter)& DefaultCappingAlgoFilter() const
281 return myDefaultCappingAlgoFilter;
284 //! Returns face aspect for none culling mode.
285 const OpenGl_AspectFace& NoneCulling() const
287 return myNoneCulling;
290 //! Returns face aspect for front face culling mode.
291 const OpenGl_AspectFace& FrontCulling() const
293 return myFrontCulling;
298 //! Copy content of Back buffer to the Front buffer
299 void copyBackToFront();
301 //! Blit image from/to specified buffers.
302 bool blitBuffers (OpenGl_FrameBuffer* theReadFbo,
303 OpenGl_FrameBuffer* theDrawFbo);
305 virtual Standard_Boolean Activate();
307 void redraw1 (const Graphic3d_CView& theCView,
308 const Aspect_CLayer2d& theCUnderLayer,
309 const Aspect_CLayer2d& theCOverLayer,
310 OpenGl_FrameBuffer* theReadDrawFbo,
311 const Graphic3d_Camera::Projection theProjection);
313 //! Setup default FBO.
314 void bindDefaultFbo (OpenGl_FrameBuffer* theCustomFbo = NULL);
316 //! Blend together views pair into stereo image.
317 void drawStereoPair (const Graphic3d_CView& theCView);
319 //! Blit snapshot containing main scene (myMainSceneFbos or BackBuffer)
320 //! into presentation buffer (myMainSceneFbos -> offscreen FBO or myMainSceneFbos -> BackBuffer or BackBuffer -> FrontBuffer),
321 //! and redraw immediate structures on top.
323 //! When scene caching is disabled (myTransientDrawToFront, no double buffer in window, etc.),
324 //! the first step (blitting) will be skipped.
326 //! @return false if immediate structures has been rendered directly into FrontBuffer and Buffer Swap should not be called.
327 bool redrawImmediate (const Graphic3d_CView& theCView,
328 const Aspect_CLayer2d& theCUnderLayer,
329 const Aspect_CLayer2d& theCOverLayer,
330 OpenGl_FrameBuffer* theReadFbo,
331 const Graphic3d_Camera::Projection theProjection,
332 OpenGl_FrameBuffer* theDrawFbo,
333 const Standard_Boolean theIsPartialUpdate = Standard_False);
335 void updateMaterial (const int theFlag);
337 void setTextureParams (Handle(OpenGl_Texture)& theTexture,
338 const Handle(Graphic3d_TextureParams)& theParams);
340 protected: //! @name protected fields
342 //! Two framebuffers (left and right views) store cached main presentation
343 //! of the view (without presentation of immediate layers).
344 Handle(OpenGl_FrameBuffer) myMainSceneFbos[2];
345 //! Additional buffers for immediate layer in stereo mode.
346 Handle(OpenGl_FrameBuffer) myImmediateSceneFbos[2];
347 //! Special flag which is invalidated when myMainSceneFbos can not be blitted for some reason (e.g. driver bugs).
348 Standard_Boolean myHasFboBlit;
350 //! Vertices for full-screen quad rendering.
351 OpenGl_VertexBuffer myFullScreenQuad;
353 Handle(OpenGl_PrinterContext) myPrintContext;
354 Handle(OpenGl_View) myView;
355 Handle(OpenGl_LineAttributes) myLineAttribs;
356 Standard_Integer myViewId;
357 Standard_Integer myAntiAliasingMode;
358 Standard_Boolean myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
359 Standard_Boolean myBackBufferRestored;
360 Standard_Boolean myIsImmediateDrawn; //!< flag indicates that immediate mode buffer contains some data
361 Standard_Boolean myUseZBuffer;
362 Standard_Boolean myUseDepthWrite;
363 Standard_Boolean myUseGLLight;
364 Standard_Boolean myIsCullingEnabled; //!< frustum culling flag
366 unsigned int myFrameCounter; //!< redraw counter, for debugging
368 Handle(OpenGl_CappingAlgoFilter) myDefaultCappingAlgoFilter;
369 OpenGl_AspectFace myNoneCulling;
370 OpenGl_AspectFace myFrontCulling;
372 protected: //! @name fields related to status
374 Handle(OpenGl_RenderFilter) myRenderFilter;
375 Handle(OpenGl_Texture) myTextureBound; //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
376 const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
377 const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
378 const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
379 const OpenGl_AspectText *AspectText_set, *AspectText_applied;
381 const OpenGl_TextParam *TextParam_set, *TextParam_applied;
383 const OpenGl_Matrix* ViewMatrix_applied;
384 const OpenGl_Matrix* StructureMatrix_applied;
386 OpenGl_Material myMatFront; //!< current front material state (cached to reduce GL context updates)
387 OpenGl_Material myMatBack; //!< current back material state
388 OpenGl_Material myMatTmp; //!< temporary variable
389 TelCullMode myCullingMode; //!< back face culling mode, applied from face aspect
391 OpenGl_Matrix myModelViewMatrix; //!< Model matrix with applied structure transformations
393 TEL_POFFSET_PARAM PolygonOffset_applied; //!< Currently applied polygon offset.
395 OpenGl_AspectFace myAspectFaceHl; //!< Hiddenline aspect
397 public: //! @name type definition
399 DEFINE_STANDARD_RTTI(OpenGl_Workspace, OpenGl_Window)
400 DEFINE_STANDARD_ALLOC
404 #endif // _OpenGl_Workspace_Header