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

Logo panel drawn along the top of the front end. More...

#include <mettoplogoscreen.h>

Inheritance diagram for MetTopLogoScreen:
Collaboration diagram for MetTopLogoScreen:

Public Member Functions

 MetTopLogoScreen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetTopLogoScreen ()
virtual void UpdateIdle (float flTime)
 Advance the wave animation to the current frame.
virtual void ResolveContainerViews ()
 Resolve the logo panel and the wave animation.
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 UpdateIdleAnimation (float flTime)
 Advance whatever the screen animates while it is neither entering nor exiting.
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.

Static Public Member Functions

static MetTopLogoScreen * New (MetRenderer *pRenderer, int nPriority)
 Build the screen on the heap.
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.

Additional Inherited Members

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.
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

Detailed Description

Logo panel drawn along the top of the front end.

Its RTTI descriptor is at 0x008f0880. It has MetScreen as its one public non-virtual base at offset 0.

The 39-entry primary vtable is at 0x0080ff98, the same length as the MetScreen table, so the class declares no virtual of its own.

The constructor at 0x003c46f8 takes only the renderer and the load priority, and supplies lp for the screen name, metagame/Shared for the directory, and freq_logo_panel for the container. It clears MetScreen::mShowsLoadedDrawables and does not write mWaveView. The screen loads the same container as MetLogoScreen under the screen name lp rather than fl, and it is one of only three classes that inherit slot 5 unchanged.

The object is 0x90 bytes, which the allocation in New() fixes.

The destructor is at 0x003c7798.

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

Constructor & Destructor Documentation

◆ MetTopLogoScreen()

MetTopLogoScreen::MetTopLogoScreen ( MetRenderer * pRenderer,
int nPriority )

Construct the screen.

Parameters
pRendererThe front-end renderer this screen registers on.
nPriorityThe load priority.
Ghidra address:
NTSC-U/C: 0x003c46f8
Ghidra address:
PAL: 0x003fb828

◆ ~MetTopLogoScreen()

virtual MetTopLogoScreen::~MetTopLogoScreen ( )
virtual
Ghidra address:
NTSC-U/C: 0x003c7798
Ghidra address:
PAL: 0x003fea08

Member Function Documentation

◆ New()

MetTopLogoScreen * MetTopLogoScreen::New ( MetRenderer * pRenderer,
int nPriority )
static

Build the screen on the heap.

The object is allocated with the tag MsgSink. MetScreen::CreateMainMenuScreens() is the one caller.

Parameters
pRendererThe front-end renderer the screen registers on.
nPriorityThe load priority.
Returns
The new screen.
Ghidra address:
NTSC-U/C: 0x003c7710
Ghidra address:
PAL: 0x003fe980

◆ UpdateIdle()

virtual void MetTopLogoScreen::UpdateIdle ( float flTime)
virtual

Advance the wave animation to the current frame.

Slot 26.

Parameters
flTimeThe current frame position.
Ghidra address:
NTSC-U/C: 0x003c77f0
Ghidra address:
PAL: 0x003fea60

Reimplemented from MetScreen.

◆ ResolveContainerViews()

virtual void MetTopLogoScreen::ResolveContainerViews ( )
virtual

Resolve the logo panel and the wave animation.

Slot 38.

The body does not run MetScreen::ResolveContainerViews(). It resolves the animation views, resolves logo_panel.view into MetScreen::mView and releases its animation references without a null test, clears MetScreen::mViewsUnresolved, and resolves wave.view into mWaveView.

Ghidra address:
NTSC-U/C: 0x003c4868
Ghidra address:
PAL: 0x003fba00

Reimplemented from MetScreen.


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