include/opencascade/Graphic3d_GraphicDriver.hxx

0001 // Created on: 1997-01-28
0002 // Created by: CAL
0003 // Copyright (c) 1997-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Graphic3d_GraphicDriver_HeaderFile
0018 #define _Graphic3d_GraphicDriver_HeaderFile
0019
0020 #include <Aspect_GenId.hxx>
0021 #include <Graphic3d_CStructure.hxx>
0022 #include <Graphic3d_ZLayerId.hxx>
0023 #include <Graphic3d_ZLayerSettings.hxx>
0024 #include <Graphic3d_TypeOfLimit.hxx>
0025 #include <TColStd_SequenceOfInteger.hxx>
0026
0027 class Aspect_DisplayConnection;
0028 class Aspect_Window;
0029 class Graphic3d_CView;
0030 class Graphic3d_Layer;
0031 class Graphic3d_StructureManager;
0032 class TCollection_AsciiString;
0033
0034 DEFINE_STANDARD_HANDLE(Graphic3d_GraphicDriver, Standard_Transient)
0035
0036 //! This class allows the definition of a graphic driver
0037 //! for 3d interface (currently only OpenGl driver is used).
0038 class Graphic3d_GraphicDriver : public Standard_Transient
0039 {
0040   DEFINE_STANDARD_RTTIEXT(Graphic3d_GraphicDriver, Standard_Transient)
0041 public:
0042
0043   //! Request limit of graphic resource of specific type.
0044   virtual Standard_Integer InquireLimit (const Graphic3d_TypeOfLimit theType) const = 0;
0045
0046   //! Request maximum number of active light sources supported by driver and hardware.
0047   Standard_Integer InquireLightLimit() const { return InquireLimit (Graphic3d_TypeOfLimit_MaxNbLights); }
0048
0049   //! Request maximum number of active clipping planes supported by driver and hardware.
0050   Standard_Integer InquirePlaneLimit() const { return InquireLimit (Graphic3d_TypeOfLimit_MaxNbClipPlanes); }
0051
0052   //! Request maximum number of views supported by driver.
0053   Standard_Integer InquireViewLimit() const { return InquireLimit (Graphic3d_TypeOfLimit_MaxNbViews); }
0054
0055 public:
0056
0057   //! Creates new empty graphic structure
0058   virtual Handle(Graphic3d_CStructure) CreateStructure (const Handle(Graphic3d_StructureManager)& theManager) = 0;
0059
0060   //! Removes structure from graphic driver and releases its resources.
0061   virtual void RemoveStructure (Handle(Graphic3d_CStructure)& theCStructure) = 0;
0062
0063   //! Creates new view for this graphic driver.
0064   virtual Handle(Graphic3d_CView) CreateView (const Handle(Graphic3d_StructureManager)& theMgr) = 0;
0065
0066   //! Removes view from graphic driver and releases its resources.
0067   virtual void RemoveView (const Handle(Graphic3d_CView)& theView) = 0;
0068
0069   //! enables/disables usage of OpenGL vertex buffer arrays while drawing primitive arrays
0070   virtual void EnableVBO (const Standard_Boolean status) = 0;
0071
0072   //! Returns TRUE if vertical synchronization with display refresh rate (VSync) should be used; TRUE by default.
0073   virtual bool IsVerticalSync() const = 0;
0074
0075   //! Set if vertical synchronization with display refresh rate (VSync) should be used.
0076   virtual void SetVerticalSync (bool theToEnable) = 0;
0077
0078   //! Returns information about GPU memory usage.
0079   virtual Standard_Boolean MemoryInfo (Standard_Size& theFreeBytes, TCollection_AsciiString& theInfo) const = 0;
0080
0081   virtual Standard_ShortReal DefaultTextHeight() const = 0;
0082
0083   //! Computes text width.
0084   virtual void TextSize (const Handle(Graphic3d_CView)& theView,
0085                          const Standard_CString         theText,
0086                          const Standard_ShortReal       theHeight,
0087                          Standard_ShortReal&            theWidth,
0088                          Standard_ShortReal&            theAscent,
0089                          Standard_ShortReal&            theDescent) const = 0;
0090
0091   //! Adds a layer to all views.
0092   //! To add a structure to desired layer on display it is necessary to set the layer ID for the structure.
0093   //! @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers).
0094   //! @param theSettings   [in] new layer settings
0095   //! @param theLayerAfter [in] id of layer to append new layer before
0096   Standard_EXPORT virtual void InsertLayerBefore (const Graphic3d_ZLayerId theNewLayerId,
0097                                                   const Graphic3d_ZLayerSettings& theSettings,
0098                                                   const Graphic3d_ZLayerId theLayerAfter) = 0;
0099
0100   //! Adds a layer to all views.
0101   //! @param theNewLayerId  [in] id of new layer, should be > 0 (negative values are reserved for default layers).
0102   //! @param theSettings    [in] new layer settings
0103   //! @param theLayerBefore [in] id of layer to append new layer after
0104   Standard_EXPORT virtual void InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId,
0105                                                  const Graphic3d_ZLayerSettings& theSettings,
0106                                                  const Graphic3d_ZLayerId theLayerBefore) = 0;
0107
0108   //! Removes Z layer. All structures displayed at the moment in layer will be displayed in
0109   //! default layer (the bottom-level z layer). By default, there are always default
0110   //! bottom-level layer that can't be removed.  The passed theLayerId should be not less than 0
0111   //! (reserved for default layers that can not be removed).
0112   Standard_EXPORT virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) = 0;
0113
0114   //! Returns list of Z layers defined for the graphical driver.
0115   Standard_EXPORT virtual void ZLayers (TColStd_SequenceOfInteger& theLayerSeq) const;
0116
0117   //! Sets the settings for a single Z layer.
0118   Standard_EXPORT virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings& theSettings) = 0;
0119
0120   //! Returns the settings of a single Z layer.
0121   Standard_EXPORT virtual const Graphic3d_ZLayerSettings& ZLayerSettings (const Graphic3d_ZLayerId theLayerId) const;
0122
0123   //! Returns view associated with the window if it is exists and is activated.
0124   //! Returns Standard_True if the view associated to the window exists.
0125   virtual Standard_Boolean ViewExists (const Handle(Aspect_Window)& theWindow, Handle(Graphic3d_CView)& theView) = 0;
0126
0127   //! returns Handle to display connection
0128   Standard_EXPORT const Handle(Aspect_DisplayConnection)& GetDisplayConnection() const;
0129
0130   //! Returns a new identification number for a new structure.
0131   Standard_EXPORT Standard_Integer NewIdentification();
0132
0133   //! Frees the identifier of a structure.
0134   Standard_EXPORT void RemoveIdentification(const Standard_Integer theId);
0135
0136   //! Dumps the content of me into the stream
0137   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
0138
0139 protected:
0140
0141   //! Initializes the Driver
0142   Standard_EXPORT Graphic3d_GraphicDriver(const Handle(Aspect_DisplayConnection)& theDisp);
0143
0144 protected:
0145
0146   Handle(Aspect_DisplayConnection) myDisplayConnection;
0147   Aspect_GenId myStructGenId;
0148   NCollection_List<Handle(Graphic3d_Layer)> myLayers;
0149   NCollection_DataMap<Graphic3d_ZLayerId, Handle(Graphic3d_Layer)> myLayerIds;
0150
0151 };
0152
0153 #endif // _Graphic3d_GraphicDriver_HeaderFile