Dokumentace třídy CAnimation

Animace. ...

#include <Animation.h>

Seznam všech členů.

Veřejné metody
	CAnimation ()
virtual	~CAnimation ()
int	getCurrentFrame () const
int	getEnd () const
bool	isPlay () const
int	getStart () const
int	getStep () const
void	setEnd (int m_end)
void	setStart (int m_start)
void	setStep (int m_step)
void	play ()
void	stop ()
void	nextFrame ()
void	update ()
void	reset ()
bool	isEnd ()
void	setup (bool m_play, int m_start, int m_end, int m_step)
Chráněné atributy
bool	m_play
int	m_step
int	m_start
int	m_end
int	m_currentFrame

---

Detailní popis

Animace.

Autor:

František Toman

Verze:

1.0

Kontakt: tomanfra@fit.cvut.cz

---

Dokumentace konstruktoru a destruktoru

CAnimation::CAnimation

(

)

Konstruktor

CAnimation::~CAnimation

(

)

[virtual]

Destruktor

---

Dokumentace k metodám

int CAnimation::getCurrentFrame

(

)

const [inline]

Vrátí číslo aktuálního snímku

Návratová hodnota:

int CAnimation::getEnd

(

)

const [inline]

Vrátí číslo posledního snímku

Návratová hodnota:

int CAnimation::getStart

(

)

const [inline]

Vrátí číslo prvního snímek

Návratová hodnota:

int CAnimation::getStep

(

)

const [inline]

Vrátí velikost kroku

Návratová hodnota:

bool CAnimation::isEnd

(

)

[inline]

Vratí, zdali je konec animace

bool CAnimation::isPlay

(

)

const [inline]

Vrátí zdali je animace přehrávána

Návratová hodnota:

void CAnimation::nextFrame

(

)

[inline]

Přejdi na další snímek

void CAnimation::play

(

)

[inline]

Spustí animaci

void CAnimation::reset

(

)

[inline]

Reset animace - přetočení na počáteční číslo snímku

void CAnimation::setEnd

(

int

m_end

)

[inline]

Nastaví poslední snímek

Parametry:

m_end

- koncový snímek

void CAnimation::setStart

(

int

m_start

)

[inline]

Nastaví první snímek

Parametry:

m_start

- počáteční snímek

void CAnimation::setStep

(

int

m_step

)

[inline]

Nastaví velikost kroku animace

Parametry:

m_step

- krok animace

void CAnimation::setup	(	bool	m_play,
		int	m_start,
		int	m_end,
		int	m_step
	)

Komplexní nastavení animace

Parametry:

	m_play	- přehát animaci?
	m_start	- počáteční snímek
	m_end	- koncový snímek
	m_step	- krok animace

void CAnimation::stop

(

)

[inline]

Zastaví animaci

void CAnimation::update

(

)

Aktualizace animace

---

Dokumentace k datovým členům

int CAnimation::m_currentFrame [protected]

Číslo aktuálního snímku

int CAnimation::m_end [protected]

Číslo posledního snímku

bool CAnimation::m_play [protected]

Je animace přehrávána?

int CAnimation::m_start [protected]

Číslo počátečního snímku

int CAnimation::m_step [protected]

Krok animace - tj. počet snímků

---

Dokumentace pro tuto třídu byla generována z následujících souborů:

• Animation.h
• Animation.cpp