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

Panel of the online main screen that lists the launchpads of the lobby, with the host and up to four players of the selected launchpad. More...

#include <netmainlaunchpadspanel.h>

Inheritance diagram for NetMainLaunchpadsPanel:
Collaboration diagram for NetMainLaunchpadsPanel:

Public Member Functions

 NetMainLaunchpadsPanel (DataArray *pData, const char *pszDir)
 Construct the panel from its script description.
 ~NetMainLaunchpadsPanel () override
 Destroy the panel.
bool DispatchPriv (Message *pMsg) override
 Route the launchpads and the choice to their handlers.
void Focus () override
 Take the focus and move the cursor of the list.
void Unfocus () override
 Lose the focus, dim the cursor of the list, and hide the players.
void RequestUpdate () override
 Request the launchpads of the lobby.
void HidePlayers ()
 Hide the host and the rows of the players.
void ShowLaunchpad (NetLaunchpadInfo *pLaunchpad)
 Show the song or the remix of a launchpad as its host, and remember the launchpad.
void ShowPlayers (std::list< LobbyPlayer > *pPlayers, int nLaunchpad)
 Show the rank icons and the names of the players of the shown launchpad, or request the players again when they belong to another launchpad.
Public Member Functions inherited from NetMainPanel
 NetMainPanel (DataArray *pData, const char *pszDir)
 Construct the panel from its script description.
 ~NetMainPanel () override
 Destroy the panel.
bool DispatchPriv (Message *pMsg) override
 Route the controller to HandleJoypad().
void Enter (bool bForce, float fTime) override
 Enter unfocused, show the titles instead of the refresh text, and request the data on the next Poll().
void Exit (bool bForce, float fTime) override
 Cancel the pending request and exit.
void Poll (float fTime) override
 Request the data once its time has passed, and advance the flash.
void FinishLoad () override
 Finish the load and find the objects of the flash.
void RequestNow (bool bHilite)
 Request the data on the next Poll() and start the flash.
Public Member Functions inherited from FocusChangePanel
 ~FocusChangePanel () override=default
 Destroy the object.
 FocusChangePanel (DataArray *pData, const char *pszDir)
 Construct the panel from its script description.
Public Member Functions inherited from FreqPanel
 FreqPanel (DataArray *pData, const char *pszDir)
 Construct a panel from its script description.
 ~FreqPanel () override
 Destroy the panel.
void Unload () override
 Drop a reference to the panel's file, forgetting the meshes and the animation on the last reference.
void DrawGizmo () override
 Stretch the gizmo pyramid from the background mesh to the gizmo and draw it.
void Draw () override
 Move the panel material animations to the front-end time and draw the panel.
void SetShowing (bool bShowing) override
 Show or hide the panel's view and the gizmo pyramid.
void SetFocus (UIComponent *pComponent, int nButton) override
 Move the focus to a component and play the sound of the directional button that moved it.
void ShowGizmoMesh (bool bShowing)
 Show or hide the gizmo pyramid.
void UpdateBgBox ()
 Measure the background mesh into mBgBox.
Public Member Functions inherited from UIPanel
 UIPanel (DataArray *pData, const char *pszDir)
 Construct a hidden panel from its script description.
 ~UIPanel () override
 Destroy the panel, its components, and the objects its file loaded.
bool Dispatch (Message *pMsg) override
 Offer a message to the current screen, the panel, the navigator, and the component with the focus.
bool DispatchPriv (Message *pMsg) override
 Handle a message sent to the panel.
virtual void Load ()
 Take a reference to the panel's file, queueing the file on the first reference.
bool IsLoaded ()
 Report whether the panel's file has loaded, finishing the load when it has.
void AddComponent (UIComponent *pComponent)
 Register a component under its name.
void SetTextsShowing (bool bShowing)
 Show or hide every text object of the panel's file.
float ComputeFrame (float fTime)
 Report the frame of the entry and exit animation at a time.
UIComponent * FindComponent (const char *pszName, bool bFail)
 Find a component by name.
void LocalizeTexts (const char *pszFile, std::list< RndObject * > &objects)
 Collect and localise the text objects of the panel's file.
const char * GetName () const
UIComponent * GetFocus () const
int GetState () const
float GetTransitionStart () const
const std::map< const char *, std::unique_ptr< UIComponent >, StrLess > & GetComponents () 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.
Public Member Functions inherited from NetFlashUpdate
 NetFlashUpdate ()
 Construct a notice that is not flashing.
void InitFlash (const char *pszPanel, const char *pszKind)
 Find the objects of a panel and the materials of a kind of panel.
void StopFlash ()
 Stop flashing and give the mesh its final material.
void HideFlash ()
 Stop flashing, hide the refresh text, and show the titles.
void StartFlash (float fTime, bool bHilite)
 Show the refresh text instead of the titles and start flashing.
void PollFlash (float fTime)
 Swap the material of the mesh each interval until the mesh has flashed enough times.

Static Public Member Functions

static UIPanel * New (DataArray *pData, const char *pszDir)
 Create a panel from its script description.
Static Public Member Functions inherited from FreqPanel
static UIPanel * New (DataArray *pData, const char *pszDir)
 Create a panel from its script description.
static void Init (DataArray *pConfig)
 Read the freq_panel section of the metagame configuration.
Static Public Member Functions inherited from UIPanel
static void Init (DataArray *pConfig)
 Read the default frames of the entry and exit animation.
static UIPanel * New (DataArray *pData, const char *pszDir)
 Create a panel from its script description.

Additional Inherited Members

Public Types inherited from UIPanel
enum  State { kStateShown = 0 , kStateHidden = 1 , kStateEntering = 2 , kStateExiting = 3 }
 Where the panel is in its entry and exit, the values of mState. More...
