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

Avatar of a player beside the tracks, with the name of the track or player under it. More...

#include <ovyavatar.h>

Inheritance diagram for OvyAvatar:
Collaboration diagram for OvyAvatar:

Public Member Functions

 OvyAvatar (int nPlayer, int nIndex, RndView *pHudView)
 Construct a hidden display.
 ~OvyAvatar () override
 Stop the animations of the avatars and move the avatar camera back to bust.
void Show (bool bShow) override
 Record whether the display is wanted, and show it while the avatar display is not hidden.
void UpdateShown ()
 Show the display when it is wanted and the avatar display is not hidden.
void Draw ()
 Render the avatar and draw the display while it is not hidden, or render the winner's avatar while it is.
void Poll (float fDelta)
 Advance the slide and the swing, and swap the avatar halfway through a swing.
void SetPlayer (int nPlayer)
 Swing the display round to another player.
void SetFreqSize (int nFreqSize)
 Choose the size of the avatar display.
void Reset ()
 Stop the animations of the avatars, apply the size from the options, and empty a display that swings.
void SetInstrument (int nPlayer, int nInstrument, int nTrackKind)
 Show the name and the colour of the instrument of a track under the avatar.
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 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 constexpr signed char kNoPlayer = -1
 The value of mPlayer and mNextPlayer for no player.
static constexpr signed char kNoChange = -2
 The value of mNextPlayer when no change of player is pending.
static float sLeaderSwingTime
 The time the swing to a new leader takes, avatar_fx_leader_time.
static Vector2 sDepthRange
 The depth range the avatars draw into, freq_z.
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

Avatar of a player beside the tracks, with the name of the track or player under it.

The RTTI records the class as deriving from HideablePanel. The object is 0x80 bytes. In a shared-screen game the avatar of the leading player shows, and a change of leader swings the display round to swap the avatar.

Constructor & Destructor Documentation

◆ OvyAvatar()

OvyAvatar::OvyAvatar ( int nPlayer,
int nIndex,
RndView * pHudView )

Construct a hidden display.

The scene objects are <hud> freq <n>.tnm, <hud> freq <n>.view, freq placeholder <n>.mesh, and, in a duel or a solo game, <hud> track<n>.txt. A shared-screen game that is not a remix swings the display with <hud> freq <n> fx.tnm.

Parameters
nPlayerThe player shown, or a negative value for the leader of a shared-screen game.
nIndexThe number of the display, from 0.
pHudViewThe view the display's view is removed from.
Ghidra address:
NTSC-U/C: 0x001ba388
Ghidra address:
PAL: 0x001c3128

◆ ~OvyAvatar()

OvyAvatar::~OvyAvatar ( )
override

Stop the animations of the avatars and move the avatar camera back to bust.

Ghidra address:
NTSC-U/C: 0x001ba8f8
Ghidra address:
PAL: 0x001c3698

Member Function Documentation

◆ Show()

void OvyAvatar::Show ( bool bShow)
inlineoverridevirtual

Record whether the display is wanted, and show it while the avatar display is not hidden.

Parameters
bShowWhether to show the display.
Ghidra address:
NTSC-U/C: 0x00367298
Ghidra address:
PAL: 0x003d59c8

Reimplemented from HideablePanel.

◆ UpdateShown()

void OvyAvatar::UpdateShown ( )

Show the display when it is wanted and the avatar display is not hidden.

Ghidra address:
NTSC-U/C: 0x001baa08
Ghidra address:
PAL: 0x001c37a8

◆ Draw()

void OvyAvatar::Draw ( )

Render the avatar and draw the display while it is not hidden, or render the winner's avatar while it is.

Ghidra address:
NTSC-U/C: 0x001baa50
Ghidra address:
PAL: 0x001c37f0

◆ Poll()

void OvyAvatar::Poll ( float fDelta)

Advance the slide and the swing, and swap the avatar halfway through a swing.

Parameters
fDeltaThe time since the last poll.
Ghidra address:
NTSC-U/C: 0x001bab68
Ghidra address:
PAL: 0x001c3908

◆ SetPlayer()

void OvyAvatar::SetPlayer ( int nPlayer)

Swing the display round to another player.

Parameters
nPlayerThe player, or a negative value for none.
Ghidra address:
NTSC-U/C: 0x001bad08
Ghidra address:
PAL: 0x001c3aa8

◆ SetFreqSize()

void OvyAvatar::SetFreqSize ( int nFreqSize)

Choose the size of the avatar display.

Parameters
nFreqSizeThe size, one of GameOptions::FreqSize.
Ghidra address:
NTSC-U/C: 0x001bad58
Ghidra address:
PAL: 0x001c3af8

◆ Reset()

void OvyAvatar::Reset ( )

Stop the animations of the avatars, apply the size from the options, and empty a display that swings.

Ghidra address:
NTSC-U/C: 0x001bad90
Ghidra address:
PAL: 0x001c3b30

◆ SetInstrument()

void OvyAvatar::SetInstrument ( int nPlayer,
int nInstrument,
int nTrackKind )

Show the name and the colour of the instrument of a track under the avatar.

Parameters
nPlayerThe player. The display does not read it.
nInstrumentThe instrument, one of GfxManager::Instrument.
nTrackKindThe kind of the track. The display does not read it.
Ghidra address:
NTSC-U/C: 0x001baee0
Ghidra address:
PAL: 0x001c3c80

Member Data Documentation

◆ kNoPlayer

signed char OvyAvatar::kNoPlayer = -1
staticconstexpr

The value of mPlayer and mNextPlayer for no player.

◆ kNoChange

signed char OvyAvatar::kNoChange = -2
staticconstexpr

The value of mNextPlayer when no change of player is pending.

◆ sLeaderSwingTime

float OvyAvatar::sLeaderSwingTime
static

The time the swing to a new leader takes, avatar_fx_leader_time.

Ghidra address:
NTSC-U/C: 0x003af924
Ghidra address:
PAL: 0x0042e7b8

◆ sDepthRange

Vector2 OvyAvatar::sDepthRange
static

The depth range the avatars draw into, freq_z.

Ghidra address:
NTSC-U/C: 0x0043b150

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