Vesper::TextureAnimationComponent Struct Reference

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

#include <Components.h>

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

Public Attributes
std::vector< Ref< SubTexture2D > >	SubTextures
	The list of sub-textures for the animation.
uint32_t	CurrentFrame = 0
	The current frame index.
float	FrameTime = 0.6f
	Time per frame in seconds.
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]

Vesper::TextureAnimationComponent::TextureAnimationComponent ( )

default

TextureAnimationComponent() [2/3]

Vesper::TextureAnimationComponent::TextureAnimationComponent ( const TextureAnimationComponent & )

default

TextureAnimationComponent() [3/3]

Vesper::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) {
        }

Member Function Documentation

GetCurrentFrame()

uint32_t Vesper::TextureAnimationComponent::GetCurrentFrame ( ) const

inline

Returns the index of the current frame.

{ return CurrentFrame; }

GetSubTextures()

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

inline

{ return SubTextures; }

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

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

inline

{ return SubTextures; }

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

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

inline

{ return SubTextures; }

Update()

void Vesper::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

uint32_t Vesper::TextureAnimationComponent::CurrentFrame = 0

The current frame index.

FrameTime

float Vesper::TextureAnimationComponent::FrameTime = 0.6f

Time per frame in seconds.

SubTextures

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

The list of sub-textures for the animation.

TimeAccumulator

float Vesper::TextureAnimationComponent::TimeAccumulator = 0.0f

Accumulated time for frame switching.

---

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

• Vesper/src/Vesper/Scene/Components.h