dWipeKuppa_c Class Reference

#include <dol/bases/d_wipe_kuppa.hpp>

Inheritance diagram for dWipeKuppa_c:

Description

A fader that animates a Bowser texture in/out.

Seen when entering a tower or castle stage, for example.

Definition at line 9 of file d_wipe_kuppa.hpp.

Public Types
enum	ACTION_e {   OPEN_SETUP ,   ANIME_END_CHECK ,   CLOSE_SETUP ,   IDLE }
	The possible actions performed in calc. More...
enum	ANIM_e {   IN ,   OUT }
	The animations for this fader. More...
Public Types inherited from mFaderBase_c
enum	EStatus {   OPAQUE ,   HIDDEN ,   FADE_IN ,   FADE_OUT }
	The fader's status. More...
enum	FLAG_e {   FADE_IN_COMPLETE = 1 ,   FADE_OUT_COMPLETE = 2 }
	Some flags related to the fader. More...

Public Member Functions
	dWipeKuppa_c (nw4r::ut::Color, mFaderBase_c::EStatus stat)
	See mFaderBase_c::mFaderBase_c.
	~dWipeKuppa_c ()
	Destroys the fader.
bool	createLayout ()
	Loads the resources and creates the layout for the fader.
void	OpenSetup ()
	Prepares the fade-out transition.
void	AnimeEndCheck ()
	Checks if the fade animation has finished yet.
void	CloseSetup ()
	Prepares the fade-in transition.
virtual int	calc ()
	Calculates the fader at the current frame.
virtual void	draw ()
	Draws the fader.
virtual void	setStatus (mFaderBase_c::EStatus stat)
	Sets the fader's status.
virtual bool	fadeIn ()
	Initiates a fade in from pure blacked-out.
virtual bool	fadeOut ()
	Initiates a fade out from no-obstruction.
Public Member Functions inherited from mFaderBase_c
	mFaderBase_c (const mColor &color, EStatus status)
	Constructs a new fader.
virtual	~mFaderBase_c ()
	Destroys the fader.
virtual void	setStatus (EStatus status)=0
	Sets the fader's status.
virtual EStatus	getStatus () const
	Gets the fader's status.
virtual bool	fadeIn ()
	Initiates a fade in from pure blacked-out.
virtual bool	fadeOut ()
	Initiates a fade out from no-obstruction.
virtual int	calc ()
	Calculates the fader at the current frame.
virtual void	draw ()=0
	Draws the fader.
void	setFrame (u16 duration)
	Sets the duration of the fade. Duration must not be zero.
void	setColor (const mColor &color)
	Sets the fader's color. Alpha is not modified.

Static Public Attributes
static dWipeKuppa_c *	m_instance
	The instance of the fader.

Private Attributes
LytBase_c	mLyt
	The layout for the fader.
nw4r::lyt::Pane *	mpRootPane
	The root pane of the fader layout.
nw4r::lyt::Window *	mpWnd [1]
	The window pane containing the fader texture.
ACTION_e	mAction
	The action to be performed in calc.
bool	mIsCreated
	Whether the layout for the fader has been created.

Additional Inherited Members
Protected Attributes inherited from mFaderBase_c
EStatus	mStatus
	The fader's status.
u8	mFlag
	The fader's flags.
u16	mFrameCount
	The fader's duration.
u16	mCurrFrame
	The fader's current frame.
mColor	mFaderColor
	The fader's color.

Member Enumeration Documentation

ACTION_e

enum dWipeKuppa_c::ACTION_e

The possible actions performed in calc.

Enumerator
OPEN_SETUP	Prepare the fade-out transition.
ANIME_END_CHECK	Fade has begun, waiting for it to end.
CLOSE_SETUP	Prepare the fade-in transition.
IDLE	The fade has not been started.

Definition at line 13 of file d_wipe_kuppa.hpp.

ANIM_e

enum dWipeKuppa_c::ANIM_e

The animations for this fader.

Enumerator
IN	Fade-in animation.
OUT	Fade-out animation.

Definition at line 21 of file d_wipe_kuppa.hpp.

Constructor & Destructor Documentation

dWipeKuppa_c()

dWipeKuppa_c::dWipeKuppa_c	(	nw4r::ut::Color	color,
		mFaderBase_c::EStatus	stat
	)

See mFaderBase_c::mFaderBase_c.

Definition at line 9 of file d_wipe_kuppa.cpp.

~dWipeKuppa_c()

dWipeKuppa_c::~dWipeKuppa_c

(

)

Destroys the fader.

Definition at line 15 of file d_wipe_kuppa.cpp.

Member Function Documentation

createLayout()

bool dWipeKuppa_c::createLayout

(

)

Loads the resources and creates the layout for the fader.

Returns

Whether the creation was successful.

Definition at line 19 of file d_wipe_kuppa.cpp.

OpenSetup()

void dWipeKuppa_c::OpenSetup

(

)

Prepares the fade-out transition.

Definition at line 85 of file d_wipe_kuppa.cpp.

AnimeEndCheck()

void dWipeKuppa_c::AnimeEndCheck

(

)

Checks if the fade animation has finished yet.

If the animation has finished, sets the status accordingly and switches back to the IDLE action.

Definition at line 91 of file d_wipe_kuppa.cpp.

CloseSetup()

void dWipeKuppa_c::CloseSetup

(

)

Prepares the fade-in transition.

Definition at line 105 of file d_wipe_kuppa.cpp.

calc()

int dWipeKuppa_c::calc ( )

virtual

Calculates the fader at the current frame.

Returns

If the operation was successful.

Reimplemented from mFaderBase_c.

Definition at line 67 of file d_wipe_kuppa.cpp.

draw()

void dWipeKuppa_c::draw ( )

virtual

Draws the fader.

Implements mFaderBase_c.

Definition at line 79 of file d_wipe_kuppa.cpp.

setStatus()

void dWipeKuppa_c::setStatus ( mFaderBase_c::EStatus  stat )

virtual

Sets the fader's status.

The only allowed values are OPAQUE and HIDDEN.

Implements mFaderBase_c.

Definition at line 111 of file d_wipe_kuppa.cpp.

fadeIn()

bool dWipeKuppa_c::fadeIn ( )

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.

Reimplemented from mFaderBase_c.

Definition at line 133 of file d_wipe_kuppa.cpp.

fadeOut()

bool dWipeKuppa_c::fadeOut ( )

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.

Reimplemented from mFaderBase_c.

Definition at line 141 of file d_wipe_kuppa.cpp.

Member Data Documentation

m_instance

dWipeKuppa_c * dWipeKuppa_c::m_instance

static

The instance of the fader.

Definition at line 54 of file d_wipe_kuppa.hpp.

mLyt

LytBase_c dWipeKuppa_c::mLyt

private

The layout for the fader.

Definition at line 57 of file d_wipe_kuppa.hpp.

mpRootPane

nw4r::lyt::Pane* dWipeKuppa_c::mpRootPane

private

The root pane of the fader layout.

Definition at line 58 of file d_wipe_kuppa.hpp.

mpWnd

nw4r::lyt::Window* dWipeKuppa_c::mpWnd[1]

private

The window pane containing the fader texture.

Definition at line 59 of file d_wipe_kuppa.hpp.

mAction

ACTION_e dWipeKuppa_c::mAction

private

The action to be performed in calc.

Definition at line 60 of file d_wipe_kuppa.hpp.

mIsCreated

bool dWipeKuppa_c::mIsCreated

private

Whether the layout for the fader has been created.

Definition at line 61 of file d_wipe_kuppa.hpp.