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

Display of the bars and gems of a pitch track on the play field, kept a stretch of ticks ahead of the song. More...

#include <pitchtrackdisplay.h>

Public Member Functions

 PitchTrackDisplay (int nTrack, int nLeadInBars, int nTicksPerBar, PlayMap *pPlayMap, SectionBoundaries *pSections, PitchTrackPlayGems *pGems)
 Construct a display.
 ~PitchTrackDisplay ()
 Withdraw the scheduled command and release the display.
void Start ()
 Show the bars ahead of the song and schedule the next update.
void Stop ()
 Withdraw the scheduled update.
void SetGems (PitchTrackPlayGems *pGems, int nStyle, int nUnused, int nOwner)
 Show other gems from the current bar on.
void BlankBars (int nStartBar, int nEndBar)
 Show a range of bars empty, outside the song.
void ShowGem (signed char nSlot, int nTick, bool bRepeat, int nOwner)
 Show a gem placed.
void HideGem (int nTick, bool bRepeat)
 Show a gem removed.
void Redraw (int nStartBar)
 Show again the gems from a bar to the last bar shown.
void Redraw (int nStartBar, int nEndBar)
 Show again the gems of a range of bars, ending no later than the last bar shown.
void ClearGems (int nStartBar)
 Remove the gems shown from a bar to the last bar shown.
void ClearGems (int nStartBar, int nEndBar)
 Remove the gems shown in a range of bars.
void RedrawBar (int nBar, bool bClear)
 Show a bar again, and each later bar shown that plays the same bar of the song.
void ClearRepeatedBars (int nBar)
 Remove the gems of a bar and of every other bar after it shown in the same section.
void ClearBar (int nBar, bool bRepeat)
 Remove the gems of a bar, and on request of every other bar after it in the same section.

Detailed Description

Display of the bars and gems of a pitch track on the play field, kept a stretch of ticks ahead of the song.

The RTTI records the command the class schedules. The class is not polymorphic. The member names are inferred.

Constructor & Destructor Documentation

◆ PitchTrackDisplay()

PitchTrackDisplay::PitchTrackDisplay ( int nTrack,
int nLeadInBars,
int nTicksPerBar,
PlayMap * pPlayMap,
SectionBoundaries * pSections,
PitchTrackPlayGems * pGems )

Construct a display.

Parameters
nTrackThe track.
nLeadInBarsThe bars the song plays before bar 0.
nTicksPerBarThe song ticks in one bar.
pPlayMapThe map of the song positions.
pSectionsThe sections of the song.
pGemsThe gems shown.
Ghidra address:
NTSC-U/C: 0x00129f50
Ghidra address:
PAL: 0x0012b748

◆ ~PitchTrackDisplay()

PitchTrackDisplay::~PitchTrackDisplay ( )

Withdraw the scheduled command and release the display.

Ghidra address:
NTSC-U/C: 0x00129fc8
Ghidra address:
PAL: 0x0012b7c0

Member Function Documentation

◆ Start()

void PitchTrackDisplay::Start ( )

Show the bars ahead of the song and schedule the next update.

Ghidra address:
NTSC-U/C: 0x0012a018
Ghidra address:
PAL: 0x0012b810

◆ Stop()

void PitchTrackDisplay::Stop ( )

Withdraw the scheduled update.

Ghidra address:
NTSC-U/C: 0x0012a038
Ghidra address:
PAL: 0x0012b830

◆ SetGems()

void PitchTrackDisplay::SetGems ( PitchTrackPlayGems * pGems,
int nStyle,
int nUnused,
int nOwner )

Show other gems from the current bar on.

Parameters
pGemsThe gems.
nStyleThe style of the gems.
nUnusedUnused.
nOwnerThe owner every gem is shown with, or -1 for the owner of each gem.
Ghidra address:
NTSC-U/C: 0x0012a070
Ghidra address:
PAL: 0x0012b868

◆ BlankBars()

void PitchTrackDisplay::BlankBars ( int nStartBar,
int nEndBar )

Show a range of bars empty, outside the song.

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

◆ ShowGem()

void PitchTrackDisplay::ShowGem ( signed char nSlot,
int nTick,
bool bRepeat,
int nOwner )

Show a gem placed.

Parameters
nSlotThe gem button.
nTickThe tick.
bRepeatWhether the gem repeats on every other bar of the section.
nOwnerThe player who placed the gem.
Ghidra address:
NTSC-U/C: 0x0012a1a8
Ghidra address:
PAL: 0x0012b9a0

◆ HideGem()

void PitchTrackDisplay::HideGem ( int nTick,
bool bRepeat )

Show a gem removed.

Parameters
nTickThe tick.
bRepeatWhether the gem repeats on every other bar of the section.
Ghidra address:
NTSC-U/C: 0x0012a1c8
Ghidra address:
PAL: 0x0012b9c0

◆ Redraw() [1/2]

void PitchTrackDisplay::Redraw ( int nStartBar)

Show again the gems from a bar to the last bar shown.

Parameters
nStartBarThe first bar.
Ghidra address:
NTSC-U/C: 0x0012a1f8
Ghidra address:
PAL: 0x0012b9f0

◆ Redraw() [2/2]

void PitchTrackDisplay::Redraw ( int nStartBar,
int nEndBar )

Show again the gems of a range of bars, ending no later than the last bar shown.

Parameters
nStartBarThe first bar.
nEndBarThe bar after the range.
Ghidra address:
NTSC-U/C: 0x0012a218
Ghidra address:
PAL: 0x0012ba10

◆ ClearGems() [1/2]

void PitchTrackDisplay::ClearGems ( int nStartBar)

Remove the gems shown from a bar to the last bar shown.

Parameters
nStartBarThe first bar.
Ghidra address:
NTSC-U/C: 0x0012a258
Ghidra address:
PAL: 0x0012ba50

◆ ClearGems() [2/2]

void PitchTrackDisplay::ClearGems ( int nStartBar,
int nEndBar )

Remove the gems shown in a range of bars.

Parameters
nStartBarThe first bar.
nEndBarThe bar after the range.
Ghidra address:
NTSC-U/C: 0x0012a278
Ghidra address:
PAL: 0x0012ba70

◆ RedrawBar()

void PitchTrackDisplay::RedrawBar ( int nBar,
bool bClear )

Show a bar again, and each later bar shown that plays the same bar of the song.

Parameters
nBarThe bar.
bClearWhether the gems of the bars are removed rather than shown again.
Ghidra address:
NTSC-U/C: 0x0012a2c8
Ghidra address:
PAL: 0x0012bac0

◆ ClearRepeatedBars()

void PitchTrackDisplay::ClearRepeatedBars ( int nBar)

Remove the gems of a bar and of every other bar after it shown in the same section.

Parameters
nBarThe bar.
Ghidra address:
NTSC-U/C: 0x0012a3c8
Ghidra address:
PAL: 0x0012bbc0

◆ ClearBar()

void PitchTrackDisplay::ClearBar ( int nBar,
bool bRepeat )

Remove the gems of a bar, and on request of every other bar after it in the same section.

Parameters
nBarThe bar.
bRepeatWhether every other bar of the section is cleared.
Ghidra address:
NTSC-U/C: 0x0012a468
Ghidra address:
PAL: 0x0012bc60

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