wavelength 1.0.0
Loading...
Searching...
No Matches
FreqMakerPartConfigScreen Class Reference

The part screen of the Freq maker, for choosing one part of the Freq and its colour. More...

#include <freqmakerpartconfigscreen.h>

Inheritance diagram for FreqMakerPartConfigScreen:
Collaboration diagram for FreqMakerPartConfigScreen:

Public Member Functions

 FreqMakerPartConfigScreen (DataArray *pData)
 Construct the screen from its script description.
 ~FreqMakerPartConfigScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Route buttons about to be chosen, focus changes, and controller buttons, and pass on every other message.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Start the entry, list the choices of the part, and show the current choice and colour.
void Exit (UIScreen *pNextScreen, float fTime) override
 Start the exit and turn the camera back to the whole Freq.
const char * Title () override
 Report the localised title, f_maker_c_TITLE.
void ShowPartHelp ()
 Show the help f_maker_s_part_HELP with the name of the part.
void ApplyColor ()
 Colour the part with the hue, saturation, and brightness the buttons show.
void StepDown (int nValue, int nMin, int nLimit, int *pValue, LRButton *pButton)
 Step a setting down, hiding the left arrow at the lowest step and playing the WRONG cue once when the setting is already there.
void StepUp (int nValue, int nMin, int nLimit, int *pValue, LRButton *pButton)
 Step a setting up, hiding the right arrow at the highest step and playing the WRONG cue once when the setting is already there.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Step the choice or a colour setting on left and right, and move the focus to done on the cross button.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Restore the part and return to f_maker_custom on the triangle button, and allow the WRONG cue again when left or right is released.
bool HandleFocusChange (UIComponentFocusChangeMsg *pMsg)
 Show the help of the part when part receives the focus.
Public Member Functions inherited from FreqScreen
 FreqScreen (DataArray *pData)
 Construct a screen from its script description.
 ~FreqScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Play the sound of a chosen component, follow a shortcut, and keep unused controllers out.
void Draw () override
 Draw what goes under each panel, then the panels.
void Exit (UIScreen *pNextScreen, float fTime) override
 Move the projector to the next screen's place and start the exit.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Play the entry sound, show or hide the projector, and start the entry.
virtual void PlayButtonSound (int nButton)
 Play the menu sound of a controller button.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Play the sound of the button that chooses a component.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Choose the component the shortcuts section of the metagame configuration lists for the screen.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Pass on a controller button of a controller the players use, and swallow any other.
Public Member Functions inherited from UIScreen
 UIScreen (DataArray *pData)
 Construct a screen from its script description.
 ~UIScreen () override
 Destroy the screen.
bool Dispatch (Message *pMsg) override
 Offer a message to the manager, then handle it here, then pass a navigation message on.
bool DispatchPriv (Message *pMsg) override
 Follow the transition of a pressed button or a chosen component.
virtual void Poll (float fTime)
 Advance the panels to a time, and finish the exit or the entry once their animations stop.
virtual void Print (PrnStream &stream)
 Write a description of the screen, its panels, and its transitions.
void ClearTransitions ()
 Empty the transition table.
void AddTransition (const char *pszComponent, int nButton, const char *pszScreen)
 Append an entry to the transition table.
void AddPanel (UIPanel *pPanel)
 Add a panel to the screen.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Follow the transition of a pressed controller button.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Follow the transition of a component chosen with the cross button.
void SetFocus (UIPanel *pPanel)
 Move the focus to a panel.
UIComponent * FindComponent (const char *pszName)
 Find a component on any of the screen's panels.
Transition * FindTransition (UIComponent *pComponent, bool bFail)
 Find the transition of a component.
Transition * FindTransition (int nButton, bool bFail)
 Find the transition of a controller button.
void Load ()
 Load the panels.
void Unload ()
 Unload the panels.
bool IsLoaded ()
 Report whether every panel has loaded.
const char * GetName () const
const char * GetGroup () const
UIPanel * GetFocusPanel () const
UIScreen * GetNextScreen () const
UIScreen * GetPrevScreen () const
const std::map< const char *, UIPanel *, StrLess > & GetPanels () const
Public Member Functions inherited from MsgSink
void * operator new (size_t nSize)
 Allocate a sink from the pool heaps under the tag "MsgSink".
void operator delete (void *pBlock)
 Return a sink to the pool heaps.
virtual ~MsgSink ()
void * operator new (size_t size)
 Allocate from the main heap under the name MsgSink.
void operator delete (void *mem)
 Return memory to its heap.
virtual ~MsgSink ()
 Destroy the sink.

Static Public Member Functions

static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from FreqScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from UIScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.

Public Attributes

Color mOriginalColor
Public Attributes inherited from FreqScreen
Vector3 mGizmoOrig
Quat mGizmoRot

Additional Inherited Members

Protected Attributes inherited from UIScreen
const char * mName
const char * mGroup
std::map< const char *, UIPanel *, StrLess > mPanels
UIPanel * mFocusPanel
std::vector< Transition > mTransitions
UIScreen * mPrevScreen
UIScreen * mNextScreen
int mForceEntryExit

Detailed Description

The part screen of the Freq maker, for choosing one part of the Freq and its colour.

The RTTI records the class as deriving from FreqScreen. The object is 0xe0 bytes and its vtable is at 0x003cfdd0. The metagame registers the class for the screen type f_maker_part_screen, and the front-end description's f_maker_part screen is one. The part is the button of the f_maker_c panel with the focus. The f_maker_s panel steps through the unlocked choices with part and sets the colour with colorize (the hue), saturation, and brightness, each in 51 steps.

