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