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