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

List of the jukebox playlist, with a light for each entry that plays and the picture of the selected entry on the panel the description's pic_panel gives. More...

#include <playlist.h>

Inheritance diagram for PlayList:
Collaboration diagram for PlayList:

Public Member Functions

 PlayList (DataArray *pData, const char *pszPanel)
 Construct a list from its script description.
 ~PlayList () override
 Destroy the list.
void UpdateRow (int nRow, int nItem) override
 Show the light and the name or the artist of an entry in a row.
void UpdateCursor () override
 Move the cursor and show the picture of the selected entry.
void SetSongs (const std::vector< PlaylistSongData > &songs, int nNumGroups)
 Replace the entries and keep the selection.
void ToggleSelected ()
 Turn the selected entry on or off.
const std::vector< PlaylistSongData > & GetSongs () const
std::vector< PlaylistSongData > & GetSongs ()
Public Member Functions inherited from FreqList
 ~FreqList () override=default
 Destroy the object.
 FreqList (DataArray *pData, const char *pszPanel)
 Construct the list from its script description.
void ScrollUp () override
 Select the previous item, and play the sound of the up button when the selection moved.
void ScrollDown () override
 Select the next item, and play the sound of the down button when the selection moved.
Public Member Functions inherited from UIList
 UIList (DataArray *pData, const char *pszPanel)
 Construct a list from its script description, cloning the template row once for each row.
 ~UIList () override
 Destroy the row clones and every object cloned with them.
bool DispatchPriv (Message *pMsg) override
 Pass a controller button to HandleJoypad().
void Print (PrnStream &stream) override
 Write a description of the list.
virtual void SetCursorSelected (bool bSelected)
 Give the cursor the material of the selected or of the normal state.
virtual bool HandleJoypad (JoypadInputMsg *pMsg)
 Scroll for up and down, and pass the cross button to the panel's cursor component.
RndView * CloneRow (int nRow, RndView *pTemplate)
 Clone the template row for one row.
void BuildRowCells (RndView *pRow)
 Record the cells of a row, emptying each text and hiding each mesh.
void SetCellMat (int nRow, int nColumn, RndMat *pMat)
 Show the mesh of a cell with a material.
void SetCellText (int nRow, int nColumn, const char *pszText)
 Set the text of a cell.
void SetCellFont (int nRow, int nColumn, RndFont *pFont)
 Set the font of a cell's text.
void SetRowFont (int nRow, RndFont *pFont)
 Set the font of every text of a row.
void SetSelected (int nSelected)
 Select an item, keeping the number of items.
void Refresh (int nItemCount, int nSelected)
 Set the number of items and the selection, and fill the rows.
int GetSelected () const
int GetItemCount () const
int GetRowCount () const
RndMesh * GetUpArrow () const
RndMesh * GetDownArrow () const
void SetShowUpArrow (int nShow)
void SetShowDownArrow (int nShow)
Public Member Functions inherited from UIComponent
 UIComponent (DataArray *pData)
 Construct a showing component in the normal state.
bool Dispatch (Message *pMsg) override
 Offer a message to the focused panel of the current screen, then handle it here.
virtual bool IsShowing () const
 Report whether the component is showing.
virtual void SetShowing (bool bShowing)
 Show or hide the component.
virtual const char * Text () const
 Report the text the component shows.
virtual void SetText (const char *pszText)
 Replace the text the component shows.
virtual int GetState () const
 Report the state the component shows.
virtual void SetState (int nState, bool bForce)
 Change the state the component shows.
virtual void Focus ()
 React to the panel giving the component the focus.
virtual void Unfocus ()
 React to the panel taking the focus away.
virtual void Poll (float fTime)
 Advance the component to a time.
const char * GetName () const
int GetShowing () 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 UIComponent * New (DataArray *pData, const char *pszPanel)
 Create a list from its script description.
Static Public Member Functions inherited from UIList
static UIComponent * New (DataArray *pData, const char *pszPanel)
 Create a list from its script description.
Static Public Member Functions inherited from UIComponent
static void Init (DataArray *pConfig)
 Read the parameters of the flash a button shows when it is chosen.

