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

Highlight the tutorial draws round a part of the screen, and an arrow that points at a place. More...

#include <hudhilitebox.h>

Public Types

enum  Changing { kChangingBoxFade = 0x01 , kChangingBoxMove = 0x02 , kChangingArrowFade = 0x04 , kChangingArrowMove = 0x08 }
 The bits of mChanging, which say what Update() still moves. More...

Public Member Functions

 HudHiliteBox ()
 Construct a hidden box and arrow from HUD hilite_box.mesh, HUD hilite_box.mat, HUD hilite arrow.view, and HUD hilite arrow.mat.
void Reset ()
 Hide the box and the arrow at once and stop every change.
void SetBoxRect (float fX0, float fY0, float fX1, float fY1, float fDuration)
 Move and stretch the box to a rectangle of the screen.
void ShowBox (bool bShow)
 Fade the box in or out over 480 ticks.
void SetArrowTarget (float fX, float fY, float fAngle, float fDuration)
 Move and turn the arrow to point at a place of the screen.
void ShowArrow (bool bShow)
 Fade the arrow in or out over 240 ticks.
void Update (float fTick)
 Advance every change that runs.

Static Public Member Functions

static void UnitToScreen (float *pfX0, float *pfY0, float *pfX1, float *pfY1)
 Convert a rectangle in the unit square of the screen to the coordinates of the display.

Static Public Attributes

static constexpr int kNumBoxVerts = 16
 The number of vertices of the box.

Detailed Description

Highlight the tutorial draws round a part of the screen, and an arrow that points at a place.

The class is not polymorphic and emits no RTTI. The object is 0x138 bytes. The box is a mesh of sixteen vertices, a corner of fixed size at each end of each edge, that stretches to the rectangle asked for. The box and the arrow fade and move against the song tick.

Member Enumeration Documentation

◆ Changing

The bits of mChanging, which say what Update() still moves.

Enumerator
kChangingBoxFade 

The box fades.

kChangingBoxMove 

The box moves and stretches.

kChangingArrowFade 

The arrow fades.

kChangingArrowMove 

The arrow moves and turns.

Constructor & Destructor Documentation

◆ HudHiliteBox()

HudHiliteBox::HudHiliteBox ( )

Construct a hidden box and arrow from HUD hilite_box.mesh, HUD hilite_box.mat, HUD hilite arrow.view, and HUD hilite arrow.mat.

Ghidra address:
NTSC-U/C: 0x001bb6f8
Ghidra address:
PAL: 0x001c4498

Member Function Documentation

◆ Reset()

void HudHiliteBox::Reset ( )

Hide the box and the arrow at once and stop every change.

Ghidra address:
NTSC-U/C: 0x001bba80
Ghidra address:
PAL: 0x001c4820

◆ UnitToScreen()

void HudHiliteBox::UnitToScreen ( float * pfX0,
float * pfY0,
float * pfX1,
float * pfY1 )
static

Convert a rectangle in the unit square of the screen to the coordinates of the display.

Parameters
pfX0The left edge, converted in place.
pfY0The top edge, converted in place.
pfX1The right edge, converted in place.
pfY1The bottom edge, converted in place.
Ghidra address:
NTSC-U/C: 0x001bbba8
Ghidra address:
PAL: 0x001c4948

◆ SetBoxRect()

void HudHiliteBox::SetBoxRect ( float fX0,
float fY0,
float fX1,
float fY1,
float fDuration )

Move and stretch the box to a rectangle of the screen.

Parameters
fX0The left edge, in the unit square of the screen.
fY0The top edge.
fX1The right edge.
fY1The bottom edge.
fDurationThe ticks the move takes.
Ghidra address:
NTSC-U/C: 0x001bbc18
Ghidra address:
PAL: 0x001c49b8

◆ ShowBox()

void HudHiliteBox::ShowBox ( bool bShow)

Fade the box in or out over 480 ticks.

Parameters
bShowWhether to show the box.
Ghidra address:
NTSC-U/C: 0x001bbdb0
Ghidra address:
PAL: 0x001c4b50

◆ SetArrowTarget()

void HudHiliteBox::SetArrowTarget ( float fX,
float fY,
float fAngle,
float fDuration )

Move and turn the arrow to point at a place of the screen.

Parameters
fXThe horizontal place, in the unit square of the screen.
fYThe vertical place.
fAngleThe direction of the arrow, in degrees.
fDurationThe ticks the move takes.
Ghidra address:
NTSC-U/C: 0x001bbe50
Ghidra address:
PAL: 0x001c4bf0

◆ ShowArrow()

void HudHiliteBox::ShowArrow ( bool bShow)

Fade the arrow in or out over 240 ticks.

Parameters
bShowWhether to show the arrow.
Ghidra address:
NTSC-U/C: 0x001bbfb8
Ghidra address:
PAL: 0x001c4d58

◆ Update()

void HudHiliteBox::Update ( float fTick)

Advance every change that runs.

Parameters
fTickThe song tick.
Ghidra address:
NTSC-U/C: 0x001bc058
Ghidra address:
PAL: 0x001c4df8

Member Data Documentation

◆ kNumBoxVerts

int HudHiliteBox::kNumBoxVerts = 16
staticconstexpr

The number of vertices of the box.


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