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

The gems of a pitch track, by the bar of the song as written they lie in. More...

#include <pitchtrackgems.h>

Classes

struct  SecStats
 The owner of a section, and the number of gems that record the owner. More...

Public Member Functions

 PitchTrackGems (SectionBoundaries *pSections, SlotGrid *pPatterns, int nNumBars, int nTicksPerBar)
 Construct a track of bars with no gems.
 ~PitchTrackGems ()
 Release the gems.
bool AddGem (signed char nSlot, int nTick, signed char nOwner)
 Place a gem, replacing a gem at the same tick.
bool RemoveGem (int nTick)
 Remove the gem at a tick.
bool ToggleGem (signed char nSlot, int nTick, signed char nOwner)
 Remove the gem at a tick when it lies under the same gem button, and place it otherwise.
int GetOwner (int nBar)
 Report the owner of the section a bar lies in.
void ClearBar (int nBar)
 Remove every gem of a bar.
void ClearSection (int nSection)
 Remove every gem of a section and its owner.
void CopyBars (int nStartBar, int nEndBar, int nDestBar)
 Copy the gems of a range of bars to other bars.
void CopyBarsFrom (int nStartBar, int nEndBar, PitchTrackGems *pSource, int nOwner)
 Copy the gems of a range of bars of other gems to the same bars.
void CopyBars (int nStartBar, int nEndBar, int nDestBar, PitchTrackGems *pSource, int nOwner)
 Copy the gems of a range of bars of other gems, and record the owners of the sections the copies land in.
void ApplyPatterns ()
 Copy the gems of each section's pattern into the section.
std::vector< PitchGem > * GetBar (int nBar)
 Report the gems of a bar.
int CountGems (int nStartBar, int nEndBar)
 Count the gems of a range of bars.
void Save (BinStream &stream)
 Write the gems of the sections that repeat no pattern.
void Load (BinStream &stream)
 Replace every gem with the gems Save() wrote.

Detailed Description

The gems of a pitch track, by the bar of the song as written they lie in.

The class is not polymorphic. The name comes from the RTTI of its nested class SecStats. Each bar keeps its gems in tick order. The owner of a section is the player who placed its gems, and a section whose gems were all removed has no owner.

Constructor & Destructor Documentation

◆ PitchTrackGems()

PitchTrackGems::PitchTrackGems ( SectionBoundaries * pSections,
SlotGrid * pPatterns,
int nNumBars,
int nTicksPerBar )

Construct a track of bars with no gems.

Parameters
pSectionsThe sections of the song.
pPatternsThe pattern each section repeats, or null.
nNumBarsThe number of bars.
nTicksPerBarThe song ticks in one bar.
Ghidra address:
NTSC-U/C: 0x0012aaa8
Ghidra address:
PAL: 0x0012c2a0

◆ ~PitchTrackGems()

PitchTrackGems::~PitchTrackGems ( )

Release the gems.

Ghidra address:
NTSC-U/C: 0x0012ad50
Ghidra address:
PAL: 0x0012c548

Member Function Documentation

◆ AddGem()

bool PitchTrackGems::AddGem ( signed char nSlot,
int nTick,
signed char nOwner )

Place a gem, replacing a gem at the same tick.

Parameters
nSlotThe gem button.
nTickThe tick.
nOwnerThe player who places the gem, or -1.
Returns
Whether a gem at the same tick was replaced.
Ghidra address:
NTSC-U/C: 0x0012aeb8
Ghidra address:
PAL: 0x0012c6b0

◆ RemoveGem()

bool PitchTrackGems::RemoveGem ( int nTick)

Remove the gem at a tick.

Parameters
nTickThe tick.
Returns
Whether a gem was removed.
Ghidra address:
NTSC-U/C: 0x0012b278
Ghidra address:
PAL: 0x0012ca70

◆ ToggleGem()

bool PitchTrackGems::ToggleGem ( signed char nSlot,
int nTick,
signed char nOwner )

Remove the gem at a tick when it lies under the same gem button, and place it otherwise.

