castor3d::AnimatedTexture Class Reference

#include <AnimatedTexture.hpp>

Inheritance diagram for castor3d::AnimatedTexture:

Collaboration diagram for castor3d::AnimatedTexture:

Public Member Functions
C3D_API	AnimatedTexture (TextureSourceInfo const &sourceInfo, TextureConfiguration const &config, Pass &pass)
	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 void	fillBuffer (TextureAnimationData *buffer) const
C3D_API bool	isPlayingAnimation () const override
C3D_API	AnimatedTexture (AnimatedTexture &&rhs)=default
C3D_API AnimatedTexture &	operator= (AnimatedTexture &&rhs)=delete
C3D_API	AnimatedTexture (AnimatedTexture const &rhs)=delete
C3D_API AnimatedTexture &	operator= (AnimatedTexture const &rhs)=delete
TextureUnit &	getTexture () const
Pass &	getPass () const
TextureAnimationInstance &	getPlayingAnimation () const
void	setTexture (TextureUnit &texture)
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

AnimatedTexture() [1/3]

C3D_API castor3d::AnimatedTexture::AnimatedTexture ( AnimatedTexture &&  rhs )

default

name Copy / Move.

AnimatedTexture() [2/3]

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

delete

AnimatedTexture() [3/3]

C3D_API castor3d::AnimatedTexture::AnimatedTexture	(	TextureSourceInfo const &	sourceInfo,
		TextureConfiguration const &	config,
		Pass &	pass
	)

Constructor.

Parameters

[in]	sourceInfo	The texture source informations.
[in]	config	The texture configuration.
[in]	pass	The pass using the texture.

Member Function Documentation

fillBuffer()

C3D_API void castor3d::AnimatedTexture::fillBuffer

(

TextureAnimationData *

buffer

)

const

getPass()

Pass & castor3d::AnimatedTexture::getPass ( ) const

inline

getPlayingAnimation()

TextureAnimationInstance & castor3d::AnimatedTexture::getPlayingAnimation ( ) const

inline

getTexture()

TextureUnit & castor3d::AnimatedTexture::getTexture ( ) const

inline

name Getters.

isPlayingAnimation()

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

inlineoverridevirtual

Returns

true if the object is playing an animation.

Implements castor3d::AnimatedObject.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

setTexture()

void castor3d::AnimatedTexture::setTexture ( TextureUnit &  texture )

inline

name Setters.

update()

C3D_API void castor3d::AnimatedTexture::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/AnimatedTexture.hpp