Radium Engine  1.5.20
Loading...
Searching...
No Matches
Ra::Core::Asset::AnimationData Class Reference

#include <Core/Asset/AnimationData.hpp>

+ Inheritance diagram for Ra::Core::Asset::AnimationData:
+ Collaboration diagram for Ra::Core::Asset::AnimationData:

Public Member Functions

 AnimationData (const std::string &name="")
 
void setName (const std::string &name)
 
void displayInfo () const
 
Time
const AnimationTimegetTime () const
 
void setTime (const AnimationTime &time)
 
AnimationTime::Time getTimeStep () const
 
void setTimeStep (const AnimationTime::Time &delta)
 
Keyframes
uint getFramesSize () const
 
std::vector< HandleAnimationgetHandleData () const
 
void setHandleData (const std::vector< HandleAnimation > &frameList)
 
- Public Member Functions inherited from Ra::Core::Asset::AssetData
 AssetData (const std::string &name)
 Construct an asset data given its name.
 
 AssetData (const AssetData &other)=default
 Copy constructor. Default here.
 
virtual ~AssetData ()
 Simple delete operator.
 
virtual const std::stringgetName () const
 Acces to the name of the asset.
 

Protected Attributes

AnimationTime m_time
 The AnimationTime for the object.
 
AnimationTime::Time m_dt { 0 }
 The animation timestep.
 
std::vector< HandleAnimationm_keyFrame
 The animation frames.
 
- Protected Attributes inherited from Ra::Core::Asset::AssetData
std::string m_name
 

Detailed Description

The AnimationData class stores all the HandleAnimation related to an animation of an object, one per animation Handle.

Note
Objects can have several AnimationData, one for each animation.

Definition at line 37 of file AnimationData.hpp.

Constructor & Destructor Documentation

◆ AnimationData()

Ra::Core::Asset::AnimationData::AnimationData ( const std::string & name = "")
explicit

Definition at line 10 of file AnimationData.cpp.

◆ ~AnimationData()

Ra::Core::Asset::AnimationData::~AnimationData ( )

Definition at line 13 of file AnimationData.cpp.

Member Function Documentation

◆ displayInfo()

void Ra::Core::Asset::AnimationData::displayInfo ( ) const
inline

Print stat info to the Debug output.

Definition at line 117 of file AnimationData.hpp.

+ Here is the call graph for this function:

◆ getFramesSize()

uint Ra::Core::Asset::AnimationData::getFramesSize ( ) const
inline
Returns
the number of HandleAnimations.

Definition at line 79 of file AnimationData.hpp.

◆ getHandleData()

std::vector< HandleAnimation > Ra::Core::Asset::AnimationData::getHandleData ( ) const
inline
Returns
the list of HandleAnimations, i.e. the whole animation frames.

Definition at line 84 of file AnimationData.hpp.

◆ getTime()

const AnimationTime & Ra::Core::Asset::AnimationData::getTime ( ) const
inline
Returns
the AnimationTime of the animation.

Definition at line 55 of file AnimationData.hpp.

◆ getTimeStep()

AnimationTime::Time Ra::Core::Asset::AnimationData::getTimeStep ( ) const
inline
Returns
the animation timestep.

Definition at line 64 of file AnimationData.hpp.

◆ setHandleData()

void Ra::Core::Asset::AnimationData::setHandleData ( const std::vector< HandleAnimation > & frameList)
inline

Sets the animation frames.

Definition at line 108 of file AnimationData.hpp.

+ Here is the call graph for this function:

◆ setName()

void Ra::Core::Asset::AnimationData::setName ( const std::string & name)
inline

Sets the name of the animation.

Definition at line 47 of file AnimationData.hpp.

◆ setTime()

void Ra::Core::Asset::AnimationData::setTime ( const AnimationTime & time)
inline

Sets the AnimationTime of the animation.

Definition at line 60 of file AnimationData.hpp.

◆ setTimeStep()

void Ra::Core::Asset::AnimationData::setTimeStep ( const AnimationTime::Time & delta)
inline

Sets the animation timestep. 

Definition at line 69 of file AnimationData.hpp.

Member Data Documentation

◆ m_dt

AnimationTime::Time Ra::Core::Asset::AnimationData::m_dt { 0 }
protected

The animation timestep.

Definition at line 102 of file AnimationData.hpp.

◆ m_keyFrame

std::vector<HandleAnimation> Ra::Core::Asset::AnimationData::m_keyFrame
protected

The animation frames.

Definition at line 105 of file AnimationData.hpp.

◆ m_time

AnimationTime Ra::Core::Asset::AnimationData::m_time
protected

The AnimationTime for the object.

Definition at line 99 of file AnimationData.hpp.


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