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

The picture of the controller on the controller menu, which highlights one button or stick. More...

#include <controllerpanel.h>

Inheritance diagram for ControllerPanel:
Collaboration diagram for ControllerPanel:

Classes

class  Region
 One button or stick of the picture. More...

Public Member Functions

 ~ControllerPanel () override=default
 Destroy the object.
 ControllerPanel (DataArray *pData, const char *pszDir)
 Construct the panel from its script description.
void Enter (bool bForce, float fTime) override
 Find the picture's view and regions, hide every highlight, and enter.
void Poll (float fTime) override
 Run the picture's view to the time, then the panel.
void SetRegion (int nRegion)
 Highlight one region and stop highlighting the previous one.
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.
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.

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.

Static Public Attributes

static constexpr int kNumRegions = 16
 The number of regions, one for each button and stick.
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.

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

Detailed Description

The picture of the controller on the controller menu, which highlights one button or stick.

The RTTI records the class as deriving from FreqPanel. The object is 0x170 bytes and its vtable is at 0x003cc288. Each region of the picture is a button or a stick, indexed by JoypadButton, and has a mesh that shows while the region is highlighted and an animation the view runs.

Constructor & Destructor Documentation

◆ ~ControllerPanel()

ControllerPanel::~ControllerPanel ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00356b40
Ghidra address:
PAL: 0x003c3da0

◆ ControllerPanel()

ControllerPanel::ControllerPanel ( 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: 0x0016d788
Ghidra address:
PAL: 0x001709b0

Member Function Documentation

◆ New()

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

Create a panel from its script description.

Parameters
pDataThe script description.
pszDirThe directory of the panel's files.
Returns
The new panel.
Ghidra address:
NTSC-U/C: 0x00356af0
Ghidra address:
PAL: 0x003c3d50

◆ Enter()

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

Find the picture's view and regions, hide every highlight, and enter.

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

Reimplemented from UIPanel.

◆ Poll()

void ControllerPanel::Poll ( float fTime)
overridevirtual

Run the picture's view to the time, then the panel.

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

Reimplemented from UIPanel.

◆ SetRegion()

void ControllerPanel::SetRegion ( int nRegion)

Highlight one region and stop highlighting the previous one.

Parameters
nRegionThe region, one of JoypadButton, or kPadNone for none.
Ghidra address:
NTSC-U/C: 0x0016da28
Ghidra address:
PAL: 0x00170c50

Member Data Documentation

◆ kNumRegions

int ControllerPanel::kNumRegions = 16
staticconstexpr

The number of regions, one for each button and stick.


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