---

ltclientshell.h

Go to the documentation of this file.

// ----------------------------------------------------------------------- //
//
// MODULE  : ltclientshell.h
//
// PURPOSE : LT Client Shell - Definition
//
// CREATED : 12/20/00
//
// (c) 2000 LithTech, Inc.  All Rights Reserved
//
// ----------------------------------------------------------------------- //

#ifndef __LT_CLIENT_SHELL_H__
#define __LT_CLIENT_SHELL_H__


// Shared includes
#include "shared_types.h"
#include "Aria.h"

// Definitions of classes
#include "mousefilter.h"
#include "JamODrum.h"
#include "MusicBoxPipe.h"
#include "BeatListener.h"

// Engine includes
#include <iclientshell.h>
#include <ilttexinterface.h>


// Global pointer to the ClientShell
class CLTClientShell;
extern CLTClientShell *g_pCShell;

class CMenuMgr;
class CClientConnClnt;
class CCamera;
class CWorldPropClnt;
class CPlayerClnt;
class CFxMgr;


enum EClientGameState
{
    CGS_STARTING_UP = 0,
    CGS_MENU,
    CGS_LOADING_WORLD,
    CGS_PLAYING,
    CGS_PAUSED,
    CGS_WORLD_EXIT,
    CGS_SCOREBOARD,
    CGS_CINEMATIC,
    CGS_SHUTTING_DOWN,

    CGS_SAMPLE,

    CGS_NUM_STATES
};


class CLTClientShell : public IClientShellStub
{
  public:
    // Construction / destruction
    CLTClientShell();
    virtual ~CLTClientShell();

    declare_interface(CLTClientShell);

    // Overridden functions

    virtual uint32      OnEngineInitialized(RMode *pMod, LTGUID *pAppGuid);
    virtual void        OnEngineTerm();

    virtual void        OnEvent(uint32 dwEventID, uint32 dwParam);

    virtual void        PreLoadWorld(const char *pWorldName);
    virtual void        OnEnterWorld();
    virtual void        OnExitWorld();

    virtual void        PreUpdate();
    virtual void        Update();
    virtual void        PostUpdate();

    virtual void        OnCommandOn(int command);
    virtual void        OnCommandOff(int command);

    virtual void        OnKeyDown(int key, int rep);
    virtual void        OnKeyUp(int key);

    virtual void        OnMessage(uint8 messageID, ILTMessage* pMessage);
    virtual void        SpecialEffectNotify(HLOCALOBJ hObj, ILTMessage* pMessage);

    virtual LTRESULT    OnObjectMove(HLOCALOBJ hObj, bool bTeleport, LTVector3f *pNewPos);
    virtual LTRESULT    OnObjectRotate(HLOCALOBJ hObj, bool bTeleport,
                            LTOrientation *pNewOrientation);
    virtual void        OnObjectRemove(HLOCALOBJ hObj);

    virtual LTRESULT    OnTouchNotify(HOBJECT hMain, LTContactInfo *pInfo);

    virtual void        OnModelKey(HLOCALOBJ hObj, ArgList *pArgs);

    virtual void        OnPlaySound(PlaySoundInfo *pPlaySoundInfo) ;


    // Non-LithTech-defined functions

    void                FirstUpdate();

    void                RegisterObject(CPlayerClnt* pPlayer);
    void                UnRegisterObject(CPlayerClnt* pPlayer);
    void                RegisterObject(CWorldPropClnt* pWorldProp);
    void                UnRegisterObject(CWorldPropClnt* pWorldProp);
    void                RegisterObject(CClientConnClnt* pClientConn);
    void                UnRegisterObject(CClientConnClnt* pClientConn);

    uint32              GetClientID() {return m_nClientID;};
    
    CPlayerClnt*        GetPlayer(uint32 iPlayer = 0)   { return m_Players[iPlayer]; }
    CCamera*            GetCamera(uint32 iCamera = 0)   { return m_Cameras[iCamera]; }

    LTOrientation       GetStartPointRot() {return m_oStartPointRot;};
    
    LTRESULT            InitGame();
    void                InitBeforeConnect();

    CMouseFilter*       GetMouseFilter()                { return &m_MouseFilter; }

    CFxMgr*             GetFxMgr() { return m_pFXMgr; };
    
  protected:
    // Non-Lithtech defined Functions

    LTRESULT            InitRenderer(RMode *pMode);
    LTRESULT            InitSound();
    LTRESULT            Render();

    void                DisplayWatermark();

    void                AddPlayer();
    void                RemovePlayer();

    void                UpdatePlayers(float fFrameTime);
    void                UpdateCameras(float fFrameTime);

    LTRESULT            RenderCameras();

    void                SetupCameraViewports();
    void                SetupCameraViewports(uint32 count, uint32 indx,
        uint32 nPrevViewports, uint32 nCurrentDigit);

//  void                Viewport2Cameras(uint32 indx,
//                          uint32 nPrevViewports, uint32 nCurrentDigit);

    // Member variables

    uint8               m_iPlayerCount;
    uint8               m_iCurrentPlayer;

    CCamera*            m_Cameras[MAX_CLIENT_PLAYERS];
    CPlayerClnt*        m_Players[MAX_CLIENT_PLAYERS];

    LTOrientation       m_oStartPointRot;
    bool                m_bRender;
    bool                m_bFirstUpdate;
    
    CWorldPropClnt*     m_pWorldProp;
    
    CClientConnClnt*    m_pClientConn;

    HTEXTURE            m_hWatermark;

    uint32              m_eClientGameState;
    uint32              m_eSavedClientGameState;
    
    uint32              m_nClientID;
    bool                m_bDisplayClientIDErrorMsg;

    CMouseFilter        m_MouseFilter;

    CFxMgr              *m_pFXMgr;

    JamODrum*           m_pJamODrum;
    MusicBoxPipe*       m_pMusicBoxPipe;
    BeatListener*       m_pBeatListener;
};

#endif // __LT_CLIENT_SHELL_H__

---