Open CASCADE Technology  7.5.0.beta
Public Member Functions | Protected Attributes
OpenGl_GraphicDriver Class Reference

This class defines an OpenGl graphic driver. More...

#include <OpenGl_GraphicDriver.hxx>

Inheritance diagram for OpenGl_GraphicDriver:
Inheritance graph
[legend]

Public Member Functions

 OpenGl_GraphicDriver (const Handle< Aspect_DisplayConnection > &theDisp, const Standard_Boolean theToInitialize=Standard_True)
 Constructor. More...
 
virtual ~OpenGl_GraphicDriver ()
 Destructor. More...
 
void ReleaseContext ()
 Release default context. More...
 
Standard_Boolean InitContext ()
 Perform initialization of default OpenGL context. More...
 
virtual Standard_Integer InquireLimit (const Graphic3d_TypeOfLimit theType) const override
 Request limit of graphic resource of specific type. More...
 
virtual Handle< Graphic3d_CStructureCreateStructure (const Handle< Graphic3d_StructureManager > &theManager) override
 Creates new empty graphic structure. More...
 
virtual void RemoveStructure (Handle< Graphic3d_CStructure > &theCStructure) override
 Removes structure from graphic driver and releases its resources. More...
 
virtual Handle< Graphic3d_CViewCreateView (const Handle< Graphic3d_StructureManager > &theMgr) override
 Creates new view for this graphic driver. More...
 
virtual void RemoveView (const Handle< Graphic3d_CView > &theView) override
 Removes view from graphic driver and releases its resources. More...
 
virtual Handle< OpenGl_WindowCreateRenderWindow (const Handle< Aspect_Window > &theWindow, const Aspect_RenderingContext theContext)
 
void TextSize (const Handle< Graphic3d_CView > &theView, const Standard_CString theText, const Standard_ShortReal theHeight, Standard_ShortReal &theWidth, Standard_ShortReal &theAscent, Standard_ShortReal &theDescent) const override
 Computes text width. More...
 
Standard_ShortReal DefaultTextHeight () const override
 
Standard_Boolean ViewExists (const Handle< Aspect_Window > &theWindow, Handle< Graphic3d_CView > &theView) override
 Returns view associated with the window if it is exists and is activated. Returns Standard_True if the view associated to the window exists. More...
 
virtual void InsertLayerBefore (const Graphic3d_ZLayerId theNewLayerId, const Graphic3d_ZLayerSettings &theSettings, const Graphic3d_ZLayerId theLayerAfter) override
 Adds a layer to all views. More...
 
virtual void InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId, const Graphic3d_ZLayerSettings &theSettings, const Graphic3d_ZLayerId theLayerBefore) override
 Adds a layer to all views. More...
 
void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) override
 Removes Z layer. All structures displayed at the moment in layer will be displayed in default layer (the bottom-level z layer). By default, there are always default bottom-level layer that can't be removed. The passed theLayerId should be not less than 0 (reserved for default layers that can not be removed). More...
 
void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings &theSettings) override
 Sets the settings for a single Z layer. More...
 
const OpenGl_CapsOptions () const
 
OpenGl_CapsChangeOptions ()
 
void SetBuffersNoSwap (const Standard_Boolean theIsNoSwap)
 Specify swap buffer behavior. More...
 
void EnableVBO (const Standard_Boolean theToTurnOn) override
 VBO usage can be forbidden by this method even if it is supported by GL driver. Notice that disabling of VBO will cause rendering performance degradation. Warning! This method should be called only before any primitives are displayed in GL scene! More...
 
Standard_Boolean MemoryInfo (Standard_Size &theFreeBytes, TCollection_AsciiString &theInfo) const override
 Returns information about GPU memory usage. Please read OpenGl_Context::MemoryInfo() for more description. More...
 
const Handle< OpenGl_Context > & GetSharedContext (bool theBound=false) const
 Method to retrieve valid GL context. Could return NULL-handle if no window created by this driver. More...
 
void setDeviceLost ()
 Set device lost flag for redrawn views. More...
 
OpenGl_StateCounterGetStateCounter () const
 State counter for OpenGl structures. More...
 
Standard_Size GetNextPrimitiveArrayUID () const
 Returns unique ID for primitive arrays. More...
 
- Public Member Functions inherited from Graphic3d_GraphicDriver
Standard_Integer InquireLightLimit () const
 Request maximum number of active light sources supported by driver and hardware. More...
 
Standard_Integer InquirePlaneLimit () const
 Request maximum number of active clipping planes supported by driver and hardware. More...
 
Standard_Integer InquireViewLimit () const
 Request maximum number of views supported by driver. More...
 
virtual void ZLayers (TColStd_SequenceOfInteger &theLayerSeq) const
 Returns list of Z layers defined for the graphical driver. More...
 
virtual const Graphic3d_ZLayerSettingsZLayerSettings (const Graphic3d_ZLayerId theLayerId) const
 Returns the settings of a single Z layer. More...
 
