Glenn Maynard
4bcf9fcbfd
top screen. This allows a screen to push a helper screen, which can then enter an entirely separate set of helper screens before one pops back. (For example, a screen could push ScreenServiceOptions to enter the options menu, which then replaces itself with the various options menus, and finally pops back to the original screen when the player backs out entirely.) (Some support is still missing to allow non-special-case use of this; coming soon ...) However, in rare cases we want to kill all screens on the stack, regardless of how many there are (operator menu). Fix that case.
131 lines
4.5 KiB
C++
131 lines
4.5 KiB
C++
/* ScreenManager - Manager/container for Screens. */
|
|
|
|
#ifndef ScreenManager_H
|
|
#define ScreenManager_H
|
|
|
|
#include "RageInputDevice.h"
|
|
#include "ScreenMessage.h"
|
|
#include "InputFilter.h"
|
|
#include "GameInput.h"
|
|
#include "MenuInput.h"
|
|
#include "StyleInput.h"
|
|
#include "RageSound.h"
|
|
|
|
class Actor;
|
|
class Screen;
|
|
struct Menu;
|
|
struct lua_State;
|
|
|
|
|
|
class ScreenManager
|
|
{
|
|
public:
|
|
ScreenManager();
|
|
~ScreenManager();
|
|
|
|
// pass these messages along to the current state
|
|
void Update( float fDeltaTime );
|
|
void Draw();
|
|
void Input( const DeviceInput& DeviceI, const InputEventType type, const GameInput &GameI, const MenuInput &MenuI, const StyleInput &StyleI );
|
|
|
|
// Main screen stack management
|
|
void SetNewScreen( const CString &sName );
|
|
void AddNewScreenToTop( const CString &sName, ScreenMessage SendOnPop=SM_None );
|
|
void PrepareScreen( const CString &sScreenName ); // creates and caches screen so that the next call to SetNewScreen for the prep'd screen will be very quick.
|
|
void GroupScreen( const CString &sScreenName );
|
|
void PersistantScreen( const CString &sScreenName );
|
|
bool ConcurrentlyPrepareScreen( const CString &sScreenName, ScreenMessage send_when_done = SM_None );
|
|
bool IsConcurrentlyLoading() const;
|
|
void PushScreen( Screen *pNewScreen, bool bDeleteWhenDone=false, ScreenMessage SendOnPop=SM_None );
|
|
void PopTopScreen( ScreenMessage SM );
|
|
void PopAllScreens();
|
|
Screen* MakeNewScreen( const CString &sName );
|
|
Screen *GetTopScreen();
|
|
|
|
// System messages
|
|
void SystemMessage( const CString &sMessage );
|
|
void SystemMessageNoAnimate( const CString &sMessage );
|
|
void HideSystemMessage();
|
|
CString GetCurrentSystemMessage() const { return m_sSystemMessage; }
|
|
|
|
// Screen messages
|
|
void PostMessageToTopScreen( ScreenMessage SM, float fDelay );
|
|
void SendMessageToTopScreen( ScreenMessage SM );
|
|
|
|
void RefreshCreditsMessages();
|
|
void ThemeChanged();
|
|
|
|
|
|
/* Return true if the given screen is in the main screen stack, but not the bottommost
|
|
* screen. If true, the screen should usually exit by popping itself, not by loading
|
|
* another screen. */
|
|
bool IsStackedScreen( const Screen *pScreen ) const;
|
|
|
|
// Lua
|
|
void PushSelf( lua_State *L );
|
|
|
|
void PlaySharedBackgroundOffCommand();
|
|
void ZeroNextUpdate();
|
|
private:
|
|
Screen *m_pInputFocus; // NULL = top of m_ScreenStack
|
|
|
|
CString m_sSystemMessage;
|
|
|
|
// Screen loads, removals, and concurrent prepares are delayed until the next update.
|
|
CString m_sDelayedScreen;
|
|
CString m_sDelayedConcurrentPrepare;
|
|
ScreenMessage m_OnDonePreparingScreen;
|
|
ScreenMessage m_PopTopScreen;
|
|
|
|
// Set this to true anywhere we create of delete objects. These
|
|
// operations take a long time, and will cause a skip on the next update.
|
|
bool m_bZeroNextUpdate;
|
|
|
|
void LoadDelayedScreen();
|
|
ScreenMessage PopTopScreenInternal( bool bSendLoseFocus = true );
|
|
|
|
// Keep these sounds always loaded, because they could be
|
|
// played at any time. We want to eliminate SOUND->PlayOnce
|
|
public:
|
|
void PlayStartSound();
|
|
void PlayCoinSound();
|
|
void PlayInvalidSound();
|
|
void PlayScreenshotSound();
|
|
|
|
private:
|
|
RageSound m_soundStart;
|
|
RageSound m_soundCoin;
|
|
RageSound m_soundInvalid;
|
|
RageSound m_soundScreenshot;
|
|
};
|
|
|
|
|
|
extern ScreenManager* SCREENMAN; // global and accessable from anywhere in our program
|
|
|
|
#endif
|
|
|
|
/*
|
|
* (c) 2001-2003 Chris Danford, Glenn Maynard
|
|
* All rights reserved.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
* copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, and/or sell copies of the Software, and to permit persons to
|
|
* whom the Software is furnished to do so, provided that the above
|
|
* copyright notice(s) and this permission notice appear in all copies of
|
|
* the Software and that both the above copyright notice(s) and this
|
|
* permission notice appear in supporting documentation.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
|
|
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
|
|
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
|
|
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
|
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
* PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|