Additional Inherited Members

Public Types inherited from UIComponent
enum  State { kStateNormal = 0 , kStateSelected = 1 , kStateDisabled = 2 }
 The state a component shows, the values of mState and the index UIStyle selects with. More...
Static Public Attributes inherited from UIList
static constexpr int kKeepSelection = -99999
 The value of Refresh()'s selection that keeps the selected item.
Protected Attributes inherited from UIList
UIStyle * mStyle
int mItemCount
int mRowCount
int mColumnCount
int mCursorRow
int mSelected
int mRowPitch
std::list< std::vector< Cell > > mRowCells
std::vector< RndView * > mRows
std::vector< RndText * > mTextCells
const char * mPanelName
RndMesh * mCursor
RndMesh * mUpArrow
RndMesh * mDownArrow
Transform mCursorXfm
int mShowUpArrow
int mShowDownArrow
Protected Attributes inherited from UIComponent
const char * mName
int mShowing
int mState
Static Protected Attributes inherited from UIComponent
static int sNumFlashes
 Number of times a chosen button flashes before it reports the choice.
static float sSelectedMs
 Milliseconds of each flash a chosen button spends in the selected state.
static float sNormalMs
 Milliseconds of each flash a chosen button spends in the normal state.

Detailed Description

List of the jukebox playlist, with a light for each entry that plays and the picture of the selected entry on the panel the description's pic_panel gives.

The RTTI records the class as deriving from FreqList. Its vtable is at 0x003d0180. The entries before mNumGroups stand for groups of songs and show their name. The other entries show the short artist of their song.

Constructor & Destructor Documentation

◆ PlayList()

PlayList::PlayList ( DataArray * pData,
const char * pszPanel )

Construct a list from its script description.

Parameters
pDataThe script description.
pszPanelThe name of the panel the list belongs to.
Ghidra address:
NTSC-U/C: 0x001a82a0
Ghidra address:
PAL: 0x001aff90

◆ ~PlayList()

PlayList::~PlayList ( )
inlineoverride

Destroy the list.

Ghidra address:
NTSC-U/C: 0x003621b8
Ghidra address:
PAL: 0x003d06d0

Member Function Documentation

◆ New()

UIComponent * PlayList::New ( DataArray * pData,
const char * pszPanel )
inlinestatic

Create a list from its script description.

Parameters
pDataThe script description.
pszPanelThe name of the panel the list belongs to.
Returns
The new list.
Ghidra address:
NTSC-U/C: 0x003622b8
Ghidra address:
PAL: 0x003d07d0

◆ UpdateRow()

void PlayList::UpdateRow ( int nRow,
int nItem )
overridevirtual

Show the light and the name or the artist of an entry in a row.

Parameters
nRowThe row.
nItemThe entry.
Ghidra address:
NTSC-U/C: 0x001a83a0
Ghidra address:
PAL: 0x001b0090

Reimplemented from UIList.

◆ UpdateCursor()

void PlayList::UpdateCursor ( )
overridevirtual

Move the cursor and show the picture of the selected entry.

Ghidra address:
NTSC-U/C: 0x001a85b8
Ghidra address:
PAL: 0x001b02a8

Reimplemented from UIList.

◆ SetSongs()

void PlayList::SetSongs ( const std::vector< PlaylistSongData > & songs,
int nNumGroups )

Replace the entries and keep the selection.

The name is inferred.

Parameters
songsThe entries to copy.
nNumGroupsThe number of entries at the start that stand for groups of songs.
Ghidra address:
NTSC-U/C: 0x001a8338
Ghidra address:
PAL: 0x001b0028

◆ ToggleSelected()

void PlayList::ToggleSelected ( )

Turn the selected entry on or off.

The first entry turns every entry with it.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x001a86b8
Ghidra address:
PAL: 0x001b03a8

◆ GetSongs() [1/2]

const std::vector< PlaylistSongData > & PlayList::GetSongs ( ) const
inline
Returns
The entries of the list.

◆ GetSongs() [2/2]

std::vector< PlaylistSongData > & PlayList::GetSongs ( )
inline
Returns
The entries of the list.

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