Increment OCCT version up to 7.4.0
[occt.git] / src / Graphic3d / Graphic3d_GraphicDriver.hxx
CommitLineData
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>
25e59720 25#include <Standard_Transient.hxx>
42cf5bc1 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_ZLayerId.hxx>
44#include <Graphic3d_ZLayerSettings.hxx>
d325cb7f 45#include <Graphic3d_MapOfZLayerSettings.hxx>
42cf5bc1 46#include <Graphic3d_CLight.hxx>
3bffef55 47#include <Graphic3d_TypeOfLimit.hxx>
42cf5bc1 48#include <TColStd_Array2OfReal.hxx>
d325cb7f 49#include <TColStd_MapOfInteger.hxx>
c357e426 50#include <TColStd_SequenceOfInteger.hxx>
51
5950d781 52class Aspect_DisplayConnection;
c357e426 53class Graphic3d_CView;
54class Graphic3d_GraphicDriver;
1c728f2d 55class Graphic3d_Layer;
42cf5bc1 56class Graphic3d_TransformError;
57class Graphic3d_Structure;
58class Graphic3d_StructureManager;
c357e426 59class Graphic3d_ViewManager;
42cf5bc1 60class Quantity_Color;
61class TCollection_AsciiString;
62
25e59720 63DEFINE_STANDARD_HANDLE(Graphic3d_GraphicDriver, Standard_Transient)
42cf5bc1 64
65//! This class allows the definition of a graphic driver
66//! for 3d interface (currently only OpenGl driver is used).
25e59720 67class Graphic3d_GraphicDriver : public Standard_Transient
42cf5bc1 68{
1c728f2d 69 DEFINE_STANDARD_RTTIEXT(Graphic3d_GraphicDriver, Standard_Transient)
42cf5bc1 70public:
71
3bffef55 72 //! Request limit of graphic resource of specific type.
73 virtual Standard_Integer InquireLimit (const Graphic3d_TypeOfLimit theType) const = 0;
74
75 //! Request maximum number of active light sources supported by driver and hardware.
76 Standard_Integer InquireLightLimit() const { return InquireLimit (Graphic3d_TypeOfLimit_MaxNbLights); }
77
78 //! Request maximum number of active clipping planes supported by driver and hardware.
79 Standard_Integer InquirePlaneLimit() const { return InquireLimit (Graphic3d_TypeOfLimit_MaxNbClipPlanes); }
80
81 //! Request maximum number of views supported by driver.
82 Standard_Integer InquireViewLimit() const { return InquireLimit (Graphic3d_TypeOfLimit_MaxNbViews); }
83
84public:
85
42cf5bc1 86 //! Creates new empty graphic structure
c357e426 87 virtual Handle(Graphic3d_CStructure) CreateStructure (const Handle(Graphic3d_StructureManager)& theManager) = 0;
42cf5bc1 88
c357e426 89 //! Removes structure from graphic driver and releases its resources.
90 virtual void RemoveStructure (Handle(Graphic3d_CStructure)& theCStructure) = 0;
42cf5bc1 91
c357e426 92 //! Creates new view for this graphic driver.
93 virtual Handle(Graphic3d_CView) CreateView (const Handle(Graphic3d_StructureManager)& theMgr) = 0;
42cf5bc1 94
c357e426 95 //! Removes view from graphic driver and releases its resources.
96 virtual void RemoveView (const Handle(Graphic3d_CView)& theView) = 0;
62e1beed 97
42cf5bc1 98 //! enables/disables usage of OpenGL vertex buffer arrays while drawing primitiev arrays
c357e426 99 virtual void EnableVBO (const Standard_Boolean status) = 0;
42cf5bc1 100
101 //! Returns information about GPU memory usage.
c357e426 102 virtual Standard_Boolean MemoryInfo (Standard_Size& theFreeBytes, TCollection_AsciiString& theInfo) const = 0;
42cf5bc1 103
c357e426 104 virtual Standard_ShortReal DefaultTextHeight() const = 0;
42cf5bc1 105
4b1c8733 106 //! Computes text width.
107 virtual void TextSize (const Handle(Graphic3d_CView)& theView,
108 const Standard_CString theText,
109 const Standard_ShortReal theHeight,
110 Standard_ShortReal& theWidth,
111 Standard_ShortReal& theAscent,
112 Standard_ShortReal& theDescent) const = 0;
42cf5bc1 113
1c728f2d 114 //! Adds a layer to all views.
115 //! To add a structure to desired layer on display it is necessary to set the layer ID for the structure.
116 //! @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers).
117 //! @param theSettings [in] new layer settings
118 //! @param theLayerAfter [in] id of layer to append new layer before
119 Standard_EXPORT virtual void InsertLayerBefore (const Graphic3d_ZLayerId theNewLayerId,
120 const Graphic3d_ZLayerSettings& theSettings,
121 const Graphic3d_ZLayerId theLayerAfter) = 0;
122
123 //! Adds a layer to all views.
124 //! @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers).
125 //! @param theSettings [in] new layer settings
126 //! @param theLayerBefore [in] id of layer to append new layer after
127 Standard_EXPORT virtual void InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId,
128 const Graphic3d_ZLayerSettings& theSettings,
129 const Graphic3d_ZLayerId theLayerBefore) = 0;
42cf5bc1 130
c357e426 131 //! Removes Z layer. All structures displayed at the moment in layer will be displayed in
132 //! default layer (the bottom-level z layer). By default, there are always default
133 //! bottom-level layer that can't be removed. The passed theLayerId should be not less than 0
134 //! (reserved for default layers that can not be removed).
1c728f2d 135 Standard_EXPORT virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) = 0;
c357e426 136
137 //! Returns list of Z layers defined for the graphical driver.
1c728f2d 138 Standard_EXPORT virtual void ZLayers (TColStd_SequenceOfInteger& theLayerSeq) const;
c357e426 139
140 //! Sets the settings for a single Z layer.
d325cb7f 141 Standard_EXPORT virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings& theSettings) = 0;
c357e426 142
143 //! Returns the settings of a single Z layer.
d325cb7f 144 Standard_EXPORT virtual const Graphic3d_ZLayerSettings& ZLayerSettings (const Graphic3d_ZLayerId theLayerId) const;
c357e426 145
146 //! Returns view associated with the window if it is exists and is activated.
147 //! Returns Standard_True if the view associated to the window exists.
148 virtual Standard_Boolean ViewExists (const Handle(Aspect_Window)& theWindow, Handle(Graphic3d_CView)& theView) = 0;
42cf5bc1 149
42cf5bc1 150 //! returns Handle to display connection
151 Standard_EXPORT const Handle(Aspect_DisplayConnection)& GetDisplayConnection() const;
42cf5bc1 152
016e5959 153 //! Returns a new identification number for a new structure.
154 Standard_EXPORT Standard_Integer NewIdentification();
155
156 //! Frees the identifier of a structure.
157 Standard_EXPORT void RemoveIdentification(const Standard_Integer theId);
158
42cf5bc1 159protected:
42cf5bc1 160
c357e426 161 //! Initializes the Driver
42cf5bc1 162 Standard_EXPORT Graphic3d_GraphicDriver(const Handle(Aspect_DisplayConnection)& theDisp);
163
851dacdb 164protected:
42cf5bc1 165
851dacdb 166 Handle(Aspect_DisplayConnection) myDisplayConnection;
016e5959 167 Aspect_GenId myStructGenId;
1c728f2d 168 NCollection_List<Handle(Graphic3d_Layer)> myLayers;
169 NCollection_DataMap<Graphic3d_ZLayerId, Handle(Graphic3d_Layer)> myLayerIds;
016e5959 170
42cf5bc1 171};
172
42cf5bc1 173#endif // _Graphic3d_GraphicDriver_HeaderFile