castor3d::AnimatedMesh Class Reference

#include <AnimatedMesh.hpp>

Inheritance diagram for castor3d::AnimatedMesh:

Collaboration diagram for castor3d::AnimatedMesh:

Public Member Functions
C3D_API	AnimatedMesh (castor::String const &name, Mesh &mesh, Geometry &geometry)
	Constructor. More...
C3D_API void	update (castor::Milliseconds const &elapsed) override
	Updates the animations of the object, given the time since the last frame. More...
bool	isPlayingAnimation () const override
Mesh &	getMesh () const
Geometry &	getGeometry () const
uint32_t	getId () const
void	setId (uint32_t id)
MeshAnimationInstance &	getPlayingAnimation () const
C3D_API	AnimatedMesh (AnimatedMesh &&rhs)=default
C3D_API AnimatedMesh &	operator= (AnimatedMesh &&rhs)=delete
C3D_API	AnimatedMesh (AnimatedMesh const &rhs)=delete
C3D_API AnimatedMesh &	operator= (AnimatedMesh const &rhs)=delete
Public Member Functions inherited from castor3d::AnimatedObject
C3D_API	AnimatedObject (AnimationType kind, castor::String const &name)
	Constructor. More...
virtual C3D_API	~AnimatedObject ()=default
	Destructor. More...
C3D_API void	addAnimation (castor::String const &name)
	adds the animation to the list More...
C3D_API void	startAnimation (castor::String const &name)
	Starts the animation identified by the given name. More...
C3D_API void	stopAnimation (castor::String const &name)
	Stops the animation identified by the given name. More...
C3D_API void	pauseAnimation (castor::String const &name)
	Pauses the animation identified by the given name. More...
C3D_API void	startAllAnimations ()
	Starts all animations. More...
C3D_API void	stopAllAnimations ()
	Stops all animations. More...
C3D_API void	pauseAllAnimations ()
	Pauses all animations. More...
C3D_API AnimationInstance &	getAnimation (castor::String const &name)
	Retrieves an animation. More...
virtual C3D_API void	update (castor::Milliseconds const &elapsed)=0
	Updates the animations of the object, given the time since the last frame. More...
virtual C3D_API bool	isPlayingAnimation () const =0
C3D_API	AnimatedObject (AnimatedObject &&rhs)=default
C3D_API AnimatedObject &	operator= (AnimatedObject &&rhs)=default
C3D_API	AnimatedObject (AnimatedObject const &rhs)=delete
C3D_API AnimatedObject &	operator= (AnimatedObject const &rhs)=delete
bool	hasAnimation (castor::String const &name)
AnimationInstancePtrStrMap const &	getAnimations () const
AnimationType	getKind () const

Protected Attributes
Mesh &	m_mesh
Geometry &	m_geometry
MeshAnimationInstanceRPtr	m_playingAnimation { nullptr }
uint32_t	m_id {}
Protected Attributes inherited from castor3d::AnimatedObject
AnimationInstancePtrStrMap	m_animations

Constructor & Destructor Documentation

AnimatedMesh() [1/3]

C3D_API castor3d::AnimatedMesh::AnimatedMesh ( AnimatedMesh &&  rhs )

default

name Copy / Move.

AnimatedMesh() [2/3]

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

delete

AnimatedMesh() [3/3]

C3D_API castor3d::AnimatedMesh::AnimatedMesh	(	castor::String const &	name,
		Mesh &	mesh,
		Geometry &	geometry
	)

Constructor.

Parameters

[in]	name	The object name.
[in]	mesh	The mesh.
[in]	geometry	The geometry instantiating the mesh.

Member Function Documentation

getGeometry()

Geometry & castor3d::AnimatedMesh::getGeometry ( ) const

inline

References m_geometry.

getId()

uint32_t castor3d::AnimatedMesh::getId ( ) const

inline

References m_id.

getMesh()

Mesh & castor3d::AnimatedMesh::getMesh ( ) const

inline

References m_mesh.

getPlayingAnimation()

MeshAnimationInstance & castor3d::AnimatedMesh::getPlayingAnimation ( ) const

inline

References m_playingAnimation.

isPlayingAnimation()

bool castor3d::AnimatedMesh::isPlayingAnimation ( ) const

inlineoverridevirtual

Returns

true if the object is playing an animation.

Implements castor3d::AnimatedObject.

References m_playingAnimation.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

setId()

void castor3d::AnimatedMesh::setId ( uint32_t  id )

inline

References m_id.

update()

C3D_API void castor3d::AnimatedMesh::update ( castor::Milliseconds const &  elapsed )

overridevirtual

Updates the animations of the object, given the time since the last frame.

Parameters

[in]

elapsed

Time elapsed since the last frame

Implements castor3d::AnimatedObject.

Member Data Documentation

m_geometry

Geometry& castor3d::AnimatedMesh::m_geometry

protected

Referenced by getGeometry().

m_id

uint32_t castor3d::AnimatedMesh::m_id {}

protected

Referenced by getId(), and setId().

m_mesh

Mesh& castor3d::AnimatedMesh::m_mesh

protected

Referenced by getMesh().

m_playingAnimation

MeshAnimationInstanceRPtr castor3d::AnimatedMesh::m_playingAnimation { nullptr }

protected

Referenced by getPlayingAnimation(), and isPlayingAnimation().

---

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

• Scene/Animation/AnimatedMesh.hpp