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

Vocal track of a remixed song, whose players switch its sections on and off. More...

#include <voxtrack.h>

Inheritance diagram for VoxTrack:
Collaboration diagram for VoxTrack:

Public Member Functions

 VoxTrack (CatchTrackData *pGems, PlayMap *pPlayMap, SectionBoundaries *pSections, SlotGrid *pPatternGrid, int nTrack, int nLeadInBars, int nNumBars, int nTicksPerBar)
 Construct the track for one song track.
 ~VoxTrack () override
 Release the track.
void Start () override
 Start the track with the song.
void Stop () override
 Stop the track with the song.
void SetPlayer (Player *pPlayer) override
 Give the track to the player it plays for, and show the player an empty phrase on it.
void HandleInput (Player *pPlayer, const PlayNoteEvent &event) override
 Play the sound of an edit the track refuses when a gem button is pressed.
void HandleInput (Player *pPlayer, const BtnEvent< 8 > &event) override
 Play the sound of an edit the track refuses.
void HandleInput (Player *pPlayer, const StickEvent< 2 > &event) override
 Ignore a stick event.
void HandleInput (Player *pPlayer, const StickEvent< 6 > &event) override
 Ignore a stick event.
void HandleInput (Player *pPlayer, const BtnEvent< 10 > &event) override
 Ignore a button event.
void SetMuteRemote (bool bMuteRemote) override
 Set whether the track is silent while a player on another console is on it.
bool GetMuteRemote () const override
 Report whether the track is silent while a player on another console is on it.
void SkipBars (int nStartBar, int nEndBar) override
 Show a range of bars empty.
void RebuildGems () override
 Copy the switch of each section's pattern into the section.
void SetActive (bool bActive) override
 Set whether the track is the one the song's player plays, which silences it.
bool IsActive () const override
 Report whether the track is the one the song's player plays.
void Redraw (int nStartBar) override
 Show the track again from a bar on.
void Save (BinStream &stream) override
 Write the switch of each section, one byte per section.
void Load (BinStream &stream) override
 Read the switch of each section, one byte per section.
void SetSection (int nSection)
 Set the section the song plays.
void SetSectionMuted (int nSection, bool bMuted)
 Switch a section off or on.
bool IsSectionMuted (int nSection) const
 Report whether a section is switched off.
Public Member Functions inherited from RemixTrack
 RemixTrack (int nIndex)
 Construct a track with no player.
Public Member Functions inherited from Track
 Track (int nIndex)
 Construct a track with no player.
virtual ~Track ()
 Release the track.
int GetIndex () const
Player * GetPlayer () const

Additional Inherited Members

Protected Attributes inherited from Track
int mIndex
Player * mPlayer

Detailed Description

Vocal track of a remixed song, whose players switch its sections on and off.

The RTTI records the class as deriving from RemixTrack. The track plays its gems unless it is active, a player on another console silences it, or the section that plays is switched off. The names of the members other than the Track and RemixTrack overrides are inferred.

Constructor & Destructor Documentation

◆ VoxTrack()

VoxTrack::VoxTrack ( CatchTrackData * pGems,
PlayMap * pPlayMap,
SectionBoundaries * pSections,
SlotGrid * pPatternGrid,
int nTrack,
int nLeadInBars,
int nNumBars,
int nTicksPerBar )

Construct the track for one song track.

Parameters
pGemsThe gems of the song track.
pPlayMapThe map of the song positions.
pSectionsThe sections of the song.
pPatternGridThe pattern each section repeats.
nTrackThe index of the song track.
nLeadInBarsThe bars the song plays before bar 0.
nNumBarsThe length of the song in bars.
nTicksPerBarThe song ticks in one bar.
Ghidra address:
NTSC-U/C: 0x00142880
Ghidra address:
PAL: 0x00144220

◆ ~VoxTrack()

VoxTrack::~VoxTrack ( )
override

Release the track.

Ghidra address:
NTSC-U/C: 0x00142aa8
Ghidra address:
PAL: 0x00144448

Member Function Documentation

◆ Start()

void VoxTrack::Start ( )
overridevirtual

Start the track with the song.

Ghidra address:
NTSC-U/C: 0x00142b38
Ghidra address:
PAL: 0x001444d8

Implements Track.

◆ Stop()

void VoxTrack::Stop ( )
overridevirtual

Stop the track with the song.

Ghidra address:
NTSC-U/C: 0x00142b70
Ghidra address:
PAL: 0x00144510

Implements Track.

◆ SetPlayer()

void VoxTrack::SetPlayer ( Player * pPlayer)
overridevirtual

Give the track to the player it plays for, and show the player an empty phrase on it.

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

Reimplemented from Track.

◆ HandleInput() [1/5]

void VoxTrack::HandleInput ( Player * pPlayer,
const PlayNoteEvent & event )
overridevirtual

Play the sound of an edit the track refuses when a gem button is pressed.

Parameters
pPlayerThe player.
eventThe event.
Ghidra address:
NTSC-U/C: 0x00143068
Ghidra address:
PAL: 0x00144a08

Implements Track.

◆ HandleInput() [2/5]

void VoxTrack::HandleInput ( Player * pPlayer,
const BtnEvent< 8 > & event )
overridevirtual

