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

Remix head-up display of one player: the main panel and the effect panels that slide out of it. More...

#include <ovyremixpanel.h>

Inheritance diagram for OvyRemixPanel:
Collaboration diagram for OvyRemixPanel:

Public Member Functions

 OvyRemixPanel (int nPlayer, int nPosition, RndTransformable *pParent)
 Construct a hidden remix display for a player.
 ~OvyRemixPanel () override
 Destroy the display and its effect panels.
void Poll (float fDelta) override
 Advance the slides and the blinks, and slide out the effect panel ShowSubPanel() asked for once the previous one is back.
void Draw () override
 Draw the effect panels and the main panel while the display is not hidden.
void ShowSubPanel (int nType)
 Slide out the effect panel of a type, after the shown one slides back.
OvyRemixGenPanel * FindSubPanel (int nType, int nUnused)
 Find the panel of a type.
const std::list< std::unique_ptr< OvyRemixSubPanel > > & GetSubPanels () const
Public Member Functions inherited from OvyRemixGenPanel
 OvyRemixGenPanel ()
 Construct an empty panel.
virtual ~OvyRemixGenPanel ()
 Destroy the panel and the objects it cloned.
void Load (char chHud, const char *pszPrefix, int nPlayer, RndTransformable *pParent)
 Clone the panel's objects from the loaded scene and build its options.
RndObject * Clone (const char *pszName, int nPlayer)
 Clone one object of the loaded scene as <name> pl <player>, and own the clone.
void SetText (int nIndex, const char *pszText)
 Set the label of an option.
void Flash ()
 Start blinking the cursor of the selected option, when there is one.
void Select (int nIndex)
 Move the cursor to an option.
void SetLit (int nIndex, bool bLit)
 Draw the label of an option in the selected font or the normal one.
RndMesh * GetPanel () const
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 Member Functions

static void LoadPositions (DataArray *pConfig, DataArray *pDefaults, bool bUnused)
 Read the places of the remix panels from remix_panel_positions.
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.

Static Public Attributes

static constexpr int kNumPositions = 4
 The number of places a remix panel can sit at.
static Vector3 sPositions [kNumPositions]
 The places a remix panel can sit at, read by LoadPositions().
Static Public Attributes inherited from OvyRemixGenPanel
static constexpr float kNoFlash = -1e9f
 The value of mFlashTime when no blink runs.
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

Public Types inherited from OvyRemixGenPanel
enum  FontIndex { kFontNormal = 0 , kFontSelected = 1 , kNumFonts = 2 }
 The indices of mFonts. More...
Protected Attributes inherited from OvyRemixGenPanel
RndMesh * mBackground
RndMesh * mPanel
Protected Attributes inherited from HideablePanel
RampAnimator mSlide

Detailed Description

Remix head-up display of one player: the main panel and the effect panels that slide out of it.

The RTTI records the class as deriving from OvyRemixGenPanel at offset 0 and from HideablePanel at +0x48. The object is 0x74 bytes.

Constructor & Destructor Documentation

◆ OvyRemixPanel()

OvyRemixPanel::OvyRemixPanel ( int nPlayer,
int nPosition,
RndTransformable * pParent )

Construct a hidden remix display for a player.

The scene objects are HUD<hud>r_fx<n>, where the layout letter and n follow the community of the game: s and 0 alone, m and 0 for the first local player and 1 for the others, and n and the player's online order.

Parameters
nPlayerThe player's index.
nPositionThe place the panel sits at, an index of sPositions.
pParentThe transform the panel moves with, or null.
Ghidra address:
NTSC-U/C: 0x001b7b40
Ghidra address:
PAL: 0x001c08e0

◆ ~OvyRemixPanel()

OvyRemixPanel::~OvyRemixPanel ( )
override

Destroy the display and its effect panels.

Ghidra address:
NTSC-U/C: 0x001b8088
Ghidra address:
PAL: 0x001c0e28

Member Function Documentation

◆ Poll()

void OvyRemixPanel::Poll ( float fDelta)
overridevirtual

Advance the slides and the blinks, and slide out the effect panel ShowSubPanel() asked for once the previous one is back.

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

Reimplemented from OvyRemixGenPanel.

◆ Draw()

void OvyRemixPanel::Draw ( )
overridevirtual

Draw the effect panels and the main panel while the display is not hidden.

Ghidra address:
NTSC-U/C: 0x001b8288
Ghidra address:
PAL: 0x001c1028

Reimplemented from OvyRemixGenPanel.

◆ ShowSubPanel()

void OvyRemixPanel::ShowSubPanel ( int nType)

Slide out the effect panel of a type, after the shown one slides back.

Parameters
nTypeThe type, one of GfxManager::RemixSubPanel.
Ghidra address:
NTSC-U/C: 0x001b8330
Ghidra address:
PAL: 0x001c10d0

◆ FindSubPanel()

OvyRemixGenPanel * OvyRemixPanel::FindSubPanel ( int nType,
int nUnused )

Find the panel of a type.

Parameters
nTypeThe type, one of GfxManager::RemixSubPanel.
nUnusedZero from every caller. The routine does not read it.
Returns
This display for the main panel, the effect panel of the type, or null.
Ghidra address:
NTSC-U/C: 0x001b8400
Ghidra address:
PAL: 0x001c11a0

◆ LoadPositions()

void OvyRemixPanel::LoadPositions ( DataArray * pConfig,
DataArray * pDefaults,
bool bUnused )
static

Read the places of the remix panels from remix_panel_positions.

Parameters
pConfigThe configuration section, or null.
pDefaultsThe section of defaults, or null.
bUnusedNot read.
Ghidra address:
NTSC-U/C: 0x001b6980
Ghidra address:
PAL: 0x001bf720

◆ GetSubPanels()

const std::list< std::unique_ptr< OvyRemixSubPanel > > & OvyRemixPanel::GetSubPanels ( ) const
inline
Returns
The effect panels.

Member Data Documentation

◆ kNumPositions

int OvyRemixPanel::kNumPositions = 4
staticconstexpr

The number of places a remix panel can sit at.

◆ sPositions

Vector3 OvyRemixPanel::sPositions[kNumPositions]
static

The places a remix panel can sit at, read by LoadPositions().

Ghidra address:
NTSC-U/C: 0x0043b1a0

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