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

The effects of one track as it is enabled or captured, which lift the track and light it with a material drawn over it. More...

#include <tnltrackfx.h>

Collaboration diagram for TnlTrackFX:

Public Types

enum  State { kStateIdle = 0 , kStateEnable = 1 , kStateCapture = 2 }
 The values of mState. More...

Public Member Functions

 TnlTrackFX (char nTrack)
 Construct the effects of a track, and for track 0 the shared spew of a capture.
 ~TnlTrackFX ()
 Release the shared spew, and the material of a track other than track 0.
void Enable (GfxTunnel *pTunnel)
 Start the enable effect.
void Capture (GfxTunnel *pTunnel, float flTick)
 Start the capture effect, and spew from the track.
void Stop (GfxTunnel *pTunnel)
 Stop the effect at once and put the track back.
bool Poll (GfxTunnel *pTunnel, TnlGeom *pGeom)
 Advance the effect.
float CaptureEndTime () const
 Report the time the drop of a capture ends.
char GetState () const
char GetTrack () const

Static Public Member Functions

static void LoadConfig (DataArray *pConfig, DataArray *pDefaults, GfxTunnel *pTunnel, int nOption)
 Load the settings of the effects of the tracks, the streak arrows, and the cripplers.

Static Public Attributes

static float sEnableTimes [3]
 The milliseconds the enable effect rises, holds lit, and fades, track_activate_lengths.
static float sCaptureTimes [3]
 The milliseconds the capture drops and falls, then an unused length, autocapture_anim_times.
static float sCaptureHeight
 The height a capture raises the track, autocapture_offset_height times the scroll speed.
static float sEnableHeight
 The depth an enable effect starts the track at, track_enable_offset_height times the scroll speed.
static float sCaptureSpewTicks
 The ticks ahead of the song a capture spews from, autocapture_burst_tick.
static float sCaptureCamJiggle
 The kick a capture gives the camera, autocapture_cam_jiggle.
static float sCaptureBrightness
 The alpha of the overlay of a capture, autocapture_track_brightness.
static Vector2 sFlareSize
 The size the gems of a capture flare from and to, autocapture_flare_size times the scroll speed.
static RndParticleSys * sSpew
 The particle system a capture spews from, autocapture spew.part.
static float sSpewFrame
 The frame of sSpew, which each capture advances.

Detailed Description

The effects of one track as it is enabled or captured, which lift the track and light it with a material drawn over it.

The RTTI identifies the class, which is not polymorphic. The object is 0x7c bytes. Track 0 draws with panel enable.mat and each other track with a copy of it.

Member Enumeration Documentation

◆ State

The values of mState.

Enumerator
kStateIdle 

No effect runs.

kStateEnable 

The track rises and lights up.

kStateCapture 

The track drops away and its gems flare.

Constructor & Destructor Documentation

◆ TnlTrackFX()

TnlTrackFX::TnlTrackFX ( char nTrack)
explicit

Construct the effects of a track, and for track 0 the shared spew of a capture.

Parameters
nTrackThe track.
Ghidra address:
NTSC-U/C: 0x001ee6d0
Ghidra address:
PAL: 0x001f7470

◆ ~TnlTrackFX()

TnlTrackFX::~TnlTrackFX ( )

Release the shared spew, and the material of a track other than track 0.

Ghidra address:
NTSC-U/C: 0x001ee930
Ghidra address:
PAL: 0x001f76d0

Member Function Documentation

◆ LoadConfig()

void TnlTrackFX::LoadConfig ( DataArray * pConfig,
DataArray * pDefaults,
GfxTunnel * pTunnel,
int nOption )
static

Load the settings of the effects of the tracks, the streak arrows, and the cripplers.

Parameters
pConfigThe configuration.
pDefaultsThe defaults of the configuration.
pTunnelThe tunnel. The routine does not read it.
nOptionThe fourth argument every loader of the tunnel receives. The routine does not read it.
Ghidra address:
NTSC-U/C: 0x001ee228
Ghidra address:
PAL: 0x001f6fc8

◆ Enable()

void TnlTrackFX::Enable ( GfxTunnel * pTunnel)

Start the enable effect.

Parameters
pTunnelThe tunnel.
Ghidra address:
NTSC-U/C: 0x001ee9e0
Ghidra address:
PAL: 0x001f7780

