Castor3D 0.12.0
Multiplatform 3D engine
Public Member Functions | Protected Attributes | Friends | List of all members
castor3d::TextureAnimation Class Reference

#include <TextureAnimation.hpp>

Inheritance diagram for castor3d::TextureAnimation:
Inheritance graph
[legend]
Collaboration diagram for castor3d::TextureAnimation:
Collaboration graph
[legend]

Public Member Functions

C3D_API TextureAnimation (Engine &engine, castor::String const &name=castor::cuEmptyString)
 Constructor. More...
 
C3D_API void setAnimable (TextureUnit &unit)
 
C3D_API void initialiseTiles (TextureUnit const &unit)
 
C3D_API castor::Point3f getTranslate (castor::Milliseconds const &time) const
 
C3D_API castor::Angle getRotate (castor::Milliseconds const &time) const
 
C3D_API castor::Point3f getScale (castor::Milliseconds const &time) const
 
C3D_API bool isTransformAnimated () const
 
void addPendingAnimated (AnimatedObject &object)
 
TextureTranslateSpeed const & getTranslateSpeed () const
 
TextureRotateSpeed const & getRotateSpeed () const
 
TextureScaleSpeed const & getScaleSpeed () const
 
void setTranslateSpeed (TextureTranslateSpeed const &translate)
 
void setRotateSpeed (TextureRotateSpeed const &rotate)
 
void setScaleSpeed (TextureScaleSpeed const &scale)
 
void enableTileAnim ()
 
bool isTileAnimated () const
 
void setTransformSpeed (TextureTranslateSpeed const &translate, TextureRotateSpeed const &rotate, TextureScaleSpeed const &scale)
 
C3D_API TextureAnimation (TextureAnimation &&rhs)=default
 
C3D_API TextureAnimationoperator= (TextureAnimation &&rhs)=delete
 
C3D_API TextureAnimation (TextureAnimation const &rhs)=delete
 
C3D_API TextureAnimationoperator= (TextureAnimation const &rhs)=delete
 
- Public Member Functions inherited from castor3d::AnimationT< Engine >
 AnimationT (Engine &handler, AnimationType type, AnimableT< Engine > &animable, castor::String const &name=castor::cuEmptyString)
 Constructor. More...
 
 AnimationT (Engine &handler, AnimationType type, castor::String const &name=castor::cuEmptyString)
 Constructor. More...
 
void addKeyFrame (AnimationKeyFrameUPtr keyFrame)
 Adds a keyframe to the animation. More...
 
AnimationKeyFrameArray::iterator find (castor::Milliseconds const &time)
 Finds a keyframe given a time index. More...
 
void findKeyFrame (castor::Milliseconds const &time, AnimationKeyFrameArray::iterator &prv, AnimationKeyFrameArray::iterator &cur) const
 Finds a keyframe given a time index. More...
 
void updateLength ()
 Updates the animation length. More...
 
bool isEmpty () 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
 
AnimableT< Engine > * getAnimable () const
 
C3D_API AnimationT (AnimationT &&rhs)=default
 
C3D_API AnimationT (AnimationT const &rhs)=delete
 
C3D_API AnimationToperator= (AnimationT &&rhs)=delete
 
C3D_API AnimationToperator= (AnimationT const &rhs)=delete
 
virtual C3D_API ~AnimationT ()=default
 

Protected Attributes

TextureTranslateSpeed m_translate
 
TextureRotateSpeed m_rotate
 
TextureScaleSpeed m_scale
 
bool m_tileAnim {}
 
std::set< AnimatedObject * > m_pending
 
- Protected Attributes inherited from castor3d::AnimationT< Engine >
AnimableT< Engine > * m_animable
 
AnimationType m_type
 
castor::Milliseconds m_length
 
AnimationKeyFrameArray m_keyframes
 

Friends

class BinaryWriter< TextureAnimation >
 
class BinaryParser< TextureAnimation >
 
class TextureAnimationInstance
 

Constructor & Destructor Documentation

◆ TextureAnimation() [1/3]

C3D_API castor3d::TextureAnimation::TextureAnimation ( TextureAnimation &&  rhs)
default

name Copy / Move.

◆ TextureAnimation() [2/3]

C3D_API castor3d::TextureAnimation::TextureAnimation ( TextureAnimation const &  rhs)
delete

◆ TextureAnimation() [3/3]