Constructor & Destructor Documentation

◆ FreqMakerPartConfigScreen()

FreqMakerPartConfigScreen::FreqMakerPartConfigScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001a0b38
Ghidra address:
PAL: 0x001a8818

◆ ~FreqMakerPartConfigScreen()

FreqMakerPartConfigScreen::~FreqMakerPartConfigScreen ( )
override

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x00360f20
Ghidra address:
PAL: 0x003cf438

Member Function Documentation

◆ New()

UIScreen * FreqMakerPartConfigScreen::New ( DataArray * pData)
inlinestatic

Create a screen from its script description.

The metagame registers the routine for the entry type f_maker_part_screen.

Parameters
pDataThe script description.
Returns
The new screen.
Ghidra address:
NTSC-U/C: 0x00360fe0
Ghidra address:
PAL: 0x003cf4f8

◆ DispatchPriv()

bool FreqMakerPartConfigScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route buttons about to be chosen, focus changes, and controller buttons, and pass on every other message.

Parameters
pMsgThe message.
Returns
Whether the message was handled.
Ghidra address:
NTSC-U/C: 0x001a1cb0
Ghidra address:
PAL: 0x001a9990

Implements MsgSink.

◆ Enter()

void FreqMakerPartConfigScreen::Enter ( UIScreen * pPrevScreen,
float fTime )
overridevirtual

Start the entry, list the choices of the part, and show the current choice and colour.

A current choice that is not unlocked is added to the end of the list.

Parameters
pPrevScreenThe screen this one replaces.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x001a0ba8
Ghidra address:
PAL: 0x001a8888

Reimplemented from UIScreen.

◆ Exit()

void FreqMakerPartConfigScreen::Exit ( UIScreen * pNextScreen,
float fTime )
overridevirtual

Start the exit and turn the camera back to the whole Freq.

Parameters
pNextScreenThe screen that replaces this one, or null.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x001a12f0
Ghidra address:
PAL: 0x001a8fd0

Reimplemented from UIScreen.

◆ Title()

const char * FreqMakerPartConfigScreen::Title ( )
overridevirtual

Report the localised title, f_maker_c_TITLE.

Returns
The title.
Ghidra address:
NTSC-U/C: 0x001a1450
Ghidra address:
PAL: 0x001a9130

Reimplemented from FreqScreen.

◆ ShowPartHelp()

void FreqMakerPartConfigScreen::ShowPartHelp ( )

Show the help f_maker_s_part_HELP with the name of the part.

Ghidra address:
NTSC-U/C: 0x001a13d8
Ghidra address:
PAL: 0x001a90b8

◆ ApplyColor()

void FreqMakerPartConfigScreen::ApplyColor ( )

Colour the part with the hue, saturation, and brightness the buttons show.

Ghidra address:
NTSC-U/C: 0x001a1480
Ghidra address:
PAL: 0x001a9160

◆ StepDown()

void FreqMakerPartConfigScreen::StepDown ( int nValue,
int nMin,
int nLimit,
int * pValue,
LRButton * pButton )

Step a setting down, hiding the left arrow at the lowest step and playing the WRONG cue once when the setting is already there.

Parameters
nValueThe setting.
nMinThe lowest step.
nLimitOne more than the highest step.
pValueReceives the new setting.
pButtonThe button of the setting.
Ghidra address:
NTSC-U/C: 0x001a1528
Ghidra address:
PAL: 0x001a9208

◆ StepUp()

void FreqMakerPartConfigScreen::StepUp ( int nValue,
int nMin,
int nLimit,
int * pValue,
LRButton * pButton )

Step a setting up, hiding the right arrow at the highest step and playing the WRONG cue once when the setting is already there.

Parameters
nValueThe setting.
nMinThe lowest step.
nLimitOne more than the highest step.
pValueReceives the new setting.
pButtonThe button of the setting.
Ghidra address:
NTSC-U/C: 0x001a15f0
Ghidra address:
PAL: 0x001a92d0

◆ HandleSelectStart()

bool FreqMakerPartConfigScreen::HandleSelectStart ( UIComponentSelectStartMsg * pMsg)

Step the choice or a colour setting on left and right, and move the focus to done on the cross button.

Parameters
pMsgThe message.
Returns
True for the buttons of the panel, otherwise the result of FreqScreen::HandleSelectStart().
Ghidra address:
NTSC-U/C: 0x001a16c0
Ghidra address:
PAL: 0x001a93a0

◆ HandleJoypad()

bool FreqMakerPartConfigScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Restore the part and return to f_maker_custom on the triangle button, and allow the WRONG cue again when left or right is released.

Parameters
pMsgThe message.
Returns
True while the screen moves, otherwise the result of FreqScreen::HandleJoypad().
Ghidra address:
NTSC-U/C: 0x001a1b30
Ghidra address:
PAL: 0x001a9810

◆ HandleFocusChange()

bool FreqMakerPartConfigScreen::HandleFocusChange ( UIComponentFocusChangeMsg * pMsg)

Show the help of the part when part receives the focus.

Parameters
pMsgThe message.
Returns
False.
Ghidra address:
NTSC-U/C: 0x001a1c48
Ghidra address:
PAL: 0x001a9928

Member Data Documentation

◆ mOriginalColor

Color FreqMakerPartConfigScreen::mOriginalColor

The colour the part had on entry. +0x80


The documentation for this class was generated from the following file: