|
resonance 1.0.1
|
Title bar shown above another screen. More...
#include <metscreentitlescreen.h>


Public Member Functions | |
| MetScreenTitleScreen (MetRenderer *pRenderer, int nPriority) | |
| Construct the screen. | |
| virtual | ~MetScreenTitleScreen () |
| virtual void | EnterAndShow () |
| Show the recorded title and then the screen. | |
| virtual void | BeginExit () |
| Start the exit. | |
| virtual void | OnEnterFinished () |
| Do nothing. | |
| virtual void | OnExitFinished () |
| Do nothing. | |
| virtual void | ResolveContainerViews () |
| Resolve the title text fst_title.txt into mTitleText. | |
| void | ApplyTitle (const HxStr &title) |
| Record one title and push this screen. | |
| void | ReplaceTitleText (const HxStr &title) |
| Record one title and set it on the title text. | |
| 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 | 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 | 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 | UpdateIdle (float flTime) |
| Advance whatever the screen updates once per frame while it is idle. | |
| 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 | 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 | 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 MetScreenTitleScreen * | New (MetRenderer *pRenderer, int nPriority) |
| Allocate and construct the screen. | |
| static void | SetTitle (const HxStr &title) |
| Replace the shared screen title. | |
| static void | ReplaceTitle (const HxStr &title) |
| Replace the shared screen title without showing the panel again. | |
| 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 |
Title bar shown above another screen.
Its RTTI descriptor is at 0x008ef8d0. It has MetScreen as its one public non-virtual base at offset 0.
The 39-entry primary vtable is at 0x0080bc40, the same length as the MetScreen table, so the class declares no virtual of its own.
The constructor at 0x00390e10 takes only the renderer and the load priority, and supplies fst for the screen name, metagame/shared for the directory, and screen_title for the container. It starts mTitle empty. The factory's 0x98-byte allocation fixes the size.
Apart from the type function and the destructor, the slots that differ from the MetScreen table are 5, 9, 33, 36, and 38, all declared below.
| MetScreenTitleScreen::MetScreenTitleScreen | ( | MetRenderer * | pRenderer, |
| int | nPriority ) |
Construct the screen.
| pRenderer | The front-end renderer this screen registers on. |
| nPriority | The load priority. |
|
virtual |
|
static |
Allocate and construct the screen.
The 0x98-byte allocation is billed to the tag MsgSink.
| pRenderer | The front-end renderer this screen registers on. |
| nPriority | The load priority. |
|
virtual |
Show the recorded title and then the screen.
Slot 5.
Reimplemented from MetScreen.
|
virtual |
Start the exit.
Slot 9.
The override runs MetScreen::BeginExit() and nothing else.
Reimplemented from MetScreen.
|
virtual |
Do nothing.
Slot 33.
Reimplemented from MetScreen.
|
virtual |
Do nothing.
Slot 36.
Reimplemented from MetScreen.
|
virtual |
|
static |
Replace the shared screen title.
The routine resolves the screen registered under the literal MetScreenTitleScreen, casts it to this class, and forwards to ApplyTitle(). The result is not tested for null. It is a static member rather than a free function, because it takes no receiver and vends exactly one class.
| title | The title to display. |
| void MetScreenTitleScreen::ApplyTitle | ( | const HxStr & | title | ) |
Record one title and push this screen.
The title is copied to mTitle and the screen registered as MetScreenTitleScreen is pushed, which shows it through EnterAndShow(). SetTitle() is the one caller.
| title | The title to display. |
|
static |
Replace the shared screen title without showing the panel again.
The same lookup and cast as SetTitle(), forwarding to ReplaceTitleText() instead. MetRemixLoadScreen calls it when the button ring changes the catalogue. The name is inferred.
| title | The title to display. |
| void MetScreenTitleScreen::ReplaceTitleText | ( | const HxStr & | title | ) |
Record one title and set it on the title text.
The title is copied to mTitle and set on mTitleText. Unlike ApplyTitle(), the screen is not pushed again. The name is inferred.
| title | The title to display. |