const Handle< Aspect_DisplayConnection > & GetDisplayConnection () const
 returns Handle to display connection More...
 
Standard_Integer NewIdentification ()
 Returns a new identification number for a new structure. More...
 
void RemoveIdentification (const Standard_Integer theId)
 Frees the identifier of a structure. More...
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Attributes

Standard_Boolean myIsOwnContext
 indicates that shared context has been created within OpenGl_GraphicDriver More...
 
Handle< OpenGl_CapsmyCaps
 
NCollection_Map< Handle< OpenGl_View > > myMapOfView
 
NCollection_DataMap< Standard_Integer, OpenGl_Structure * > myMapOfStructure
 
OpenGl_StateCounter myStateCounter
 State counter for OpenGl structures. More...
 
OpenGl_StateCounter myUIDGenerator
 Unique ID counter for primitive arrays. More...
 
- Protected Attributes inherited from Graphic3d_GraphicDriver
Handle< Aspect_DisplayConnectionmyDisplayConnection
 
Aspect_GenId myStructGenId
 
NCollection_List< Handle< Graphic3d_Layer > > myLayers
 
NCollection_DataMap< Graphic3d_ZLayerId, Handle< Graphic3d_Layer > > myLayerIds
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from Graphic3d_GraphicDriver
 Graphic3d_GraphicDriver (const Handle< Aspect_DisplayConnection > &theDisp)
 Initializes the Driver. More...
 

Detailed Description

This class defines an OpenGl graphic driver.

Constructor & Destructor Documentation

◆ OpenGl_GraphicDriver()

OpenGl_GraphicDriver::OpenGl_GraphicDriver ( const Handle< Aspect_DisplayConnection > &  theDisp,
const Standard_Boolean  theToInitialize = Standard_True 
)

Constructor.

Parameters
theDispconnection to display, required on Linux but optional on other systems
theToInitializeperform initialization of default OpenGL context on construction

◆ ~OpenGl_GraphicDriver()

virtual OpenGl_GraphicDriver::~OpenGl_GraphicDriver ( )
virtual

Destructor.

Member Function Documentation

◆ ChangeOptions()

OpenGl_Caps& OpenGl_GraphicDriver::ChangeOptions ( )
inline
Returns
the visualization options

◆ CreateRenderWindow()

virtual Handle< OpenGl_Window > OpenGl_GraphicDriver::CreateRenderWindow ( const Handle< Aspect_Window > &  theWindow,
const Aspect_RenderingContext  theContext 
)
virtual

◆ CreateStructure()

virtual Handle< Graphic3d_CStructure > OpenGl_GraphicDriver::CreateStructure ( const Handle< Graphic3d_StructureManager > &  theManager)
overridevirtual

Creates new empty graphic structure.

Implements Graphic3d_GraphicDriver.

◆ CreateView()

virtual Handle< Graphic3d_CView > OpenGl_GraphicDriver::CreateView ( const Handle< Graphic3d_StructureManager > &  theMgr)
overridevirtual

Creates new view for this graphic driver.

Implements Graphic3d_GraphicDriver.

◆ DefaultTextHeight()

Standard_ShortReal OpenGl_GraphicDriver::DefaultTextHeight ( ) const
overridevirtual

◆ EnableVBO()

void OpenGl_GraphicDriver::EnableVBO ( const Standard_Boolean  theToTurnOn)
overridevirtual

VBO usage can be forbidden by this method even if it is supported by GL driver. Notice that disabling of VBO will cause rendering performance degradation. Warning! This method should be called only before any primitives are displayed in GL scene!

Implements Graphic3d_GraphicDriver.

◆ GetNextPrimitiveArrayUID()

Standard_Size OpenGl_GraphicDriver::GetNextPrimitiveArrayUID ( ) const
inline

Returns unique ID for primitive arrays.

◆ GetSharedContext()

const Handle< OpenGl_Context >& OpenGl_GraphicDriver::GetSharedContext ( bool  theBound = false) const

Method to retrieve valid GL context. Could return NULL-handle if no window created by this driver.

Parameters
theBoundif TRUE then currently bound context will be returned, any context will be returned otherwise

◆ GetStateCounter()

OpenGl_StateCounter* OpenGl_GraphicDriver::GetStateCounter ( ) const
inline

State counter for OpenGl structures.

◆ InitContext()

Standard_Boolean OpenGl_GraphicDriver::InitContext ( )

Perform initialization of default OpenGL context.

◆ InquireLimit()

virtual Standard_Integer OpenGl_GraphicDriver::InquireLimit ( const Graphic3d_TypeOfLimit  theType) const
overridevirtual

Request limit of graphic resource of specific type.

Implements Graphic3d_GraphicDriver.

◆ InsertLayerAfter()

