castor3d::SceneNodeAnimation Class Reference

#include <SceneNodeAnimation.hpp>

Inheritance diagram for castor3d::SceneNodeAnimation:

Collaboration diagram for castor3d::SceneNodeAnimation:

Public Member Functions
C3D_API	SceneNodeAnimation (SceneNodeAnimation &&rhs) noexcept=default
C3D_API SceneNodeAnimation &	operator= (SceneNodeAnimation &&rhs) noexcept=delete
C3D_API	SceneNodeAnimation (SceneNodeAnimation const &rhs)=delete
C3D_API SceneNodeAnimation &	operator= (SceneNodeAnimation const &rhs)=delete
C3D_API	~SceneNodeAnimation () noexcept override=default
C3D_API	SceneNodeAnimation (SceneNode &node, castor::String const &name=castor::cuEmptyString)
	Constructor.
Public Member Functions inherited from castor3d::Animation
C3D_API	Animation (Engine &handler, AnimationType type, Animable &animable, castor::String const &name=castor::cuEmptyString)
	Constructor.
C3D_API	Animation (Engine &handler, AnimationType type, castor::String const &name=castor::cuEmptyString)
	Constructor.
C3D_API void	addKeyFrame (AnimationKeyFrameUPtr keyFrame)
	Adds a keyframe to the animation.
C3D_API AnimationKeyFrameArray::iterator	find (castor::Milliseconds const &time)
	Finds a keyframe given a time index.
C3D_API void	findKeyFrame (castor::Milliseconds const &time, AnimationKeyFrameArray::iterator &prv, AnimationKeyFrameArray::iterator &cur) const
	Finds a keyframe given a time index.
C3D_API void	updateLength ()
	Updates the animation length.
C3D_API void	cloneInto (Animation &output) const
	Clones this object into the given one.
bool	isEmpty () const
size_t	size () 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
Animable *	getAnimable () const
C3D_API	Animation (Animation &&rhs) noexcept=default
C3D_API Animation &	operator= (Animation &&rhs) noexcept=delete
C3D_API	Animation (Animation const &rhs)=delete
C3D_API Animation &	operator= (Animation const &rhs)=delete
virtual C3D_API	~Animation () noexcept=default
Public Member Functions inherited from castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructor.
T const &	getName () const noexcept
	Retrieves the name.
void	rename (T name) noexcept
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const noexcept
void	setOwner (Engine &owner) noexcept

Friends
class	BinaryWriter< SceneNodeAnimation >
class	BinaryParser< SceneNodeAnimation >
class	SceneNodeAnimationInstance

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner) noexcept
	Constructor.
Protected Attributes inherited from castor3d::Animation
Animable *	m_animable {}
AnimationType	m_type { AnimationType::eCount }
castor::Milliseconds	m_length { 0 }
AnimationKeyFrameArray	m_keyframes
Protected Attributes inherited from castor::NamedBaseT< T >
T	m_name

Constructor & Destructor Documentation

SceneNodeAnimation() [1/3]

C3D_API castor3d::SceneNodeAnimation::SceneNodeAnimation ( SceneNodeAnimation && rhs )

defaultnoexcept

SceneNodeAnimation() [2/3]

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

delete

~SceneNodeAnimation()

C3D_API castor3d::SceneNodeAnimation::~SceneNodeAnimation ( )

overridedefaultnoexcept

SceneNodeAnimation() [3/3]

C3D_API castor3d::SceneNodeAnimation::SceneNodeAnimation ( SceneNode & node, castor::String const & name = castor::cuEmptyString )

explicit

Constructor.

Parameters

[in]	node	The parent animable object.
[in]	name	The name of the animation.

Member Function Documentation

operator=() [1/2]

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

deletenoexcept

operator=() [2/2]

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

delete

Friends And Related Symbol Documentation

BinaryParser< SceneNodeAnimation >

friend class BinaryParser< SceneNodeAnimation >

friend

BinaryWriter< SceneNodeAnimation >

friend class BinaryWriter< SceneNodeAnimation >

friend

SceneNodeAnimationInstance

friend class SceneNodeAnimationInstance

friend

---

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

• Castor3D/Scene/Animation/SceneNodeAnimation.hpp