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:

Public Member Functions
	OpenGl_CappingPlaneResource (const Handle< Graphic3d_ClipPlane > &thePlane)
	Constructor. Create capping plane presentation associated to clipping plane data.
virtual	~OpenGl_CappingPlaneResource ()
	Destroy object.
void	Update (const Handle< OpenGl_Context > &theContext, const Handle< Graphic3d_Aspects > &theObjAspect)
	Update resource data in the passed context.
virtual void	Release (OpenGl_Context *theContext) override
	Release associated OpenGl resources.
virtual Standard_Size	EstimatedDataSize () const override
	Returns estimated GPU memory usage - not implemented.
const Handle< Graphic3d_ClipPlane > &	Plane () const
	Return parent clipping plane structure.
const OpenGl_Aspects *	AspectFace () const
const OpenGl_Mat4 &	Orientation () const
const OpenGl_PrimitiveArray &	Primitives () const
Public Member Functions inherited from OpenGl_Resource
	OpenGl_Resource ()
	Empty constructor.
virtual	~OpenGl_Resource ()
	Destructor. Inheritors should call Clean (NULL) within it.
virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
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.
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.
Standard_Transient *	This () 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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

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:

• one instance should be shared between contexts.
• instance associated to Graphic3d_ClipPlane data by id.
• should created and released within context (owns OpenGl elements and resources).

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_Mat4 & 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:

• OpenGl_CappingPlaneResource.hxx