src/OpenGl/OpenGl_GraphicDriver.hxx

   1 // Created on: 2011-10-20
   2 // Created by: Sergey ZERCHANINOV
   3 // Copyright (c) 2011-2014 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_GraphicDriver_HeaderFile
  17 #define _OpenGl_GraphicDriver_HeaderFile
  18
  19 #include <Graphic3d_GraphicDriver.hxx>
  20 #include <Handle_OpenGl_GraphicDriver.hxx>
  21 #include <OpenGl_Context.hxx>
  22 #include <OpenGl_PrinterContext.hxx>
  23
  24 #include <Standard_CString.hxx>
  25
  26 #include <Handle_TColStd_HArray1OfByte.hxx>
  27 #include <Handle_TColStd_HArray1OfReal.hxx>
  28 #include <Quantity_PlaneAngle.hxx>
  29 #include <Quantity_NameOfColor.hxx>
  30 #include <Handle_OpenGl_View.hxx>
  31 #include <Handle_OpenGl_Workspace.hxx>
  32
  33 #include <Aspect_Display.hxx>
  34 #include <Aspect_DisplayConnection.hxx>
  35 #include <Aspect_GradientFillMethod.hxx>
  36 #include <Aspect_FillMethod.hxx>
  37 #include <Aspect_CLayer2d.hxx>
  38 #include <Aspect_TypeOfTriedronPosition.hxx>
  39 #include <Aspect_TypeOfTriedronEcho.hxx>
  40 #include <Aspect_Handle.hxx>
  41 #include <Aspect_PrintAlgo.hxx>
  42 #include <gp_Ax2.hxx>
  43 #include <Graphic3d_CView.hxx>
  44 #include <Graphic3d_CStructure.hxx>
  45 #include <Graphic3d_TextPath.hxx>
  46 #include <Graphic3d_HorizontalTextAlignment.hxx>
  47 #include <Graphic3d_VerticalTextAlignment.hxx>
  48 #include <Graphic3d_CUserDraw.hxx>
  49 #include <Graphic3d_GraduatedTrihedron.hxx>
  50 #include <Graphic3d_TypeOfComposition.hxx>
  51 #include <Graphic3d_ExportFormat.hxx>
  52 #include <Graphic3d_SortType.hxx>
  53 #include <Graphic3d_PtrFrameBuffer.hxx>
  54 #include <Graphic3d_Array1OfVertex.hxx>
  55 #include <Graphic3d_Array2OfVertex.hxx>
  56 #include <Graphic3d_BufferType.hxx>
  57 #include <NCollection_DataMap.hxx>
  58
  59 class TColStd_Array1OfInteger;
  60 class TColStd_Array1OfReal;
  61 class TColStd_Array2OfReal;
  62 class TColStd_HArray1OfByte;
  63 class Graphic3d_Vector;
  64 class Quantity_Color;
  65 class Graphic3d_Vertex;
  66 class TCollection_ExtendedString;
  67 class Image_PixMap;
  68 class TColStd_HArray1OfReal;
  69 class Handle(OpenGl_Workspace);
  70 class OpenGl_Element;
  71 class OpenGl_Structure;
  72 class OpenGl_Text;
  73
  74 //! Tool class to implement consistent state counter
  75 //! for objects inside the same driver instance.
  76 class OpenGl_StateCounter
  77 {
  78 public:
  79
  80   OpenGl_StateCounter() : myCounter (0) { }
  81
  82   Standard_Size Increment() { return ++myCounter; }
  83
  84 private:
  85
  86   Standard_Size myCounter;
  87 };
  88
  89 //! This class defines an OpenGl graphic driver
  90 class OpenGl_GraphicDriver : public Graphic3d_GraphicDriver
  91 {
  92 public:
  93
  94   //! Constructor.
  95   //! @param theDisp connection to display, required on Linux but optional on other systems
  96   //! @param theToInitialize perform initialization of default OpenGL context on construction
  97   Standard_EXPORT OpenGl_GraphicDriver (const Handle(Aspect_DisplayConnection)& theDisp,
  98                                         const Standard_Boolean                  theToInitialize = Standard_True);
  99
 100   //! Destructor.
 101   Standard_EXPORT virtual ~OpenGl_GraphicDriver();
 102
 103   //! Release default context.
 104   Standard_EXPORT void ReleaseContext();
 105
 106   //! Perform initialization of default OpenGL context.
 107   Standard_EXPORT Standard_Boolean InitContext();
 108
 109 #if defined(HAVE_EGL) || defined(__ANDROID__)
 110   //! Initialize default OpenGL context using existing one.
 111   //! @param theEglDisplay EGL connection to the Display
 112   //! @param theEglContext EGL rendering context
 113   //! @param theEglConfig  EGL configuration
 114   Standard_EXPORT Standard_Boolean InitEglContext (Aspect_Display          theEglDisplay,
 115                                                    Aspect_RenderingContext theEglContext,
 116                                                    void*                   theEglConfig);
 117 #endif
 118
 119   Standard_EXPORT Standard_Integer InquireLightLimit ();
 120   Standard_EXPORT Standard_Integer InquireViewLimit ();
 121
 122 public: // Methods for graphical structures
 123
 124   Standard_EXPORT void DisplayStructure (const Graphic3d_CView&             theCView,
 125                                          const Handle(Graphic3d_Structure)& theStructure,
 126                                          const Standard_Integer             thePriority);
 127   Standard_EXPORT void EraseStructure (const Graphic3d_CView&             theCView,
 128                                        const Handle(Graphic3d_Structure)& theStructure);
 129   Standard_EXPORT void RemoveStructure (Handle(Graphic3d_CStructure)& theCStructure);
 130   Standard_EXPORT Handle(Graphic3d_CStructure) Structure (const Handle(Graphic3d_StructureManager)& theManager);
 131
 132   Standard_EXPORT Standard_Boolean SetImmediateModeDrawToFront (const Graphic3d_CView& theCView,
 133                                                                 const Standard_Boolean theDrawToFrontBuffer);
 134   Standard_EXPORT void DisplayImmediateStructure (const Graphic3d_CView&             theCView,
 135                                                   const Handle(Graphic3d_Structure)& theStructure);
 136   Standard_EXPORT void EraseImmediateStructure (const Graphic3d_CView&      theCView,
 137                                                 const Graphic3d_CStructure& theCStructure);
 138
 139 public:
 140
 141   Standard_EXPORT void ActivateView (const Graphic3d_CView& ACView);
 142   Standard_EXPORT void AntiAliasing (const Graphic3d_CView& ACView, const Standard_Boolean AFlag);
 143   Standard_EXPORT void Background (const Graphic3d_CView& ACView);
 144   Standard_EXPORT void GradientBackground (const Graphic3d_CView& ACView, const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod FillStyle);
 145   Standard_EXPORT void BackgroundImage (const Standard_CString FileName, const Graphic3d_CView& ACView, const Aspect_FillMethod FillStyle);
 146   Standard_EXPORT void SetBgImageStyle (const Graphic3d_CView& ACView, const Aspect_FillMethod FillStyle);
 147   Standard_EXPORT void SetBgGradientStyle (const Graphic3d_CView& ACView, const Aspect_GradientFillMethod FillStyle);
 148   Standard_EXPORT void ClipLimit (const Graphic3d_CView& ACView, const Standard_Boolean AWait);
 149   Standard_EXPORT void DeactivateView (const Graphic3d_CView& ACView);
 150   Standard_EXPORT void DepthCueing (const Graphic3d_CView& ACView, const Standard_Boolean AFlag);
 151   Standard_EXPORT void RatioWindow (const Graphic3d_CView& ACView);
 152   Standard_EXPORT void Redraw (const Graphic3d_CView& theCView,
 153                                const Aspect_CLayer2d& theCUnderLayer,
 154                                const Aspect_CLayer2d& theCOverLayer,
 155                                const Standard_Integer theX = 0,
 156                                const Standard_Integer theY = 0,
 157                                const Standard_Integer theWidth  = 0,
 158                                const Standard_Integer theHeight = 0);
 159   Standard_EXPORT void RedrawImmediate (const Graphic3d_CView& theCView,
 160                                         const Aspect_CLayer2d& theCUnderLayer,
 161                                         const Aspect_CLayer2d& theCOverLayer);
 162   Standard_EXPORT void Invalidate (const Graphic3d_CView& theCView);
 163   Standard_EXPORT void RemoveView (const Graphic3d_CView& ACView);
 164   Standard_EXPORT void SetLight (const Graphic3d_CView& ACView);
 165   Standard_EXPORT void SetClipPlanes (const Graphic3d_CView& theCView);
 166   Standard_EXPORT void SetCamera (const Graphic3d_CView& theCView);
 167   Standard_EXPORT void SetVisualisation (const Graphic3d_CView& ACView);
 168   Standard_EXPORT Standard_Boolean View (Graphic3d_CView& ACView);
 169   Standard_EXPORT void Environment (const Graphic3d_CView& ACView);
 170   Standard_EXPORT void ZBufferTriedronSetup (const Graphic3d_CView& theCView,
 171                                              const Quantity_NameOfColor XColor = Quantity_NOC_RED,
 172                                              const Quantity_NameOfColor YColor = Quantity_NOC_GREEN,
 173                                              const Quantity_NameOfColor ZColor = Quantity_NOC_BLUE1,
 174                                              const Standard_Real SizeRatio = 0.8,
 175                                              const Standard_Real AxisDiametr = 0.05,
 176                                              const Standard_Integer NbFacettes = 12);
 177   Standard_EXPORT void TriedronDisplay (const Graphic3d_CView& ACView, const Aspect_TypeOfTriedronPosition APosition = Aspect_TOTP_CENTER, const Quantity_NameOfColor AColor = Quantity_NOC_WHITE, const Standard_Real AScale = 0.02, const Standard_Boolean AsWireframe = Standard_True);
 178   Standard_EXPORT void TriedronErase (const Graphic3d_CView& ACView);
 179   Standard_EXPORT void TriedronEcho (const Graphic3d_CView& ACView, const Aspect_TypeOfTriedronEcho AType = Aspect_TOTE_NONE);
 180
 181   //! Displays Graduated trihedron
 182   //! @param theView [in] the graphic view
 183   //! @param theCubic [in] Graduated Trihedon parameters.
 184   //! @sa OpenGl_GraduatedTrihedron
 185   //! @sa Graphic3d_GraduatedTrihedron
 186   Standard_EXPORT void GraduatedTrihedronDisplay (const Graphic3d_CView& theView, const Graphic3d_GraduatedTrihedron& theCubic);
 187
 188   //! Erases Graduated Trihedron from the view.
 189   //! theView [in] graphic view
 190   //! @sa OpenGl_GraduatedTrihedron
 191   Standard_EXPORT void GraduatedTrihedronErase (const Graphic3d_CView& theView);
 192
 193   //! Sets minimum and maximum points of scene bounding box for Graduated Trihedron
 194   //! stored in graphic view object.
 195   //! @param theView [in] current graphic view
 196   //! @param theMin [in] the minimum point of scene.
 197   //! @param theMax [in] the maximum point of scene.
 198   //! @sa OpenGl_GraduatedTrihedron
 199   Standard_EXPORT void GraduatedTrihedronMinMaxValues (const Graphic3d_CView& theView,
 200                                                        const Graphic3d_Vec3 theMin, const Graphic3d_Vec3 theMax);
 201
 202   Standard_EXPORT void Layer (Aspect_CLayer2d& ACLayer);
 203   Standard_EXPORT void RemoveLayer (const Aspect_CLayer2d& ACLayer);
 204   Standard_EXPORT void BeginLayer (const Aspect_CLayer2d& ACLayer);
 205   Standard_EXPORT void BeginPolygon2d ();
 206   Standard_EXPORT void BeginPolyline2d ();
 207   Standard_EXPORT void ClearLayer (const Aspect_CLayer2d& ACLayer);
 208   Standard_EXPORT void Draw (const Standard_ShortReal X,const Standard_ShortReal Y);
 209   Standard_EXPORT void Edge (const Standard_ShortReal X,const Standard_ShortReal Y);
 210   Standard_EXPORT void EndLayer ();
 211   Standard_EXPORT void EndPolygon2d ();
 212   Standard_EXPORT void EndPolyline2d ();
 213   Standard_EXPORT void Move (const Standard_ShortReal X,const Standard_ShortReal Y);
 214   Standard_EXPORT void Rectangle (const Standard_ShortReal X,const Standard_ShortReal Y,const Standard_ShortReal Width,const Standard_ShortReal Height);
 215   Standard_EXPORT void SetColor (const Standard_ShortReal R,const Standard_ShortReal G,const Standard_ShortReal B);
 216   Standard_EXPORT void SetTransparency (const Standard_ShortReal ATransparency);
 217   Standard_EXPORT void UnsetTransparency ();
 218   Standard_EXPORT void SetLineAttributes (const Standard_Integer Type,const Standard_ShortReal Width);
 219
 220   //! Set text attributes for under-/overlayer.
 221   //! @param theFontName the name of the font to be used
 222   //! @param theType     the display type of the text
 223   //! theR theG theB values define the color of decal or subtitle background
 224   //! To set the color of the text you can use the SetColor method.
 225   Standard_EXPORT void SetTextAttributes (const Standard_CString   theFontName,
 226                                           const Standard_Integer   theType,
 227                                           const Standard_ShortReal theR,
 228                                           const Standard_ShortReal theG,
 229                                           const Standard_ShortReal theB);
 230   Standard_EXPORT void Text (const Standard_CString AText,const Standard_ShortReal X,const Standard_ShortReal Y,const Standard_ShortReal AHeight);
 231   Standard_EXPORT void TextSize (const Standard_CString AText,const Standard_ShortReal AHeight,Standard_ShortReal& AWidth,Standard_ShortReal& AnAscent,Standard_ShortReal& ADescent) const;
 232   Standard_EXPORT void SetBackFacingModel (const Graphic3d_CView& aView);
 233
 234   //! Print the contents of all layers of the view to the printer.
 235   //! @param thePrinterDC        pass the PrinterDeviceContext (HDC)
 236   //! @param theToShowBackground when set to FALSE then print the view without background color (background is white) else set to TRUE for printing with current background color
 237   //! @param theFileName         if != NULL, then the view will be printed to a file
 238   //! @param thePrintAlgorithm   select print algorithm: stretch, tile
 239   //! @param theScaleFactor      scaling coefficient, used internally to scale the printings accordingly to the scale factor selected in the printer properties dialog
 240   //! @return Standard_True if the data is passed to the printer, otherwise Standard_False if the print operation failed due to the printer errors,
 241   //! or lack of system memory. This might be related to insufficient memory or some internal errors.
 242   //! All this errors are indicated by the message boxes (on level of OpenGl_GraphicDriver).
 243   //! Warning: This function can reuse FBO assigned to the view, please take it into account if you use it for your purposes.
 244   Standard_EXPORT Standard_Boolean Print (const Graphic3d_CView& theCView,
 245                                           const Aspect_CLayer2d& theCUnderLayer,
 246                                           const Aspect_CLayer2d& theCOverLayer,
 247                                           const Aspect_Handle    thePrinterDC,
 248                                           const Standard_Boolean theToShowBackground,
 249                                           const Standard_CString theFileName,
 250                                           const Aspect_PrintAlgo thePrintAlgorithm = Aspect_PA_STRETCH,
 251                                           const Standard_Real    theScaleFactor = 1.0) const;
 252
 253   //! Reads depths of shown pixels of the given rectangle (glReadPixels with GL_DEPTH_COMPONENT)
 254   Standard_EXPORT void ReadDepths (const Graphic3d_CView& view,const Standard_Integer x,const Standard_Integer y,const Standard_Integer width,const Standard_Integer height,const Standard_Address buffer) const;
 255
 256   //! Generate offscreen FBO (needs OpenGL2+ hardware).
 257   //! If not supported on hardware returns NULL.
 258   Standard_EXPORT Graphic3d_PtrFrameBuffer FBOCreate (const Graphic3d_CView& view, const Standard_Integer width, const Standard_Integer height);
 259
 260   //! Remove offscreen FBO
 261   Standard_EXPORT void FBORelease (const Graphic3d_CView& view, Graphic3d_PtrFrameBuffer& fboPtr);
 262
 263   //! Dump active rendering buffer into specified memory buffer.
 264   Standard_EXPORT Standard_Boolean BufferDump (const Graphic3d_CView&      theCView,
 265                                                Image_PixMap&               theImage,
 266                                                const Graphic3d_BufferType& theBufferType);
 267
 268   Standard_EXPORT void SetGLLightEnabled (const Graphic3d_CView& view,const Standard_Boolean isEnabled) const;
 269
 270   Standard_EXPORT Standard_Boolean IsGLLightEnabled (const Graphic3d_CView& view) const;
 271
 272   Standard_EXPORT Standard_Integer InquirePlaneLimit();
 273
 274   Standard_EXPORT Standard_ShortReal DefaultTextHeight() const;
 275
 276   Standard_EXPORT void FBOGetDimensions(const Graphic3d_CView& view,const Graphic3d_PtrFrameBuffer fboPtr,Standard_Integer& width,Standard_Integer& height,Standard_Integer& widthMax,Standard_Integer& heightMax);
 277
 278   Standard_EXPORT void FBOChangeViewport(const Graphic3d_CView& view,Graphic3d_PtrFrameBuffer& fboPtr,const Standard_Integer width,const Standard_Integer height);
 279
 280   Standard_EXPORT Standard_Boolean Export(const Standard_CString theFileName,const Graphic3d_ExportFormat theFormat,const Graphic3d_SortType theSortType,const Standard_Integer theWidth,const Standard_Integer theHeight,const Graphic3d_CView& theView,const Aspect_CLayer2d& theLayerUnder,const Aspect_CLayer2d& theLayerOver,const Standard_Real thePrecision = 0.005,const Standard_Address theProgressBarFunc = NULL,const Standard_Address theProgressObject = NULL);
 281
 282   //! Add a new top-level z layer with ID theLayerId for the view. Z layers allow drawing structures in higher layers in foreground of structures in lower layers.
 283   //! To add a structure to desired layer on display it is necessary to set the layer index for the structure.
 284   Standard_EXPORT void AddZLayer (const Graphic3d_CView&   theCView,
 285                                   const Graphic3d_ZLayerId theLayerId);
 286
 287   //! Remove Z layer from the specified view.
 288   //! All structures displayed at the moment in layer will be displayed in default layer (the bottom-level z layer).
 289   //! To unset layer index from associated structures use method UnsetZLayer (...).
 290   Standard_EXPORT void RemoveZLayer (const Graphic3d_CView&   theCView,
 291                                      const Graphic3d_ZLayerId theLayerId);
 292
 293   //! Unset Z layer ID for all structures.
 294   //! The structure indexes will be set to default layer (the bottom-level z layer with ID = 0).
 295   Standard_EXPORT void UnsetZLayer (const Graphic3d_ZLayerId theLayerId);
 296
 297   //! Change Z layer of a structure already presented in view.
 298   //! It is recommended to update z layer of already displayed structures with this method before setting new z layer index to the structure.
 299   //! This is usually done by viewer manager.
 300   Standard_EXPORT void ChangeZLayer (const Graphic3d_CStructure& theCStructure,
 301                                      const Graphic3d_CView&      theCView,
 302                                      const Graphic3d_ZLayerId    theNewLayerId);
 303
 304   //! Sets the settings for a single Z layer of specified view.
 305   Standard_EXPORT void SetZLayerSettings (const Graphic3d_CView&          theCView,
 306                                           const Graphic3d_ZLayerId        theLayerId,
 307                                           const Graphic3d_ZLayerSettings& theSettings);
 308
 309   //! Changes priority of a structure within its Z layer for the specified view.
 310   Standard_EXPORT void ChangePriority (const Graphic3d_CStructure& theCStructure,
 311                                        const Graphic3d_CView& theCView,
 312                                        const Standard_Integer theNewPriority);
 313
 314 public:
 315
 316   //! @return the visualization options
 317   inline const OpenGl_Caps& Options() const
 318   {
 319     return *myCaps.operator->();
 320   }
 321
 322   //! @return the visualization options
 323   inline OpenGl_Caps& ChangeOptions()
 324   {
 325     return *myCaps.operator->();
 326   }
 327
 328   //! VBO usage can be forbidden by this method even if it is supported by GL driver.
 329   //! Notice that disabling of VBO will cause rendering performance degradation.
 330   //! Warning! This method should be called only before any primitives are displayed in GL scene!
 331   Standard_EXPORT void EnableVBO (const Standard_Boolean theToTurnOn);
 332
 333   //! Returns information about GPU memory usage.
 334   //! Please read OpenGl_Context::MemoryInfo() for more description.
 335   Standard_EXPORT Standard_Boolean MemoryInfo (Standard_Size&           theFreeBytes,
 336                                                TCollection_AsciiString& theInfo) const;
 337
 338   //! UserDraw function prototype
 339   typedef OpenGl_Element* (*OpenGl_UserDrawCallback_t )(const CALL_DEF_USERDRAW* );
 340
 341   //! Method to setup UserDraw callback
 342   Standard_EXPORT OpenGl_UserDrawCallback_t& UserDrawCallback();
 343
 344 public:
 345
 346   //! Method to retrieve valid GL context.
 347   //! Could return NULL-handle if no window created by this driver.
 348   Standard_EXPORT const Handle(OpenGl_Context)& GetSharedContext() const;
 349
 350   //! Marks BVH tree for given priority list as dirty and
 351   //! marks primitive set for rebuild.
 352   Standard_EXPORT void InvalidateBVHData (Graphic3d_CView& theCView, const Standard_Integer theLayerId);
 353
 354 #if defined(HAVE_EGL) || defined(__ANDROID__)
 355   Aspect_Display          getRawGlDisplay() const { return myEglDisplay; }
 356   Aspect_RenderingContext getRawGlContext() const { return myEglContext;  }
 357   void*                   getRawGlConfig()  const { return myEglConfig; }
 358 #endif
 359
 360 public:
 361
 362   DEFINE_STANDARD_RTTI(OpenGl_GraphicDriver, Graphic3d_GraphicDriver)
 363
 364 private:
 365
 366   Standard_Boolean        myIsOwnContext; //!< indicates that shared context has been created within OpenGl_GraphicDriver
 367 #if defined(HAVE_EGL) || defined(__ANDROID__)
 368   Aspect_Display          myEglDisplay;   //!< EGL connection to the Display : EGLDisplay
 369   Aspect_RenderingContext myEglContext;   //!< EGL rendering context         : EGLContext
 370   void*                   myEglConfig;    //!< EGL configuration             : EGLConfig
 371 #endif
 372
 373   Handle(OpenGl_Caps)                                             myCaps;
 374   NCollection_Map<Handle(OpenGl_View)>                            myMapOfView;
 375   NCollection_Map<Handle(OpenGl_Workspace)>                       myMapOfWS;
 376   NCollection_DataMap<Standard_Integer, OpenGl_Structure*>        myMapOfStructure;
 377   mutable Handle(OpenGl_PrinterContext)                           myPrintContext;
 378   OpenGl_UserDrawCallback_t                                       myUserDrawCallback;
 379   OpenGl_Text*                                                    myTempText;         //!< variable for compatibility (drawing text in layers)
 380
 381 public:
 382
 383   //! State counter for OpenGl structures.
 384   OpenGl_StateCounter* GetStateCounter() const { return &myStateCounter; }
 385
 386   //! Returns unique ID for primitive arrays.
 387   const Standard_Size GetNextPrimitiveArrayUID() const { return myUIDGenerator.Increment(); }
 388
 389 private:
 390
 391   mutable OpenGl_StateCounter myStateCounter; //!< State counter for OpenGl structures.
 392   mutable OpenGl_StateCounter myUIDGenerator; //!< Unique ID counter for primitive arrays.
 393
 394 };
 395
 396 #endif //_OpenGl_GraphicDriver_HeaderFile