wavelength 1.0.0
Loading...
Searching...
No Matches
Track Class Referenceabstract

One instrument track of the song that a player can play. More...

#include <track.h>

Inheritance diagram for Track:
Collaboration diagram for Track:

Public Member Functions

 Track (int nIndex)
 Construct a track with no player.
virtual ~Track ()
 Release the track.
virtual void Start ()=0
 Start the track with the song.
virtual void Stop ()=0
 Stop the track with the song.
virtual void SetPlayer (Player *pPlayer)
 Assign the player, and record the assignment in the session statistics.
virtual void HandleInput (Player *pPlayer, const PlayNoteEvent &event)=0
 Act on a note a player played on this track.
virtual void HandleInput (Player *pPlayer, const BtnEvent< 8 > &event)=0
 Act on a button event of a player on this track.
virtual void HandleInput (Player *pPlayer, const StickEvent< 2 > &event)=0
 Act on a stick event of a player on this track.
virtual void HandleInput (Player *pPlayer, const StickEvent< 6 > &event)=0
 Act on a stick event of a player on this track.
virtual void HandleInput (Player *pPlayer, const BtnEvent< 10 > &event)=0
 Act on a button event of a player on this track.
int GetIndex () const
Player * GetPlayer () const

Protected Attributes

int mIndex
Player * mPlayer

Detailed Description

One instrument track of the song that a player can play.

The RTTI includes the class name, and the class has no base. The derived classes include CatchTrack, FreestyleTrack, and RemixTrack. Two data words precede the vptr. The controller input a player receives is handed to the player's track through the five HandleInput() overloads, which this class declares pure.

Constructor & Destructor Documentation

◆ Track()

Track::Track ( int nIndex)
explicit

Construct a track with no player.

Parameters
nIndexThe track's index in the song.
Ghidra address:
NTSC-U/C: 0x0013e6c0
Ghidra address:
PAL: 0x0013ff90

◆ ~Track()

virtual Track::~Track ( )
inlinevirtual

Release the track.

Ghidra address:
NTSC-U/C: 0x00343758
Ghidra address:
PAL: 0x003b0c90

Member Function Documentation

◆ Start()

virtual void Track::Start ( )
pure virtual

Start the track with the song.

Implemented in AxeTrack, CatchTrack, DuelTrack, PitchTrack, ScratchTrack, and VoxTrack.

◆ Stop()

virtual void Track::Stop ( )
pure virtual

Stop the track with the song.

Implemented in AxeTrack, CatchTrack, DuelTrack, FreestyleTrack, PitchTrack, ScratchTrack, and VoxTrack.

◆ SetPlayer()

virtual void Track::SetPlayer ( Player * pPlayer)
virtual

Assign the player, and record the assignment in the session statistics.

Parameters
pPlayerThe player, or null.
Ghidra address:
NTSC-U/C: 0x0013e6e0
Ghidra address:
PAL: 0x0013ffb0

Reimplemented in AxeTrack, CatchTrack, FreestyleTrack, PitchTrack, ScratchTrack, and VoxTrack.

◆ HandleInput() [1/5]

virtual void Track::HandleInput ( Player * pPlayer,
const PlayNoteEvent & event )
pure virtual

Act on a note a player played on this track.

Parameters
pPlayerThe player.
eventThe event.

Implemented in AxeTrack, CatchTrack, DuelTrack, FreestyleTrack, PitchTrack, ScratchTrack, and VoxTrack.

◆ HandleInput() [2/5]

virtual void Track::HandleInput ( Player * pPlayer,
const BtnEvent< 8 > & event )
pure virtual

Act on a button event of a player on this track.

Parameters
pPlayerThe player.
eventThe event.

Implemented in AxeTrack, CatchTrack, DuelTrack, FreestyleTrack, PitchTrack, ScratchTrack, and VoxTrack.

◆ HandleInput() [3/5]

virtual void Track::HandleInput ( Player * pPlayer,
const StickEvent< 2 > & event )
pure virtual

Act on a stick event of a player on this track.

Parameters
pPlayerThe player.
eventThe event.

Implemented in AxeTrack, CatchTrack, DuelTrack, FreestyleTrack, PitchTrack, ScratchTrack, and VoxTrack.

◆ HandleInput() [4/5]

virtual void Track::HandleInput ( Player * pPlayer,
const StickEvent< 6 > & event )
pure virtual

Act on a stick event of a player on this track.

Parameters
pPlayerThe player.
eventThe event.

Implemented in AxeTrack, CatchTrack, DuelTrack, FreestyleTrack, PitchTrack, ScratchTrack, and VoxTrack.

◆ HandleInput() [5/5]

virtual void Track::HandleInput ( Player * pPlayer,
const BtnEvent< 10 > & event )
pure virtual

Act on a button event of a player on this track.

Parameters
pPlayerThe player.
eventThe event.

Implemented in AxeTrack, CatchTrack, DuelTrack, FreestyleTrack, PitchTrack, ScratchTrack, and VoxTrack.

◆ GetIndex()

int Track::GetIndex ( ) const
inline
Returns
The track's index in the song.

◆ GetPlayer()

Player * Track::GetPlayer ( ) const
inline
Returns
The player on the track, or null.

Member Data Documentation

◆ mIndex

int Track::mIndex
protected

The track's index in the song. +0x00

◆ mPlayer

Player* Track::mPlayer
protected

The player on the track, or null. +0x04


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