castor3d::AnimatedTexture Class Reference

#include <AnimatedTexture.hpp>

Inheritance diagram for castor3d::AnimatedTexture:

Collaboration diagram for castor3d::AnimatedTexture:

Public Member Functions
C3D_API	AnimatedTexture (AnimatedTexture &&rhs) noexcept=default
C3D_API AnimatedTexture &	operator= (AnimatedTexture &&rhs) noexcept=delete
C3D_API	AnimatedTexture (AnimatedTexture const &rhs)=delete
C3D_API AnimatedTexture &	operator= (AnimatedTexture const &rhs)=delete
C3D_API	~AnimatedTexture () noexcept override=default
C3D_API	AnimatedTexture (TextureSourceInfo const &sourceInfo, TextureConfiguration const &config, Pass &pass)
	Constructor.
C3D_API void	update (castor::Milliseconds const &elapsed) override
	Updates the animations of the object, given the time since the last frame.
C3D_API void	fillBuffer (TextureAnimationData *buffer) const
C3D_API bool	isPlayingAnimation () const override
bool	hasTextureUnit () const noexcept
TextureUnit &	getTextureUnit () const noexcept
Pass &	getPass () const noexcept
TextureAnimationInstance &	getPlayingAnimation () const noexcept
void	setTextureUnit (TextureUnit &texture) noexcept
Public Member Functions inherited from castor3d::AnimatedObject
C3D_API	AnimatedObject (AnimationType kind, castor::String const &name)
	Constructor.
virtual C3D_API	~AnimatedObject () noexcept=default
	Destructor.
C3D_API void	addAnimation (castor::String const &name)
	adds the animation to the list
C3D_API void	startAnimation (castor::String const &name)
	Starts the animation identified by the given name.
C3D_API void	stopAnimation (castor::String const &name)
	Stops the animation identified by the given name.
C3D_API void	pauseAnimation (castor::String const &name)
	Pauses the animation identified by the given name.
C3D_API void	startAllAnimations ()
	Starts all animations.
C3D_API void	stopAllAnimations ()
	Stops all animations.
C3D_API void	pauseAllAnimations ()
	Pauses all animations.
C3D_API AnimationInstance &	getAnimation (castor::String const &name)
	Retrieves an animation.
C3D_API	AnimatedObject (AnimatedObject &&rhs) noexcept=default
C3D_API AnimatedObject &	operator= (AnimatedObject &&rhs) noexcept=default
C3D_API	AnimatedObject (AnimatedObject const &rhs)=delete
C3D_API AnimatedObject &	operator= (AnimatedObject const &rhs)=delete
bool	hasAnimation (castor::String const &name)
AnimationInstancesMap const &	getAnimations () const
AnimationType	getKind () const
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

Additional Inherited Members
Public Types inherited from castor3d::AnimatedObject
using	AnimationInstancesMap = castor::StringMap< AnimationInstanceUPtr >
Protected Attributes inherited from castor3d::AnimatedObject
AnimationInstancesMap	m_animations
Protected Attributes inherited from castor::NamedBaseT< T >
T	m_name

Constructor & Destructor Documentation

AnimatedTexture() [1/3]

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

defaultnoexcept

AnimatedTexture() [2/3]

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

delete

~AnimatedTexture()

C3D_API castor3d::AnimatedTexture::~AnimatedTexture ( )

overridedefaultnoexcept

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

inlinenoexcept

getPlayingAnimation()

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

inlinenoexcept

References CU_Require.

getTextureUnit()

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

inlinenoexcept

References CU_Require, and hasTextureUnit().

Here is the call graph for this function:

hasTextureUnit()

bool castor3d::AnimatedTexture::hasTextureUnit ( ) const

inlinenoexcept

name Getters.

Referenced by getTextureUnit().

Here is the caller graph for this function:

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 )

deletenoexcept

operator=() [2/2]

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

delete

setTextureUnit()

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

inlinenoexcept

name Setters.

References CU_Require.

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:

• Castor3D/Scene/Animation/AnimatedTexture.hpp