Commit | Line | Data |
---|---|---|
b311480e | 1 | // Created on: 2011-10-20 |
2 | // Created by: Sergey ZERCHANINOV | |
3 | // Copyright (c) 2011-2012 OPEN CASCADE SAS | |
4 | // | |
5 | // The content of this file is subject to the Open CASCADE Technology Public | |
6 | // License Version 6.5 (the "License"). You may not use the content of this file | |
7 | // except in compliance with the License. Please obtain a copy of the License | |
8 | // at http://www.opencascade.org and read it completely before using this file. | |
9 | // | |
10 | // The Initial Developer of the Original Code is Open CASCADE S.A.S., having its | |
11 | // main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France. | |
12 | // | |
13 | // The Original Code and all software distributed under the License is | |
14 | // distributed on an "AS IS" basis, without warranty of any kind, and the | |
15 | // Initial Developer hereby disclaims all such warranties, including without | |
16 | // limitation, any warranties of merchantability, fitness for a particular | |
17 | // purpose or non-infringement. Please see the License for the specific terms | |
18 | // and conditions governing the rights and limitations under the License. | |
19 | ||
2166f0fa SK |
20 | #ifndef _OpenGl_GraphicDriver_HeaderFile |
21 | #define _OpenGl_GraphicDriver_HeaderFile | |
22 | ||
23 | #include <Graphic3d_GraphicDriver.hxx> | |
24 | #include <Handle_OpenGl_GraphicDriver.hxx> | |
fd4a6963 | 25 | #include <Handle_OpenGl_Display.hxx> |
5e27df78 | 26 | #include <OpenGl_Context.hxx> |
a174a3c5 | 27 | #include <OpenGl_PrinterContext.hxx> |
2166f0fa SK |
28 | |
29 | #include <Standard_CString.hxx> | |
30 | ||
31 | #include <Handle_TColStd_HArray1OfByte.hxx> | |
32 | #include <Handle_TColStd_HArray1OfReal.hxx> | |
33 | #include <Quantity_PlaneAngle.hxx> | |
34 | #include <Quantity_NameOfColor.hxx> | |
bf75be98 | 35 | #include <Handle_OpenGl_View.hxx> |
1981cb22 | 36 | #include <Handle_OpenGl_Workspace.hxx> |
2166f0fa SK |
37 | |
38 | #include <Aspect_Display.hxx> | |
dc3fe572 | 39 | #include <Aspect_DisplayConnection.hxx> |
2166f0fa SK |
40 | #include <Aspect_GradientFillMethod.hxx> |
41 | #include <Aspect_FillMethod.hxx> | |
42 | #include <Aspect_CLayer2d.hxx> | |
43 | #include <Aspect_TypeOfTriedronPosition.hxx> | |
44 | #include <Aspect_TypeOfTriedronEcho.hxx> | |
45 | #include <Aspect_Handle.hxx> | |
46 | #include <Aspect_PrintAlgo.hxx> | |
47 | ||
48 | #include <Graphic3d_CView.hxx> | |
49 | #include <Graphic3d_CStructure.hxx> | |
50 | #include <Graphic3d_CGroup.hxx> | |
51 | #include <Graphic3d_TypeOfPrimitive.hxx> | |
52 | #include <Graphic3d_CPick.hxx> | |
2166f0fa SK |
53 | #include <Graphic3d_TextPath.hxx> |
54 | #include <Graphic3d_HorizontalTextAlignment.hxx> | |
55 | #include <Graphic3d_VerticalTextAlignment.hxx> | |
56 | #include <Graphic3d_PrimitiveArray.hxx> | |
57 | #include <Graphic3d_CUserDraw.hxx> | |
58 | #include <Graphic3d_CGraduatedTrihedron.hxx> | |
59 | #include <Graphic3d_TypeOfComposition.hxx> | |
2166f0fa SK |
60 | #include <Graphic3d_ExportFormat.hxx> |
61 | #include <Graphic3d_SortType.hxx> | |
62 | #include <Graphic3d_PtrFrameBuffer.hxx> | |
63 | #include <Graphic3d_Array1OfVertex.hxx> | |
2166f0fa | 64 | #include <Graphic3d_Array2OfVertex.hxx> |
692613e5 | 65 | #include <Graphic3d_BufferType.hxx> |
2166f0fa SK |
66 | #include <NCollection_DataMap.hxx> |
67 | ||
68 | class TColStd_Array1OfInteger; | |
69 | class TColStd_Array1OfReal; | |
70 | class TColStd_Array2OfReal; | |
71 | class TColStd_HArray1OfByte; | |
2166f0fa SK |
72 | class Graphic3d_Vector; |
73 | class Quantity_Color; | |
74 | class Graphic3d_Vertex; | |
75 | class Aspect_Array1OfEdge; | |
76 | class TCollection_ExtendedString; | |
692613e5 | 77 | class Image_PixMap; |
2166f0fa | 78 | class TColStd_HArray1OfReal; |
2166f0fa | 79 | class Handle(OpenGl_Workspace); |
5e27df78 | 80 | class OpenGl_Element; |
2166f0fa | 81 | class OpenGl_Structure; |
a174a3c5 | 82 | class OpenGl_Text; |
2166f0fa SK |
83 | |
84 | //! This class defines an OpenGl graphic driver <br> | |
85 | class OpenGl_GraphicDriver : public Graphic3d_GraphicDriver | |
86 | { | |
bf75be98 | 87 | public: |
2166f0fa SK |
88 | |
89 | //! Constructor | |
58655684 | 90 | Standard_EXPORT OpenGl_GraphicDriver (const Standard_CString theShrName = "TKOpenGl"); |
2166f0fa | 91 | |
dc3fe572 | 92 | Standard_EXPORT Standard_Boolean Begin (const Handle(Aspect_DisplayConnection)& theDisplayConnection); |
2166f0fa SK |
93 | Standard_EXPORT void End (); |
94 | Standard_EXPORT Standard_Integer InquireLightLimit (); | |
95 | Standard_EXPORT void InquireMat (const Graphic3d_CView& ACView, TColStd_Array2OfReal& AMatO, TColStd_Array2OfReal& AMatM); | |
96 | Standard_EXPORT Standard_Integer InquireViewLimit (); | |
2166f0fa SK |
97 | Standard_EXPORT void Blink (const Graphic3d_CStructure& ACStructure,const Standard_Boolean Create); |
98 | Standard_EXPORT void BoundaryBox (const Graphic3d_CStructure& ACStructure, const Standard_Boolean Create); | |
99 | Standard_EXPORT void HighlightColor (const Graphic3d_CStructure& ACStructure, const Standard_ShortReal R, const Standard_ShortReal G, const Standard_ShortReal B, const Standard_Boolean Create); | |
100 | Standard_EXPORT void NameSetStructure (const Graphic3d_CStructure& ACStructure); | |
101 | ||
102 | public: // Methods for graphical groups | |
103 | ||
104 | Standard_EXPORT void ClearGroup (const Graphic3d_CGroup& ACGroup); | |
2166f0fa SK |
105 | Standard_EXPORT void FaceContextGroup (const Graphic3d_CGroup& theCGroup, |
106 | const Standard_Integer theNoInsert); | |
107 | Standard_EXPORT void Group (Graphic3d_CGroup& theCGroup); | |
108 | Standard_EXPORT void LineContextGroup (const Graphic3d_CGroup& theCGroup, | |
109 | const Standard_Integer theNoInsert); | |
110 | Standard_EXPORT void MarkerContextGroup (const Graphic3d_CGroup& theCGroup, | |
111 | const Standard_Integer theNoInsert); | |
2166f0fa SK |
112 | Standard_EXPORT void RemoveGroup (const Graphic3d_CGroup& theCGroup); |
113 | Standard_EXPORT void TextContextGroup (const Graphic3d_CGroup& theCGroup, | |
114 | const Standard_Integer theNoInsert); | |
115 | ||
116 | public: // Methods for graphical structures | |
117 | ||
118 | Standard_EXPORT void ClearStructure (const Graphic3d_CStructure& theCStructure); | |
119 | Standard_EXPORT void ContextStructure (const Graphic3d_CStructure& theCStructure); | |
120 | Standard_EXPORT void Connect (const Graphic3d_CStructure& theFather, | |
121 | const Graphic3d_CStructure& theSon); | |
122 | Standard_EXPORT void Disconnect (const Graphic3d_CStructure& theFather, | |
123 | const Graphic3d_CStructure& theSon); | |
124 | Standard_EXPORT void DisplayStructure (const Graphic3d_CView& theCView, | |
125 | const Graphic3d_CStructure& theCStructure, | |
126 | const Standard_Integer thePriority); | |
127 | Standard_EXPORT void EraseStructure (const Graphic3d_CView& theCView, | |
128 | const Graphic3d_CStructure& theCStructure); | |
129 | Standard_EXPORT void RemoveStructure (const Graphic3d_CStructure& theCStructure); | |
130 | Standard_EXPORT void Structure (Graphic3d_CStructure& theCStructure); | |
131 | ||
132 | public: | |
133 | ||
2166f0fa SK |
134 | Standard_EXPORT void ActivateView (const Graphic3d_CView& ACView); |
135 | Standard_EXPORT void AntiAliasing (const Graphic3d_CView& ACView, const Standard_Boolean AFlag); | |
136 | Standard_EXPORT void Background (const Graphic3d_CView& ACView); | |
137 | Standard_EXPORT void GradientBackground (const Graphic3d_CView& ACView, const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod FillStyle); | |
138 | Standard_EXPORT void BackgroundImage (const Standard_CString FileName, const Graphic3d_CView& ACView, const Aspect_FillMethod FillStyle); | |
139 | Standard_EXPORT void SetBgImageStyle (const Graphic3d_CView& ACView, const Aspect_FillMethod FillStyle); | |
140 | Standard_EXPORT void SetBgGradientStyle (const Graphic3d_CView& ACView, const Aspect_GradientFillMethod FillStyle); | |
141 | Standard_EXPORT void ClipLimit (const Graphic3d_CView& ACView, const Standard_Boolean AWait); | |
142 | Standard_EXPORT void DeactivateView (const Graphic3d_CView& ACView); | |
143 | Standard_EXPORT void DepthCueing (const Graphic3d_CView& ACView, const Standard_Boolean AFlag); | |
144 | Standard_EXPORT Standard_Boolean ProjectRaster (const Graphic3d_CView& ACView, const Standard_ShortReal AX, const Standard_ShortReal AY, const Standard_ShortReal AZ, Standard_Integer& AU, Standard_Integer& AV); | |
145 | Standard_EXPORT Standard_Boolean UnProjectRaster (const Graphic3d_CView& ACView, const Standard_Integer Axm, const Standard_Integer Aym, const Standard_Integer AXM, const Standard_Integer AYM, const Standard_Integer AU, const Standard_Integer AV, Standard_ShortReal& AX, Standard_ShortReal& AY, Standard_ShortReal& AZ); | |
146 | Standard_EXPORT Standard_Boolean UnProjectRasterWithRay (const Graphic3d_CView& ACView, const Standard_Integer Axm, const Standard_Integer Aym, const Standard_Integer AXM, const Standard_Integer AYM, const Standard_Integer AU, const Standard_Integer AV, Standard_ShortReal& AX, Standard_ShortReal& AY, Standard_ShortReal& AZ, Standard_ShortReal& DX, Standard_ShortReal& DY, Standard_ShortReal& DZ); | |
147 | Standard_EXPORT void RatioWindow (const Graphic3d_CView& ACView); | |
148 | Standard_EXPORT void Redraw (const Graphic3d_CView& ACView, const Aspect_CLayer2d& ACUnderLayer, const Aspect_CLayer2d& ACOverLayer, const Standard_Integer x = 0, const Standard_Integer y = 0, const Standard_Integer width = 0, const Standard_Integer height = 0); | |
149 | Standard_EXPORT void RemoveView (const Graphic3d_CView& ACView); | |
150 | Standard_EXPORT void SetLight (const Graphic3d_CView& ACView); | |
4269bd1b | 151 | Standard_EXPORT void SetClipPlanes (const Graphic3d_CView& theCView); |
152 | Standard_EXPORT void SetClipPlanes (const Graphic3d_CStructure& theCStructure); | |
2166f0fa SK |
153 | Standard_EXPORT void SetVisualisation (const Graphic3d_CView& ACView); |
154 | Standard_EXPORT void TransformStructure (const Graphic3d_CStructure& ACStructure); | |
2166f0fa SK |
155 | Standard_EXPORT void Transparency (const Graphic3d_CView& ACView, const Standard_Boolean AFlag); |
156 | Standard_EXPORT void Update (const Graphic3d_CView& ACView, const Aspect_CLayer2d& ACUnderLayer, const Aspect_CLayer2d& ACOverLayer); | |
157 | Standard_EXPORT Standard_Boolean View (Graphic3d_CView& ACView); | |
158 | Standard_EXPORT void ViewMapping (const Graphic3d_CView& ACView, const Standard_Boolean AWait); | |
159 | Standard_EXPORT void ViewOrientation (const Graphic3d_CView& ACView,const Standard_Boolean AWait); | |
160 | Standard_EXPORT void Environment (const Graphic3d_CView& ACView); | |
a6eb515f | 161 | Standard_EXPORT void SetStencilTestOptions (const Graphic3d_CGroup& theCGroup, const Standard_Boolean theIsEnabled); |
2166f0fa SK |
162 | 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); |
163 | 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); | |
164 | 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); | |
165 | 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); | |
2166f0fa SK |
166 | Standard_EXPORT void PrimitiveArray (const Graphic3d_CGroup& ACGroup,const Graphic3d_PrimitiveArray& parray,const Standard_Boolean EvalMinMax = Standard_True); |
167 | Standard_EXPORT void UserDraw (const Graphic3d_CGroup& ACGroup,const Graphic3d_CUserDraw& AUserDraw); | |
168 | 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); | |
169 | 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); | |
170 | Standard_EXPORT void TriedronErase (const Graphic3d_CView& ACView); | |
171 | Standard_EXPORT void TriedronEcho (const Graphic3d_CView& ACView, const Aspect_TypeOfTriedronEcho AType = Aspect_TOTE_NONE); | |
172 | Standard_EXPORT void GraduatedTrihedronDisplay (const Graphic3d_CView& view, const Graphic3d_CGraduatedTrihedron& cubic); | |
173 | Standard_EXPORT void GraduatedTrihedronErase (const Graphic3d_CView& view); | |
174 | 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); | |
1981cb22 | 175 | Standard_EXPORT Standard_Boolean SetImmediateModeDrawToFront (const Graphic3d_CView& theCView, |
176 | const Standard_Boolean theDrawToFrontBuffer); | |
2166f0fa SK |
177 | Standard_EXPORT Standard_Boolean BeginAddMode (const Graphic3d_CView& ACView); |
178 | Standard_EXPORT void EndAddMode (); | |
179 | Standard_EXPORT Standard_Boolean BeginImmediatMode(const Graphic3d_CView& ACView, const Aspect_CLayer2d& ACUnderLayer, const Aspect_CLayer2d& ACOverLayer, const Standard_Boolean DoubleBuffer, const Standard_Boolean RetainMode); | |
2166f0fa | 180 | Standard_EXPORT void ClearImmediatMode (const Graphic3d_CView& ACView,const Standard_Boolean aFlush = Standard_True); |
2166f0fa SK |
181 | Standard_EXPORT void DrawStructure (const Graphic3d_CStructure& ACStructure); |
182 | Standard_EXPORT void EndImmediatMode (const Standard_Integer Synchronize); | |
2166f0fa SK |
183 | Standard_EXPORT void Layer (Aspect_CLayer2d& ACLayer); |
184 | Standard_EXPORT void RemoveLayer (const Aspect_CLayer2d& ACLayer); | |
185 | Standard_EXPORT void BeginLayer (const Aspect_CLayer2d& ACLayer); | |
186 | Standard_EXPORT void BeginPolygon2d (); | |
187 | Standard_EXPORT void BeginPolyline2d (); | |
188 | Standard_EXPORT void ClearLayer (const Aspect_CLayer2d& ACLayer); | |
189 | Standard_EXPORT void Draw (const Standard_ShortReal X,const Standard_ShortReal Y); | |
190 | Standard_EXPORT void Edge (const Standard_ShortReal X,const Standard_ShortReal Y); | |
191 | Standard_EXPORT void EndLayer (); | |
192 | Standard_EXPORT void EndPolygon2d (); | |
193 | Standard_EXPORT void EndPolyline2d (); | |
194 | Standard_EXPORT void Move (const Standard_ShortReal X,const Standard_ShortReal Y); | |
195 | Standard_EXPORT void Rectangle (const Standard_ShortReal X,const Standard_ShortReal Y,const Standard_ShortReal Width,const Standard_ShortReal Height); | |
196 | Standard_EXPORT void SetColor (const Standard_ShortReal R,const Standard_ShortReal G,const Standard_ShortReal B); | |
197 | Standard_EXPORT void SetTransparency (const Standard_ShortReal ATransparency); | |
198 | Standard_EXPORT void UnsetTransparency (); | |
199 | Standard_EXPORT void SetLineAttributes (const Standard_Integer Type,const Standard_ShortReal Width); | |
25289ec1 | 200 | |
201 | //! Set text attributes for under-/overlayer. <br> | |
202 | //! <Font> argument defines the name of the font to be used, <br> | |
203 | //! <Type> argument defines the display type of the text, <br> | |
204 | //! <R> <G> <B> values define the color of decal or subtitle background. <br> | |
205 | //! To set the color of the text you can use the SetColor method. <br> | |
2166f0fa SK |
206 | Standard_EXPORT void SetTextAttributes (const Standard_CString FontName,const Standard_Integer Type,const Standard_ShortReal R,const Standard_ShortReal G,const Standard_ShortReal B); |
207 | Standard_EXPORT void Text (const Standard_CString AText,const Standard_ShortReal X,const Standard_ShortReal Y,const Standard_ShortReal AHeight); | |
208 | Standard_EXPORT void TextSize (const Standard_CString AText,const Standard_ShortReal AHeight,Standard_ShortReal& AWidth,Standard_ShortReal& AnAscent,Standard_ShortReal& ADescent) const; | |
209 | Standard_EXPORT void SetBackFacingModel (const Graphic3d_CView& aView); | |
210 | //! print the contents of all layers of the view to the printer. <br> | |
211 | //! <hPrnDC> : Pass the PrinterDeviceContext (HDC), <br> | |
212 | //! <showBackground> : When set to FALSE then print the view without background color <br> | |
213 | //! (background is white) <br> | |
214 | //! else set to TRUE for printing with current background color. <br> | |
215 | //! <filename>: If != NULL, then the view will be printed to a file. <br> | |
216 | //! <printAlgorithm>: Select print algorithm: stretch, tile. <br> | |
217 | //! <theScaleFactor>: Scaling coefficient, used internally to scale the <br> | |
218 | //! printings accordingly to the scale factor selected in the printer <br> | |
219 | //! properties dialog. <br> | |
220 | //! Returns Standard_True if the data is passed to the printer, otherwise <br> | |
221 | //! Standard_False if the print operation failed due to the printer errors, <br> | |
222 | //! or lack of system memory. This might be related to insufficient memory <br> | |
223 | //! or some internal errors. All this errors are indicated by the message <br> | |
224 | //! boxes (on level of OpenGl_GraphicDriver). <br> | |
225 | //! Warning: This function can reuse FBO assigned to the view <br> | |
226 | //! Please take it into account if you use it for your purposes; <br> | |
227 | Standard_EXPORT Standard_Boolean Print (const Graphic3d_CView& ACView, const Aspect_CLayer2d& ACUnderLayer, const Aspect_CLayer2d& ACOverLayer, const Aspect_Handle hPrnDC, const Standard_Boolean showBackground, const Standard_CString filename, const Aspect_PrintAlgo printAlgorithm = Aspect_PA_STRETCH, const Standard_Real theScaleFactor = 1.0) const; | |
228 | Standard_EXPORT void SetDepthTestEnabled (const Graphic3d_CView& view,const Standard_Boolean isEnabled) const; | |
229 | Standard_EXPORT Standard_Boolean IsDepthTestEnabled (const Graphic3d_CView& view) const; | |
230 | //! Reads depths of shown pixels of the given rectangle (glReadPixels with GL_DEPTH_COMPONENT) <br> | |
231 | 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; | |
232 | //! Generate offscreen FBO (needs OpenGL2+ hardware) <br> | |
233 | //! If not supported on hardware returns NULL. <br> | |
234 | Standard_EXPORT Graphic3d_PtrFrameBuffer FBOCreate (const Graphic3d_CView& view, const Standard_Integer width, const Standard_Integer height); | |
235 | //! Remove offscreen FBO <br> | |
236 | Standard_EXPORT void FBORelease (const Graphic3d_CView& view, Graphic3d_PtrFrameBuffer& fboPtr); | |
237 | //! Dump active rendering buffer into specified memory buffer. <br> | |
692613e5 | 238 | Standard_EXPORT Standard_Boolean BufferDump (const Graphic3d_CView& theCView, |
239 | Image_PixMap& theImage, | |
240 | const Graphic3d_BufferType& theBufferType); | |
2166f0fa SK |
241 | Standard_EXPORT void SetGLLightEnabled (const Graphic3d_CView& view,const Standard_Boolean isEnabled) const; |
242 | Standard_EXPORT Standard_Boolean IsGLLightEnabled (const Graphic3d_CView& view) const; | |
243 | //! Clear visualization data in graphical driver and stop <br> | |
244 | //! displaying the primitives array of the graphical group <theCGroup>. <br> | |
245 | //! This method is internal and should be used by Graphic3d_Group only. <br> | |
2166f0fa | 246 | Standard_EXPORT Standard_Integer InquirePlaneLimit(); |
2166f0fa SK |
247 | Standard_EXPORT Standard_ShortReal DefaultTextHeight() const; |
248 | Standard_EXPORT void FBOGetDimensions(const Graphic3d_CView& view,const Graphic3d_PtrFrameBuffer fboPtr,Standard_Integer& width,Standard_Integer& height,Standard_Integer& widthMax,Standard_Integer& heightMax); | |
249 | Standard_EXPORT void FBOChangeViewport(const Graphic3d_CView& view,Graphic3d_PtrFrameBuffer& fboPtr,const Standard_Integer width,const Standard_Integer height); | |
250 | 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); | |
3c3131a0 | 251 | |
59f45b7c | 252 | //! Add a new top-level z layer with ID <theLayerId> for <br> |
253 | //! the view. Z layers allow drawing structures in higher layers <br> | |
254 | //! in foreground of structures in lower layers. To add a structure <br> | |
255 | //! to desired layer on display it is necessary to set the layer <br> | |
256 | //! index for the structure. <br> | |
257 | Standard_EXPORT void AddZLayer(const Graphic3d_CView& theCView, | |
258 | const Standard_Integer theLayerId); | |
259 | ||
260 | //! Remove Z layer from the specified view. All structures <br> | |
261 | //! displayed at the moment in layer will be displayed in default layer <br> | |
262 | //! ( the bottom-level z layer ). To unset layer index from associated <br> | |
263 | //! structures use method UnsetZLayer (...). <br> | |
264 | Standard_EXPORT void RemoveZLayer(const Graphic3d_CView& theCView, | |
265 | const Standard_Integer theLayerId); | |
266 | ||
267 | //! Unset Z layer ID for all structures. The structure <br> | |
268 | //! indexes will be set to default layer ( the bottom-level z layer with <br> | |
269 | //! ID = 0 ). <br> | |
270 | Standard_EXPORT void UnsetZLayer(const Standard_Integer theLayerId); | |
271 | ||
272 | //! Change Z layer of a structure. The new z layer ID will <br> | |
273 | //! be used to define the associated layer for structure on display. <br> | |
274 | //! It is recommended to take care of redisplaying the structures already <br> | |
275 | //! presented in view with previously set layer index. This is usually <br> | |
276 | //! done by viewer manager. Z layers allow drawing structures in <br> | |
277 | //! higher layers in foreground of structures in lower layers. <br> | |
278 | Standard_EXPORT void ChangeZLayer(const Graphic3d_CStructure& theCStructure, | |
279 | const Standard_Integer theLayerId); | |
280 | ||
281 | //! Change Z layer of a structure already presented in view. <br> | |
282 | //! It is recommended to update z layer of already <br> | |
283 | //! displayed structures with this method before setting new z layer <br> | |
284 | //! index to the structure. This is usually done by viewer manager. <br> | |
285 | Standard_EXPORT void ChangeZLayer(const Graphic3d_CStructure& theCStructure, | |
286 | const Graphic3d_CView& theCView, | |
287 | const Standard_Integer theNewLayerId); | |
288 | ||
289 | //! Get Z layer ID of the structure. If the structure doesn't exists in <br> | |
290 | //! graphic driver, the method returns -1. <br> | |
291 | Standard_EXPORT Standard_Integer GetZLayer(const Graphic3d_CStructure& theCStructure) const; | |
2166f0fa SK |
292 | |
293 | public: | |
294 | ||
58655684 | 295 | //! @return the visualization options |
296 | inline const OpenGl_Caps& Options() const | |
297 | { | |
298 | return *myCaps.operator->(); | |
299 | } | |
300 | ||
301 | //! @return the visualization options | |
302 | inline OpenGl_Caps& ChangeOptions() | |
303 | { | |
304 | return *myCaps.operator->(); | |
305 | } | |
2166f0fa SK |
306 | |
307 | //! VBO usage can be forbidden by this method even if it is supported by GL driver. | |
308 | //! Notice that disabling of VBO will cause rendering performance degradation. | |
309 | //! Warning! This method should be called only before any primitives are displayed in GL scene! | |
310 | Standard_EXPORT void EnableVBO (const Standard_Boolean theToTurnOn); | |
311 | ||
f0430952 | 312 | //! Returns information about GPU memory usage. |
313 | //! Please read OpenGl_Context::MemoryInfo() for more description. | |
314 | Standard_EXPORT Standard_Boolean MemoryInfo (Standard_Size& theFreeBytes, | |
315 | TCollection_AsciiString& theInfo) const; | |
316 | ||
5e27df78 | 317 | //! UserDraw function prototype |
318 | typedef OpenGl_Element* (*OpenGl_UserDrawCallback_t )(const CALL_DEF_USERDRAW* ); | |
2166f0fa | 319 | |
5e27df78 | 320 | //! Method to setup UserDraw callback |
321 | Standard_EXPORT OpenGl_UserDrawCallback_t& UserDrawCallback(); | |
2166f0fa | 322 | |
e276548b | 323 | public: |
324 | ||
325 | //! Returns information about OpenCL device used for computations. | |
326 | Standard_EXPORT Standard_Boolean GetOpenClDeviceInfo (const Graphic3d_CView& theCView, | |
327 | NCollection_DataMap<TCollection_AsciiString, TCollection_AsciiString>& theInfo); | |
328 | ||
5e27df78 | 329 | private: |
2166f0fa | 330 | |
5e27df78 | 331 | //! Method to retrieve valid GL context. |
332 | //! Could return NULL-handle if no window created by this driver. | |
333 | Standard_EXPORT const Handle(OpenGl_Context)& GetSharedContext() const; | |
2166f0fa | 334 | |
2166f0fa SK |
335 | public: |
336 | ||
337 | DEFINE_STANDARD_RTTI(OpenGl_GraphicDriver) | |
5e27df78 | 338 | |
339 | private: | |
340 | ||
fd4a6963 | 341 | Handle(OpenGl_Display) myGlDisplay; |
58655684 | 342 | Handle(OpenGl_Caps) myCaps; |
5e27df78 | 343 | NCollection_DataMap<Standard_Integer, Handle(OpenGl_View)> myMapOfView; |
344 | NCollection_DataMap<Standard_Integer, Handle(OpenGl_Workspace)> myMapOfWS; | |
345 | NCollection_DataMap<Standard_Integer, OpenGl_Structure*> myMapOfStructure; | |
1981cb22 | 346 | Handle(OpenGl_Workspace) myImmediateWS; |
a174a3c5 | 347 | mutable Handle(OpenGl_PrinterContext) myPrintContext; |
5e27df78 | 348 | OpenGl_UserDrawCallback_t myUserDrawCallback; |
a174a3c5 | 349 | OpenGl_Text* myTempText; //!< variable for compatibility (drawing text in layers) |
5e27df78 | 350 | |
2166f0fa SK |
351 | }; |
352 | ||
353 | #endif //_OpenGl_GraphicDriver_HeaderFile |