One front-end screen, a set of panels shown together with one panel holding the focus.
More...
|
| | UIScreen (DataArray *pData) |
| | Construct a screen from its script description.
|
| | ~UIScreen () override |
| | Destroy the screen.
|
| bool | Dispatch (Message *pMsg) override |
| | Offer a message to the manager, then handle it here, then pass a navigation message on.
|
| bool | DispatchPriv (Message *pMsg) override |
| | Follow the transition of a pressed button or a chosen component.
|
| virtual void | Poll (float fTime) |
| | Advance the panels to a time, and finish the exit or the entry once their animations stop.
|
| virtual void | Draw () |
| | Draw the panels.
|
| virtual void | Exit (UIScreen *pNextScreen, float fTime) |
| | Start the exit to another screen.
|
| virtual void | Enter (UIScreen *pPrevScreen, float fTime) |
| | Become the current screen and start the entry animations of the panels.
|
| virtual void | Print (PrnStream &stream) |
| | Write a description of the screen, its panels, and its transitions.
|
| void | ClearTransitions () |
| | Empty the transition table.
|
| void | AddTransition (const char *pszComponent, int nButton, const char *pszScreen) |
| | Append an entry to the transition table.
|
| void | AddPanel (UIPanel *pPanel) |
| | Add a panel to the screen.
|
| bool | HandleJoypad (JoypadInputMsg *pMsg) |
| | Follow the transition of a pressed controller button.
|
| bool | HandleSelect (UIComponentSelectMsg *pMsg) |
| | Follow the transition of a component chosen with the cross button.
|
| void | SetFocus (UIPanel *pPanel) |
| | Move the focus to a panel.
|
| UIComponent * | FindComponent (const char *pszName) |
| | Find a component on any of the screen's panels.
|
| Transition * | FindTransition (UIComponent *pComponent, bool bFail) |
| | Find the transition of a component.
|
| Transition * | FindTransition (int nButton, bool bFail) |
| | Find the transition of a controller button.
|
| void | Load () |
| | Load the panels.
|
| void | Unload () |
| | Unload the panels.
|
| bool | IsLoaded () |
| | Report whether every panel has loaded.
|
| const char * | GetName () const |
| const char * | GetGroup () const |
| UIPanel * | GetFocusPanel () const |
| UIScreen * | GetNextScreen () const |
| UIScreen * | GetPrevScreen () const |
| const std::map< const char *, UIPanel *, StrLess > & | GetPanels () const |
| void * | operator new (size_t nSize) |
| | Allocate a sink from the pool heaps under the tag "MsgSink".
|
| void | operator delete (void *pBlock) |
| | Return a sink to the pool heaps.
|
| virtual | ~MsgSink () |
| void * | operator new (size_t size) |
| | Allocate from the main heap under the name MsgSink.
|
| void | operator delete (void *mem) |
| | Return memory to its heap.
|
| virtual | ~MsgSink () |
| | Destroy the sink.
|
One front-end screen, a set of panels shown together with one panel holding the focus.
The RTTI records the class as deriving from MsgSink. The object is 0x3c bytes. UIManager creates one for each screen entry of the front-end description, through the factory registered for the entry's type. The entry provides these:
- index 1, the name;
- panels, the names of the panels the screen shows;
- focus, the panel that first receives the focus, or the first panel by name;
- screen_transitions, pairs of a component name or a controller button and the screen that choosing the component or pressing the button leads to;
- force_entry_exit, whether the panels skip their animations;
- group, the loading group, which must be one of the allowable_groups of the configuration.
UIManager::GotoScreen() calls Exit() on the current screen. Once the exit animations have played and the next screen has loaded, Poll() unloads this screen's panels and calls Enter() on the next screen, which becomes current. A screen that has entered dispatches a UITransitionCompleteMsg to itself.
| bool UIScreen::Dispatch |
( |
Message * | pMsg | ) |
|
|
overridevirtual |
Offer a message to the manager, then handle it here, then pass a navigation message on.
A message that is neither a controller button nor a keyboard key goes first to UIManager. A controller button or keyboard key that the screen does not handle goes to the panel with the focus.
- Parameters
-
- Returns
- Whether the message was handled.
- Ghidra address:
- NTSC-U/C: 0x0020af00
- Ghidra address:
- PAL: 0x00213d00
Reimplemented from MsgSink.
| virtual void UIScreen::Exit |
( |
UIScreen * | pNextScreen, |
|
|
float | fTime ) |
|
virtual |
Start the exit to another screen.
A panel the next screen shares stays, and one of those that is exiting enters again. The others start their exit animations.
- Parameters
-
| pNextScreen | The screen to change to. |
| fTime | The front-end time in milliseconds. |
- Ghidra address:
- NTSC-U/C: 0x0020b6c8
- Ghidra address:
- PAL: 0x002144c8
Reimplemented in ArenaUnlockScreen, BossUnlockScreen, ControllerConfigScreen, FreqMakerEmblemScreen, FreqMakerMainScreen, FreqMakerPartConfigScreen, FreqScreen, JukeboxScreen, MainOptionsScreen, MCCheckScreen, MetaMainScreen, MetaSongScreen, MetaStartScreen, NetLpadScreen, NetMainScreen, NetParamsScreen, PartUnlockScreen, and SongDecryptScreen.
| virtual void UIScreen::Enter |
( |
UIScreen * | pPrevScreen, |
|
|
float | fTime ) |
|
virtual |
Become the current screen and start the entry animations of the panels.
- Parameters
-
| pPrevScreen | The screen this one replaces, or null. |
| fTime | The front-end time in milliseconds. |
- Ghidra address:
- NTSC-U/C: 0x0020b2e0
- Ghidra address:
- PAL: 0x002140e0
Reimplemented in ArenaUnlockScreen, BootScreen, BossJourneyScreen, BossUnlockScreen, CardsConnectedScreen, ChooseMemCardScreen, ControllerConfigScreen, CopyFreqScreen, CreditsScreen, FreqConfirmScreen, FreqCopyDelScreen, FreqMakerCustomScreen, FreqMakerEmblemScreen, FreqMakerMainScreen, FreqMakerPartConfigScreen, FreqScreen, GameOptionsScreen, JukeboxScreen, LaunchScreen, MainOptionsScreen, MetaArenaScreen, MetaMainScreen, MetaSkillScreen, MetaSongScreen, MetaStartScreen, ModeScreen, MsgErrorScreen, MultiEndGameScreen, MultiFreqSelectScreen, MultiLoadFreqScreen, MultiSetupRemixSaveScreen, NameErrorScreen, NetChangePasswordScreen, NetChooseIConfigScreen, NetCreateUserScreen, NetEULAScreen, NetHostingScreen, NetLoginScreen, NetLpadScreen, NetMainScreen, NetParamsScreen, NetPasswordScreen, NetRankingScreen, NetSearchScreen, NetServerSelScreen, NetSortedScreen, NetWelcomeScreen, NoControllerScreen, NumPlayersScreen, PartUnlockDoneScreen, PartUnlockScreen, PauseScreen, PlayerSearchResultsScreen, PowerupScreen, PupTipsScreen, RedbookPlaybackScreen, RemixOrFreqScreen, RemixSelectScreen, RemixSongScreen, RemixTypeScreen, SaveFreqScreen, SelLoadedFreqScreen, SelRemixDownloadScreen, SetupNameScreen, SetupNewChatroomScreen, SetupRemixSaveScreen, SoloEndGameScreen, SongDecryptScreen, SpaceErrorScreen, TipsScreen, TransitionErrorScreen, and UploadNoteScreen.