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