examples/SFExamples/RockPaperScissorsGameSourceCode_S60/RPS/inc/rpsGameScreens.h

/*
Copyright (c) 2002-2011 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of Nokia Corporation nor the names of its contributors
  may be used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description:  
*/

#ifndef RPSGAMESCREENS_
#define RPSGAMESCREENS_

#include "rpsMenuOptions.h"
#include "rpsPlayTimer.h"
#include "roshambo.h"

const TInt KMaxRpsTextElement = 30;
const TInt KRPSScreensHAlignment = 15;

extern TInt gScreenWidth;
extern TInt gScreenHeight;

class CRpsGameEngine;
class CBluetoothManager;
class CGameScreen;
class CWsBitmap;
                
class TGameData
        {
public:
        TInt iRpsError;
        };

/*
============================================================================
The screens manager. Manages the RPS's screen to display to the player
============================================================================
*/      
class CGameScreenManager : public CBase
        {
public:
        enum TGameState
                {
                ESplashScreen,          //Splash screen, displayed as game starts
                EMainScreen,            //Player select one/two players or view the about screen
                EPausedScreen,          //When the app loses the focus the pause screen is displayed
                EPlayScreen,            //Display the Roshambo game
                EWaitOpponentScreen,//Screen presented to th player for waiting the opponent move
                EResultScreen,          //Display the result
                EControlScreen,         //For choosing either master or slave mode
                ENotifierScreen,        //Displays a notifier
                EConnectingScreen,  //Screen presented to the Master during connection to the Slave
                EStartScreen,           //Screen presented to the Master with the option to kick off the game
                EWaitStartScreen,       //Screen presented to the Slave with a msg to wait for the Master to kick off the game
                EWaitConnScreen,        //Screen presented to the Slave with a waiting connection msg
                EErrorScreen,           //Display any errors to the player      
                EAboutScreen,           //About screen
                EGameScreensTotal       //Marks the end of the screen array
                };
        enum TPlayMode
                {
                ESinglePlayer,
                ETwoPlayerShortlink,
                };
public:
        static CGameScreenManager* NewL(CRpsGameEngine& aEngine);
        
        ~CGameScreenManager();
public:
        void SetGameState(TGameState aNewGameState);    
public:
        inline void SetPlayMode(TPlayMode aPlayMode) {iPlayMode = aPlayMode;};

        inline TGameState GameState() const {return (iGameState);};

        inline TPlayMode PlayMode() const {return (iPlayMode);};

        inline CGameScreen* GameScreen() {return (iGameScreens[iGameState]);};

        inline TRoshambo& Roshambo() {return (iRoshambo);};

        inline CRpsGameEngine& GameEngine() {return iEngine;};
        
        inline CBluetoothManager& BluetoothManager() {return (*iBTManager);};
        
        inline TGameData& GameData() {return iGameData;};
        
private:
        void ConstructL();
        
        CGameScreenManager(CRpsGameEngine& aEngine);
private:
        TGameState iGameState;

        TPlayMode iPlayMode;

        CRpsGameEngine& iEngine;

        CGameScreen* iGameScreens[EGameScreensTotal];
        
        TRoshambo iRoshambo;
        
        TGameData iGameData;
        
        CBluetoothManager* iBTManager;
        };
        
/*
============================================================================
This is displayed as a line of text on the screen
============================================================================
*/      
class TGameScreenItem
        {
public:
        TGameScreenItem(RPS::TMenuOption aOption, const TDesC& aText);  
        TDblQueLink iDlink; // Double-linked list link  
        RPS::TMenuOption iOption;
        TBool iHighlighted; // Indicates whether item is highlighted
        TInt iX; // X position on screen
        TInt iY; // Y position on screen
        TBufC<KMaxRpsTextElement> iText;
        };
        

        /*
============================================================================
The screen interface class - abstract C class
============================================================================
*/      
class CGameScreen : public CBase
                {
        public:
                // Draws the screen
                virtual void DrawGameScreen() =0; 
                // Handles user input and updates game state
                virtual void ProcessInput(TUint& /*aKeyState*/) {}; 
                // Called prior to each screen activation (when switching to it from another state)
                virtual void PreActivate() {}; 
                //Called prior to deactivation (when switching to another game state)
                virtual void DeActivate() {}; 
                virtual ~CGameScreen();
        protected:
                CGameScreen(CGameScreenManager& iGameScreenMgr);
        protected:
                CGameScreenManager& iGameScreenMgr;
                };      
        
/*
============================================================================
A generic menu screen
============================================================================
*/      
class CMenuScreen : public CGameScreen
        {
public:
        virtual ~CMenuScreen();
public: // From CGameScreen
        virtual void DrawGameScreen();
        virtual void ProcessInput(TUint& aKeyState);
protected:      
        CMenuScreen(CGameScreenManager& iGameScreenMgr);
        virtual void DoProcessInput(RPS::TMenuOption aSelected) =0;
protected:
        TDblQue<TGameScreenItem> iItems; // Linked list
        TDblQueIter<TGameScreenItem> iIterator;
        };
        

/*
============================================================================
The main menu screen
============================================================================
*/      
class CMainScreen : public CMenuScreen
        {
public:
        static CGameScreen* NewL(CGameScreenManager& aScreenMgr);
protected:      
        virtual void DoProcessInput(RPS::TMenuOption aSelected);
private:
        void ConstructL();
        CMainScreen(CGameScreenManager& aScreenMgr);
        };
        

