castor3d::SkeletonAnimationObject Class Reference

#include <SkeletonAnimationObject.hpp>

Inheritance diagram for castor3d::SkeletonAnimationObject:

Collaboration diagram for castor3d::SkeletonAnimationObject:

Public Member Functions
virtual C3D_API	~SkeletonAnimationObject ()=default
	Destructor. More...
C3D_API void	addChild (SkeletonAnimationObjectSPtr object)
	adds a child to this object. More...
virtual C3D_API castor::String const &	getName () const =0
	Retrieves the object name. More...
InterpolatorType	getInterpolationMode () const
SkeletonAnimationObjectType	getType () const
castor::Matrix4x4f const &	getNodeTransform () const
	Retrieves the animation node transformation. More...
void	setNodeTransform (castor::Matrix4x4f const &transform)
	Sets the animation node transformation. More...
SkeletonAnimationObjectPtrArray const &	getChildren () const
SkeletonAnimationObjectSPtr	getParent () const

Protected Member Functions
C3D_API	SkeletonAnimationObject (SkeletonAnimation &animation, SkeletonAnimationObjectType type)
	Constructor. More...
C3D_API	SkeletonAnimationObject (SkeletonAnimationObject const &rhs)=default
	Copy constructor. More...

Protected Attributes
InterpolatorType	m_mode { InterpolatorType::eCount }
SkeletonAnimationObjectType	m_type
castor::Matrix4x4f	m_nodeTransform
SkeletonAnimationObjectPtrArray	m_children
SkeletonAnimationObjectWPtr	m_parent
castor::BoundingBox	m_boundingBox

Friends
class	BinaryWriter< SkeletonAnimationObject >
class	BinaryParser< SkeletonAnimationObject >
class	SkeletonAnimationInstanceObject

Constructor & Destructor Documentation

SkeletonAnimationObject() [1/2]

C3D_API castor3d::SkeletonAnimationObject::SkeletonAnimationObject ( SkeletonAnimation &  animation, SkeletonAnimationObjectType  type  )

protected

Constructor.

Parameters

[in]	animation	The parent animation.
[in]	type	The skeleton animation object type.

SkeletonAnimationObject() [2/2]

C3D_API castor3d::SkeletonAnimationObject::SkeletonAnimationObject ( SkeletonAnimationObject const &  rhs )

protecteddefault

Copy constructor.

~SkeletonAnimationObject()

virtual C3D_API castor3d::SkeletonAnimationObject::~SkeletonAnimationObject ( )

virtualdefault

Destructor.

Member Function Documentation

addChild()

C3D_API void castor3d::SkeletonAnimationObject::addChild

(

SkeletonAnimationObjectSPtr

object

)

adds a child to this object.

Remarks

The child's transformations are affected by this object's ones.

Parameters

[in]

object

The child.

getChildren()

SkeletonAnimationObjectPtrArray const & castor3d::SkeletonAnimationObject::getChildren ( ) const

inline

Returns

The children array.

References m_children.

getInterpolationMode()

InterpolatorType castor3d::SkeletonAnimationObject::getInterpolationMode ( ) const

inline

Returns

The scaling key frames interpolation mode.

References m_mode.

getName()

virtual C3D_API castor::String const & castor3d::SkeletonAnimationObject::getName ( ) const

pure virtual

Retrieves the object name.

Returns

The name.

Implemented in castor3d::SkeletonAnimationBone, and castor3d::SkeletonAnimationNode.

getNodeTransform()

castor::Matrix4x4f const & castor3d::SkeletonAnimationObject::getNodeTransform ( ) const

inline

Retrieves the animation node transformation.

Returns

The value.

References m_nodeTransform.

getParent()

SkeletonAnimationObjectSPtr castor3d::SkeletonAnimationObject::getParent ( ) const

inline

Returns

The parent object.

References m_parent.

getType()

SkeletonAnimationObjectType castor3d::SkeletonAnimationObject::getType ( ) const

inline

Returns

The moving object type.

References m_type.

setNodeTransform()

void castor3d::SkeletonAnimationObject::setNodeTransform ( castor::Matrix4x4f const &  transform )

inline

Sets the animation node transformation.

Parameters

[in]

transform

The new value.

References m_nodeTransform.

Friends And Related Function Documentation

BinaryParser< SkeletonAnimationObject >

friend class BinaryParser< SkeletonAnimationObject >

friend

BinaryWriter< SkeletonAnimationObject >

friend class BinaryWriter< SkeletonAnimationObject >

friend

SkeletonAnimationInstanceObject

friend class SkeletonAnimationInstanceObject

friend

Member Data Documentation

m_boundingBox

castor::BoundingBox castor3d::SkeletonAnimationObject::m_boundingBox

protected

The bounding box.

m_children

SkeletonAnimationObjectPtrArray castor3d::SkeletonAnimationObject::m_children

protected

The objects depending on this one.

Referenced by getChildren().

m_mode

InterpolatorType castor3d::SkeletonAnimationObject::m_mode { InterpolatorType::eCount }

protected

The interpolation mode.

Referenced by getInterpolationMode().

m_nodeTransform

castor::Matrix4x4f castor3d::SkeletonAnimationObject::m_nodeTransform

protected

Animation node transformations.

Referenced by getNodeTransform(), and setNodeTransform().

m_parent

SkeletonAnimationObjectWPtr castor3d::SkeletonAnimationObject::m_parent

protected

The parent object.

Referenced by getParent().

m_type

SkeletonAnimationObjectType castor3d::SkeletonAnimationObject::m_type

protected

The moving thing type.

Referenced by getType().

---

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

• Model/Skeleton/Animation/SkeletonAnimationObject.hpp