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

Panel that shows the picture of a band or of an arena on the mesh <name>.mesh. More...

#include <songpicpanel.h>

Inheritance diagram for SongPicPanel:
Collaboration diagram for SongPicPanel:

Public Member Functions

 ~SongPicPanel () override=default
 Destroy the object.
 SongPicPanel (DataArray *pData, const char *pszDir)
 Construct a panel from its script description, with no picture.
void Exit (bool bForce, float fTime) override
 Start the exit and release the picture.
void Poll (float fTime) override
 Advance the panel, and place a picture that finished loading on the picture mesh.
void FinishLoad () override
 Finish the load, and find and hide the picture mesh <name>.mesh.
void SetBandPicture (const char *pszSong, bool bSmall, bool bUnlocked, bool bEncrypted)
 Start loading the picture of a song's band.
void SetArenaPicture (const char *pszArena)
 Start loading the picture of an arena, Metagame\image\<arena>_band.bmp.
void SetPictureShowing (bool bShowing)
 Show or hide the picture mesh.
int GetPictureReady () const
int GetPictureShowing () const
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 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.
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.

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

Panel that shows the picture of a band or of an arena on the mesh <name>.mesh.

The RTTI records the class as deriving from FreqPanel. The object is 0x110 bytes and its vtable is at 0x003cc838. The metagame registers the class for the panel type song_pic_panel, and the song screen's s_g_sel_song_pic panel is one. A picture is a texture file that loads in the background. Poll() places it on the mesh once it has loaded. The destructor at 0x00357140 is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ ~SongPicPanel()

SongPicPanel::~SongPicPanel ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00357140
Ghidra address:
PAL: 0x003c43a0

◆ SongPicPanel()

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

Construct a panel from its script description, with no picture.

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

Member Function Documentation

◆ New()

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

Create a panel from its script description.

The metagame registers the routine for the panel type song_pic_panel.

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

◆ Exit()

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

Start the exit and release the picture.

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

Reimplemented from FreqPanel.

◆ Poll()

void SongPicPanel::Poll ( float fTime)
overridevirtual

Advance the panel, and place a picture that finished loading on the picture mesh.

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

Reimplemented from FreqPanel.

◆ FinishLoad()

void SongPicPanel::FinishLoad ( )
overridevirtual

Finish the load, and find and hide the picture mesh <name>.mesh.

Ghidra address:
NTSC-U/C: 0x0016f3b8
Ghidra address:
PAL: 0x00172608

Reimplemented from FreqPanel.

◆ SetBandPicture()

void SongPicPanel::SetBandPicture ( const char * pszSong,
bool bSmall,
bool bUnlocked,
bool bEncrypted )

Start loading the picture of a song's band.

The picture is Songs\<song>\<song>_encrypt.bmp for an encrypted song, Songs\<song>\<song>_band_sm.bmp for the small picture, and Songs\<song>\<song>_band.bmp otherwise.

Parameters
pszSongThe song.
bSmallWhether the small picture loads.
bUnlockedWhether the song is unlocked.
bEncryptedWhether the song is locked and hidden.
Ghidra address:
NTSC-U/C: 0x0016f458
Ghidra address:
PAL: 0x001726a8

◆ SetArenaPicture()

void SongPicPanel::SetArenaPicture ( const char * pszArena)

Start loading the picture of an arena, Metagame\image\<arena>_band.bmp.

Parameters
pszArenaThe arena.
Ghidra address:
NTSC-U/C: 0x0016f550
Ghidra address:
PAL: 0x00172808

◆ SetPictureShowing()

void SongPicPanel::SetPictureShowing ( bool bShowing)

Show or hide the picture mesh.

A shown picture appears only once the panel is loaded and the picture is placed.

Parameters
bShowingWhether the picture shows.
Ghidra address:
NTSC-U/C: 0x0016f5f8
Ghidra address:
PAL: 0x00172900

◆ GetPictureReady()

int SongPicPanel::GetPictureReady ( ) const
inline
Returns
Whether the loaded picture is placed on the mesh.

◆ GetPictureShowing()

int SongPicPanel::GetPictureShowing ( ) const
inline
Returns
Whether the picture shows.

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