Muto::TextureAnimationComponent Struct Reference

Animates through a series of sub textures. More...

#include <Components.h>

Public Member Functions
int	GetCurrentFrame () const
	Returns the index of the current frame.
Ref< SubTexture2D >	GetCurrentSubTexture ()
std::vector< Ref< SubTexture2D > > &	GetSubTextures ()
	operator const std::vector< Ref< SubTexture2D > > & () const
	operator std::vector< Ref< SubTexture2D > > & ()
	TextureAnimationComponent ()=default
	TextureAnimationComponent (const std::vector< Ref< SubTexture2D > > &subTextures, float frameTime)
	Constructor that initializes the sub-textures and frame time.
	TextureAnimationComponent (const TextureAnimationComponent &)=default
void	Update (float deltaTime)
	Updates the animation based on the elapsed time.

Public Attributes
int	CurrentFrame = 0
	The current frame index.
float	FrameTime = 0.6f
	Time per frame in seconds.
bool	IsLooping = true
std::vector< Ref< SubTexture2D > >	SubTextures
	The list of sub-textures for the animation.
float	TimeAccumulator = 0.0f
	Accumulated time for frame switching.

Detailed Description

Animates through a series of sub textures.

(can be used with full textures)

Constructor & Destructor Documentation

TextureAnimationComponent() [1/3]

Muto::TextureAnimationComponent::TextureAnimationComponent ( )

default

TextureAnimationComponent() [2/3]

Muto::TextureAnimationComponent::TextureAnimationComponent ( const TextureAnimationComponent &  )

default

TextureAnimationComponent() [3/3]

Muto::TextureAnimationComponent::TextureAnimationComponent ( const std::vector< Ref< SubTexture2D > > &  subTextures, float  frameTime  )

inline

Constructor that initializes the sub-textures and frame time.

Parameters

subTextures	Vector of sub-textures for the animation.
frameTime	Time per frame in seconds.

            : SubTextures(subTextures), FrameTime(frameTime) {
        }

References FrameTime, and TextureAnimationComponent().

Referenced by TextureAnimationComponent().

Member Function Documentation

GetCurrentFrame()

int Muto::TextureAnimationComponent::GetCurrentFrame ( ) const

inline

Returns the index of the current frame.

{ return CurrentFrame; }

GetCurrentSubTexture()

Ref< SubTexture2D > Muto::TextureAnimationComponent::GetCurrentSubTexture ( )

inline

                                                 { 
            if (SubTextures.empty())
                return nullptr;
            if (CurrentFrame < 0) CurrentFrame = 0;
            if (CurrentFrame >= (int)SubTextures.size()) CurrentFrame = (int)SubTextures.size() - 1;
            return SubTextures[CurrentFrame]; 
        }

GetSubTextures()

std::vector< Ref< SubTexture2D > > & Muto::TextureAnimationComponent::GetSubTextures ( )

inline

{ return SubTextures; }

operator const std::vector< Ref< SubTexture2D > > &()

Muto::TextureAnimationComponent::operator const std::vector< Ref< SubTexture2D > > & ( ) const

inline

{ return SubTextures; }

operator std::vector< Ref< SubTexture2D > > &()

Muto::TextureAnimationComponent::operator std::vector< Ref< SubTexture2D > > & ( )

inline

{ return SubTextures; }

Update()

void Muto::TextureAnimationComponent::Update ( float  deltaTime )

inline

Updates the animation based on the elapsed time.

Parameters

deltaTime

The elapsed time since the last update.

                                     {
            if (SubTextures.empty() || FrameTime <= 0.0f)
                return;
 
            TimeAccumulator += deltaTime;
            while (TimeAccumulator >= FrameTime) {
                CurrentFrame = (CurrentFrame + 1) % static_cast<uint32_t>(SubTextures.size());
                TimeAccumulator -= FrameTime;
            }
        }

Member Data Documentation

CurrentFrame

int Muto::TextureAnimationComponent::CurrentFrame = 0

The current frame index.

Referenced by Muto::TextureAnimationEdit().

FrameTime

float Muto::TextureAnimationComponent::FrameTime = 0.6f

Time per frame in seconds.

Referenced by TextureAnimationComponent().

IsLooping

bool Muto::TextureAnimationComponent::IsLooping = true

SubTextures

std::vector<Ref<SubTexture2D> > Muto::TextureAnimationComponent::SubTextures

The list of sub-textures for the animation.

TimeAccumulator

float Muto::TextureAnimationComponent::TimeAccumulator = 0.0f

Accumulated time for frame switching.

---

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

• Muto/src/Scene/Components.h