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

A screen that shows its panels for a fixed time and then moves on to another screen. More...

#include <introscreen.h>

Inheritance diagram for IntroScreen:
Collaboration diagram for IntroScreen:

Public Member Functions

 ~IntroScreen () override=default
 Destroy the object.
 IntroScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Start the hold once the move to the screen has finished, and pass every other message to UIScreen.
void Poll (float fTime) override
 Advance the screen, and move to the next screen once the hold has run out.
Public Member Functions inherited from UIScreen
 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 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
Public Member Functions inherited from MsgSink
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.

Static Public Member Functions

static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from UIScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.

Protected Member Functions

bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Start the hold.

Protected Attributes

float mEndTime
float mHoldMs
const char * mNextScreen
Protected Attributes inherited from UIScreen
const char * mName
const char * mGroup
std::map< const char *, UIPanel *, StrLess > mPanels
UIPanel * mFocusPanel
std::vector< Transition > mTransitions
UIScreen * mPrevScreen
UIScreen * mNextScreen
int mForceEntryExit

Detailed Description

A screen that shows its panels for a fixed time and then moves on to another screen.

The RTTI includes the name and records UIScreen as the one base. The object is 0x48 bytes. The metagame registers the class for the screen type intro_screen. The start-up flow shows two of them, sony_pres with the presented-by notice and hmx_logo, each with a hold_time and a next_screen.

Constructor & Destructor Documentation

◆ ~IntroScreen()

IntroScreen::~IntroScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035cfc8
Ghidra address:
PAL: 0x003cb0a0

◆ IntroScreen()

IntroScreen::IntroScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

The next_screen entry is required. The hold_time entry is optional and defaults to one second.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0018c158
Ghidra address:
PAL: 0x00192910

Member Function Documentation

◆ New()

UIScreen * IntroScreen::New ( DataArray * pData)
inlinestatic

Create a screen from its script description.

The metagame registers the routine for the screen type intro_screen.

Parameters
pDataThe script description.
Returns
The new screen.
Ghidra address:
NTSC-U/C: 0x0035cf88
Ghidra address:
PAL: 0x003cb060

◆ DispatchPriv()

bool IntroScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Start the hold once the move to the screen has finished, and pass every other message to UIScreen.

Parameters
pMsgThe message.
Returns
False for the end of the move, and what UIScreen reports for any other message.
Ghidra address:
NTSC-U/C: 0x0018c320
Ghidra address:
PAL: 0x00192e58

Implements MsgSink.

Reimplemented in MarketingScreen.

◆ Poll()

void IntroScreen::Poll ( float fTime)
overridevirtual

Advance the screen, and move to the next screen once the hold has run out.

Parameters
fTimeThe front-end time.
Ghidra address:
NTSC-U/C: 0x0018c1e0
Ghidra address:
PAL: 0x00192998

Reimplemented from UIScreen.

◆ HandleTransitionComplete()

bool IntroScreen::HandleTransitionComplete ( UITransitionCompleteMsg * pMsg)
protected

Start the hold.

Parameters
pMsgThe message that reported the end of the move.
Returns
False.
Ghidra address:
NTSC-U/C: 0x0018c2a0
Ghidra address:
PAL: 0x00192a58

Member Data Documentation

◆ mEndTime

float IntroScreen::mEndTime
protected

◆ mHoldMs

float IntroScreen::mHoldMs
protected

◆ mNextScreen

const char* IntroScreen::mNextScreen
protected

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