1 // Created on: 2011-10-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _OpenGl_GraphicDriver_HeaderFile
17 #define _OpenGl_GraphicDriver_HeaderFile
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>
25 #include <Standard_CString.hxx>
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>
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>
44 #include <Graphic3d_CView.hxx>
45 #include <Graphic3d_CStructure.hxx>
46 #include <Graphic3d_CPick.hxx>
47 #include <Graphic3d_TextPath.hxx>
48 #include <Graphic3d_HorizontalTextAlignment.hxx>
49 #include <Graphic3d_VerticalTextAlignment.hxx>
50 #include <Graphic3d_CUserDraw.hxx>
51 #include <Graphic3d_CGraduatedTrihedron.hxx>
52 #include <Graphic3d_TypeOfComposition.hxx>
53 #include <Graphic3d_ExportFormat.hxx>
54 #include <Graphic3d_SortType.hxx>
55 #include <Graphic3d_PtrFrameBuffer.hxx>
56 #include <Graphic3d_Array1OfVertex.hxx>
57 #include <Graphic3d_Array2OfVertex.hxx>
58 #include <Graphic3d_BufferType.hxx>
59 #include <NCollection_DataMap.hxx>
61 class TColStd_Array1OfInteger;
62 class TColStd_Array1OfReal;
63 class TColStd_Array2OfReal;
64 class TColStd_HArray1OfByte;
65 class Graphic3d_Vector;
67 class Graphic3d_Vertex;
68 class Aspect_Array1OfEdge;
69 class TCollection_ExtendedString;
71 class TColStd_HArray1OfReal;
72 class Handle(OpenGl_Workspace);
74 class OpenGl_Structure;
77 //! Tool class to implement consistent state counter
78 //! for objects inside the same driver instance.
79 class OpenGl_StateCounter
83 OpenGl_StateCounter() : myCounter (0) { }
85 Standard_Size Increment() { return ++myCounter; }
89 Standard_Size myCounter;
92 //! This class defines an OpenGl graphic driver
93 class OpenGl_GraphicDriver : public Graphic3d_GraphicDriver
98 Standard_EXPORT OpenGl_GraphicDriver (const Handle(Aspect_DisplayConnection)& theDisplayConnection);
101 Standard_EXPORT OpenGl_GraphicDriver (const Standard_CString theShrName = "TKOpenGl");
102 Standard_EXPORT Standard_Boolean Begin (const Handle(Aspect_DisplayConnection)& theDisplayConnection);
103 Standard_EXPORT void End ();
105 Standard_EXPORT Standard_Integer InquireLightLimit ();
106 Standard_EXPORT Standard_Integer InquireViewLimit ();
108 public: // Methods for graphical structures
110 Standard_EXPORT void DisplayStructure (const Graphic3d_CView& theCView,
111 Graphic3d_CStructure& theCStructure,
112 const Standard_Integer thePriority);
113 Standard_EXPORT void EraseStructure (const Graphic3d_CView& theCView,
114 Graphic3d_CStructure& theCStructure);
115 Standard_EXPORT void RemoveStructure (Handle(Graphic3d_CStructure)& theCStructure);
116 Standard_EXPORT Handle(Graphic3d_CStructure) Structure (const Handle(Graphic3d_StructureManager)& theManager);
118 Standard_EXPORT Standard_Boolean SetImmediateModeDrawToFront (const Graphic3d_CView& theCView,
119 const Standard_Boolean theDrawToFrontBuffer);
120 Standard_EXPORT void DisplayImmediateStructure (const Graphic3d_CView& theCView,
121 const Graphic3d_CStructure& theCStructure);
122 Standard_EXPORT void EraseImmediateStructure (const Graphic3d_CView& theCView,
123 const Graphic3d_CStructure& theCStructure);
127 Standard_EXPORT void ActivateView (const Graphic3d_CView& ACView);
128 Standard_EXPORT void AntiAliasing (const Graphic3d_CView& ACView, const Standard_Boolean AFlag);
129 Standard_EXPORT void Background (const Graphic3d_CView& ACView);
130 Standard_EXPORT void GradientBackground (const Graphic3d_CView& ACView, const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod FillStyle);
131 Standard_EXPORT void BackgroundImage (const Standard_CString FileName, const Graphic3d_CView& ACView, const Aspect_FillMethod FillStyle);
132 Standard_EXPORT void SetBgImageStyle (const Graphic3d_CView& ACView, const Aspect_FillMethod FillStyle);
133 Standard_EXPORT void SetBgGradientStyle (const Graphic3d_CView& ACView, const Aspect_GradientFillMethod FillStyle);
134 Standard_EXPORT void ClipLimit (const Graphic3d_CView& ACView, const Standard_Boolean AWait);
135 Standard_EXPORT void DeactivateView (const Graphic3d_CView& ACView);
136 Standard_EXPORT void DepthCueing (const Graphic3d_CView& ACView, const Standard_Boolean AFlag);
137 Standard_EXPORT void RatioWindow (const Graphic3d_CView& ACView);
138 Standard_EXPORT void Redraw (const Graphic3d_CView& theCView,
139 const Aspect_CLayer2d& theCUnderLayer,
140 const Aspect_CLayer2d& theCOverLayer,
141 const Standard_Integer theX = 0,
142 const Standard_Integer theY = 0,
143 const Standard_Integer theWidth = 0,
144 const Standard_Integer theHeight = 0);
145 Standard_EXPORT void RedrawImmediate (const Graphic3d_CView& theCView,
146 const Aspect_CLayer2d& theCUnderLayer,
147 const Aspect_CLayer2d& theCOverLayer);
148 Standard_EXPORT void Invalidate (const Graphic3d_CView& theCView);
149 Standard_EXPORT void RemoveView (const Graphic3d_CView& ACView);
150 Standard_EXPORT void SetLight (const Graphic3d_CView& ACView);
151 Standard_EXPORT void SetClipPlanes (const Graphic3d_CView& theCView);
152 Standard_EXPORT void SetCamera (const Graphic3d_CView& theCView);
153 Standard_EXPORT void SetVisualisation (const Graphic3d_CView& ACView);
154 Standard_EXPORT void Transparency (const Graphic3d_CView& ACView, const Standard_Boolean AFlag);
155 Standard_EXPORT Standard_Boolean View (Graphic3d_CView& ACView);
156 Standard_EXPORT void Environment (const Graphic3d_CView& ACView);
157 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);
158 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);
159 Standard_EXPORT void TriedronErase (const Graphic3d_CView& ACView);
160 Standard_EXPORT void TriedronEcho (const Graphic3d_CView& ACView, const Aspect_TypeOfTriedronEcho AType = Aspect_TOTE_NONE);
161 Standard_EXPORT void GraduatedTrihedronDisplay (const Graphic3d_CView& view, const Graphic3d_CGraduatedTrihedron& cubic);
162 Standard_EXPORT void GraduatedTrihedronErase (const Graphic3d_CView& view);
163 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);
164 Standard_EXPORT void Layer (Aspect_CLayer2d& ACLayer);
165 Standard_EXPORT void RemoveLayer (const Aspect_CLayer2d& ACLayer);
166 Standard_EXPORT void BeginLayer (const Aspect_CLayer2d& ACLayer);
167 Standard_EXPORT void BeginPolygon2d ();
168 Standard_EXPORT void BeginPolyline2d ();
169 Standard_EXPORT void ClearLayer (const Aspect_CLayer2d& ACLayer);
170 Standard_EXPORT void Draw (const Standard_ShortReal X,const Standard_ShortReal Y);
171 Standard_EXPORT void Edge (const Standard_ShortReal X,const Standard_ShortReal Y);
172 Standard_EXPORT void EndLayer ();
173 Standard_EXPORT void EndPolygon2d ();
174 Standard_EXPORT void EndPolyline2d ();
175 Standard_EXPORT void Move (const Standard_ShortReal X,const Standard_ShortReal Y);
176 Standard_EXPORT void Rectangle (const Standard_ShortReal X,const Standard_ShortReal Y,const Standard_ShortReal Width,const Standard_ShortReal Height);
177 Standard_EXPORT void SetColor (const Standard_ShortReal R,const Standard_ShortReal G,const Standard_ShortReal B);
178 Standard_EXPORT void SetTransparency (const Standard_ShortReal ATransparency);
179 Standard_EXPORT void UnsetTransparency ();
180 Standard_EXPORT void SetLineAttributes (const Standard_Integer Type,const Standard_ShortReal Width);
182 //! Set text attributes for under-/overlayer.
183 //! @param theFontName the name of the font to be used
184 //! @param theType the display type of the text
185 //! theR theG theB values define the color of decal or subtitle background
186 //! To set the color of the text you can use the SetColor method.
187 Standard_EXPORT void SetTextAttributes (const Standard_CString theFontName,
188 const Standard_Integer theType,
189 const Standard_ShortReal theR,
190 const Standard_ShortReal theG,
191 const Standard_ShortReal theB);
192 Standard_EXPORT void Text (const Standard_CString AText,const Standard_ShortReal X,const Standard_ShortReal Y,const Standard_ShortReal AHeight);
193 Standard_EXPORT void TextSize (const Standard_CString AText,const Standard_ShortReal AHeight,Standard_ShortReal& AWidth,Standard_ShortReal& AnAscent,Standard_ShortReal& ADescent) const;
194 Standard_EXPORT void SetBackFacingModel (const Graphic3d_CView& aView);
196 //! Print the contents of all layers of the view to the printer.
197 //! @param thePrinterDC pass the PrinterDeviceContext (HDC)
198 //! @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
199 //! @param theFileName if != NULL, then the view will be printed to a file
200 //! @param thePrintAlgorithm select print algorithm: stretch, tile
201 //! @param theScaleFactor scaling coefficient, used internally to scale the printings accordingly to the scale factor selected in the printer properties dialog
202 //! @return Standard_True if the data is passed to the printer, otherwise Standard_False if the print operation failed due to the printer errors,
203 //! or lack of system memory. This might be related to insufficient memory or some internal errors.
204 //! All this errors are indicated by the message boxes (on level of OpenGl_GraphicDriver).
205 //! Warning: This function can reuse FBO assigned to the view, please take it into account if you use it for your purposes.
206 Standard_EXPORT Standard_Boolean Print (const Graphic3d_CView& theCView,
207 const Aspect_CLayer2d& theCUnderLayer,
208 const Aspect_CLayer2d& theCOverLayer,
209 const Aspect_Handle thePrinterDC,
210 const Standard_Boolean theToShowBackground,
211 const Standard_CString theFileName,
212 const Aspect_PrintAlgo thePrintAlgorithm = Aspect_PA_STRETCH,
213 const Standard_Real theScaleFactor = 1.0) const;
214 Standard_EXPORT void SetDepthTestEnabled (const Graphic3d_CView& view,const Standard_Boolean isEnabled) const;
215 Standard_EXPORT Standard_Boolean IsDepthTestEnabled (const Graphic3d_CView& view) const;
217 //! Reads depths of shown pixels of the given rectangle (glReadPixels with GL_DEPTH_COMPONENT)
218 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;
220 //! Generate offscreen FBO (needs OpenGL2+ hardware).
221 //! If not supported on hardware returns NULL.
222 Standard_EXPORT Graphic3d_PtrFrameBuffer FBOCreate (const Graphic3d_CView& view, const Standard_Integer width, const Standard_Integer height);
224 //! Remove offscreen FBO
225 Standard_EXPORT void FBORelease (const Graphic3d_CView& view, Graphic3d_PtrFrameBuffer& fboPtr);
227 //! Dump active rendering buffer into specified memory buffer.
228 Standard_EXPORT Standard_Boolean BufferDump (const Graphic3d_CView& theCView,
229 Image_PixMap& theImage,
230 const Graphic3d_BufferType& theBufferType);
232 Standard_EXPORT void SetGLLightEnabled (const Graphic3d_CView& view,const Standard_Boolean isEnabled) const;
234 Standard_EXPORT Standard_Boolean IsGLLightEnabled (const Graphic3d_CView& view) const;
236 Standard_EXPORT Standard_Integer InquirePlaneLimit();
238 Standard_EXPORT Standard_ShortReal DefaultTextHeight() const;
240 Standard_EXPORT void FBOGetDimensions(const Graphic3d_CView& view,const Graphic3d_PtrFrameBuffer fboPtr,Standard_Integer& width,Standard_Integer& height,Standard_Integer& widthMax,Standard_Integer& heightMax);
242 Standard_EXPORT void FBOChangeViewport(const Graphic3d_CView& view,Graphic3d_PtrFrameBuffer& fboPtr,const Standard_Integer width,const Standard_Integer height);
244 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);
246 //! 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.
247 //! To add a structure to desired layer on display it is necessary to set the layer index for the structure.
248 Standard_EXPORT void AddZLayer (const Graphic3d_CView& theCView,
249 const Standard_Integer theLayerId);
251 //! Remove Z layer from the specified view.
252 //! All structures displayed at the moment in layer will be displayed in default layer (the bottom-level z layer).
253 //! To unset layer index from associated structures use method UnsetZLayer (...).
254 Standard_EXPORT void RemoveZLayer (const Graphic3d_CView& theCView,
255 const Standard_Integer theLayerId);
257 //! Unset Z layer ID for all structures.
258 //! The structure indexes will be set to default layer (the bottom-level z layer with ID = 0).
259 Standard_EXPORT void UnsetZLayer (const Standard_Integer theLayerId);
261 //! Change Z layer of a structure.
262 //! The new z layer ID will be used to define the associated layer for structure on display.
263 //! It is recommended to take care of redisplaying the structures already presented in view with previously set layer index.
264 //! This is usually done by viewer manager. Z layers allow drawing structures in higher layers in foreground of structures in lower layers.
265 Standard_EXPORT void ChangeZLayer (const Graphic3d_CStructure& theCStructure,
266 const Standard_Integer theLayerId);
268 //! Change Z layer of a structure already presented in view.
269 //! It is recommended to update z layer of already displayed structures with this method before setting new z layer index to the structure.
270 //! This is usually done by viewer manager.
271 Standard_EXPORT void ChangeZLayer (const Graphic3d_CStructure& theCStructure,
272 const Graphic3d_CView& theCView,
273 const Standard_Integer theNewLayerId);
275 //! Get Z layer ID of the structure. If the structure doesn't exists in graphic driver, the method returns -1.
276 Standard_EXPORT Standard_Integer GetZLayer (const Graphic3d_CStructure& theCStructure) const;
278 //! Sets the settings for a single Z layer of specified view.
279 Standard_EXPORT void SetZLayerSettings (const Graphic3d_CView& theCView,
280 const Standard_Integer theLayerId,
281 const Graphic3d_ZLayerSettings& theSettings);
285 //! @return the visualization options
286 inline const OpenGl_Caps& Options() const
288 return *myCaps.operator->();
291 //! @return the visualization options
292 inline OpenGl_Caps& ChangeOptions()
294 return *myCaps.operator->();
297 //! VBO usage can be forbidden by this method even if it is supported by GL driver.
298 //! Notice that disabling of VBO will cause rendering performance degradation.
299 //! Warning! This method should be called only before any primitives are displayed in GL scene!
300 Standard_EXPORT void EnableVBO (const Standard_Boolean theToTurnOn);
302 //! Returns information about GPU memory usage.
303 //! Please read OpenGl_Context::MemoryInfo() for more description.
304 Standard_EXPORT Standard_Boolean MemoryInfo (Standard_Size& theFreeBytes,
305 TCollection_AsciiString& theInfo) const;
307 //! UserDraw function prototype
308 typedef OpenGl_Element* (*OpenGl_UserDrawCallback_t )(const CALL_DEF_USERDRAW* );
310 //! Method to setup UserDraw callback
311 Standard_EXPORT OpenGl_UserDrawCallback_t& UserDrawCallback();
315 //! Method to retrieve valid GL context.
316 //! Could return NULL-handle if no window created by this driver.
317 Standard_EXPORT const Handle(OpenGl_Context)& GetSharedContext() const;
321 DEFINE_STANDARD_RTTI(OpenGl_GraphicDriver)
325 Handle(OpenGl_Display) myGlDisplay;
326 Handle(OpenGl_Caps) myCaps;
327 NCollection_DataMap<Standard_Integer, Handle(OpenGl_View)> myMapOfView;
328 NCollection_DataMap<Standard_Integer, Handle(OpenGl_Workspace)> myMapOfWS;
329 NCollection_DataMap<Standard_Integer, OpenGl_Structure*> myMapOfStructure;
330 mutable Handle(OpenGl_PrinterContext) myPrintContext;
331 OpenGl_UserDrawCallback_t myUserDrawCallback;
332 OpenGl_Text* myTempText; //!< variable for compatibility (drawing text in layers)
336 OpenGl_StateCounter* GetStateCounter() const { return &myStateCounter; }
340 mutable OpenGl_StateCounter myStateCounter;
344 #endif //_OpenGl_GraphicDriver_HeaderFile