Dokumentacja klasy AnimatedTex

Klasa animowanej tekstury, odpowiada za rysowanie i odswieżanie animacji. Więcej...

#include <AnimatedTex.hpp>

Metody publiczne
	AnimatedTex (sf::Time frameTime=sf::seconds(0.1f), bool paused=false, bool looped=true)
void	update (sf::Time deltaTime)
	Odświeża animacje.
void	setAnimation (const Animation &animation)
	Ustawia animacje.
void	setFrameTime (sf::Time time)
	Ustawia czas między klatkami.
void	play ()
	Uruchamia animacje.
void	play (const Animation &animation)
	Ustawia animacje i ją uruchamia.
void	pause ()
	Zatrzymuje animacje.
void	stop ()
	Zatrzymuje animacje i ustawia aktualną klatke na na pierwszą
void	setLooped (bool looped)
	Ustawia zapętlenie animacji.
void	setColor (const sf::Color &color)
	Ustawia kolor teksturki klatki.
const Animation *	getAnimation () const
	Zwraca wskaźnik na animacje.
bool	isLooped () const
	Zwraca zapętlenie animacji.
bool	isPlaying () const
	Zwraca wartość czy animacja aktualnie jest odgrywana.
sf::Time	getFrameTime () const
	Zwraca czas między klatkami.
void	setFrame (std::size_t newFrame)
	Ustawia klatke.
virtual void	draw (sf::RenderTarget &target, sf::RenderStates states) const
	Rysuje animacje.

Opis szczegółowy

Klasa animowanej tekstury, odpowiada za rysowanie i odswieżanie animacji.

Dokumentacja konstruktora i destruktora

AnimatedTex::AnimatedTex	(	sf::Time	frameTime = sf::seconds(0.1f),
		bool	paused = false,
		bool	looped = true
	)

Parametry

frameTime

- Czas wyświetlania klatki, paused - pauza looped - zapętlenie

Dokumentacja funkcji składowych

const Animation * AnimatedTex::getAnimation

(

)

const

Zwraca wskaźnik na animacje.

Zwraca

Animacja

sf::Time AnimatedTex::getFrameTime

(

)

const

Zwraca czas między klatkami.

Zwraca

sf::Time - czas

bool AnimatedTex::isLooped

(

)

const

Zwraca zapętlenie animacji.

Zwraca

Zapętlenie

bool AnimatedTex::isPlaying

(

)

const

Zwraca wartość czy animacja aktualnie jest odgrywana.

Zwraca

Stan

void AnimatedTex::play

(

const Animation &

animation

)

Ustawia animacje i ją uruchamia.

Parametry

animation

- animacja

void AnimatedTex::setAnimation

(

const Animation &

animation

)

Ustawia animacje.

Parametry

animation

- animacja

void AnimatedTex::setColor

(

const sf::Color &

color

)

Ustawia kolor teksturki klatki.

Parametry

color

- kolor

void AnimatedTex::setFrame

(

std::size_t

newFrame

)

Ustawia klatke.

Przełącza klatke

Parametry

Numer

klatki

void AnimatedTex::setFrameTime

(

sf::Time

time

)

Ustawia czas między klatkami.

Parametry

time

- czas

void AnimatedTex::setLooped

(

bool

looped

)

Ustawia zapętlenie animacji.

Parametry

looped

- zapętlenie

void AnimatedTex::update

(

sf::Time

deltaTime

)

Odświeża animacje.

Parametry

deltaTime

- delta

Przełącza klatki animacji

---

Dokumentacja dla tej klasy została wygenerowana z plików:

• AnimatedSprite/AnimatedTex.hpp
• AnimatedSprite/AnimatedTex.cpp