castor3d::MeshAnimation Class Reference

#include <MeshAnimation.hpp>

Inheritance diagram for castor3d::MeshAnimation:

Collaboration diagram for castor3d::MeshAnimation:

Public Member Functions
C3D_API	MeshAnimation (Mesh &mesh, castor::String const &name=castor::cuEmptyString)
	Constructor. More...
C3D_API void	addChild (MeshAnimationSubmesh object)
	adds a child to this object. More...
MeshAnimationSubmesh &	getSubmesh (uint32_t index)
C3D_API	MeshAnimation (MeshAnimation &&rhs)=default
C3D_API MeshAnimation &	operator= (MeshAnimation &&rhs)=delete
C3D_API	MeshAnimation (MeshAnimation const &rhs)=delete
C3D_API MeshAnimation &	operator= (MeshAnimation const &rhs)=delete
Public Member Functions inherited from castor3d::AnimationT< Engine >
	AnimationT (Engine &handler, AnimationType type, AnimableT< Engine > &animable, castor::String const &name=castor::cuEmptyString)
	Constructor. More...
	AnimationT (Engine &handler, AnimationType type, castor::String const &name=castor::cuEmptyString)
	Constructor. More...
void	addKeyFrame (AnimationKeyFrameUPtr keyFrame)
	Adds a keyframe to the animation. More...
AnimationKeyFrameArray::iterator	find (castor::Milliseconds const &time)
	Finds a keyframe given a time index. More...
void	findKeyFrame (castor::Milliseconds const &time, AnimationKeyFrameArray::iterator &prv, AnimationKeyFrameArray::iterator &cur) const
	Finds a keyframe given a time index. More...
void	updateLength ()
	Updates the animation length. More...
bool	isEmpty () const
AnimationKeyFrameArray::const_iterator	begin () const
AnimationKeyFrameArray::iterator	begin ()
AnimationKeyFrameArray::const_iterator	end () const
AnimationKeyFrameArray::iterator	end ()
AnimationType	getType () const
castor::Milliseconds const &	getLength () const
AnimableT< Engine > *	getAnimable () const
C3D_API	AnimationT (AnimationT &&rhs)=default
C3D_API	AnimationT (AnimationT const &rhs)=delete
C3D_API AnimationT &	operator= (AnimationT &&rhs)=delete
C3D_API AnimationT &	operator= (AnimationT const &rhs)=delete
virtual C3D_API	~AnimationT ()=default

Protected Attributes
MeshAnimationSubmeshArray	m_submeshes
Protected Attributes inherited from castor3d::AnimationT< Engine >
AnimableT< Engine > *	m_animable
AnimationType	m_type
castor::Milliseconds	m_length
AnimationKeyFrameArray	m_keyframes

Friends
class	BinaryWriter< MeshAnimation >
class	BinaryParser< MeshAnimation >
class	MeshAnimationInstance

Constructor & Destructor Documentation

MeshAnimation() [1/3]

C3D_API castor3d::MeshAnimation::MeshAnimation ( MeshAnimation &&  rhs )

default

name Copy / Move.

MeshAnimation() [2/3]

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

delete

MeshAnimation() [3/3]

C3D_API castor3d::MeshAnimation::MeshAnimation ( Mesh &  mesh, castor::String const &  name = castor::cuEmptyString  )

explicit

Constructor.

Parameters

[in]	mesh	The parent mesh.
[in]	name	The name of the animation.

Member Function Documentation

addChild()

C3D_API void castor3d::MeshAnimation::addChild

(

MeshAnimationSubmesh

object

)

adds a child to this object.

Remarks

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

Parameters

[in]

object

The child.

getSubmesh()

MeshAnimationSubmesh & castor3d::MeshAnimation::getSubmesh ( uint32_t  index )

inline

Parameters

[in]

index

The index.

Returns

The animated submesh at given index.

References m_submeshes.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

Friends And Related Function Documentation

BinaryParser< MeshAnimation >

friend class BinaryParser< MeshAnimation >

friend

BinaryWriter< MeshAnimation >

friend class BinaryWriter< MeshAnimation >

friend

MeshAnimationInstance

friend class MeshAnimationInstance

friend

Member Data Documentation

m_submeshes

MeshAnimationSubmeshArray castor3d::MeshAnimation::m_submeshes

protected

The animated submesh.

Referenced by getSubmesh().

---

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

• Model/Mesh/Animation/MeshAnimation.hpp