Public Attributes inherited from FreqPanel
Box mBgBox
Static Public Attributes inherited from FreqPanel
static constexpr int kNumGizmoOffsets = 3
 The number of gizmo offsets the configuration provides.
static Vector3 sGizmoOrigPos
 The position of the gizmo, the panel_gizmo_orig_pos setting.
static Vector3 sGizmoOffsets [kNumGizmoOffsets]
 The points of the gizmo the pyramids reach, the panel_gizmo_offset_1 to _3 settings.
Protected Member Functions inherited from NetMainPanel
bool HandleJoypad (JoypadInputMsg *pMsg)
 Swallow a button during a transition, give the focus back to fn_main with the triangle or the left button, and request the data at once with the L1 button.
Protected Attributes inherited from NetMainPanel
float mRequestTime
int mFlashPanel
Protected Attributes inherited from FocusChangePanel
String mMaterialPrefix
Protected Attributes inherited from UIPanel
float mFrame
float mIdleFrame
const char * mName
String mFile
int mState
RndView * mView
const char * mFocusName
float mLoopStart
RndAnimatable * mLoopAnim
RndAnimatable * mEnterExitAnim
float mTransitionStart
float mShownFrame
float mHiddenFrame
float mEnterMs
float mExitMs
int mEnterReversed
int mExitReversed
float mEnterStartFrame
float mExitStartFrame
int mLoadRefs
int mLoaded
DataArray * mData
std::list< RndText * > mTexts
std::map< const char *, std::unique_ptr< UIComponent >, StrLess > mComponents
std::unique_ptr< UINavigator > mNavigator
UIComponent * mFocus
RndLoader * mLoader
std::unique_ptr< RndLoader > mOwnedLoader
 The loader the panel created, or null when it has none or uses a shared one.
Protected Attributes inherited from NetFlashUpdate
int mHilite
int mFlashing
int mFlashes
int mMaxFlashes
RndMat * mMat
RndMat * mHiliteMat
float mFlashTime
float mFlashInterval
RndView * mTitles
RndText * mRefresh
RndMesh * mPanelMesh

Detailed Description

Panel of the online main screen that lists the launchpads of the lobby, with the host and up to four players of the selected launchpad.

The RTTI records the class as deriving from NetMainPanel. Its vtable is at 0x003ccce0. The cross button on the cursor goes to join the selected launchpad.

Constructor & Destructor Documentation

◆ NetMainLaunchpadsPanel()

NetMainLaunchpadsPanel::NetMainLaunchpadsPanel ( DataArray * pData,
const char * pszDir )
inline

Construct the panel from its script description.

Parameters
pDataThe script description.
pszDirThe directory of the description file.
Ghidra address:
NTSC-U/C: 0x00173408
Ghidra address:
PAL: 0x00176850

◆ ~NetMainLaunchpadsPanel()

NetMainLaunchpadsPanel::~NetMainLaunchpadsPanel ( )
inlineoverride

Destroy the panel.

Ghidra address:
NTSC-U/C: 0x00358208
Ghidra address:
PAL: 0x003c55b8

Member Function Documentation

◆ New()

UIPanel * NetMainLaunchpadsPanel::New ( DataArray * pData,
const char * pszDir )
inlinestatic

Create a panel from its script description.

Metagame::RegisterScreenClasses() registers the routine for the entry type fn_main_launchpads_panel.

Parameters
pDataThe script description.
pszDirThe directory of the description file.
Returns
The new panel.
Ghidra address:
NTSC-U/C: 0x00358310
Ghidra address:
PAL: 0x003c56c0

◆ DispatchPriv()

bool NetMainLaunchpadsPanel::DispatchPriv ( Message * pMsg)
overridevirtual

Route the launchpads and the choice to their handlers.

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

Implements MsgSink.

◆ Focus()

void NetMainLaunchpadsPanel::Focus ( )
overridevirtual

Take the focus and move the cursor of the list.

Ghidra address:
NTSC-U/C: 0x00173490
Ghidra address:
PAL: 0x001768d8

Reimplemented from FocusChangePanel.

◆ Unfocus()

void NetMainLaunchpadsPanel::Unfocus ( )
overridevirtual

Lose the focus, dim the cursor of the list, and hide the players.

Ghidra address:
NTSC-U/C: 0x001734f8
Ghidra address:
PAL: 0x00176940

Reimplemented from FocusChangePanel.

◆ RequestUpdate()

void NetMainLaunchpadsPanel::RequestUpdate ( )
overridevirtual

Request the launchpads of the lobby.

Ghidra address:
NTSC-U/C: 0x00173440
Ghidra address:
PAL: 0x00176888

Reimplemented from NetMainPanel.

◆ HidePlayers()

void NetMainLaunchpadsPanel::HidePlayers ( )

Hide the host and the rows of the players.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x00173568
Ghidra address:
PAL: 0x001769b0

◆ ShowLaunchpad()

void NetMainLaunchpadsPanel::ShowLaunchpad ( NetLaunchpadInfo * pLaunchpad)

Show the song or the remix of a launchpad as its host, and remember the launchpad.

The name is inferred.

Parameters
pLaunchpadThe launchpad.
Ghidra address:
NTSC-U/C: 0x00173730
Ghidra address:
PAL: 0x00176b78

◆ ShowPlayers()

void NetMainLaunchpadsPanel::ShowPlayers ( std::list< LobbyPlayer > * pPlayers,
int nLaunchpad )

Show the rank icons and the names of the players of the shown launchpad, or request the players again when they belong to another launchpad.

The name is inferred.

Parameters
pPlayersThe players.
nLaunchpadThe launchpad of the players.
Ghidra address:
NTSC-U/C: 0x001738c0
Ghidra address:
PAL: 0x00176d20

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