◆ Capture()

void TnlTrackFX::Capture ( GfxTunnel * pTunnel,
float flTick )

Start the capture effect, and spew from the track.

Parameters
pTunnelThe tunnel.
flTickThe tick the captured phrase ends at.
Ghidra address:
NTSC-U/C: 0x001eea88
Ghidra address:
PAL: 0x001f7828

◆ Stop()

void TnlTrackFX::Stop ( GfxTunnel * pTunnel)

Stop the effect at once and put the track back.

Parameters
pTunnelThe tunnel.
Ghidra address:
NTSC-U/C: 0x001eecb0
Ghidra address:
PAL: 0x001f7a50

◆ Poll()

bool TnlTrackFX::Poll ( GfxTunnel * pTunnel,
TnlGeom * pGeom )

Advance the effect.

Parameters
pTunnelThe tunnel.
pGeomThe geometry of the tracks.
Returns
Whether a capture runs. An enable effect and an idle track report false.
Ghidra address:
NTSC-U/C: 0x001eed30
Ghidra address:
PAL: 0x001f7ad0

◆ CaptureEndTime()

float TnlTrackFX::CaptureEndTime ( ) const

Report the time the drop of a capture ends.

Returns
The time in milliseconds.
Ghidra address:
NTSC-U/C: 0x001ef1a0
Ghidra address:
PAL: 0x001f7f40

◆ GetState()

char TnlTrackFX::GetState ( ) const
inline
Returns
The effect, one of State.

◆ GetTrack()

char TnlTrackFX::GetTrack ( ) const
inline
Returns
The track.

Member Data Documentation

◆ sEnableTimes

float TnlTrackFX::sEnableTimes[3]
static

The milliseconds the enable effect rises, holds lit, and fades, track_activate_lengths.

Ghidra address:
NTSC-U/C: 0x003afad8
Ghidra address:
PAL: 0x0042e970

◆ sCaptureTimes

float TnlTrackFX::sCaptureTimes[3]
static

The milliseconds the capture drops and falls, then an unused length, autocapture_anim_times.

Ghidra address:
NTSC-U/C: 0x003afae8
Ghidra address:
PAL: 0x0042e980

◆ sCaptureHeight

float TnlTrackFX::sCaptureHeight
static

The height a capture raises the track, autocapture_offset_height times the scroll speed.

Ghidra address:
NTSC-U/C: 0x003afaf4
Ghidra address:
PAL: 0x0042e98c

◆ sEnableHeight

float TnlTrackFX::sEnableHeight
static

The depth an enable effect starts the track at, track_enable_offset_height times the scroll speed.

Ghidra address:
NTSC-U/C: 0x003afaf8
Ghidra address:
PAL: 0x0042e990

◆ sCaptureSpewTicks

float TnlTrackFX::sCaptureSpewTicks
static

The ticks ahead of the song a capture spews from, autocapture_burst_tick.

Ghidra address:
NTSC-U/C: 0x003afafc
Ghidra address:
PAL: 0x0042e994

◆ sCaptureCamJiggle

float TnlTrackFX::sCaptureCamJiggle
static

The kick a capture gives the camera, autocapture_cam_jiggle.

Ghidra address:
NTSC-U/C: 0x003afb00
Ghidra address:
PAL: 0x0042e998

◆ sCaptureBrightness

float TnlTrackFX::sCaptureBrightness
static

The alpha of the overlay of a capture, autocapture_track_brightness.

Ghidra address:
NTSC-U/C: 0x003afb04
Ghidra address:
PAL: 0x0042e99c

◆ sFlareSize

Vector2 TnlTrackFX::sFlareSize
static

The size the gems of a capture flare from and to, autocapture_flare_size times the scroll speed.

Ghidra address:
NTSC-U/C: 0x0043b5c0

◆ sSpew

RndParticleSys* TnlTrackFX::sSpew
static

The particle system a capture spews from, autocapture spew.part.

Ghidra address:
NTSC-U/C: 0x003afb6c
Ghidra address:
PAL: 0x0042ea04

◆ sSpewFrame

float TnlTrackFX::sSpewFrame
static

The frame of sSpew, which each capture advances.

Ghidra address:
NTSC-U/C: 0x003afb70
Ghidra address:
PAL: 0x0042ea08

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