01a326c69095fd9f1dcf174d3c37ecf2cd0b2de9
[occt.git] / src / Graphic3d / Graphic3d_GraphicDriver.hxx
1 // Created on: 1997-01-28
2 // Created by: CAL
3 // Copyright (c) 1997-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _Graphic3d_GraphicDriver_HeaderFile
18 #define _Graphic3d_GraphicDriver_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Integer.hxx>
24 #include <Aspect_DisplayConnection.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <MMgt_TShared.hxx>
27 #include <Graphic3d_CView.hxx>
28 #include <Graphic3d_CStructure.hxx>
29 #include <Aspect_GradientFillMethod.hxx>
30 #include <Standard_CString.hxx>
31 #include <Aspect_FillMethod.hxx>
32 #include <Standard_Size.hxx>
33 #include <Quantity_NameOfColor.hxx>
34 #include <Standard_Real.hxx>
35 #include <Aspect_TypeOfTriedronPosition.hxx>
36 #include <Aspect_TypeOfTriedronEcho.hxx>
37 #include <Graphic3d_GraduatedTrihedron.hxx>
38 #include <Graphic3d_Vec3.hxx>
39 #include <Standard_ShortReal.hxx>
40 #include <Standard_Address.hxx>
41 #include <Image_PixMap.hxx>
42 #include <Graphic3d_BufferType.hxx>
43 #include <Aspect_GenId.hxx>
44 #include <Aspect_Handle.hxx>
45 #include <Aspect_PrintAlgo.hxx>
46 #include <Graphic3d_ExportFormat.hxx>
47 #include <Graphic3d_SortType.hxx>
48 #include <Graphic3d_ZLayerId.hxx>
49 #include <Graphic3d_ZLayerSettings.hxx>
50 #include <Graphic3d_CLight.hxx>
51 #include <TColStd_Array2OfReal.hxx>
52 #include <TColStd_SequenceOfInteger.hxx>
53
54 class Graphic3d_CView;
55 class Graphic3d_GraphicDriver;
56 class Graphic3d_TransformError;
57 class Graphic3d_Structure;
58 class Graphic3d_StructureManager;
59 class Graphic3d_ViewManager;
60 class Quantity_Color;
61 class TCollection_AsciiString;
62
63 DEFINE_STANDARD_HANDLE(Graphic3d_GraphicDriver, MMgt_TShared)
64
65 //! This class allows the definition of a graphic driver
66 //! for 3d interface (currently only OpenGl driver is used).
67 class Graphic3d_GraphicDriver : public MMgt_TShared
68 {
69
70 public:
71
72   
73   //! call_togl_inquirelight
74   virtual Standard_Integer InquireLightLimit() = 0;
75   
76   //! call_togl_inquireplane
77   virtual Standard_Integer InquirePlaneLimit() = 0;
78   
79   //! call_togl_inquireview
80   virtual Standard_Integer InquireViewLimit() = 0;
81   
82   //! Creates new empty graphic structure
83   virtual Handle(Graphic3d_CStructure) CreateStructure (const Handle(Graphic3d_StructureManager)& theManager) = 0;
84   
85   //! Removes structure from graphic driver and releases its resources.
86   virtual void RemoveStructure (Handle(Graphic3d_CStructure)& theCStructure) = 0;
87   
88   //! Creates new view for this graphic driver.
89   virtual Handle(Graphic3d_CView) CreateView (const Handle(Graphic3d_StructureManager)& theMgr) = 0;
90   
91   //! Removes view from graphic driver and releases its resources.
92   virtual void RemoveView (const Handle(Graphic3d_CView)& theView) = 0;
93
94   //! enables/disables usage of OpenGL vertex buffer arrays while drawing primitiev arrays
95   virtual void EnableVBO (const Standard_Boolean status) = 0;
96   
97   //! Returns information about GPU memory usage.
98   virtual Standard_Boolean MemoryInfo (Standard_Size& theFreeBytes, TCollection_AsciiString& theInfo) const = 0;
99   
100   virtual Standard_ShortReal DefaultTextHeight() const = 0;
101   
102   //! Computes text width.
103   virtual void TextSize (const Handle(Graphic3d_CView)& theView,
104                          const Standard_CString         theText,
105                          const Standard_ShortReal       theHeight,
106                          Standard_ShortReal&            theWidth,
107                          Standard_ShortReal&            theAscent,
108                          Standard_ShortReal&            theDescent) const = 0;
109
110   //! Add a new top-level z layer with ID <theLayerId> for
111   //! the view. Z layers allow drawing structures in higher layers
112   //! in foreground of structures in lower layers. To add a structure
113   //! to desired layer on display it is necessary to set the layer
114   //! ID for the structure.
115   virtual void AddZLayer (const Graphic3d_ZLayerId theLayerId) = 0;
116
117   //! Removes Z layer. All structures displayed at the moment in layer will be displayed in
118   //! default layer (the bottom-level z layer). By default, there are always default
119   //! bottom-level layer that can't be removed.  The passed theLayerId should be not less than 0
120   //! (reserved for default layers that can not be removed).
121   virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) = 0;
122
123   //! Returns list of Z layers defined for the graphical driver.
124   virtual void ZLayers (TColStd_SequenceOfInteger& theLayerSeq) const = 0;
125
126   //! Sets the settings for a single Z layer.
127   virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings& theSettings) = 0;
128
129   //! Returns the settings of a single Z layer.
130   virtual Graphic3d_ZLayerSettings ZLayerSettings (const Graphic3d_ZLayerId theLayerId) = 0;
131
132   //! Returns view associated with the window if it is exists and is activated.
133   //! Returns Standard_True if the view associated to the window exists.
134   virtual Standard_Boolean ViewExists (const Handle(Aspect_Window)& theWindow, Handle(Graphic3d_CView)& theView) = 0;
135
136   //! returns Handle to display connection
137   Standard_EXPORT const Handle(Aspect_DisplayConnection)& GetDisplayConnection() const;
138   
139   Standard_EXPORT Standard_Boolean IsDeviceLost() const;
140   
141   Standard_EXPORT void ResetDeviceLostFlag();
142
143   //! Returns a new identification number for a new structure.
144   Standard_EXPORT Standard_Integer NewIdentification();
145
146   //! Frees the identifier of a structure.
147   Standard_EXPORT void RemoveIdentification(const Standard_Integer theId);
148
149   DEFINE_STANDARD_RTTIEXT(Graphic3d_GraphicDriver,MMgt_TShared)
150
151 protected:
152
153   
154   //! Initializes the Driver
155   Standard_EXPORT Graphic3d_GraphicDriver(const Handle(Aspect_DisplayConnection)& theDisp);
156
157   Handle(Aspect_DisplayConnection) myDisplayConnection;
158   Standard_Boolean myDeviceLostFlag;
159
160   Aspect_GenId myStructGenId;
161
162
163 private:
164
165
166
167
168 };
169
170
171
172
173
174
175
176 #endif // _Graphic3d_GraphicDriver_HeaderFile