Play the sound of an edit the track refuses.

Parameters
pPlayerThe player.
eventThe event.
Ghidra address:
NTSC-U/C: 0x00143090
Ghidra address:
PAL: 0x00144a30

Implements Track.

◆ HandleInput() [3/5]

void VoxTrack::HandleInput ( Player * pPlayer,
const StickEvent< 2 > & event )
inlineoverridevirtual

Ignore a stick event.

The body is empty.

Parameters
pPlayerThe player.
eventThe event.
Ghidra address:
NTSC-U/C: 0x003444b0
Ghidra address:
PAL: 0x003b19e8

Implements Track.

◆ HandleInput() [4/5]

void VoxTrack::HandleInput ( Player * pPlayer,
const StickEvent< 6 > & event )
inlineoverridevirtual

Ignore a stick event.

The body is empty.

Parameters
pPlayerThe player.
eventThe event.
Ghidra address:
NTSC-U/C: 0x003444b8
Ghidra address:
PAL: 0x003b19f0

Implements Track.

◆ HandleInput() [5/5]

void VoxTrack::HandleInput ( Player * pPlayer,
const BtnEvent< 10 > & event )
inlineoverridevirtual

Ignore a button event.

The body is empty.

Parameters
pPlayerThe player.
eventThe event.
Ghidra address:
NTSC-U/C: 0x003444c0
Ghidra address:
PAL: 0x003b19f8

Implements Track.

◆ SetMuteRemote()

void VoxTrack::SetMuteRemote ( bool bMuteRemote)
overridevirtual

Set whether the track is silent while a player on another console is on it.

Parameters
bMuteRemoteWhether the track is silent.
Ghidra address:
NTSC-U/C: 0x00142c10
Ghidra address:
PAL: 0x001445b0

Implements RemixTrack.

◆ GetMuteRemote()

bool VoxTrack::GetMuteRemote ( ) const
overridevirtual

Report whether the track is silent while a player on another console is on it.

Returns
mMuteRemote.
Ghidra address:
NTSC-U/C: 0x00142c30
Ghidra address:
PAL: 0x001445d0

Implements RemixTrack.

◆ SkipBars()

void VoxTrack::SkipBars ( int nStartBar,
int nEndBar )
overridevirtual

Show a range of bars empty.

Parameters
nStartBarThe first bar of the range.
nEndBarThe bar after the range.
Ghidra address:
NTSC-U/C: 0x00142e30
Ghidra address:
PAL: 0x001447d0

Implements RemixTrack.

◆ RebuildGems()

void VoxTrack::RebuildGems ( )
overridevirtual

Copy the switch of each section's pattern into the section.

Ghidra address:
NTSC-U/C: 0x00142e50
Ghidra address:
PAL: 0x001447f0

Implements RemixTrack.

◆ SetActive()

void VoxTrack::SetActive ( bool bActive)
overridevirtual

Set whether the track is the one the song's player plays, which silences it.

Parameters
bActiveWhether the track is active.
Ghidra address:
NTSC-U/C: 0x00142c58
Ghidra address:
PAL: 0x001445f8

Implements RemixTrack.

◆ IsActive()

bool VoxTrack::IsActive ( ) const
overridevirtual

Report whether the track is the one the song's player plays.

Returns
mActive.
Ghidra address:
NTSC-U/C: 0x00142c78
Ghidra address:
PAL: 0x00144618

Implements RemixTrack.

◆ Redraw()

void VoxTrack::Redraw ( int nStartBar)
overridevirtual

Show the track again from a bar on.

Parameters
nStartBarThe first bar.
Ghidra address:
NTSC-U/C: 0x00143048
Ghidra address:
PAL: 0x001449e8

Implements RemixTrack.

◆ Save()

void VoxTrack::Save ( BinStream & stream)
overridevirtual

Write the switch of each section, one byte per section.

Parameters
streamThe stream.
Ghidra address:
NTSC-U/C: 0x001430b0
Ghidra address:
PAL: 0x00144a50

Implements RemixTrack.

◆ Load()

void VoxTrack::Load ( BinStream & stream)
overridevirtual

Read the switch of each section, one byte per section.

Parameters
streamThe stream.
Ghidra address:
NTSC-U/C: 0x00143268
Ghidra address:
PAL: 0x00144c00

Implements RemixTrack.

◆ SetSection()

void VoxTrack::SetSection ( int nSection)

Set the section the song plays.

Parameters
nSectionThe section.
Ghidra address:
NTSC-U/C: 0x00142c38
Ghidra address:
PAL: 0x001445d8

◆ SetSectionMuted()

void VoxTrack::SetSectionMuted ( int nSection,
bool bMuted )

Switch a section off or on.

Parameters
nSectionThe section.
bMutedWhether the section is silent.
Ghidra address:
NTSC-U/C: 0x00142c80
Ghidra address:
PAL: 0x00144620

◆ IsSectionMuted()

bool VoxTrack::IsSectionMuted ( int nSection) const

Report whether a section is switched off.

Parameters
nSectionThe section.
Returns
Whether the section is silent.
Ghidra address:
NTSC-U/C: 0x00142d70
Ghidra address:
PAL: 0x00144710

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