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

Animation of the vortex the play field flies through on the way into and out of a song. More...

#include <vortex.h>

Public Types

enum  Mode {
  kModeIdle = 0 , kModeOutro = 1 , kModeIn = 2 , kModeHold = 3 ,
  kModeOut = 4
}
 The values of mMode. More...

Public Member Functions

 Vortex (const char *pszName)
 Construct an idle vortex from its configuration.
 ~Vortex ()
 Release the configuration.
float GetOutroLength () const
 Report the length of the run at the end of a song.
float GetInLength () const
 Report the length of the run into the play field.
float GetOutLength () const
 Report the length of the run out of the play field.
void Start (float fLength, int eMode)
 Start a run.
void Poll ()
 Advance the run to the time of the system clock.
void Draw ()
 Draw the vortex while a run is in progress.
void Load ()
 Queue the load of the file of the configuration and find its views.
void Unload ()
 Stop the run, forget the views, and delete the loader with its objects.
int GetMode () const
float GetFrame () const
const LinearInterpolator & GetInterp () const

Detailed Description

Animation of the vortex the play field flies through on the way into and out of a song.

The class is not polymorphic and emits no RTTI. The object is 0x78 bytes, and its configuration is the entry of gfx vortices with the name given to the constructor. The name is inferred.

Member Enumeration Documentation

◆ Mode

The values of mMode.

Enumerator
kModeIdle 

The vortex does not run.

kModeOutro 

The run at the end of a song.

kModeIn 

The run into the play field, vortex_in.

kModeHold 

A mode the display tests for and never starts.

kModeOut 

The run out of the play field, vortex_out.

Constructor & Destructor Documentation

◆ Vortex()

Vortex::Vortex ( const char * pszName)
explicit

Construct an idle vortex from its configuration.

Parameters
pszNameThe name of the entry of gfx vortices.
Ghidra address:
NTSC-U/C: 0x001e4c10
Ghidra address:
PAL: 0x001ed9b0

◆ ~Vortex()

Vortex::~Vortex ( )

Release the configuration.

Ghidra address:
NTSC-U/C: 0x001e4d98
Ghidra address:
PAL: 0x001edb38

Member Function Documentation

◆ GetOutroLength()

float Vortex::GetOutroLength ( ) const

Report the length of the run at the end of a song.

Returns
The length in milliseconds.
Ghidra address:
NTSC-U/C: 0x001e5120
Ghidra address:
PAL: 0x001edec0

◆ GetInLength()

float Vortex::GetInLength ( ) const

Report the length of the run into the play field.

Returns
The length in milliseconds.
Ghidra address:
NTSC-U/C: 0x001e5138
Ghidra address:
PAL: 0x001eded8

◆ GetOutLength()

float Vortex::GetOutLength ( ) const

Report the length of the run out of the play field.

Returns
The length in milliseconds.
Ghidra address:
NTSC-U/C: 0x001e5150
Ghidra address:
PAL: 0x001edef0

◆ Start()

void Vortex::Start ( float fLength,
int eMode )

Start a run.

Parameters
fLengthThe length of the run in milliseconds, or a negative value for the length the configuration gives.
eModeThe run, one of Mode.
Ghidra address:
NTSC-U/C: 0x001e5168
Ghidra address:
PAL: 0x001edf08

◆ Poll()

void Vortex::Poll ( )

Advance the run to the time of the system clock.

Ghidra address:
NTSC-U/C: 0x001e52f8
Ghidra address:
PAL: 0x001ee098

◆ Draw()

void Vortex::Draw ( )

Draw the vortex while a run is in progress.

Ghidra address:
NTSC-U/C: 0x001e5478
Ghidra address:
PAL: 0x001ee218

◆ Load()

void Vortex::Load ( )

Queue the load of the file of the configuration and find its views.

Ghidra address:
NTSC-U/C: 0x001e4df8
Ghidra address:
PAL: 0x001edb98

◆ Unload()

void Vortex::Unload ( )

Stop the run, forget the views, and delete the loader with its objects.

Ghidra address:
NTSC-U/C: 0x001e50d8
Ghidra address:
PAL: 0x001ede78

◆ GetMode()

int Vortex::GetMode ( ) const
inline
Returns
The run in progress, one of Mode.

◆ GetFrame()

float Vortex::GetFrame ( ) const
inline
Returns
The frame of the run.

◆ GetInterp()

const LinearInterpolator & Vortex::GetInterp ( ) const
inline
Returns
The frame of the run over the system clock.

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