Radium Engine  1.5.20
Loading...
Searching...
No Matches
Ra::Core::Animation::HandleArray Class Reference

#include <Core/Animation/HandleArray.hpp>

+ Inheritance diagram for Ra::Core::Animation::HandleArray:
+ Collaboration diagram for Ra::Core::Animation::HandleArray:

Public Types

enum class  SpaceType : bool { LOCAL , MODEL }
 

Public Member Functions

 HandleArray (const uint n)
 
 HandleArray (const HandleArray &handle)=default
 
HandleArrayoperator= (const HandleArray &handle)=default
 
virtual uint size () const
 
virtual void clear ()
 
virtual const PosegetPose (const SpaceType MODE) const
 
virtual void setPose (const Pose &pose, const SpaceType MODE)
 
virtual const Transform & getTransform (const uint i, const SpaceType MODE) const
 
virtual void setTransform (const uint i, const Transform &T, const SpaceType MODE)
 
Label getName () const
 
void setName (const Label &name)
 
Label getLabel (const uint i) const
 
void setLabel (const uint i, const Label &text)
 

Public Attributes

LocalPose m_pose
 

Protected Attributes

Label m_name
 
std::vector< Labelm_label
 

Detailed Description

The HandleArray class describes the base handle structure used for deformation.

Definition at line 19 of file HandleArray.hpp.

Member Enumeration Documentation

◆ SpaceType

The SpaceType specifies the space the transform lives in.

Definition at line 25 of file HandleArray.hpp.

Constructor & Destructor Documentation

◆ HandleArray() [1/2]

Ra::Core::Animation::HandleArray::HandleArray ( )

Definition at line 7 of file HandleArray.cpp.

◆ HandleArray() [2/2]

Ra::Core::Animation::HandleArray::HandleArray ( const uint n)
explicit

Definition at line 9 of file HandleArray.cpp.

◆ ~HandleArray()

Ra::Core::Animation::HandleArray::~HandleArray ( )
virtual

Definition at line 12 of file HandleArray.cpp.

Member Function Documentation

◆ clear()

void Ra::Core::Animation::HandleArray::clear ( )
virtual

Clear the transformations data

Reimplemented in Ra::Core::Animation::Cage, and Ra::Core::Animation::Skeleton.

Definition at line 14 of file HandleArray.cpp.

◆ getLabel()

Label Ra::Core::Animation::HandleArray::getLabel ( const uint i) const
inline
Returns
the name of the i-th transform.

Definition at line 104 of file HandleArray.hpp.

+ Here is the call graph for this function:

◆ getName()

Label Ra::Core::Animation::HandleArray::getName ( ) const
inline
Returns
the Handle's name

Definition at line 70 of file HandleArray.hpp.

◆ getPose()

const Pose & Ra::Core::Animation::HandleArray::getPose ( const SpaceType MODE) const
virtual
Returns
the current pose in the MODE space.

Reimplemented in Ra::Core::Animation::Skeleton.

Definition at line 18 of file HandleArray.cpp.

◆ getTransform()

const Transform & Ra::Core::Animation::HandleArray::getTransform ( const uint i,
const SpaceType MODE ) const
virtual
Returns
the i-th transformation in MODE space.

Reimplemented in Ra::Core::Animation::Skeleton.

Definition at line 26 of file HandleArray.cpp.

◆ setLabel()

void Ra::Core::Animation::HandleArray::setLabel ( const uint i,
const Label & text )
inline

Set the name of the i-th transform.

Definition at line 109 of file HandleArray.hpp.

+ Here is the call graph for this function:

◆ setName()

void Ra::Core::Animation::HandleArray::setName ( const Label & name)
inline

Set the Handle's name

Definition at line 75 of file HandleArray.hpp.

◆ setPose()

void Ra::Core::Animation::HandleArray::setPose ( const Pose & pose,
const SpaceType MODE )
virtual

Set the current pose.

Parameters
posethe new pose
MODEthe space the psoe lives in

Reimplemented in Ra::Core::Animation::Skeleton.

Definition at line 22 of file HandleArray.cpp.

◆ setTransform()

void Ra::Core::Animation::HandleArray::setTransform ( const uint i,
const Transform & T,
const SpaceType MODE )
virtual

Set the i-th transform to T, which is given in the MODE space.

Reimplemented in Ra::Core::Animation::Skeleton.

Definition at line 31 of file HandleArray.cpp.

◆ size()

virtual uint Ra::Core::Animation::HandleArray::size ( ) const
inlinevirtual
Returns
the number of transformations

Reimplemented in Ra::Core::Animation::Skeleton.

Definition at line 38 of file HandleArray.hpp.

Member Data Documentation

◆ m_label

std::vector<Label> Ra::Core::Animation::HandleArray::m_label
protected

The names of the transforms.

Definition at line 101 of file HandleArray.hpp.

◆ m_name

Label Ra::Core::Animation::HandleArray::m_name
protected

The Handle's name

Definition at line 96 of file HandleArray.hpp.

◆ m_pose

LocalPose Ra::Core::Animation::HandleArray::m_pose

The current pose of the Handle

Definition at line 90 of file HandleArray.hpp.


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