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

Panel of the online main screen whose data the lobby service sends, requested again a while after each reply. More...

#include <netmainpanel.h>

Inheritance diagram for NetMainPanel:
Collaboration diagram for NetMainPanel:

Public Member Functions

 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.
virtual void RequestUpdate ()
 Request the data of the panel from the lobby service.
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.
void Focus () override
 Take the focus, and show the focused materials once the panel has loaded.
void Unfocus () override
 Show the unfocused materials once the panel has loaded.
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.

Protected Member Functions

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

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

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...
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.
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.

Detailed Description

Panel of the online main screen whose data the lobby service sends, requested again a while after each reply.

The RTTI records the class as deriving from FocusChangePanel and from NetFlashUpdate at +0x100. Its vtable is at 0x003cd028. The L1 button requests the data at once. With the description's hilite_flash_panel set, the panel mesh flashes while a request is pending.

Constructor & Destructor Documentation

◆ NetMainPanel()

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

Construct the panel from its script description.

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

◆ ~NetMainPanel()

NetMainPanel::~NetMainPanel ( )
inlineoverride

Destroy the panel.

Ghidra address:
NTSC-U/C: 0x00357b80
Ghidra address:
PAL: 0x003c4f30

Member Function Documentation

◆ DispatchPriv()

bool NetMainPanel::DispatchPriv ( Message * pMsg)
overridevirtual

Route the controller to HandleJoypad().

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

Implements MsgSink.

Reimplemented in NetMainPlayersPanel.

◆ Enter()

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

Enter unfocused, show the titles instead of the refresh text, and request the data on the next Poll().

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

Reimplemented from FreqPanel.

Reimplemented in NetMainPlayersPanel.

◆ Exit()

void NetMainPanel::Exit ( bool bForce,
float fTime )
overridevirtual

Cancel the pending request and exit.

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

Reimplemented from FreqPanel.

Reimplemented in NetMainPlayersPanel.

◆ Poll()

void NetMainPanel::Poll ( float fTime)
overridevirtual

Request the data once its time has passed, and advance the flash.

Parameters
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x00171f30
Ghidra address:
PAL: 0x00175378

Reimplemented from FreqPanel.

◆ FinishLoad()

void NetMainPanel::FinishLoad ( )
overridevirtual

Finish the load and find the objects of the flash.

Ghidra address:
NTSC-U/C: 0x00171df0
Ghidra address:
PAL: 0x00175238

Reimplemented from FreqPanel.

Reimplemented in NetMainPlayersPanel.

◆ RequestUpdate()

virtual void NetMainPanel::RequestUpdate ( )
inlinevirtual

Request the data of the panel from the lobby service.

The panel itself requests nothing. The name is inferred.

Ghidra address:
NTSC-U/C: 0x00357c48
Ghidra address:
PAL: 0x003c4ff8

Reimplemented in NetMainLaunchpadsPanel, NetMainLobbiesPanel, and NetMainPlayersPanel.

◆ RequestNow()

void NetMainPanel::RequestNow ( bool bHilite)

Request the data on the next Poll() and start the flash.

The name is inferred.

Parameters
bHiliteWhether the mesh ends with the lit material.
Ghidra address:
NTSC-U/C: 0x00172010
Ghidra address:
PAL: 0x00175458

◆ HandleJoypad()

bool NetMainPanel::HandleJoypad ( JoypadInputMsg * pMsg)
protected

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.

The name is inferred.

Parameters
pMsgThe message.
Returns
True during a transition, otherwise false.
Ghidra address:
NTSC-U/C: 0x00172120
Ghidra address:
PAL: 0x00175568

Member Data Documentation

◆ mRequestTime

float NetMainPanel::mRequestTime
protected

The SystemMs() time of the next request, or 0 for none.

◆ mFlashPanel

int NetMainPanel::mFlashPanel
protected

The description's hilite_flash_panel, whether the mesh flashes.


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