C3D_API castor3d::TextureAnimation::TextureAnimation ( Engine engine,
castor::String const &  name = castor::cuEmptyString 
)
explicit

Constructor.

Parameters
[in]engineThe engine.
[in]nameThe name of the animation.

Member Function Documentation

◆ addPendingAnimated()

void castor3d::TextureAnimation::addPendingAnimated ( AnimatedObject object)
inline

References m_pending.

◆ enableTileAnim()

void castor3d::TextureAnimation::enableTileAnim ( )
inline

References m_tileAnim.

◆ getRotate()

C3D_API castor::Angle castor3d::TextureAnimation::getRotate ( castor::Milliseconds const &  time) const

◆ getRotateSpeed()

TextureRotateSpeed const & castor3d::TextureAnimation::getRotateSpeed ( ) const
inline

References m_rotate.

◆ getScale()

C3D_API castor::Point3f castor3d::TextureAnimation::getScale ( castor::Milliseconds const &  time) const

◆ getScaleSpeed()

TextureScaleSpeed const & castor3d::TextureAnimation::getScaleSpeed ( ) const
inline

References m_scale.

◆ getTranslate()

C3D_API castor::Point3f castor3d::TextureAnimation::getTranslate ( castor::Milliseconds const &  time) const

◆ getTranslateSpeed()

TextureTranslateSpeed const & castor3d::TextureAnimation::getTranslateSpeed ( ) const
inline

References m_translate.

◆ initialiseTiles()

C3D_API void castor3d::TextureAnimation::initialiseTiles ( TextureUnit const &  unit)

◆ isTileAnimated()

bool castor3d::TextureAnimation::isTileAnimated ( ) const
inline

References m_tileAnim.

◆ isTransformAnimated()

C3D_API bool castor3d::TextureAnimation::isTransformAnimated ( ) const

◆ operator=() [1/2]

C3D_API TextureAnimation & castor3d::TextureAnimation::operator= ( TextureAnimation &&  rhs)
delete

◆ operator=() [2/2]

C3D_API TextureAnimation & castor3d::TextureAnimation::operator= ( TextureAnimation const &  rhs)
delete

◆ setAnimable()

C3D_API void castor3d::TextureAnimation::setAnimable ( TextureUnit unit)

◆ setRotateSpeed()

void castor3d::TextureAnimation::setRotateSpeed ( TextureRotateSpeed const &  rotate)
inline

References m_rotate.

Referenced by setTransformSpeed().

Here is the caller graph for this function:

◆ setScaleSpeed()

void castor3d::TextureAnimation::setScaleSpeed ( TextureScaleSpeed const &  scale)
inline

References m_scale.

Referenced by setTransformSpeed().

Here is the caller graph for this function:

◆ setTransformSpeed()

void castor3d::TextureAnimation::setTransformSpeed ( TextureTranslateSpeed const &  translate,
TextureRotateSpeed const &  rotate,
TextureScaleSpeed const &  scale 
)
inline

References setRotateSpeed(), setScaleSpeed(), and setTranslateSpeed().

Here is the call graph for this function:

◆ setTranslateSpeed()

void castor3d::TextureAnimation::setTranslateSpeed ( TextureTranslateSpeed const &  translate)
inline

References m_translate.

Referenced by setTransformSpeed().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ BinaryParser< TextureAnimation >

friend class BinaryParser< TextureAnimation >
friend

◆ BinaryWriter< TextureAnimation >

friend class BinaryWriter< TextureAnimation >
friend

◆ TextureAnimationInstance

friend class TextureAnimationInstance
friend

Member Data Documentation

◆ m_pending

std::set< AnimatedObject * > castor3d::TextureAnimation::m_pending
protected

Referenced by addPendingAnimated().

◆ m_rotate

TextureRotateSpeed castor3d::TextureAnimation::m_rotate
protected

Referenced by getRotateSpeed(), and setRotateSpeed().

◆ m_scale

TextureScaleSpeed castor3d::TextureAnimation::m_scale
protected

Referenced by getScaleSpeed(), and setScaleSpeed().

◆ m_tileAnim

bool castor3d::TextureAnimation::m_tileAnim {}
protected

Referenced by enableTileAnim(), and isTileAnimated().

◆ m_translate

TextureTranslateSpeed castor3d::TextureAnimation::m_translate
protected

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