42cf5bc1 |
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> |
42cf5bc1 |
24 | #include <Standard_Boolean.hxx> |
25 | #include <MMgt_TShared.hxx> |
26 | #include <Graphic3d_CView.hxx> |
27 | #include <Graphic3d_CStructure.hxx> |
28 | #include <Aspect_GradientFillMethod.hxx> |
29 | #include <Standard_CString.hxx> |
30 | #include <Aspect_FillMethod.hxx> |
42cf5bc1 |
31 | #include <Standard_Size.hxx> |
32 | #include <Quantity_NameOfColor.hxx> |
33 | #include <Standard_Real.hxx> |
34 | #include <Aspect_TypeOfTriedronPosition.hxx> |
42cf5bc1 |
35 | #include <Graphic3d_GraduatedTrihedron.hxx> |
36 | #include <Graphic3d_Vec3.hxx> |
37 | #include <Standard_ShortReal.hxx> |
38 | #include <Standard_Address.hxx> |
42cf5bc1 |
39 | #include <Image_PixMap.hxx> |
40 | #include <Graphic3d_BufferType.hxx> |
016e5959 |
41 | #include <Aspect_GenId.hxx> |
42cf5bc1 |
42 | #include <Aspect_Handle.hxx> |
42cf5bc1 |
43 | #include <Graphic3d_ExportFormat.hxx> |
44 | #include <Graphic3d_SortType.hxx> |
45 | #include <Graphic3d_ZLayerId.hxx> |
46 | #include <Graphic3d_ZLayerSettings.hxx> |
47 | #include <Graphic3d_CLight.hxx> |
3bffef55 |
48 | #include <Graphic3d_TypeOfLimit.hxx> |
42cf5bc1 |
49 | #include <TColStd_Array2OfReal.hxx> |
c357e426 |
50 | #include <TColStd_SequenceOfInteger.hxx> |
51 | |
5950d781 |
52 | class Aspect_DisplayConnection; |
c357e426 |
53 | class Graphic3d_CView; |
54 | class Graphic3d_GraphicDriver; |
42cf5bc1 |
55 | class Graphic3d_TransformError; |
56 | class Graphic3d_Structure; |
57 | class Graphic3d_StructureManager; |
c357e426 |
58 | class Graphic3d_ViewManager; |
42cf5bc1 |
59 | class Quantity_Color; |
60 | class TCollection_AsciiString; |
61 | |
42cf5bc1 |
62 | DEFINE_STANDARD_HANDLE(Graphic3d_GraphicDriver, MMgt_TShared) |
63 | |
64 | //! This class allows the definition of a graphic driver |
65 | //! for 3d interface (currently only OpenGl driver is used). |
66 | class Graphic3d_GraphicDriver : public MMgt_TShared |
67 | { |
68 | |
69 | public: |
70 | |
3bffef55 |
71 | //! Request limit of graphic resource of specific type. |
72 | virtual Standard_Integer InquireLimit (const Graphic3d_TypeOfLimit theType) const = 0; |
73 | |
74 | //! Request maximum number of active light sources supported by driver and hardware. |
75 | Standard_Integer InquireLightLimit() const { return InquireLimit (Graphic3d_TypeOfLimit_MaxNbLights); } |
76 | |
77 | //! Request maximum number of active clipping planes supported by driver and hardware. |
78 | Standard_Integer InquirePlaneLimit() const { return InquireLimit (Graphic3d_TypeOfLimit_MaxNbClipPlanes); } |
79 | |
80 | //! Request maximum number of views supported by driver. |
81 | Standard_Integer InquireViewLimit() const { return InquireLimit (Graphic3d_TypeOfLimit_MaxNbViews); } |
82 | |
83 | public: |
84 | |
42cf5bc1 |
85 | //! Creates new empty graphic structure |
c357e426 |
86 | virtual Handle(Graphic3d_CStructure) CreateStructure (const Handle(Graphic3d_StructureManager)& theManager) = 0; |
42cf5bc1 |
87 | |
c357e426 |
88 | //! Removes structure from graphic driver and releases its resources. |
89 | virtual void RemoveStructure (Handle(Graphic3d_CStructure)& theCStructure) = 0; |
42cf5bc1 |
90 | |
c357e426 |
91 | //! Creates new view for this graphic driver. |
92 | virtual Handle(Graphic3d_CView) CreateView (const Handle(Graphic3d_StructureManager)& theMgr) = 0; |
42cf5bc1 |
93 | |
c357e426 |
94 | //! Removes view from graphic driver and releases its resources. |
95 | virtual void RemoveView (const Handle(Graphic3d_CView)& theView) = 0; |
62e1beed |
96 | |
42cf5bc1 |
97 | //! enables/disables usage of OpenGL vertex buffer arrays while drawing primitiev arrays |
c357e426 |
98 | virtual void EnableVBO (const Standard_Boolean status) = 0; |
42cf5bc1 |
99 | |
100 | //! Returns information about GPU memory usage. |
c357e426 |
101 | virtual Standard_Boolean MemoryInfo (Standard_Size& theFreeBytes, TCollection_AsciiString& theInfo) const = 0; |
42cf5bc1 |
102 | |
c357e426 |
103 | virtual Standard_ShortReal DefaultTextHeight() const = 0; |
42cf5bc1 |
104 | |
4b1c8733 |
105 | //! Computes text width. |
106 | virtual void TextSize (const Handle(Graphic3d_CView)& theView, |
107 | const Standard_CString theText, |
108 | const Standard_ShortReal theHeight, |
109 | Standard_ShortReal& theWidth, |
110 | Standard_ShortReal& theAscent, |
111 | Standard_ShortReal& theDescent) const = 0; |
42cf5bc1 |
112 | |
42cf5bc1 |
113 | //! Add a new top-level z layer with ID <theLayerId> for |
114 | //! the view. Z layers allow drawing structures in higher layers |
115 | //! in foreground of structures in lower layers. To add a structure |
116 | //! to desired layer on display it is necessary to set the layer |
117 | //! ID for the structure. |
c357e426 |
118 | virtual void AddZLayer (const Graphic3d_ZLayerId theLayerId) = 0; |
42cf5bc1 |
119 | |
c357e426 |
120 | //! Removes Z layer. All structures displayed at the moment in layer will be displayed in |
121 | //! default layer (the bottom-level z layer). By default, there are always default |
122 | //! bottom-level layer that can't be removed. The passed theLayerId should be not less than 0 |
123 | //! (reserved for default layers that can not be removed). |
124 | virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) = 0; |
125 | |
126 | //! Returns list of Z layers defined for the graphical driver. |
127 | virtual void ZLayers (TColStd_SequenceOfInteger& theLayerSeq) const = 0; |
128 | |
129 | //! Sets the settings for a single Z layer. |
130 | virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings& theSettings) = 0; |
131 | |
132 | //! Returns the settings of a single Z layer. |
7c3ef2f7 |
133 | virtual const Graphic3d_ZLayerSettings& ZLayerSettings (const Graphic3d_ZLayerId theLayerId) const = 0; |
c357e426 |
134 | |
135 | //! Returns view associated with the window if it is exists and is activated. |
136 | //! Returns Standard_True if the view associated to the window exists. |
137 | virtual Standard_Boolean ViewExists (const Handle(Aspect_Window)& theWindow, Handle(Graphic3d_CView)& theView) = 0; |
42cf5bc1 |
138 | |
42cf5bc1 |
139 | //! returns Handle to display connection |
140 | Standard_EXPORT const Handle(Aspect_DisplayConnection)& GetDisplayConnection() const; |
141 | |
142 | Standard_EXPORT Standard_Boolean IsDeviceLost() const; |
143 | |
144 | Standard_EXPORT void ResetDeviceLostFlag(); |
145 | |
016e5959 |
146 | //! Returns a new identification number for a new structure. |
147 | Standard_EXPORT Standard_Integer NewIdentification(); |
148 | |
149 | //! Frees the identifier of a structure. |
150 | Standard_EXPORT void RemoveIdentification(const Standard_Integer theId); |
151 | |
92efcf78 |
152 | DEFINE_STANDARD_RTTIEXT(Graphic3d_GraphicDriver,MMgt_TShared) |
42cf5bc1 |
153 | |
154 | protected: |
155 | |
156 | |
c357e426 |
157 | //! Initializes the Driver |
42cf5bc1 |
158 | Standard_EXPORT Graphic3d_GraphicDriver(const Handle(Aspect_DisplayConnection)& theDisp); |
159 | |
42cf5bc1 |
160 | Handle(Aspect_DisplayConnection) myDisplayConnection; |
161 | Standard_Boolean myDeviceLostFlag; |
162 | |
016e5959 |
163 | Aspect_GenId myStructGenId; |
164 | |
42cf5bc1 |
165 | |
166 | private: |
167 | |
168 | |
169 | |
170 | |
171 | }; |
172 | |
173 | |
174 | |
175 | |
176 | |
177 | |
178 | |
179 | #endif // _Graphic3d_GraphicDriver_HeaderFile |