resonance 1.0.1
Loading...
Searching...
No Matches
MetGizmoPanel Class Reference

Base of the four gizmo panels that frame the front end. More...

#include <metgizmopanel.h>

Inheritance diagram for MetGizmoPanel:
Collaboration diagram for MetGizmoPanel:

Public Member Functions

 MetGizmoPanel (MetRenderer *pRenderer, int nPriority, const HxStr &name, const HxStr &directory, const HxStr &container)
 Construct the panel with no alternate views.
virtual ~MetGizmoPanel ()
 Release the two view vectors.
virtual void UpdateIdle (float flTime)
 Set every alternate view to one animation frame.
virtual void UpdateIdleAnimation (float flTime)
 Forward to UpdateIdle().
virtual void ResolveContainerViews ()
 Resolve the base views, and then each name in mViewNames into mViews as a Rnd::View.
Public Member Functions inherited from MetScreen
 MetScreen (MetRenderer *pRenderer, int nPriority, const HxStr &name, const HxStr &directory, const HxStr &file)
 Construct a screen and start its container load.
virtual ~MetScreen ()
 Unregister from the renderer and release the container.
void DeliverCommand (const MetScreenCommand *pCommand)
 Play the sound one navigation command calls for and then act on the command.
void UpdateAnimationFrame (float flTime)
 Drive the frame of whichever animation is running and run the idle hook when none is.
void UpdateFrame (float flTime)
 Advance one screen by one frame.
virtual void PushNamedScreen (const HxStr &name)
 Bring one named screen onto the renderer's screen stack.
virtual void EnterAndShow ()
 Show this screen and start its enter animation.
virtual void ActivateNamedPanel (const HxStr &name)
 Make one named screen the renderer's active panel.
virtual void OnPanelActivated ()
 Act on this screen having become the renderer's active panel.
virtual void ExitScreenByName (const HxStr &name)
 Start one named screen's exit animation.
virtual void BeginExit ()
 Start this screen's exit animation at the renderer's current time.
virtual void OnUnusedHook ()
 Do nothing.
virtual void OnKeyboardDismissed ()
 Take control back after the keyboard screen has finished.
virtual void OnDrawPass ()
 Contribute to the renderer's draw pass.
virtual void OnDestroying ()
 Release what the screen acquired, ahead of the rest of destruction.
virtual int PollContainerLoad ()
 Advance this screen's container load and resolve its views once the load finishes.
virtual void OnMsgScreenDismissed (const HxStr &name, int nChoice)
 Act on the choice the user made in a message dialogue.
virtual void OnMsgScreenShown (const HxStr &name)
 Act on a message dialogue becoming visible.
virtual void SetShowing (int nShowing)
 Show or hide the view and every drawable the container loaded.
virtual void BeginContainerLoad (const HxStr &directory, const HxStr &file)
 Intern a container load under this screen's container name and enqueue it.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Act on a navigation command.
virtual void PlaySlideSound (int nSelector)
 Play the sound that accompanies sliding between screens.
virtual void PlayLeaveSound (int nSelector)
 Play the sound that accompanies departing a screen.
virtual void PlayHighSound (int nSelector)
 Play the sound that accompanies the emphasised selection.
virtual void PlayCycleLeftSound (int nSelector)
 Play the sound that accompanies cycling a value to the left.
virtual void PlayCycleRightSound (int nSelector)
 Play the sound that accompanies cycling a value to the right.
virtual void PlayErrorSound (int nSelector)
 Play the sound that accompanies a rejected input.
virtual void StartRepeatingSound (float flStartTime, float flInterval, Rnd::Button *pButton, int nCycles)
 Start alternating one button between its states 2 and 1.
virtual void UpdateRepeatingSound (float flTime)
 Advance the alternation that StartRepeatingSound() started.
virtual void OnRepeatingSoundFinished (Rnd::Button *pButton)
 Act on the alternation that StartRepeatingSound() started having finished.
virtual void StartEnterAnimation (float flTime)
 Rewind the enter animation and record the time it starts at.
virtual void UpdateEnterAnimation (float flTime)
 Drive the enter animation and finish it once it passes its end.
virtual void OnEnterFinished ()
 Act on the enter animation having finished.
virtual void StartExitAnimation (float flTime)
 Record the time the exit animation starts at.
virtual void UpdateExitAnimation (float flTime)
 Drive the exit animation and hide the screen once it passes its end.
virtual void OnExitFinished ()
 Act on the exit animation having finished.
virtual void Draw ()
 Draw the view.
Public Member Functions inherited from MsgSink
void * operator new (size_t nSize)
 Allocate a sink from the tagged heap under the tag "MsgSink".
void operator delete (void *pBlock)
 Release a sink to the tagged heap.
virtual ~MsgSink ()
virtual void Dispatch (Message *pMsg)
 Accept a message.

Protected Attributes

std::vector< HxStr > mViewNames
std::vector< Rnd::View * > mViews
Protected Attributes inherited from MetScreen
float mAnimEndFrame
float mEnterStartTime
MetRenderer * mRenderer
int mExitChoice
int mAcceptsCommands
Rnd::View * mEnterAnim
std::vector< HxStr > mHelpKeys
int mViewsUnresolved
int mPlaysCommandSounds
int mShowsLoadedDrawables

