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

Part of the head-up display that slides in and out of view. More...

#include <hideablepanel.h>

Inheritance diagram for HideablePanel:
Collaboration diagram for HideablePanel:

Public Member Functions

 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 Member Functions

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.

Static Public Attributes

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.

Protected Attributes

RampAnimator mSlide

Detailed Description

Part of the head-up display that slides in and out of view.

The RTTI records the class in an anonymous namespace of the overlay's translation unit, with no base. The object is 0x1c bytes. An animation runs from frame 0 (hidden) to frame 240 (shown), and the drawable shows while the frame is not 0.

Constructor & Destructor Documentation

◆ HideablePanel()

HideablePanel::HideablePanel ( const char * pszAnim,
const char * pszDrawable,
bool bShown )

Construct a panel and find its animation and drawable.

Parameters
pszAnimThe animation that slides the panel, or null.
pszDrawableThe drawable shown with the panel, or null.
bShownWhether the panel starts shown.
Ghidra address:
NTSC-U/C: 0x001b65e8
Ghidra address:
PAL: 0x001bf388

◆ ~HideablePanel()

virtual HideablePanel::~HideablePanel ( )
virtualdefault

Destroy the panel.

Ghidra address:
NTSC-U/C: 0x00366d00
Ghidra address:
PAL: 0x003d5430

Member Function Documentation

◆ Show()

virtual void HideablePanel::Show ( bool bShow)
virtual

Slide the panel in or out, or move it at once while sSnap is set.

Parameters
bShowWhether to show the panel.
Ghidra address:
NTSC-U/C: 0x001b6778
Ghidra address:
PAL: 0x001bf518

Reimplemented in OvyAvatar, OvyJuice, OvyScore, and OvyTrackLabel.

◆ ShowNow()

virtual void HideablePanel::ShowNow ( bool bShow)
virtual

Show or hide the panel at once.

Parameters
bShowWhether to show the panel.
Ghidra address:
NTSC-U/C: 0x001b67d8
Ghidra address:
PAL: 0x001bf578

◆ SetObjects()

void HideablePanel::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.

Parameters
pszAnimThe animation that slides the panel, or null to retain the current one.
pszDrawableThe drawable shown with the panel, or null to retain the current one.
bShownWhether the panel is shown.
Ghidra address:
NTSC-U/C: 0x001b6670
Ghidra address:
PAL: 0x001bf410

◆ Poll()

void HideablePanel::Poll ( )

Advance the slide by sDeltaTime, and show the drawable while the panel is not hidden.

Ghidra address:
NTSC-U/C: 0x001b6808
Ghidra address:
PAL: 0x001bf5a8

◆ ClearSnap()

void HideablePanel::ClearSnap ( )
static

Clear sSnap.

Ghidra address:
NTSC-U/C: 0x001b65c8
Ghidra address:
PAL: 0x001bf368

◆ SetDeltaTime()

void HideablePanel::SetDeltaTime ( float fDeltaTime)
static

Set the time the next Poll() of every panel advances by.

Parameters
fDeltaTimeThe time.
Ghidra address:
NTSC-U/C: 0x001b65d8
Ghidra address:
PAL: 0x001bf378

◆ Init()

void HideablePanel::Init ( )
static

Find the animation of the two-dimensional materials and the frame it rests at.

The frame is enter_stop_frame of the panel_enter_exit entry of the ui section of the configuration, when the section exists. Clears sSnap.

Ghidra address:
NTSC-U/C: 0x001b6878
Ghidra address:
PAL: 0x001bf618

◆ Terminate()

void HideablePanel::Terminate ( )
static

Forget the animation of the two-dimensional materials.

Ghidra address:
NTSC-U/C: 0x001b6940
Ghidra address:
PAL: 0x001bf6e0

◆ PoseMaterials()

void HideablePanel::PoseMaterials ( )
static

Pose the animation of the two-dimensional materials at its resting frame.

Ghidra address:
NTSC-U/C: 0x001b6950
Ghidra address:
PAL: 0x001bf6f0

Member Data Documentation

◆ kShownFrame

float HideablePanel::kShownFrame = 240.0f
staticconstexpr

The frame of the animation at which the panel is fully shown.

◆ sSnap

int HideablePanel::sSnap
static

Whether Show() moves a panel at once rather than sliding it.

Ghidra address:
NTSC-U/C: 0x003af908
Ghidra address:
PAL: 0x0042e79c

◆ sDeltaTime

float HideablePanel::sDeltaTime
static

The time Poll() advances every panel by.

Ghidra address:
NTSC-U/C: 0x003af90c
Ghidra address:
PAL: 0x0042e7a0

◆ sMaterialAnim

RndAnimatable* HideablePanel::sMaterialAnim
static

The animation of the two-dimensional materials, mat_2d_EE.anim, or null.

Ghidra address:
NTSC-U/C: 0x003af910
Ghidra address:
PAL: 0x0042e7a4

◆ sMaterialFrame

float HideablePanel::sMaterialFrame
static

The frame PoseMaterials() poses sMaterialAnim at.

Ghidra address:
NTSC-U/C: 0x003af914
Ghidra address:
PAL: 0x0042e7a8

◆ mSlide

RampAnimator HideablePanel::mSlide
protected

The slide, from 0 (hidden) to kShownFrame (shown).


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