castor3d::TextureAnimationInstance Class Reference

#include <TextureAnimationInstance.hpp>

Inheritance diagram for castor3d::TextureAnimationInstance:

Collaboration diagram for castor3d::TextureAnimationInstance:

Public Member Functions
C3D_API	TextureAnimationInstance (AnimatedTexture &object, TextureAnimation &animation)
	Constructor. More...
C3D_API	TextureAnimationInstance (TextureAnimationInstance &&rhs)=default
C3D_API TextureAnimationInstance &	operator= (TextureAnimationInstance &&rhs)=delete
C3D_API	TextureAnimationInstance (TextureAnimationInstance const &rhs)=delete
C3D_API TextureAnimationInstance &	operator= (TextureAnimationInstance const &rhs)=delete
TextureAnimation const &	getTextureAnimation () const
AnimatedTexture &	getAnimatedTexture ()
TextureTransform const &	getTransform () const
castor::Point2ui const &	getTile () const
Public Member Functions inherited from castor3d::AnimationInstance
C3D_API	AnimationInstance (AnimatedObject &object, Animation &animation)
	Constructor. More...
virtual C3D_API	~AnimationInstance ()=default
	Destructor. More...
C3D_API void	update (castor::Milliseconds const &elapsed)
	Updates the animation, updates the key frame at the good time index. More...
C3D_API void	play ()
	Plays the animation. More...
C3D_API void	pause ()
	Pauses the animation. More...
C3D_API void	stop ()
	Stops the animation. More...
AnimationState	getState () const
float	getScale () const
void	setScale (float value)
	Sets the animation time scale. More...
castor::Milliseconds	getStartingPoint () const
void	setStartingPoint (castor::Milliseconds value)
	Sets the animation stopping point. More...
castor::Milliseconds	getStoppingPoint () const
void	setStoppingPoint (castor::Milliseconds value)
	Sets the animation stopping point. More...
bool	isLooped () const
void	setLooped (bool value)
	Sets the animation loop status. More...
Animation const &	getAnimation () const

Protected Attributes
AnimatedTexture &	m_animatedTexture
TextureAnimation &	m_textureAnimation
TextureTransform	m_transform
castor::Point2ui	m_tile
AnimationKeyFrameArray::iterator	m_prev
AnimationKeyFrameArray::iterator	m_curr
float	m_ratio { 0.0f }
bool	m_first { true }
Protected Attributes inherited from castor3d::AnimationInstance
Animation const &	m_animation
float	m_scale { 1.0f }
bool	m_looped { false }
castor::Milliseconds	m_startingPoint { 0 }
castor::Milliseconds	m_stoppingPoint { 0 }
castor::Milliseconds	m_currentTime { 0 }
AnimationState	m_state { AnimationState::eStopped }

Friends
class	BinaryWriter< TextureAnimation >
class	BinaryParser< TextureAnimation >

Constructor & Destructor Documentation

TextureAnimationInstance() [1/3]

C3D_API castor3d::TextureAnimationInstance::TextureAnimationInstance ( TextureAnimationInstance &&  rhs )

default

name Copy / Move.

TextureAnimationInstance() [2/3]

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

delete

TextureAnimationInstance() [3/3]

C3D_API castor3d::TextureAnimationInstance::TextureAnimationInstance	(	AnimatedTexture &	object,
		TextureAnimation &	animation
	)

Constructor.

Parameters

[in]	object	The parent AnimatedMesh.
[in]	animation	The animation.

Member Function Documentation

getAnimatedTexture()

AnimatedTexture & castor3d::TextureAnimationInstance::getAnimatedTexture ( )

inline

References m_animatedTexture.

getTextureAnimation()

TextureAnimation const & castor3d::TextureAnimationInstance::getTextureAnimation ( ) const

inline

name Getters.

References m_textureAnimation.

getTile()

castor::Point2ui const & castor3d::TextureAnimationInstance::getTile ( ) const

inline

References m_tile.

getTransform()

TextureTransform const & castor3d::TextureAnimationInstance::getTransform ( ) const

inline

References m_transform.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

Friends And Related Function Documentation

BinaryParser< TextureAnimation >

friend class BinaryParser< TextureAnimation >

friend

BinaryWriter< TextureAnimation >

friend class BinaryWriter< TextureAnimation >

friend

Member Data Documentation

m_animatedTexture

AnimatedTexture& castor3d::TextureAnimationInstance::m_animatedTexture

protected

Referenced by getAnimatedTexture().

m_curr

AnimationKeyFrameArray::iterator castor3d::TextureAnimationInstance::m_curr

protected

m_first

bool castor3d::TextureAnimationInstance::m_first { true }

protected

m_prev

AnimationKeyFrameArray::iterator castor3d::TextureAnimationInstance::m_prev

protected

m_ratio

float castor3d::TextureAnimationInstance::m_ratio { 0.0f }

protected

m_textureAnimation

TextureAnimation& castor3d::TextureAnimationInstance::m_textureAnimation

protected

Referenced by getTextureAnimation().

m_tile

castor::Point2ui castor3d::TextureAnimationInstance::m_tile

protected

Referenced by getTile().

m_transform

TextureTransform castor3d::TextureAnimationInstance::m_transform

protected

Referenced by getTransform().

---

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

• Scene/Animation/Texture/TextureAnimationInstance.hpp