castor3d::SkeletonAnimationObject Class Reference

#include <SkeletonAnimationObject.hpp>

Inheritance diagram for castor3d::SkeletonAnimationObject:

Collaboration diagram for castor3d::SkeletonAnimationObject:

Public Member Functions
virtual C3D_API	~SkeletonAnimationObject () noexcept=default
	Destructor.
C3D_API void	addChild (SkeletonAnimationObjectRPtr object)
	adds a child to this object.
virtual C3D_API castor::String const &	getName () const =0
	Retrieves the object name.
virtual C3D_API NodeTransform const &	getNodeTransform () const noexcept=0
InterpolatorType	getInterpolationMode () const
SkeletonNodeType	getType () const
SkeletonAnimationObjectArray const &	getChildren () const
SkeletonAnimationObjectRPtr	getParent () const
Public Member Functions inherited from castor::OwnedBy< SkeletonAnimation >
SkeletonAnimation *	getOwner () const

Protected Member Functions
C3D_API	SkeletonAnimationObject (SkeletonAnimationObject const &rhs)=default
C3D_API	SkeletonAnimationObject (SkeletonAnimationObject &&rhs) noexcept=default
C3D_API SkeletonAnimationObject &	operator= (SkeletonAnimationObject const &rhs)=default
C3D_API SkeletonAnimationObject &	operator= (SkeletonAnimationObject &&rhs) noexcept=default
C3D_API	SkeletonAnimationObject (SkeletonAnimation &animation, SkeletonNodeType type)
	Constructor.
Protected Member Functions inherited from castor::OwnedBy< SkeletonAnimation >
	OwnedBy (SkeletonAnimation &owner)
	Constructor.

Protected Attributes
InterpolatorType	m_mode { InterpolatorType::eCount }
SkeletonNodeType	m_type
SkeletonAnimationObjectArray	m_children
SkeletonAnimationObjectRPtr	m_parent {}
castor::BoundingBox	m_boundingBox

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

Constructor & Destructor Documentation

SkeletonAnimationObject() [1/3]

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

protecteddefault

SkeletonAnimationObject() [2/3]

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

protecteddefaultnoexcept

SkeletonAnimationObject() [3/3]

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

protected

Constructor.

Parameters

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

~SkeletonAnimationObject()

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

virtualdefaultnoexcept

Destructor.

Member Function Documentation

addChild()

C3D_API void castor3d::SkeletonAnimationObject::addChild

(

SkeletonAnimationObjectRPtr

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()

SkeletonAnimationObjectArray 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()

virtual C3D_API NodeTransform const & castor3d::SkeletonAnimationObject::getNodeTransform ( ) const

pure virtualnoexcept

Returns

The object's node transform.

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

getParent()

SkeletonAnimationObjectRPtr castor3d::SkeletonAnimationObject::getParent ( ) const

inline

Returns

The parent object.

References m_parent.

getType()

SkeletonNodeType castor3d::SkeletonAnimationObject::getType ( ) const

inline

Returns

The moving object type.

References m_type.

operator=() [1/2]

C3D_API SkeletonAnimationObject & castor3d::SkeletonAnimationObject::operator= ( SkeletonAnimationObject && rhs )

protecteddefaultnoexcept

operator=() [2/2]

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

protecteddefault

Friends And Related Symbol 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

SkeletonAnimationObjectArray 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_parent

SkeletonAnimationObjectRPtr castor3d::SkeletonAnimationObject::m_parent {}

protected

The parent object.

Referenced by getParent().

m_type

SkeletonNodeType castor3d::SkeletonAnimationObject::m_type

protected

The moving thing type.

Referenced by getType().

---

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

• Castor3D/Model/Skeleton/Animation/SkeletonAnimationObject.hpp