EGG::ColorFader Class Reference

Inheritance diagram for EGG::ColorFader:

Description

Definition at line 12 of file eggColorFader.h.

Public Member Functions
	ColorFader (float x, float y, float w, float h, nw4r::ut::Color color, EStatus initialStatus)
virtual void	setStatus (EStatus status)
virtual EStatus	getStatus () const
	Sets the fader's status.
virtual bool	fadeIn ()
	Gets the fader's status.
virtual bool	fadeOut ()
	Initiates a fade in from pure blacked-out.
virtual bool	calc ()
	Initiates a fade out from no-obstruction.
virtual void	draw ()
	Calculates the fader at the current frame.
void	setFrame (u16 frame)
void	setColor (nw4r::ut::Color color)

Protected Types
enum	eFlag {   SIGNAL_ON_FADE_IN ,   SIGNAL_ON_FADE_OUT }

Protected Attributes
EStatus	mStatus
TBitFlag< u8 >	mFlag
u16	mFrameCount
u16	mFrame
nw4r::ut::Color	mCurrColor
nw4r::ut::Rect	mDims

Additional Inherited Members
Public Types inherited from EGG::Fader
enum	EStatus {   OPAQUE ,   HIDDEN ,   FADE_IN ,   FADE_OUT }
	The fader's status. More...

Member Enumeration Documentation

eFlag

enum EGG::ColorFader::eFlag

protected

Definition at line 28 of file eggColorFader.h.

Constructor & Destructor Documentation

ColorFader()

EGG::ColorFader::ColorFader	(	float	x,
		float	y,
		float	w,
		float	h,
		nw4r::ut::Color	color,
		Fader::EStatus	initialStatus )

Definition at line 7 of file eggColorFader.cpp.

~ColorFader()

virtual EGG::ColorFader::~ColorFader ( )

inlinevirtual

Definition at line 22 of file eggColorFader.h.

Member Function Documentation

setStatus()

void EGG::ColorFader::setStatus ( Fader::EStatus status )

virtual

Implements EGG::Fader.

Definition at line 31 of file eggColorFader.cpp.

getStatus()

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

inlinevirtual

Sets the fader's status.

Implements EGG::Fader.

Definition at line 17 of file eggColorFader.h.

fadeIn()

bool EGG::ColorFader::fadeIn ( )

virtual

Gets the fader's status.

Implements EGG::Fader.

Definition at line 41 of file eggColorFader.cpp.

fadeOut()

bool EGG::ColorFader::fadeOut ( )

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.

Implements EGG::Fader.

Definition at line 51 of file eggColorFader.cpp.

calc()

bool EGG::ColorFader::calc ( )

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.

Implements EGG::Fader.

Definition at line 61 of file eggColorFader.cpp.

draw()

void EGG::ColorFader::draw ( )

virtual

Calculates the fader at the current frame.

Returns

If the operation was successful.

Implements EGG::Fader.

Definition at line 99 of file eggColorFader.cpp.

setFrame()

void EGG::ColorFader::setFrame

(

u16

frame

)

Definition at line 19 of file eggColorFader.cpp.

setColor()

void EGG::ColorFader::setColor

(

nw4r::ut::Color

color

)

Definition at line 24 of file eggColorFader.cpp.

Member Data Documentation

mStatus

EStatus EGG::ColorFader::mStatus

protected

Definition at line 30 of file eggColorFader.h.

mFlag

TBitFlag<u8> EGG::ColorFader::mFlag

protected

Definition at line 31 of file eggColorFader.h.

mFrameCount

u16 EGG::ColorFader::mFrameCount

protected

Definition at line 32 of file eggColorFader.h.

mFrame

u16 EGG::ColorFader::mFrame

protected

Definition at line 33 of file eggColorFader.h.

mCurrColor

nw4r::ut::Color EGG::ColorFader::mCurrColor

protected

Definition at line 34 of file eggColorFader.h.

mDims

nw4r::ut::Rect EGG::ColorFader::mDims

protected

Definition at line 35 of file eggColorFader.h.