Open CASCADE Technology  7.4.1.dev
Public Member Functions | Protected Attributes
Aspect_XRAction Class Reference

XR action definition. More...

#include <Aspect_XRAction.hxx>

Inheritance diagram for Aspect_XRAction:
Inheritance graph
[legend]

Public Member Functions

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

TCollection_AsciiString myId
 action id More...
 
uint64_t myRawHandle
 action handle More...
 
Aspect_XRActionType myType
 action type 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

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: