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

Panel with the list of launchpads sorted or found by the player, whose mesh flashes while the list loads. More...

#include <netsortedlaunchpadspanel.h>

Inheritance diagram for NetSortedLaunchpadsPanel:
Collaboration diagram for NetSortedLaunchpadsPanel:

Public Types

enum  Page { kPageFirst = 0 , kPageNext = 1 , kPageRefresh = 2 , kPagePrevious = 3 }
 The pages Request() takes, as NetLobby::RequestLaunchpads() takes them. More...
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 Member Functions

 NetSortedLaunchpadsPanel (DataArray *pData, const char *pszDir)
 Construct the panel from its script description, with an empty query.
 ~NetSortedLaunchpadsPanel () override
 Destroy the panel.
bool DispatchPriv (Message *pMsg) override
 Route the list of launchpads, the choice, and the controller messages.
void Enter (bool bForce, float fTime) override
 Enter, find the objects of the flash, and request the start of the list.
void SetSearch (const char *pszArena, int nRuleSet, int nSkillLevel)
 Set the search whose sessions the panel lists.
void Request (int nPage)
 Clear the data panel and request a page, unless the previous page is requested and no launchpads precede the list.
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 Exit (bool bForce, float fTime) override
 Start the exit animation and the exit of the panel material animation.
void DrawGizmo () override
 Stretch the gizmo pyramid from the background mesh to the gizmo and draw it.
void Poll (float fTime) override
 Advance the panel to a time and move the panel animation to the panel's frame.
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 FinishLoad () override
 Find the meshes and animations of the panel once its file has loaded.
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.
virtual void Focus ()
 React to the screen giving the panel the focus by letting the navigator move the focus.
virtual void Unfocus ()
 React to the screen taking the focus away.
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 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 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 with the list of launchpads sorted or found by the player, whose mesh flashes while the list loads.

The RTTI records the class as deriving from FreqPanel and from NetFlashUpdate.

Member Enumeration Documentation

◆ Page

The pages Request() takes, as NetLobby::RequestLaunchpads() takes them.

Enumerator
kPageFirst 

The start of the list.

kPageNext 

The page after the list.

kPageRefresh 

The list again, from the L1 button.

kPagePrevious 

The page before the list.

Constructor & Destructor Documentation

◆ NetSortedLaunchpadsPanel()

NetSortedLaunchpadsPanel::NetSortedLaunchpadsPanel ( DataArray * pData,
const char * pszDir )

Construct the panel from its script description, with an empty query.

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

◆ ~NetSortedLaunchpadsPanel()

NetSortedLaunchpadsPanel::~NetSortedLaunchpadsPanel ( )
inlineoverride

Destroy the panel.

Ghidra address:
NTSC-U/C: 0x003587e0
Ghidra address:
PAL: 0x003c5b90

Member Function Documentation

◆ New()

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

Create a panel from its script description.

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

◆ DispatchPriv()

bool NetSortedLaunchpadsPanel::DispatchPriv ( Message * pMsg)
overridevirtual

Route the list of launchpads, the choice, and the controller messages.

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

Implements MsgSink.

◆ Enter()

void NetSortedLaunchpadsPanel::Enter ( bool bForce,
float fTime )
overridevirtual

Enter, find the objects of the flash, and request the start of the list.

Parameters
bForceWhether the panel skips its animation.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x00176358
Ghidra address:
PAL: 0x001797b8

Reimplemented from FreqPanel.

◆ SetSearch()

void NetSortedLaunchpadsPanel::SetSearch ( const char * pszArena,
int nRuleSet,
int nSkillLevel )

Set the search whose sessions the panel lists.

Parameters
pszArenaThe arena, or an empty string for any.
nRuleSetThe game mode.
nSkillLevelThe skill level, or -1 for any.
Ghidra address:
NTSC-U/C: 0x00176310
Ghidra address:
PAL: 0x00179770

◆ Request()

void NetSortedLaunchpadsPanel::Request ( int nPage)

Clear the data panel and request a page, unless the previous page is requested and no launchpads precede the list.

The name is inferred.

Parameters
nPageOne of Page.
Ghidra address:
NTSC-U/C: 0x00176498
Ghidra address:
PAL: 0x001798f8

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