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