#include <game/bases/d_controller_information.hpp>

Inheritance diagram for dControllerInformation_c:

Description

Displays the controller information screen.

This is the screen that reads "Hold the Wii Remote sideways". It's spawned automatically by the boot scene (dScBoot_c), which also performs the button input check and consequent state change.

Definition at line 12 of file d_controller_information.hpp.

Public Types
enum	ANIM_e { IN2BTN , LOOP2BTN , HIT2BTN }
	The identifier for each animation. More...

enum	STATE_e { IDLE , SHOW_IN , SHOW_LOOP , WAITING_FOR_END , END }
	The screen's current state. More...

Public Types inherited from fBase_c
enum	LIFECYCLE_e { CREATING , ACTIVE , DELETING }
	The possible lifecycle states. More...

enum	GROUP_TYPE_e { OTHER , SCENE , ACTOR }
	The possible group types. More...

enum	MAIN_STATE_e { CANCELED , ERROR , SUCCESS , WAITING }
	The possible operation results. More...

enum	PACK_RESULT_e { NOT_READY , SUCCEEDED , FAILED }
	The possible operation step results. More...

enum	PROC_DISABLE_e { ROOT_DISABLE_EXECUTE = BIT_FLAG(0) , DISABLE_EXECUTE = BIT_FLAG(1) , ROOT_DISABLE_DRAW = BIT_FLAG(2) , DISABLE_DRAW = BIT_FLAG(3) }
	Controls if the `execute` and `draw` operations should be skipped. More...

Public Member Functions
	dControllerInformation_c ()
	Constructs a new base.

virtual	~dControllerInformation_c ()
	Destroys the base.

virtual int	create ()
	`do` method for the `create` operation.

virtual int	doDelete ()
	`do` method for the `delete` operation.

virtual int	execute ()
	`do` method for the `execute` operation.

virtual int	draw ()
	`do` method for the `draw` operation.

void	setVisible (bool visible)

void	setState (STATE_e state)

Public Member Functions inherited from dBase_c
	dBase_c ()
	Constructs a new base.

virtual int	preCreate ()
	`pre` method for the `create` operation.

virtual void	postCreate (fBase_c::MAIN_STATE_e status)
	`post` method for the `create` operation.

virtual int	preDelete ()
	`pre` method for the `delete` operation.

virtual void	postDelete (fBase_c::MAIN_STATE_e status)
	`post` method for the `delete` operation.

virtual int	preExecute ()
	`pre` method for the `execute` operation.

virtual void	postExecute (fBase_c::MAIN_STATE_e status)
	`post` method for the `execute` operation.

virtual int	preDraw ()
	`pre` method for the `draw` operation.

virtual void	postDraw (fBase_c::MAIN_STATE_e status)
	`post` method for the `draw` operation.

virtual	~dBase_c ()
	Destroys the base.

virtual const char *	getKindString () const
	Gets the base's kind string.

Public Member Functions inherited from fBase_c
	fBase_c ()
	Constructs a new base.

void	deleteRequest ()
	Requests deletion of the base.

fBase_c *	getConnectParent () const
	Gets the base's parent.

fBase_c *	getConnectChild () const
	Gets the base's first child.

fBase_c *	getConnectBrNext () const
	Gets the base's next sibling.

bool	checkChildProcessCreateState () const
	Checks if the base has at least one child in the CREATING state.

Public Member Functions inherited from cOwnerSetMg_c
	cOwnerSetMg_c ()
	Constructs a new set container.

	~cOwnerSetMg_c ()
	Destroys the set.

void	add (cOwnerSetNd_c nd, void owner)
	Adds a node to the set.

void	remove (cOwnerSetNd_c nd, void owner)
	Removes a node from the set.

Private Member Functions
bool	createLayout ()
	Loads the resources and creates the layout for the base.

Private Attributes
LytBase_c	mLayout
	The layout of the base.

bool	mIsCreated
	If the layout has been successfully created.

bool	mVisible
	If the layout should be rendered.

STATE_e	mState
	Which state the base is currently in.

Additional Inherited Members
Static Public Member Functions inherited from dBase_c
static dBase_c *	searchBaseByProfName (ProfileName profile, const dBase_c *parent)
	Searches for a base with a given profile name, optionally under a given parent.

static void	initLoader ()
	[Unused]. Sets the callbacks for the scrapped relocatable profile system.

static dBase_c *	createBase (ProfileName profName, dBase_c *parent, unsigned long param, u8 groupType)
	Creates a child base under the given parent.

static dBase_c *	createRoot (ProfileName profName, unsigned long param, u8 groupType)
	Creates a root base.

Static Public Member Functions inherited from fBase_c
static void *	operator new (size_t)
	`new` operator override for all bases.

static void	operator delete (void *)
	`delete` operator override for all bases.

static fBase_c *	createChild (ProfileName profName, fBase_c *parent, unsigned long param, u8 groupType)
	Creates a child base under the given parent.

static fBase_c *	createRoot (ProfileName profName, unsigned long param, u8 groupType)
	Creates a root base.

Public Attributes inherited from fBase_c
fBaseID_e	mUniqueID
	The base's unique identifier.

u32	mParam
	A bitfield that configures the base's behaviour. Its usage varies from profile to profile.

ProfileName	mProfName
	The base's profile name.

Protected Member Functions inherited from fBase_c
bool	isProcControlFlag (u8 flag) const
	Checks if a flag is set in mProcControl.

void	setProcControlFlag (u8 flag)
	Sets a flag in mProcControl.

