castor3d::AnimatedSceneNode Class Reference

#include <AnimatedSceneNode.hpp>

Inheritance diagram for castor3d::AnimatedSceneNode:

Collaboration diagram for castor3d::AnimatedSceneNode:

Public Member Functions
C3D_API	AnimatedSceneNode (castor::String const &name, SceneNode &node)
	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...
C3D_API bool	isPlayingAnimation () const override
C3D_API	AnimatedSceneNode (AnimatedSceneNode &&rhs)=default
C3D_API AnimatedSceneNode &	operator= (AnimatedSceneNode &&rhs)=delete
C3D_API	AnimatedSceneNode (AnimatedSceneNode const &rhs)=delete
C3D_API AnimatedSceneNode &	operator= (AnimatedSceneNode const &rhs)=delete
SceneNode &	getSceneNode () const
SceneNodeAnimationInstance &	getPlayingAnimation () const
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

Additional Inherited Members
Protected Attributes inherited from castor3d::AnimatedObject
AnimationInstancePtrStrMap	m_animations

Constructor & Destructor Documentation

AnimatedSceneNode() [1/3]

C3D_API castor3d::AnimatedSceneNode::AnimatedSceneNode ( AnimatedSceneNode &&  rhs )

default

name Copy / Move.

AnimatedSceneNode() [2/3]

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

delete

AnimatedSceneNode() [3/3]

C3D_API castor3d::AnimatedSceneNode::AnimatedSceneNode	(	castor::String const &	name,
		SceneNode &	node
	)

Constructor.

Parameters

[in]	name	The object name.
[in]	node	The scene node.

Member Function Documentation

getPlayingAnimation()

SceneNodeAnimationInstance & castor3d::AnimatedSceneNode::getPlayingAnimation ( ) const

inline

getSceneNode()

SceneNode & castor3d::AnimatedSceneNode::getSceneNode ( ) const

inline

name Getters.

isPlayingAnimation()

C3D_API bool castor3d::AnimatedSceneNode::isPlayingAnimation ( ) const

inlineoverridevirtual

Returns

true if the object is playing an animation.

Implements castor3d::AnimatedObject.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

update()

C3D_API void castor3d::AnimatedSceneNode::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.

---

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

• Scene/Animation/AnimatedSceneNode.hpp