Parameters
nSlotThe gem button.
nTickThe tick.
nOwnerThe player who places the gem, or -1.
Returns
Whether a gem lies at the tick afterwards.
Ghidra address:
NTSC-U/C: 0x0012b3a0
Ghidra address:
PAL: 0x0012cb98

◆ GetOwner()

int PitchTrackGems::GetOwner ( int nBar)

Report the owner of the section a bar lies in.

Parameters
nBarThe bar.
Returns
The player, or -1.
Ghidra address:
NTSC-U/C: 0x0012b7e8
Ghidra address:
PAL: 0x0012cfe0

◆ ClearBar()

void PitchTrackGems::ClearBar ( int nBar)

Remove every gem of a bar.

Parameters
nBarThe bar.
Ghidra address:
NTSC-U/C: 0x0012b820
Ghidra address:
PAL: 0x0012d018

◆ ClearSection()

void PitchTrackGems::ClearSection ( int nSection)

Remove every gem of a section and its owner.

Parameters
nSectionThe section.
Ghidra address:
NTSC-U/C: 0x0012b920
Ghidra address:
PAL: 0x0012d118

◆ CopyBars() [1/2]

void PitchTrackGems::CopyBars ( int nStartBar,
int nEndBar,
int nDestBar )

Copy the gems of a range of bars to other bars.

Parameters
nStartBarThe first bar of the range.
nEndBarThe bar after the range.
nDestBarThe bar the copy of the first bar goes to.
Ghidra address:
NTSC-U/C: 0x0012b9c8
Ghidra address:
PAL: 0x0012d1c0

◆ CopyBarsFrom()

void PitchTrackGems::CopyBarsFrom ( int nStartBar,
int nEndBar,
PitchTrackGems * pSource,
int nOwner )

Copy the gems of a range of bars of other gems to the same bars.

Parameters
nStartBarThe first bar of the range.
nEndBarThe bar after the range.
pSourceThe gems copied.
nOwnerThe owner the copies receive, or -1 to retain the owner of each gem.
Ghidra address:
NTSC-U/C: 0x0012b9e8
Ghidra address:
PAL: 0x0012d1e0

◆ CopyBars() [2/2]

void PitchTrackGems::CopyBars ( int nStartBar,
int nEndBar,
int nDestBar,
PitchTrackGems * pSource,
int nOwner )

Copy the gems of a range of bars of other gems, and record the owners of the sections the copies land in.

Parameters
nStartBarThe first bar of the range.
nEndBarThe bar after the range.
nDestBarThe bar the copy of the first bar goes to.
pSourceThe gems copied.
nOwnerThe owner the copies receive, or -1 to retain the owner of each gem.
Ghidra address:
NTSC-U/C: 0x0012ba10
Ghidra address:
PAL: 0x0012d208

◆ ApplyPatterns()

void PitchTrackGems::ApplyPatterns ( )

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

Ghidra address:
NTSC-U/C: 0x0012bd38
Ghidra address:
PAL: 0x0012d530

◆ GetBar()

std::vector< PitchGem > * PitchTrackGems::GetBar ( int nBar)

Report the gems of a bar.

Parameters
nBarThe bar.
Returns
The gems.
Ghidra address:
NTSC-U/C: 0x0012bdf0
Ghidra address:
PAL: 0x0012d5e8

◆ CountGems()

int PitchTrackGems::CountGems ( int nStartBar,
int nEndBar )

Count the gems of a range of bars.

Parameters
nStartBarThe first bar of the range.
nEndBarThe bar after the range.
Returns
The number of gems.
Ghidra address:
NTSC-U/C: 0x0012be08
Ghidra address:
PAL: 0x0012d600

◆ Save()

void PitchTrackGems::Save ( BinStream & stream)

Write the gems of the sections that repeat no pattern.

Parameters
streamThe stream.
Ghidra address:
NTSC-U/C: 0x0012be60
Ghidra address:
PAL: 0x0012d658

◆ Load()

void PitchTrackGems::Load ( BinStream & stream)

Replace every gem with the gems Save() wrote.

The gems read have no owner, and every section loses its owner.

Parameters
streamThe stream.
Ghidra address:
NTSC-U/C: 0x0012c1e0
Ghidra address:
PAL: 0x0012d9c8

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