Aspect_XRAction Class Reference

XR action definition. More...

#include <Aspect_XRAction.hxx>

Inheritance diagram for Aspect_XRAction:

Public Member Functions
const TCollection_AsciiString &	Id () const
	Return action id.
Aspect_XRActionType	Type () const
	Return action type.
bool	IsValid () const
	Return TRUE if action is defined.
uint64_t	RawHandle () const
	Return action handle.
void	SetRawHandle (uint64_t theHande)
	Set action handle.
	Aspect_XRAction (const TCollection_AsciiString &theId, const Aspect_XRActionType theType)
	Main constructor.
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.

Protected Attributes
TCollection_AsciiString	myId
	action id
uint64_t	myRawHandle
	action handle
Aspect_XRActionType	myType
	action type

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

XR action definition.

Constructor & Destructor Documentation

Aspect_XRAction()

Aspect_XRAction::Aspect_XRAction ( const TCollection_AsciiString & theId, const Aspect_XRActionType theType )

inline

Main constructor.

Member Function Documentation

Id()

const TCollection_AsciiString & Aspect_XRAction::Id ( ) const

inline

Return action id.

IsValid()

bool Aspect_XRAction::IsValid ( ) const

inline

Return TRUE if action is defined.

RawHandle()

uint64_t Aspect_XRAction::RawHandle ( ) const

inline

Return action handle.

SetRawHandle()

void Aspect_XRAction::SetRawHandle ( uint64_t theHande )

inline

Set action handle.

Type()

Aspect_XRActionType Aspect_XRAction::Type ( ) const

inline

Return action type.

Field Documentation

myId

TCollection_AsciiString Aspect_XRAction::myId

protected

action id

myRawHandle

uint64_t Aspect_XRAction::myRawHandle

protected

action handle

myType

Aspect_XRActionType Aspect_XRAction::myType

protected

action type

---

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

• Aspect_XRAction.hxx