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
  21 #include <Aspect_Display.hxx>
  22 #include <Aspect_DisplayConnection.hxx>
  23 #include <Aspect_GradientFillMethod.hxx>
  24 #include <Aspect_FillMethod.hxx>
  25 #include <Aspect_TypeOfTriedronPosition.hxx>
  26 #include <Aspect_Handle.hxx>
  27 #include <Aspect_RenderingContext.hxx>
  28 #include <gp_Ax2.hxx>
  29 #include <Graphic3d_CView.hxx>
  30 #include <Graphic3d_CStructure.hxx>
  31 #include <Graphic3d_TextPath.hxx>
  32 #include <Graphic3d_HorizontalTextAlignment.hxx>
  33 #include <Graphic3d_VerticalTextAlignment.hxx>
  34 #include <Graphic3d_GraduatedTrihedron.hxx>
  35 #include <Graphic3d_TypeOfComposition.hxx>
  36 #include <Graphic3d_ExportFormat.hxx>
  37 #include <Graphic3d_SortType.hxx>
  38 #include <Graphic3d_BufferType.hxx>
  39 #include <NCollection_DataMap.hxx>
  40 #include <OpenGl_Context.hxx>
  41 #include <OpenGl_MapOfZLayerSettings.hxx>
  42 #include <Quantity_PlaneAngle.hxx>
  43 #include <Quantity_NameOfColor.hxx>
  44 #include <Standard_CString.hxx>
  45 #include <TColStd_Array1OfInteger.hxx>
  46 #include <TColStd_Array2OfReal.hxx>
  47 #include <TColStd_HArray1OfByte.hxx>
  48 #include <TColStd_HArray1OfReal.hxx>
  49 #include <TColStd_MapOfInteger.hxx>
  50
  51 class Aspect_Window;
  52 class Graphic3d_Vector;
  53 class Quantity_Color;
  54 class Graphic3d_Vertex;
  55 class TCollection_ExtendedString;
  56 class Image_PixMap;
  57 class OpenGl_Element;
  58 class OpenGl_Structure;
  59 class OpenGl_Text;
  60 class OpenGl_View;
  61 class OpenGl_Window;
  62
  63 //! Tool class to implement consistent state counter
  64 //! for objects inside the same driver instance.
  65 class OpenGl_StateCounter
  66 {
  67 public:
  68
  69   OpenGl_StateCounter() : myCounter (0) { }
  70
  71   Standard_Size Increment() { return ++myCounter; }
  72
  73 private:
  74
  75   Standard_Size myCounter;
  76 };
  77
  78 class OpenGl_GraphicDriver;
  79
  80 DEFINE_STANDARD_HANDLE(OpenGl_GraphicDriver,Graphic3d_GraphicDriver)
  81
  82 //! This class defines an OpenGl graphic driver
  83 class OpenGl_GraphicDriver : public Graphic3d_GraphicDriver
  84 {
  85 public:
  86
  87   //! Constructor.
  88   //! @param theDisp connection to display, required on Linux but optional on other systems
  89   //! @param theToInitialize perform initialization of default OpenGL context on construction
  90   Standard_EXPORT OpenGl_GraphicDriver (const Handle(Aspect_DisplayConnection)& theDisp,
  91                                         const Standard_Boolean                  theToInitialize = Standard_True);
  92
  93   //! Destructor.
  94   Standard_EXPORT virtual ~OpenGl_GraphicDriver();
  95
  96   //! Release default context.
  97   Standard_EXPORT void ReleaseContext();
  98
  99   //! Perform initialization of default OpenGL context.
 100   Standard_EXPORT Standard_Boolean InitContext();
 101
 102 #if defined(HAVE_EGL) || defined(HAVE_GLES2) || defined(OCCT_UWP) || defined(__ANDROID__) || defined(__QNX__)
 103   //! Initialize default OpenGL context using existing one.
 104   //! @param theEglDisplay EGL connection to the Display
 105   //! @param theEglContext EGL rendering context
 106   //! @param theEglConfig  EGL configuration
 107   Standard_EXPORT Standard_Boolean InitEglContext (Aspect_Display          theEglDisplay,
 108                                                    Aspect_RenderingContext theEglContext,
 109                                                    void*                   theEglConfig);
 110 #endif
 111
 112   //! Request limit of graphic resource of specific type.
 113   Standard_EXPORT virtual Standard_Integer InquireLimit (const Graphic3d_TypeOfLimit theType) const Standard_OVERRIDE;
 114
 115 public:
 116
 117   Standard_EXPORT virtual Handle(Graphic3d_CStructure) CreateStructure (const Handle(Graphic3d_StructureManager)& theManager) Standard_OVERRIDE;
 118
 119   Standard_EXPORT virtual void RemoveStructure (Handle(Graphic3d_CStructure)& theCStructure) Standard_OVERRIDE;
 120
 121   Standard_EXPORT virtual Handle(Graphic3d_CView) CreateView (const Handle(Graphic3d_StructureManager)& theMgr) Standard_OVERRIDE;
 122
 123   Standard_EXPORT virtual void RemoveView (const Handle(Graphic3d_CView)& theView) Standard_OVERRIDE;
 124
 125   Standard_EXPORT virtual Handle(OpenGl_Window) CreateRenderWindow (const Handle(Aspect_Window)& theWindow, const Aspect_RenderingContext theContext);
 126
 127 public:
 128
 129   Standard_EXPORT void TextSize (const Handle(Graphic3d_CView)& theView,
 130                                  const Standard_CString         theText,
 131                                  const Standard_ShortReal       theHeight,
 132                                  Standard_ShortReal&            theWidth,
 133                                  Standard_ShortReal&            theAscent,
 134                                  Standard_ShortReal&            theDescent) const Standard_OVERRIDE;
 135
 136   Standard_EXPORT Standard_ShortReal DefaultTextHeight() const Standard_OVERRIDE;
 137
 138   Standard_EXPORT Standard_Boolean ViewExists (const Handle(Aspect_Window)& theWindow, Handle(Graphic3d_CView)& theView) Standard_OVERRIDE;
 139
 140 public:
 141
 142   //! Adds a new top-level z layer with ID theLayerId for all views. Z layers allow drawing structures in higher layers
 143   //! in foreground of structures in lower layers. To add a structure to desired layer on display it is necessary to
 144   //! set the layer index for the structure. The passed theLayerId should be not less than 0 (reserved for default layers).
 145   Standard_EXPORT void AddZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
 146
 147   //! Removes Z layer. All structures displayed at the moment in layer will be displayed in
 148   //! default layer (the bottom-level z layer). By default, there are always default
 149   //! bottom-level layer that can't be removed.  The passed theLayerId should be not less than 0
 150   //! (reserved for default layers that can not be removed).
 151   Standard_EXPORT void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
 152
 153   //! Returns list of Z layers defined for the graphical driver.
 154   Standard_EXPORT void ZLayers (TColStd_SequenceOfInteger& theLayerSeq) const Standard_OVERRIDE;
 155
 156   //! Sets the settings for a single Z layer.
 157   Standard_EXPORT void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings& theSettings) Standard_OVERRIDE;
 158
 159   //! Returns the settings of a single Z layer.
 160   Standard_EXPORT virtual const Graphic3d_ZLayerSettings& ZLayerSettings (const Graphic3d_ZLayerId theLayerId) const Standard_OVERRIDE;
 161
 162 public:
 163
 164   //! @return the visualization options
 165   inline const OpenGl_Caps& Options() const
 166   {
 167     return *myCaps.operator->();
 168   }
 169
 170   //! @return the visualization options
 171   inline OpenGl_Caps& ChangeOptions()
 172   {
 173     return *myCaps.operator->();
 174   }
 175
 176   //! Specify swap buffer behavior.
 177   Standard_EXPORT void SetBuffersNoSwap (const Standard_Boolean theIsNoSwap);
 178
 179   //! VBO usage can be forbidden by this method even if it is supported by GL driver.
 180   //! Notice that disabling of VBO will cause rendering performance degradation.
 181   //! Warning! This method should be called only before any primitives are displayed in GL scene!
 182   Standard_EXPORT void EnableVBO (const Standard_Boolean theToTurnOn) Standard_OVERRIDE;
 183
 184   //! Returns information about GPU memory usage.
 185   //! Please read OpenGl_Context::MemoryInfo() for more description.
 186   Standard_EXPORT Standard_Boolean MemoryInfo (Standard_Size&           theFreeBytes,
 187                                                TCollection_AsciiString& theInfo) const Standard_OVERRIDE;
 188
 189 public:
 190
 191   //! Method to retrieve valid GL context.
 192   //! Could return NULL-handle if no window created by this driver.
 193   Standard_EXPORT const Handle(OpenGl_Context)& GetSharedContext() const;
 194
 195 #if defined(HAVE_EGL) || defined(HAVE_GLES2) || defined(OCCT_UWP) || defined(__ANDROID__) || defined(__QNX__)
 196   Aspect_Display          getRawGlDisplay() const { return myEglDisplay; }
 197   Aspect_RenderingContext getRawGlContext() const { return myEglContext;  }
 198   void*                   getRawGlConfig()  const { return myEglConfig; }
 199 #endif
 200
 201   //! Insert index layer at proper position.
 202   Standard_EXPORT void addZLayerIndex (const Graphic3d_ZLayerId theLayerId);
 203
 204 public:
 205
 206   DEFINE_STANDARD_RTTIEXT(OpenGl_GraphicDriver,Graphic3d_GraphicDriver)
 207
 208 protected:
 209
 210   Standard_Boolean        myIsOwnContext; //!< indicates that shared context has been created within OpenGl_GraphicDriver
 211 #if defined(HAVE_EGL) || defined(HAVE_GLES2) || defined(OCCT_UWP) || defined(__ANDROID__) || defined(__QNX__)
 212   Aspect_Display          myEglDisplay;   //!< EGL connection to the Display : EGLDisplay
 213   Aspect_RenderingContext myEglContext;   //!< EGL rendering context         : EGLContext
 214   void*                   myEglConfig;    //!< EGL configuration             : EGLConfig
 215 #endif
 216
 217   Handle(OpenGl_Caps)                                             myCaps;
 218   NCollection_Map<Handle(OpenGl_View)>                            myMapOfView;
 219   NCollection_DataMap<Standard_Integer, OpenGl_Structure*>        myMapOfStructure;
 220
 221 public:
 222
 223   TColStd_MapOfInteger       myLayerIds;
 224   TColStd_SequenceOfInteger  myLayerSeq;
 225   OpenGl_MapOfZLayerSettings myMapOfZLayerSettings;
 226
 227 public:
 228
 229   //! State counter for OpenGl structures.
 230   OpenGl_StateCounter* GetStateCounter() const { return &myStateCounter; }
 231
 232   //! Returns unique ID for primitive arrays.
 233   Standard_Size GetNextPrimitiveArrayUID() const { return myUIDGenerator.Increment(); }
 234
 235 protected:
 236
 237   mutable OpenGl_StateCounter myStateCounter; //!< State counter for OpenGl structures.
 238   mutable OpenGl_StateCounter myUIDGenerator; //!< Unique ID counter for primitive arrays.
 239
 240 };
 241
 242 #endif //_OpenGl_GraphicDriver_HeaderFile