EGG::Fader Class Reference

#include <lib/egg/fader/eggFader.hpp>

Inheritance diagram for EGG::Fader:

Description

Interface for a fader.

This seems to be pretty much a copy-paste of mFaderBase_c (or vice-versa)

Definition at line 8 of file eggFader.hpp.

Public Types
enum	EStatus {   OPAQUE ,   HIDDEN ,   FADE_IN ,   FADE_OUT }
	The fader's status. More...

Public Member Functions
virtual void	setStatus (EStatus status)=0
virtual EStatus	getStatus () const =0
	Sets the fader's status.
virtual bool	fadeIn ()=0
	Gets the fader's status.
virtual bool	fadeOut ()=0
	Initiates a fade in from pure blacked-out.
virtual int	calc ()=0
	Initiates a fade out from no-obstruction.
virtual void	draw ()=0
	Calculates the fader at the current frame.

Member Enumeration Documentation

EStatus

enum EGG::Fader::EStatus

The fader's status.

Definition at line 12 of file eggFader.hpp.

Member Function Documentation

getStatus()

virtual EStatus EGG::Fader::getStatus ( ) const

pure virtual

Sets the fader's status.

Implemented in EGG::ColorFader.

fadeIn()

virtual bool EGG::Fader::fadeIn ( )

pure virtual

Gets the fader's status.

Implemented in EGG::ColorFader.

fadeOut()

virtual bool EGG::Fader::fadeOut ( )

pure virtual

Initiates a fade in from pure blacked-out.

The screen must be OPAQUE for the operation to be executed.

Returns

If the action was carried out.

Implemented in EGG::ColorFader.

calc()

virtual int EGG::Fader::calc ( )

pure virtual

Initiates a fade out from no-obstruction.

The screen must be HIDDEN for the operation to be executed.

Returns

If the action was carried out.

Implemented in EGG::ColorFader.

draw()

virtual void EGG::Fader::draw ( )

pure virtual

Calculates the fader at the current frame.

Returns

If the operation was successful.

Implemented in EGG::ColorFader.