/*
============================================================================
Play menu screen
============================================================================
*/      
class CPlayScreen : public CMenuScreen
        {
public:
        static CGameScreen* NewL(CGameScreenManager& aScreenMgr);
        ~CPlayScreen();
        void PlayTimeout();
protected:      
        virtual void DoProcessInput(RPS::TMenuOption aSelected);
        virtual void PreActivate();
        virtual void DeActivate();
private:
        void ConstructL();
        CPlayScreen(CGameScreenManager& aScreenMgr);
private:
        CPlayTimer* iPlayTimer;
        };      
        
/*
============================================================================
About screen
============================================================================
*/      
class CAboutScreen : public CMenuScreen
        {
public:
        static CGameScreen* NewL(CGameScreenManager& aScreenMgr);
protected:      // From CMenuScreen
        virtual void DrawGameScreen();
        virtual void DoProcessInput(RPS::TMenuOption aSelected);
private:
        void ConstructL();
        CAboutScreen(CGameScreenManager& aScreenMgr);
        };
        
/*
============================================================================
Pause screen
============================================================================
*/      
class CPauseScreen : public CGameScreen
        {
public:
        static CGameScreen* NewL(CGameScreenManager& aScreenMgr);
        ~CPauseScreen();
public: // From CGameScreen
        virtual void DrawGameScreen();
        virtual void ProcessInput(TUint& aKeyState);
        virtual void DeActivate(); 
private:
        void ConstructL();
        CPauseScreen(CGameScreenManager& aScreenMgr);
private:
        CWsBitmap* iBmp;
        TPoint iPos;
        };
/*      
============================================================================
Splash screen
============================================================================
*/      
class CSplashScreen : public CGameScreen
        {
public:
        static CGameScreen* NewL(CGameScreenManager& aScreenMgr);
        ~CSplashScreen();
public: // From CGameScreen
        virtual void DrawGameScreen(); 
private:
        void ConstructL();
        CSplashScreen(CGameScreenManager& aScreenMgr);
private:
        TInt iSplashCounter;
        CWsBitmap* iBmp;
        TPoint iPos;
        };      
        
/*
============================================================================
Result screen
============================================================================
*/      
class CResultScreen : public CGameScreen
        {
public:
        static CResultScreen* NewL(CGameScreenManager& aScreenMgr);
public: // From CGameScreen
        virtual void DrawGameScreen();
        virtual void ProcessInput(TUint& aKeyState);
private:
        void ConstructL();
        CResultScreen(CGameScreenManager& aScreenMgr);
        };              


/*
============================================================================
Control menu screen. User chooses to be either a Master (the player controls the game) or 
a Slave (the player waits for other player connection)  
============================================================================
*/      
class CControlScreen : public CMenuScreen
        {
public:
        static CGameScreen* NewL(CGameScreenManager& aScreenMgr);
protected:      
        virtual void DoProcessInput(RPS::TMenuOption aSelected);
private:
        void ConstructL();
        CControlScreen(CGameScreenManager& aScreenMgr);
        };

/*
============================================================================
Start the game (Master)
============================================================================
*/      
class CStartScreen : public CMenuScreen
        {
public:
        static CGameScreen* NewL(CGameScreenManager& aScreenMgr);
protected:      
        virtual void DoProcessInput(RPS::TMenuOption aSelected);
private:
        void ConstructL();
        CStartScreen(CGameScreenManager& aScreenMgr);
        };

/*
============================================================================
Waiting to start the game (Slave mode)
============================================================================
*/      
class CWaitStartScreen : public CGameScreen
        {
public:
        static CWaitStartScreen* NewL(CGameScreenManager& aScreenMgr);
public: // From CGameScreen
        virtual void DrawGameScreen();
private:
        void ConstructL();
        CWaitStartScreen(CGameScreenManager& aScreenMgr);
        };              

/*
============================================================================
Waiting for a connection (Slave mode)
============================================================================
*/      
class CWaitConnScreen : public CGameScreen
        {
public:
        static CWaitConnScreen* NewL(CGameScreenManager& aScreenMgr);
public: // From CGameScreen
        virtual void DrawGameScreen();
private:
        void ConstructL();
        CWaitConnScreen(CGameScreenManager& aScreenMgr);
        };              

/*
============================================================================
Display a error message to the player
============================================================================
*/      
class CErrorScreen : public CGameScreen
        {
public:
        static CErrorScreen* NewL(CGameScreenManager& aScreenMgr);
public: // From CGameScreen
        virtual void DrawGameScreen();
        virtual void ProcessInput(TUint& aKeyState);
        virtual void DeActivate();
private:
        void ConstructL();
        CErrorScreen(CGameScreenManager& aScreenMgr);
        };              

/*
============================================================================
Display connecting message to the player (Master mode)
============================================================================
*/      
class CConnectingScreen : public CGameScreen
        {
public:
        static CConnectingScreen* NewL(CGameScreenManager& aScreenMgr);
public: // From CGameScreen
        virtual void DrawGameScreen();
        virtual void ProcessInput(TUint& aKeyState);
private:
        void ConstructL();
        CConnectingScreen(CGameScreenManager& aScreenMgr);
        };              
        
/*
============================================================================
Waiting for the opponent move
============================================================================
*/      
class CWaitOpponentScreen : public CGameScreen
        {
public:
        static CWaitOpponentScreen* NewL(CGameScreenManager& aScreenMgr);
public: // From CGameScreen
        virtual void DrawGameScreen();
private:
        void ConstructL();
        CWaitOpponentScreen(CGameScreenManager& aScreenMgr);
        };      
        
        
class CNotifierScreen : public CGameScreen
        {
public:
        static CNotifierScreen* NewL(CGameScreenManager& aGameScreenMgr);
        ~CNotifierScreen();
public: // From CGameScreen
        virtual void DrawGameScreen();
private:
        CNotifierScreen(CGameScreenManager& aGameScreenMgr);    
        };

#endif /*RPSGAMESCREENS_*/

---