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