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 <map>
  20 #include <set>
  21
  22 #include <OpenGl_Window.hxx>
  23
  24 #include <TColStd_Array2OfReal.hxx>
  25 #include <Quantity_Color.hxx>
  26 #include <Graphic3d_CView.hxx>
  27 #include <Graphic3d_TypeOfComposition.hxx>
  28 #include <Graphic3d_TypeOfTexture.hxx>
  29 #include <Graphic3d_PtrFrameBuffer.hxx>
  30 #include <Graphic3d_BufferType.hxx>
  31
  32 #include <Aspect_Handle.hxx>
  33 #include <Aspect_PrintAlgo.hxx>
  34 #include <Aspect_PolygonOffsetMode.hxx>
  35
  36 #include <InterfaceGraphic_Graphic3d.hxx>
  37 #include <InterfaceGraphic_Visual3d.hxx>
  38
  39 #include <NCollection_Sequence.hxx>
  40
  41 #include <OpenGl_AspectFace.hxx>
  42 #include <OpenGl_FrameBuffer.hxx>
  43 #include <OpenGl_Matrix.hxx>
  44 #include <OpenGl_NamedStatus.hxx>
  45 #include <OpenGl_PrinterContext.hxx>
  46 #include <OpenGl_SceneGeometry.hxx>
  47 #include <OpenGl_TextParam.hxx>
  48 #include <OpenGl_RenderFilter.hxx>
  49 #include <OpenGl_Vec.hxx>
  50 #include <OpenGl_LineAttributes.hxx>
  51 #include <OpenGl_CappingAlgo.hxx>
  52
  53
  54 #include <OpenGl_ShaderObject.hxx>
  55 #include <OpenGl_ShaderProgram.hxx>
  56 #include <OpenGl_TextureBufferArb.hxx>
  57
  58 class OpenGl_AspectLine;
  59 class OpenGl_AspectMarker;
  60 class OpenGl_AspectText;
  61 class OpenGl_FrameBuffer;
  62 class OpenGl_Structure;
  63 class OpenGl_TriangleSet;
  64 class OpenGl_Element;
  65 class OpenGl_View;
  66 class Image_PixMap;
  67
  68 //! OpenGL material definition
  69 struct OpenGl_Material
  70 {
  71
  72   OpenGl_Vec4 Ambient;  //!< ambient reflection coefficient
  73   OpenGl_Vec4 Diffuse;  //!< diffuse reflection coefficient
  74   OpenGl_Vec4 Specular; //!< glossy  reflection coefficient
  75   OpenGl_Vec4 Emission; //!< material emission
  76   OpenGl_Vec4 Params;   //!< extra packed parameters
  77
  78   Standard_ShortReal  Shine()              const { return Params.x(); }
  79   Standard_ShortReal& ChangeShine()              { return Params.x(); }
  80
  81   Standard_ShortReal  Transparency()       const { return Params.y(); }
  82   Standard_ShortReal& ChangeTransparency()       { return Params.y(); }
  83
  84   //! Initialize material
  85   void Init (const OPENGL_SURF_PROP& theProps);
  86
  87   //! Returns packed (serialized) representation of material properties
  88   const OpenGl_Vec4* Packed() const { return reinterpret_cast<const OpenGl_Vec4*> (this); }
  89   static Standard_Integer NbOfVec4() { return 5; }
  90
  91 };
  92
  93 class OpenGl_RaytraceFilter;
  94 DEFINE_STANDARD_HANDLE (OpenGl_RaytraceFilter, OpenGl_RenderFilter)
  95
  96 //! Graphical ray-tracing filter.
  97 //! Filters out all raytracable structures.
  98 class OpenGl_RaytraceFilter : public OpenGl_RenderFilter
  99 {
 100 public:
 101
 102   //! Default constructor.
 103   OpenGl_RaytraceFilter() {}
 104
 105   //! Returns the previously set filter.
 106   const Handle(OpenGl_RenderFilter)& PrevRenderFilter()
 107   {
 108     return myPrevRenderFilter;
 109   }
 110
 111   //! Remembers the previously set filter.
 112   void SetPrevRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
 113   {
 114     myPrevRenderFilter = theFilter;
 115   }
 116
 117   //! Checks whether the element can be rendered or not.
 118   //! @param theElement [in] the element to check.
 119   //! @return True if element can be rendered.
 120   virtual Standard_Boolean CanRender (const OpenGl_Element* theElement);
 121
 122 private:
 123
 124   Handle(OpenGl_RenderFilter) myPrevRenderFilter;
 125
 126 public:
 127
 128   DEFINE_STANDARD_RTTI(OpenGl_RaytraceFilter, OpenGl_RenderFilter)
 129 };
 130
 131 class OpenGl_Workspace;
 132 DEFINE_STANDARD_HANDLE(OpenGl_Workspace,OpenGl_Window)
 133
 134 //! Represents window with GL context.
 135 //! Provides methods to render primitives and maintain GL state.
 136 class OpenGl_Workspace : public OpenGl_Window
 137 {
 138 public:
 139
 140   //! Main constructor - prepare GL context for specified window.
 141   Standard_EXPORT 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);
 146
 147   //! Destructor
 148   Standard_EXPORT virtual ~OpenGl_Workspace();
 149
 150   Standard_EXPORT void SetActiveView (const Handle(OpenGl_View)& theView,
 151                                       const Standard_Integer     theViewId);
 152
 153   const Handle(OpenGl_View)& ActiveView() const { return myView; }
 154
 155   Standard_Integer ActiveViewId() const { return myViewId; }
 156
 157   //! Redraw the window.
 158   Standard_EXPORT virtual void Redraw (const Graphic3d_CView& theCView);
 159
 160   Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer);
 161   Standard_EXPORT virtual void RedrawImmediate (const Graphic3d_CView& theCView);
 162
 163   //! Mark cached view content invalid (e.g. complete view redraw should be performed on next frame).
 164   void Invalidate() { myBackBufferRestored = Standard_False; }
 165
 166   //! Return true if view content cache has been invalidated.
 167   Standard_Boolean IsInvalidated() const { return !myBackBufferRestored; }
 168
 169   //! Special method to perform printing.
 170   //! System-specific and currently only Win platform implemented.
 171   Standard_Boolean Print (const Handle(OpenGl_PrinterContext)& thePrintContext,
 172                           const Graphic3d_CView& theCView,
 173                           const Aspect_Handle    theHPrintDC,
 174                           const Standard_Boolean theToShowBackground,
 175                           const Standard_CString theFileName,
 176                           const Aspect_PrintAlgo thePrintAlgorithm,
 177                           const Standard_Real    theScaleFactor);
 178
 179   const Handle(OpenGl_PrinterContext)& PrinterContext() const
 180   {
 181     return myPrintContext;
 182   }
 183
 184   void DisplayCallback (const Graphic3d_CView& theCView, int theReason);
 185
 186   Graphic3d_PtrFrameBuffer FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight);
 187   void FBORelease (Graphic3d_PtrFrameBuffer theFBOPtr);
 188   Standard_Boolean BufferDump (OpenGl_FrameBuffer*         theFBOPtr,
 189                                Image_PixMap&               theImage,
 190                                const Graphic3d_BufferType& theBufferType);
 191
 192   //! Setup Z-buffer usage flag (without affecting GL state!).
 193   //! Returns previously set flag.
 194   Standard_Boolean SetUseZBuffer (const Standard_Boolean theToUse)
 195   {
 196     const Standard_Boolean wasUsed = myUseZBuffer;
 197     myUseZBuffer = theToUse;
 198     return wasUsed;
 199   }
 200
 201   Standard_Boolean& UseZBuffer()    { return myUseZBuffer; }
 202   Standard_Boolean& UseDepthWrite() { return myUseDepthWrite; }
 203   Standard_Boolean& UseGLLight()    { return myUseGLLight; }
 204
 205   Standard_Integer AntiAliasingMode() const { return myAntiAliasingMode; }
 206
 207   //// RELATED TO STATUS ////
 208
 209   Standard_Integer   NamedStatus;
 210
 211   const TEL_COLOUR* HighlightColor;
 212
 213   const OpenGl_AspectLine*   SetAspectLine   (const OpenGl_AspectLine*   theAspect);
 214   const OpenGl_AspectFace*   SetAspectFace   (const OpenGl_AspectFace*   theAspect);
 215   const OpenGl_AspectMarker* SetAspectMarker (const OpenGl_AspectMarker* theAspect);
 216   const OpenGl_AspectText*   SetAspectText   (const OpenGl_AspectText*   theAspect);
 217
 218   void SetTextParam (const OpenGl_TextParam* theParam) { TextParam_set = theParam; }
 219
 220   //// THESE METHODS ARE EXPORTED AS THEY PROVIDE STATE INFO TO USERDRAW
 221   Standard_EXPORT const OpenGl_AspectLine*   AspectLine   (const Standard_Boolean theWithApply);
 222   Standard_EXPORT const OpenGl_AspectFace*   AspectFace   (const Standard_Boolean theWithApply);
 223   Standard_EXPORT const OpenGl_AspectMarker* AspectMarker (const Standard_Boolean theWithApply);
 224   Standard_EXPORT const OpenGl_AspectText*   AspectText   (const Standard_Boolean theWithApply);
 225   inline const OpenGl_TextParam* AspectTextParams() const
 226   {
 227     return TextParam_applied;
 228   }
 229
 230   //! Clear the applied aspect state.
 231   void ResetAppliedAspect();
 232
 233   Standard_EXPORT Handle(OpenGl_Texture) DisableTexture();
 234   Standard_EXPORT Handle(OpenGl_Texture) EnableTexture (const Handle(OpenGl_Texture)&          theTexture,
 235                                                         const Handle(Graphic3d_TextureParams)& theParams = NULL);
 236   const Handle(OpenGl_Texture)& ActiveTexture() const { return myTextureBound; }
 237
 238   //! Set filter for restricting rendering of particular elements.
 239   //! Filter can be applied for rendering passes used by recursive
 240   //! rendering algorithms for rendering elements of groups.
 241   //! @param theFilter [in] the filter instance.
 242   inline void SetRenderFilter (const Handle(OpenGl_RenderFilter)& theFilter)
 243   {
 244     myRenderFilter = theFilter;
 245   }
 246
 247   //! Get rendering filter.
 248   //! @return filter instance.
 249   inline const Handle(OpenGl_RenderFilter)& GetRenderFilter() const
 250   {
 251     return myRenderFilter;
 252   }
 253
 254   //! @return applied view matrix.
 255   inline const OpenGl_Matrix* ViewMatrix() const { return ViewMatrix_applied; }
 256
 257   //! @return applied model structure matrix.
 258   inline const OpenGl_Matrix* ModelMatrix() const { return StructureMatrix_applied; }
 259
 260   //! Sets and applies current polygon offset.
 261   void SetPolygonOffset (int theMode, Standard_ShortReal theFactor, Standard_ShortReal theUnits);
 262
 263   //! Returns currently applied polygon offset params.
 264   const TEL_POFFSET_PARAM& AppliedPolygonOffset() { return PolygonOffset_applied; }
 265
 266   //! @return true if clipping algorithm enabled
 267   inline Standard_Boolean IsCullingEnabled() const { return myIsCullingEnabled; }
 268
 269   //! Returns capping algorithm rendering filter.
 270   const Handle(OpenGl_CappingAlgoFilter)& DefaultCappingAlgoFilter() const
 271   {
 272     return myDefaultCappingAlgoFilter;
 273   }
 274
 275   //! Returns face aspect for none culling mode.
 276   const OpenGl_AspectFace& NoneCulling() const
 277   {
 278     return myNoneCulling;
 279   }
 280
 281   //! Returns face aspect for front face culling mode.
 282   const OpenGl_AspectFace& FrontCulling() const
 283   {
 284     return myFrontCulling;
 285   }
 286
 287 protected:
 288
 289   //! Copy content of Back buffer to the Front buffer
 290   void copyBackToFront();
 291
 292   //! Initialize blit quad.
 293   Standard_EXPORT OpenGl_VertexBuffer* initBlitQuad (const Standard_Boolean theToFlip);
 294
 295   //! Blit image from/to specified buffers.
 296   Standard_EXPORT bool blitBuffers (OpenGl_FrameBuffer*    theReadFbo,
 297                                     OpenGl_FrameBuffer*    theDrawFbo,
 298                                     const Standard_Boolean theToFlip = Standard_False);
 299
 300   Standard_EXPORT virtual Standard_Boolean Activate();
 301
 302   void redraw1 (const Graphic3d_CView&               theCView,
 303                 OpenGl_FrameBuffer*                  theReadDrawFbo,
 304                 const Graphic3d_Camera::Projection   theProjection);
 305
 306   //! Setup default FBO.
 307   void bindDefaultFbo (OpenGl_FrameBuffer* theCustomFbo = NULL);
 308
 309   //! Blend together views pair into stereo image.
 310   void drawStereoPair (const Graphic3d_CView& theCView);
 311
 312   //! Blit snapshot containing main scene (myMainSceneFbos or BackBuffer)
 313   //! into presentation buffer (myMainSceneFbos -> offscreen FBO or myMainSceneFbos -> BackBuffer or BackBuffer -> FrontBuffer),
 314   //! and redraw immediate structures on top.
 315   //!
 316   //! When scene caching is disabled (myTransientDrawToFront, no double buffer in window, etc.),
 317   //! the first step (blitting) will be skipped.
 318   //!
 319   //! @return false if immediate structures has been rendered directly into FrontBuffer and Buffer Swap should not be called.
 320   bool redrawImmediate (const Graphic3d_CView& theCView,
 321                         OpenGl_FrameBuffer*    theReadFbo,
 322                         const Graphic3d_Camera::Projection theProjection,
 323                         OpenGl_FrameBuffer*    theDrawFbo,
 324                         const Standard_Boolean theIsPartialUpdate = Standard_False);
 325
 326   void updateMaterial (const int theFlag);
 327
 328   void setTextureParams (Handle(OpenGl_Texture)&                theTexture,
 329                          const Handle(Graphic3d_TextureParams)& theParams);
 330
 331 protected: //! @name protected fields
 332
 333   //! Two framebuffers (left and right views) store cached main presentation
 334   //! of the view (without presentation of immediate layers).
 335   Handle(OpenGl_FrameBuffer) myMainSceneFbos[2];
 336   //! Additional buffers for immediate layer in stereo mode.
 337   Handle(OpenGl_FrameBuffer) myImmediateSceneFbos[2];
 338   //! Special flag which is invalidated when myMainSceneFbos can not be blitted for some reason (e.g. driver bugs).
 339   Standard_Boolean           myHasFboBlit;
 340
 341   //! Flag to draw result image upside-down
 342   Standard_Boolean           myToFlipOutput;
 343
 344   //! Vertices for full-screen quad rendering.
 345   OpenGl_VertexBuffer        myFullScreenQuad;
 346   OpenGl_VertexBuffer        myFullScreenQuadFlip;
 347
 348   Handle(OpenGl_PrinterContext) myPrintContext;
 349   Handle(OpenGl_View)           myView;
 350   Handle(OpenGl_LineAttributes) myLineAttribs;
 351   Standard_Integer       myViewId;
 352   Standard_Integer       myAntiAliasingMode;
 353   Standard_Boolean       myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
 354   Standard_Boolean       myBackBufferRestored;
 355   Standard_Boolean       myIsImmediateDrawn;     //!< flag indicates that immediate mode buffer contains some data
 356   Standard_Boolean       myUseZBuffer;
 357   Standard_Boolean       myUseDepthWrite;
 358   Standard_Boolean       myUseGLLight;
 359   Standard_Boolean       myIsCullingEnabled;     //!< frustum culling flag
 360
 361   unsigned int           myFrameCounter;         //!< redraw counter, for debugging
 362
 363   Handle(OpenGl_CappingAlgoFilter) myDefaultCappingAlgoFilter;
 364   OpenGl_AspectFace                myNoneCulling;
 365   OpenGl_AspectFace                myFrontCulling;
 366
 367 protected: //! @name fields related to status
 368
 369   Handle(OpenGl_RenderFilter) myRenderFilter;
 370   Handle(OpenGl_Texture) myTextureBound;    //!< currently bound texture (managed by OpenGl_AspectFace and OpenGl_View environment texture)
 371   const OpenGl_AspectLine *AspectLine_set, *AspectLine_applied;
 372   const OpenGl_AspectFace *AspectFace_set, *AspectFace_applied;
 373   const OpenGl_AspectMarker *AspectMarker_set, *AspectMarker_applied;
 374   const OpenGl_AspectText *AspectText_set, *AspectText_applied;
 375
 376   const OpenGl_TextParam *TextParam_set, *TextParam_applied;
 377
 378   const OpenGl_Matrix* ViewMatrix_applied;
 379   const OpenGl_Matrix* StructureMatrix_applied;
 380
 381   OpenGl_Material myMatFront;    //!< current front material state (cached to reduce GL context updates)
 382   OpenGl_Material myMatBack;     //!< current back  material state
 383   OpenGl_Material myMatTmp;      //!< temporary variable
 384   TelCullMode     myCullingMode; //!< back face culling mode, applied from face aspect
 385
 386   OpenGl_Matrix myModelViewMatrix; //!< Model matrix with applied structure transformations
 387
 388   TEL_POFFSET_PARAM PolygonOffset_applied; //!< Currently applied polygon offset.
 389
 390   OpenGl_AspectFace myAspectFaceHl; //!< Hiddenline aspect
 391
 392 public: //! @name type definition
 393
 394   DEFINE_STANDARD_RTTI(OpenGl_Workspace, OpenGl_Window)
 395   DEFINE_STANDARD_ALLOC
 396
 397 };
 398
 399 #endif // _OpenGl_Workspace_Header