Open CASCADE Technology  7.5.0
Public Member Functions

OpenGl_CappingPlaneResource Class Reference

Container of graphical resources for rendering capping plane associated to graphical clipping plane. This resource holds data necessary for OpenGl_CappingAlgo. This object is implemented as OpenGl resource for the following reasons: More...

#include <OpenGl_CappingPlaneResource.hxx>

Inheritance diagram for OpenGl_CappingPlaneResource:
Inheritance graph
[legend]

Public Member Functions

 OpenGl_CappingPlaneResource (const Handle< Graphic3d_ClipPlane > &thePlane)
 Constructor. Create capping plane presentation associated to clipping plane data. More...
 
virtual ~OpenGl_CappingPlaneResource ()
 Destroy object. More...
 
void Update (const Handle< OpenGl_Context > &theContext, const Handle< Graphic3d_Aspects > &theObjAspect)
 Update resource data in the passed context. More...
 
virtual void Release (OpenGl_Context *theContext) override
 Release associated OpenGl resources. More...
 
virtual Standard_Size EstimatedDataSize () const override
 Returns estimated GPU memory usage - not implemented. More...
 
const Handle< Graphic3d_ClipPlane > & Plane () const
 Return parent clipping plane structure. More...
 
const OpenGl_AspectsAspectFace () const
 
const OpenGl_MatrixOrientation () const
 
const OpenGl_PrimitiveArrayPrimitives () const
 
- Public Member Functions inherited from OpenGl_Resource
 OpenGl_Resource ()
 Empty constructor. More...
 
virtual ~OpenGl_Resource ()
 Destructor. Inheritors should call Clean (NULL) within it. More...
 
virtual 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...
 

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...
 

Detailed Description

Container of graphical resources for rendering capping plane associated to graphical clipping plane. This resource holds data necessary for OpenGl_CappingAlgo. This object is implemented as OpenGl resource for the following reasons:

Constructor & Destructor Documentation

◆ OpenGl_CappingPlaneResource()

OpenGl_CappingPlaneResource::OpenGl_CappingPlaneResource ( const Handle< Graphic3d_ClipPlane > &  thePlane)

Constructor. Create capping plane presentation associated to clipping plane data.

Parameters
thePlane[in] the plane data.

◆ ~OpenGl_CappingPlaneResource()

virtual OpenGl_CappingPlaneResource::~OpenGl_CappingPlaneResource ( )
virtual

Destroy object.

Member Function Documentation

◆ AspectFace()

const OpenGl_Aspects* OpenGl_CappingPlaneResource::AspectFace ( ) const
inline
Returns
aspect face for rendering capping surface.

◆ EstimatedDataSize()

virtual Standard_Size OpenGl_CappingPlaneResource::EstimatedDataSize ( ) const
inlineoverridevirtual

Returns estimated GPU memory usage - not implemented.

Implements OpenGl_Resource.

◆ Orientation()

const OpenGl_Matrix* OpenGl_CappingPlaneResource::Orientation ( ) const
inline
Returns
evaluated orientation matrix to transform infinite plane.

◆ Plane()

const Handle< Graphic3d_ClipPlane >& OpenGl_CappingPlaneResource::Plane ( ) const
inline

Return parent clipping plane structure.

◆ Primitives()

const OpenGl_PrimitiveArray& OpenGl_CappingPlaneResource::Primitives ( ) const
inline
Returns
primitive array of vertices to render infinite plane.

◆ Release()

virtual void OpenGl_CappingPlaneResource::Release ( OpenGl_Context theContext)
overridevirtual

Release associated OpenGl resources.

Parameters
theContext[in] the resource context.

Implements OpenGl_Resource.

◆ Update()

void OpenGl_CappingPlaneResource::Update ( const Handle< OpenGl_Context > &  theContext,
const Handle< Graphic3d_Aspects > &  theObjAspect 
)

Update resource data in the passed context.

Parameters
theContext[in] the context
theObjAspect[in] object aspect

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