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

Panel whose meshes change material while it has the focus. More...

#include <focuschangepanel.h>

Inheritance diagram for FocusChangePanel:
Collaboration diagram for FocusChangePanel:

Public Member Functions

 ~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 Enter (bool bForce, float fTime) override
 Start the entry animation and the entry of the panel material animation.
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.
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.

Protected Attributes

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.

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 whose meshes change material while it has the focus.

The RTTI records the class as deriving from FreqPanel. Its vtable is at 0x003cc8c0. With the focus, the panel mesh <name>_panel.mesh takes panel_<prefix>_hi.mat and the background <name>_bg.mesh takes bg_hi.mat. Without the focus they take panel_<prefix>.mat and bg_no.mat. The prefix is the description's focus_material_prefix, sub by default.

Constructor & Destructor Documentation

◆ ~FocusChangePanel()

FocusChangePanel::~FocusChangePanel ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00357098
Ghidra address:
PAL: 0x003c42f8

◆ FocusChangePanel()

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

Construct the panel from its script description.

Parameters
pDataThe script description.
pszDirThe directory of the panel's files.
Ghidra address:
NTSC-U/C: 0x0016ef40
Ghidra address:
PAL: 0x00172190

Member Function Documentation

◆ Focus()

void FocusChangePanel::Focus ( )
overridevirtual

Take the focus, and show the focused materials once the panel has loaded.

Ghidra address:
NTSC-U/C: 0x0016efb8
Ghidra address:
PAL: 0x00172208

Reimplemented from UIPanel.

Reimplemented in NetHostLPadButtonPanel, NetMainLaunchpadsPanel, NetMainLobbiesPanel, NetMainPlayersPanel, and PlaylistPanel.

◆ Unfocus()

void FocusChangePanel::Unfocus ( )
overridevirtual

Show the unfocused materials once the panel has loaded.

Ghidra address:
NTSC-U/C: 0x0016f178
Ghidra address:
PAL: 0x001723c8

Reimplemented from UIPanel.

Reimplemented in NetHostLPadButtonPanel, NetMainLaunchpadsPanel, NetMainLobbiesPanel, NetMainPlayersPanel, and PlaylistPanel.

Member Data Documentation

◆ mMaterialPrefix

String FocusChangePanel::mMaterialPrefix
protected

The focus_material_prefix entry.


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