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

TrackBuilder that reads the notes of a guitar track into AxeTrackData. More...

#include <axetrackcontourbuilder.h>

Inheritance diagram for AxeTrackContourBuilder:
Collaboration diagram for AxeTrackContourBuilder:

Classes

struct  MidiMsg
 One channel message of the track. More...

Public Member Functions

 AxeTrackContourBuilder (int nTrack, bool bValidate, ErrorHandler pfnError, int nChannel, int nTicksPerBar, int nIntroTicks, AxeTrackData *pData)
 Construct a builder.
 ~AxeTrackContourBuilder () override
 Release the builder.
void OnNewTrack (unsigned char nTrack) override
 Ignore the start of the track.
void OnEndTrack () override
 Build the notes of each set of three gem button notes, and add them to the data.
void OnAllDone () override
 Ignore the end of the file.
void OnMidi (int nTick, unsigned char nStatus, unsigned char nData1, unsigned char nData2) override
 Record a gem button note, or collect any other channel message.
void OnTempo (int nTick, int nMicrosecondsPerBeat) override
 Ignore a tempo change.
void OnText (int nTick, const char *pszText, unsigned char nType) override
 Ignore a text meta event.
void OnTimeSignature (int nTick, int nNumerator, int nDenominator) override
 Ignore a time signature.
Public Member Functions inherited from TrackBuilder
 TrackBuilder (int nTrack, bool bValidate, ErrorHandler pfnError)
 Construct a builder.
 ~TrackBuilder () override
 Release the builder.
void Error (int nTick, const char *pszMessage)
 Report a build error at a tick.
Public Member Functions inherited from MidiReceiver
virtual ~MidiReceiver ()
 Release the receiver.

Static Public Member Functions

static int ButtonForNote (unsigned char nNote)
 Report the gem button a note plays.

Additional Inherited Members

Public Types inherited from TrackBuilder
typedef void(* ErrorHandler) (String &message)
 Routine that reports a build error.
Protected Attributes inherited from TrackBuilder
int mTrack
int mValidate
ErrorHandler mErrorHandler

Detailed Description

TrackBuilder that reads the notes of a guitar track into AxeTrackData.

The RTTI includes the class name and records TrackBuilder as the base. The object is 0x4b0 bytes. The gem buttons are notes in sets of three, one on each button, and each set gives the span of the song its notes play over. The other channel messages are the notes and the sounds of the spans.

Constructor & Destructor Documentation

◆ AxeTrackContourBuilder()

AxeTrackContourBuilder::AxeTrackContourBuilder ( int nTrack,
bool bValidate,
ErrorHandler pfnError,
int nChannel,
int nTicksPerBar,
int nIntroTicks,
AxeTrackData * pData )

Construct a builder.

Parameters
nTrackThe number of the MIDI track the error messages give.
bValidateCheck the events for authoring errors.
pfnErrorThe routine that reports an error, or null to print it.
nChannelThe MIDI channel of the track.
nTicksPerBarThe length of a bar.
nIntroTicksThe length of the song intro, which must not have notes.
pDataThe data to fill.
Ghidra address:
NTSC-U/C: 0x00147ea0
Ghidra address:
PAL: 0x00149860

◆ ~AxeTrackContourBuilder()

AxeTrackContourBuilder::~AxeTrackContourBuilder ( )
override

Release the builder.

Ghidra address:
NTSC-U/C: 0x00147f68
Ghidra address:
PAL: 0x00149928

Member Function Documentation

◆ OnNewTrack()

void AxeTrackContourBuilder::OnNewTrack ( unsigned char nTrack)
inlineoverridevirtual

Ignore the start of the track.

Parameters
nTrackThe track index.
Ghidra address:
NTSC-U/C: 0x00348558
Ghidra address:
PAL: 0x003b5988

Implements MidiReceiver.

◆ OnEndTrack()

void AxeTrackContourBuilder::OnEndTrack ( )
overridevirtual

Build the notes of each set of three gem button notes, and add them to the data.

Ghidra address:
NTSC-U/C: 0x00148078
Ghidra address:
PAL: 0x00149a38

Implements MidiReceiver.

◆ OnAllDone()

void AxeTrackContourBuilder::OnAllDone ( )
inlineoverridevirtual

Ignore the end of the file.

Ghidra address:
NTSC-U/C: 0x00348560
Ghidra address:
PAL: 0x003b5990

Implements MidiReceiver.

◆ OnMidi()

void AxeTrackContourBuilder::OnMidi ( int nTick,
unsigned char nStatus,
unsigned char nData1,
unsigned char nData2 )
overridevirtual

Record a gem button note, or collect any other channel message.

A note-off message moves back to a multiple of 30 ticks.

Parameters
nTickThe tick.
nStatusThe status byte.
nData1The first data byte.
nData2The second data byte.
Ghidra address:
NTSC-U/C: 0x001486f0
Ghidra address:
PAL: 0x0014a0b0

Implements MidiReceiver.

◆ OnTempo()

void AxeTrackContourBuilder::OnTempo ( int nTick,
int nMicrosecondsPerBeat )
inlineoverridevirtual

Ignore a tempo change.

Parameters
nTickThe tick.
nMicrosecondsPerBeatThe new tempo.
Ghidra address:
NTSC-U/C: 0x00348568
Ghidra address:
PAL: 0x003b5998

Implements MidiReceiver.

◆ OnText()

void AxeTrackContourBuilder::OnText ( int nTick,
const char * pszText,
unsigned char nType )
inlineoverridevirtual

Ignore a text meta event.

Parameters
nTickThe tick.
pszTextThe text.
nTypeThe meta event type.
Ghidra address:
NTSC-U/C: 0x00348570
Ghidra address:
PAL: 0x003b59a0

Implements MidiReceiver.

◆ OnTimeSignature()

void AxeTrackContourBuilder::OnTimeSignature ( int nTick,
int nNumerator,
int nDenominator )
inlineoverridevirtual

Ignore a time signature.

Parameters
nTickThe tick.
nNumeratorThe beats per bar.
nDenominatorThe beat unit.
Ghidra address:
NTSC-U/C: 0x00348578
Ghidra address:
PAL: 0x003b59a8

Implements MidiReceiver.

◆ ButtonForNote()

int AxeTrackContourBuilder::ButtonForNote ( unsigned char nNote)
static

Report the gem button a note plays.

Parameters
nNoteThe note.
Returns
The button, 0 to 2, or -1 for a note that is not a gem button.
Ghidra address:
NTSC-U/C: 0x00147e40
Ghidra address:
PAL: 0x00149800

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