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

Bar of the song's progress on the head-up display, with a marker per checkpoint. More...

#include <ovysongpos.h>

Inheritance diagram for OvySongPos:
Collaboration diagram for OvySongPos:

Classes

struct  Section
 One checkpoint marker. More...

Public Member Functions

 OvySongPos (RndView *pHudView)
 Construct a hidden bar and find its scene objects.
 ~OvySongPos () override
 Destroy the bar and its checkpoint labels.
void AddCheckpoint (float fPos, const char *pszLabel)
 Add a checkpoint marker, unless one is already at the place.
void ClearCheckpoints ()
 Remove every checkpoint marker and its label.
void Reset ()
 Remove the checkpoints and empty the future part of the bar.
void SetFuture (float fFuture)
 Pose the future part of the bar.
void Poll ()
 Advance the slide.
void Draw ()
 Draw the bar, the checkpoints, and the ship while the bar is not hidden.
Public Member Functions inherited from HideablePanel
 HideablePanel (const char *pszAnim, const char *pszDrawable, bool bShown)
 Construct a panel and find its animation and drawable.
virtual ~HideablePanel ()=default
 Destroy the panel.
virtual void Show (bool bShow)
 Slide the panel in or out, or move it at once while sSnap is set.
virtual void ShowNow (bool bShow)
 Show or hide the panel at once.
void SetObjects (const char *pszAnim, const char *pszDrawable, bool bShown)
 Find the animation and the drawable of the panel, and show or hide it at once.
void Poll ()
 Advance the slide by sDeltaTime, and show the drawable while the panel is not hidden.

Static Public Attributes

static Vector3 sStartPos
 The place of the start of the bar, song_pos_start_pos.
static Vector3 sEndPos
 The place of the end of the bar, song_pos_end_pos.
static int sNumLabels
 The number of checkpoint labels created, which numbers their names.
Static Public Attributes inherited from HideablePanel
static constexpr float kShownFrame = 240.0f
 The frame of the animation at which the panel is fully shown.
static int sSnap
 Whether Show() moves a panel at once rather than sliding it.
static float sDeltaTime
 The time Poll() advances every panel by.
static RndAnimatable * sMaterialAnim
 The animation of the two-dimensional materials, mat_2d_EE.anim, or null.
static float sMaterialFrame
 The frame PoseMaterials() poses sMaterialAnim at.

Additional Inherited Members

Static Public Member Functions inherited from HideablePanel
static void ClearSnap ()
 Clear sSnap.
static void SetDeltaTime (float fDeltaTime)
 Set the time the next Poll() of every panel advances by.
static void Init ()
 Find the animation of the two-dimensional materials and the frame it rests at.
static void Terminate ()
 Forget the animation of the two-dimensional materials.
static void PoseMaterials ()
 Pose the animation of the two-dimensional materials at its resting frame.
Protected Attributes inherited from HideablePanel
RampAnimator mSlide

Detailed Description

Bar of the song's progress on the head-up display, with a marker per checkpoint.

The RTTI records the class as deriving from HideablePanel. The object is 0x3c bytes.

Constructor & Destructor Documentation

◆ OvySongPos()

OvySongPos::OvySongPos ( RndView * pHudView)
explicit

Construct a hidden bar and find its scene objects.

The objects are <hud> songpos.view, <hud> songpos chpt.mesh, <hud> songpos future.mesh, <hud> songpos ship.mesh, <hud> songpos future.msnm, and the label template HUDr songpos chpt.txt. The head-up display prefix is HUD1 in an online game that is not a remix, and the overlay's prefix otherwise.

Parameters
pHudViewThe view the bar's view is removed from.
Ghidra address:
NTSC-U/C: 0x001b9230
Ghidra address:
PAL: 0x001c1fd0

◆ ~OvySongPos()

OvySongPos::~OvySongPos ( )
inlineoverride

Destroy the bar and its checkpoint labels.

Ghidra address:
NTSC-U/C: 0x00367040
Ghidra address:
PAL: 0x003d5770

Member Function Documentation

◆ AddCheckpoint()

void OvySongPos::AddCheckpoint ( float fPos,
const char * pszLabel )

Add a checkpoint marker, unless one is already at the place.

Parameters
fPosThe place on the bar, from 0 to 1.
pszLabelThe label, or null for none.
Ghidra address:
NTSC-U/C: 0x001b96e8
Ghidra address:
PAL: 0x001c2488

◆ ClearCheckpoints()

void OvySongPos::ClearCheckpoints ( )

Remove every checkpoint marker and its label.

Ghidra address:
NTSC-U/C: 0x001b98f8
Ghidra address:
PAL: 0x001c2698

◆ Reset()

void OvySongPos::Reset ( )

Remove the checkpoints and empty the future part of the bar.

Ghidra address:
NTSC-U/C: 0x001b99b8
Ghidra address:
PAL: 0x001c2758

◆ SetFuture()

void OvySongPos::SetFuture ( float fFuture)

Pose the future part of the bar.

Parameters
fFutureThe length of the future part, in seconds.
Ghidra address:
NTSC-U/C: 0x001b99e8
Ghidra address:
PAL: 0x001c2788

◆ Poll()

void OvySongPos::Poll ( )

Advance the slide.

Ghidra address:
NTSC-U/C: 0x001b9a10
Ghidra address:
PAL: 0x001c27b0

◆ Draw()

void OvySongPos::Draw ( )

Draw the bar, the checkpoints, and the ship while the bar is not hidden.

Ghidra address:
NTSC-U/C: 0x001b9a30
Ghidra address:
PAL: 0x001c27d0

Member Data Documentation

◆ sStartPos

Vector3 OvySongPos::sStartPos
static

The place of the start of the bar, song_pos_start_pos.

Ghidra address:
NTSC-U/C: 0x0043b130

◆ sEndPos

Vector3 OvySongPos::sEndPos
static

The place of the end of the bar, song_pos_end_pos.

Ghidra address:
NTSC-U/C: 0x0043b140

◆ sNumLabels

int OvySongPos::sNumLabels
static

The number of checkpoint labels created, which numbers their names.

Ghidra address:
NTSC-U/C: 0x003af948
Ghidra address:
PAL: 0x0042e7dc

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