void	clearProcControlFlag (u8 flag)
	Clears a flag in mProcControl.

virtual void	deleteReady ()
	Informs the base that it's about to be deleted.

virtual bool	entryFrmHeap (unsigned long size, EGG::Heap *parentHeap)
	[Unused]. Creates a heap of the given size for the base.

virtual bool	entryFrmHeapNonAdjust (unsigned long size, EGG::Heap *parentHeap)
	[Unused]. Creates a heap of the given size for the base.

virtual bool	createHeap ()
	[Unused]. [Does nothing].

virtual	~fBase_c ()
	Destroys the base.

Protected Attributes inherited from fBase_c
u8	mLifecycleState
	The base's lifecycle state. Value is a LIFECYCLE_e.

bool	mDeleteRequested
	If deletion of the base was requested, but the `delete` operation has not been scheduled yet.

bool	mDeferExecute
	If the `create` operation was completed, but scheduling the `execute` and `draw` operations isn't possible at this time.

bool	mDeferRetryCreate
	If the `create` operation has not been completed, and rescheduling it isn't possible at this time.

u8	mGroupType
	The base's group type. Value is a GROUP_TYPE_e.

u8	mProcControl
	The operations to be skipped. Value is a PROC_DISABLE_e.

fManager_c	mMng
	The base's process manager.

fBaHelper_c *	mpUnusedHelper
	[Unused]. See Unused Content.

fLiMgBa_c	mUnusedList
	[Unused]. See Unused Content.

EGG::FrmHeap *	mHeap
	[Unused]. The base's dedicated heap.

Static Protected Attributes inherited from fBase_c
static int(*	sLoadAsyncCallback )()
	[Unused]. See Unused Content.

static void(*	sUnloadCallback )()
	[Unused]. See Unused Content.

Member Enumeration Documentation

◆ ANIM_e

enum dControllerInformation_c::ANIM_e

The identifier for each animation.

Enumerator
IN2BTN	The button's pop-out animation.
LOOP2BTN	The button's blinking loop animation.
HIT2BTN	The button's hit animation.

Definition at line 16 of file d_controller_information.hpp.

◆ STATE_e

enum dControllerInformation_c::STATE_e

The screen's current state.

Enumerator
IDLE	Initial state; waiting for layout creation.
SHOW_IN	Playing the button pop-out animation.
SHOW_LOOP	Waiting for the pop-out to finish.
WAITING_FOR_END	Playing the button animation while waiting for user input.
END	Playing the button pressed sound effect and the button shrinking animation.

Definition at line 23 of file d_controller_information.hpp.

Constructor & Destructor Documentation

◆ dControllerInformation_c()

dControllerInformation_c::dControllerInformation_c ( )

Constructs a new base.

Definition at line 10 of file d_controller_information.cpp.

◆ ~dControllerInformation_c()

dControllerInformation_c::~dControllerInformation_c ( )

virtual

Destroys the base.

Definition at line 12 of file d_controller_information.cpp.

Member Function Documentation

◆ create()

int dControllerInformation_c::create ( )

virtual

do method for the create operation.

Returns: A PACK_RESULT_e value.

Reimplemented from fBase_c.

Definition at line 14 of file d_controller_information.cpp.

◆ doDelete()

int dControllerInformation_c::doDelete ( )

virtual

do method for the delete operation.

This method was renamed due to conflict with the delete C++ keyword.

Returns: A PACK_RESULT_e value.

Reimplemented from fBase_c.

Definition at line 107 of file d_controller_information.cpp.

◆ execute()

int dControllerInformation_c::execute ( )

virtual

do method for the execute operation.

Returns: A PACK_RESULT_e value.

Reimplemented from fBase_c.

Definition at line 71 of file d_controller_information.cpp.

◆ draw()

int dControllerInformation_c::draw ( )

virtual

do method for the draw operation.

Returns: A PACK_RESULT_e value.

Reimplemented from fBase_c.

Definition at line 100 of file d_controller_information.cpp.

◆ setVisible()

void dControllerInformation_c::setVisible ( bool visible )

inline

Definition at line 38 of file d_controller_information.hpp.

◆ setState()

void dControllerInformation_c::setState ( STATE_e state )

inline

Definition at line 39 of file d_controller_information.hpp.

◆ createLayout()

bool dControllerInformation_c::createLayout ( )

private

Loads the resources and creates the layout for the base.

Returns: If the creation was successful.

Definition at line 33 of file d_controller_information.cpp.

Member Data Documentation

◆ mLayout

LytBase_c dControllerInformation_c::mLayout

private

The layout of the base.

Definition at line 46 of file d_controller_information.hpp.

◆ mIsCreated

bool dControllerInformation_c::mIsCreated

private

If the layout has been successfully created.

Definition at line 47 of file d_controller_information.hpp.

◆ mVisible

bool dControllerInformation_c::mVisible

private

If the layout should be rendered.

Definition at line 48 of file d_controller_information.hpp.

◆ mState

STATE_e dControllerInformation_c::mState

private

Which state the base is currently in.

Definition at line 49 of file d_controller_information.hpp.

Description

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ ANIM_e

◆ STATE_e

Constructor & Destructor Documentation

◆ dControllerInformation_c()

◆ ~dControllerInformation_c()

Member Function Documentation

◆ create()

◆ doDelete()

◆ execute()

◆ draw()

◆ setVisible()

◆ setState()

◆ createLayout()

Member Data Documentation

◆ mLayout

◆ mIsCreated

◆ mVisible

◆ mState