Additional Inherited Members

Static Public Member Functions inherited from MetScreen
static std::map< HxStr, MetContainerLoad * > & ContainerLoaderMap ()
 Shared table of container loads, interned under the container name.
static std::map< HxStr, MetScreenEntry > & ScreenRegistry ()
 Shared table of live screens, interned under the screen registry key.
static MetScreen * FindScreenByName (const HxStr &name)
 Resolve one screen by its registry key.
static MetScreen * FindEndScreen (MetRenderer *pRenderer, const HxStr &name)
 Resolve one end-of-game screen by its registry key, failing fatally when it is absent.
static void CreateMainMenuScreens (MetRenderer *pRenderer)
 Create the main-menu screens.
static void DestroyAllScreens ()
 Delete every registered screen and release every container loader.
static void CreateStartupScreens (MetRenderer *pRenderer)
 Create the four screens the front end needs before its containers have loaded.
static void CreateFrontEndScreens (MetRenderer *pRenderer)
 Create every remaining front-end screen, once.
static void DestroyCategory2Screens ()
 Delete and unregister every screen in category 2.
static void DestroyCategory1Screens ()
 Delete and unregister every screen in category 1.
static void DestroyNonDefaultScreens ()
 Delete and unregister every screen outside category 0, then rewind the rndMetLocAndNet zone.
static void PollContainerLoads ()
 Poll every container load that has not finished, and hide the drawables of each that does.
Public Attributes inherited from MetScreen
Rnd::View * mView
 The container's root view.
int mEnterPending
 Set when the screen was pushed before its container load finished.
int mActivatePending
 Set when the screen was activated as a panel before its container load finished.
float mRepeatScale
 Scale on the input auto-repeat interval.
Protected Member Functions inherited from MetScreen
virtual void DispatchPriv (Message *pMsg)
 Act on a message.
void ResolveAnimationViews ()
 Resolves the two animation views from the screen name and records the enter animation's end frame.

Detailed Description

Base of the four gizmo panels that frame the front end.

Its RTTI descriptor is at 0x00901c30. It has MetScreen as its one public non-virtual base at offset 0. The 39-entry vtable at 0x007f4340 is the same length as the MetScreen table, and the class declares no new virtual.

Four classes derive from the class, MetEndGameGizmoScreen, MetLeftGizmoScreen, MetLeftGizmoSmallScreen, and MetRightGizmoScreen. Each child fills mViewNames after the constructor returns. No child declares a data member, and each child's New() allocates 0xa4 bytes.

The four child destructors expand this class's destructor and restore this class's vptr during teardown.

The translation unit spans 0x00276d38 to 0x0027c2e0 and includes all five classes, with their type functions, per-unit copies of MsgSink routines, and template library emissions.

Apart from the type function and the destructor, the slots that differ from the MetScreen table are 26, 27, and 38.

Constructor & Destructor Documentation

◆ MetGizmoPanel()

MetGizmoPanel::MetGizmoPanel ( MetRenderer * pRenderer,
int nPriority,
const HxStr & name,
const HxStr & directory,
const HxStr & container )

Construct the panel with no alternate views.

Parameters
pRendererThe front-end renderer this screen registers on.
nPriorityThe load priority.
nameThe screen name.
directoryThe directory the container loads from.
containerThe container name, without its .rnd suffix.
Ghidra address:
NTSC-U/C: 0x00276d38
Ghidra address:
PAL: 0x0028f690

◆ ~MetGizmoPanel()

virtual MetGizmoPanel::~MetGizmoPanel ( )
virtual

Release the two view vectors.

Ghidra address:
NTSC-U/C: 0x0027b218
Ghidra address:
PAL: 0x00293eb8

Member Function Documentation

◆ UpdateIdle()

virtual void MetGizmoPanel::UpdateIdle ( float flTime)
virtual

Set every alternate view to one animation frame.

Slot 26.

Parameters
flTimeThe frame.
Ghidra address:
NTSC-U/C: 0x0027b3b0
Ghidra address:
PAL: 0x00294068

Reimplemented from MetScreen.

◆ UpdateIdleAnimation()

virtual void MetGizmoPanel::UpdateIdleAnimation ( float flTime)
virtual

Forward to UpdateIdle().

Slot 27.

Parameters
flTimeThe frame.
Ghidra address:
NTSC-U/C: 0x0027b388
Ghidra address:
PAL: 0x00294040

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetGizmoPanel::ResolveContainerViews ( )
virtual

Resolve the base views, and then each name in mViewNames into mViews as a Rnd::View.

Slot 38. mViews is resized to the length of mViewNames first.

Ghidra address:
NTSC-U/C: 0x00276d90
Ghidra address:
PAL: 0x0028f6e8

Reimplemented from MetScreen.

Member Data Documentation

◆ mViewNames

std::vector<HxStr> MetGizmoPanel::mViewNames
protected

◆ mViews

std::vector<Rnd::View *> MetGizmoPanel::mViews
protected

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