virtual void OpenGl_GraphicDriver::InsertLayerAfter ( const Graphic3d_ZLayerId  theNewLayerId,
const Graphic3d_ZLayerSettings theSettings,
const Graphic3d_ZLayerId  theLayerBefore 
)
overridevirtual

Adds a layer to all views.

Parameters
theLayerId[in] id of created layer
theSettings[in] new layer settings
theLayerBefore[in] id of layer to append new layer after

Implements Graphic3d_GraphicDriver.

◆ InsertLayerBefore()

virtual void OpenGl_GraphicDriver::InsertLayerBefore ( const Graphic3d_ZLayerId  theNewLayerId,
const Graphic3d_ZLayerSettings theSettings,
const Graphic3d_ZLayerId  theLayerAfter 
)
overridevirtual

Adds a layer to all views.

Parameters
theLayerId[in] id of new layer, should be > 0 (negative values are reserved for default layers).
theSettings[in] new layer settings
theLayerAfter[in] id of layer to append new layer before

Implements Graphic3d_GraphicDriver.

◆ MemoryInfo()

Standard_Boolean OpenGl_GraphicDriver::MemoryInfo ( Standard_Size theFreeBytes,
TCollection_AsciiString theInfo 
) const
overridevirtual

Returns information about GPU memory usage. Please read OpenGl_Context::MemoryInfo() for more description.

Implements Graphic3d_GraphicDriver.

◆ Options()

const OpenGl_Caps& OpenGl_GraphicDriver::Options ( ) const
inline
Returns
the visualization options

◆ ReleaseContext()

void OpenGl_GraphicDriver::ReleaseContext ( )

Release default context.

◆ RemoveStructure()

virtual void OpenGl_GraphicDriver::RemoveStructure ( Handle< Graphic3d_CStructure > &  theCStructure)
overridevirtual

Removes structure from graphic driver and releases its resources.

Implements Graphic3d_GraphicDriver.

◆ RemoveView()

virtual void OpenGl_GraphicDriver::RemoveView ( const Handle< Graphic3d_CView > &  theView)
overridevirtual

Removes view from graphic driver and releases its resources.

Implements Graphic3d_GraphicDriver.

◆ RemoveZLayer()

void OpenGl_GraphicDriver::RemoveZLayer ( const Graphic3d_ZLayerId  theLayerId)
overridevirtual

Removes Z layer. All structures displayed at the moment in layer will be displayed in default layer (the bottom-level z layer). By default, there are always default bottom-level layer that can't be removed. The passed theLayerId should be not less than 0 (reserved for default layers that can not be removed).

Implements Graphic3d_GraphicDriver.

◆ SetBuffersNoSwap()

void OpenGl_GraphicDriver::SetBuffersNoSwap ( const Standard_Boolean  theIsNoSwap)

Specify swap buffer behavior.

◆ setDeviceLost()

void OpenGl_GraphicDriver::setDeviceLost ( )

Set device lost flag for redrawn views.

◆ SetZLayerSettings()

void OpenGl_GraphicDriver::SetZLayerSettings ( const Graphic3d_ZLayerId  theLayerId,
const Graphic3d_ZLayerSettings theSettings 
)
overridevirtual

Sets the settings for a single Z layer.

Implements Graphic3d_GraphicDriver.

◆ TextSize()

void OpenGl_GraphicDriver::TextSize ( const Handle< Graphic3d_CView > &  theView,
const Standard_CString  theText,
const Standard_ShortReal  theHeight,
Standard_ShortReal theWidth,
Standard_ShortReal theAscent,
Standard_ShortReal theDescent 
) const
overridevirtual

Computes text width.

Implements Graphic3d_GraphicDriver.

◆ ViewExists()

Standard_Boolean OpenGl_GraphicDriver::ViewExists ( const Handle< Aspect_Window > &  theWindow,
Handle< Graphic3d_CView > &  theView 
)
overridevirtual

Returns view associated with the window if it is exists and is activated. Returns Standard_True if the view associated to the window exists.

Implements Graphic3d_GraphicDriver.

Field Documentation

◆ myCaps

Handle< OpenGl_Caps > OpenGl_GraphicDriver::myCaps
protected

◆ myIsOwnContext

Standard_Boolean OpenGl_GraphicDriver::myIsOwnContext
protected

indicates that shared context has been created within OpenGl_GraphicDriver

◆ myMapOfStructure

NCollection_DataMap<Standard_Integer, OpenGl_Structure*> OpenGl_GraphicDriver::myMapOfStructure
protected

◆ myMapOfView

NCollection_Map<Handle< OpenGl_View > > OpenGl_GraphicDriver::myMapOfView
protected

◆ myStateCounter

OpenGl_StateCounter OpenGl_GraphicDriver::myStateCounter
mutableprotected

State counter for OpenGl structures.

◆ myUIDGenerator

OpenGl_StateCounter OpenGl_GraphicDriver::myUIDGenerator
mutableprotected

Unique ID counter for primitive arrays.


The documentation for this class was generated from the following file: