IParaEngineApp.h

#pragma once
//-----------------------------------------------------------------------------
// Copyright (C) 2007 - 2010 ParaEngine Corporation, All Rights Reserved.
// Author: LiXizhi
// Date:    2010.2
// Description: API for ParaEngine App windows management interface 
//-----------------------------------------------------------------------------
#include <string>
#include "baseinterface.h"
#include <stdint.h>

struct IDirect3DDevice9;
struct IDirect3DSwapChain9;

namespace NPL{
    class INPLRuntime;
}

#ifndef WIN32
#ifndef WM_USER
    #define WM_USER                         0x0400
#endif
#ifndef LRESULT
    #define LRESULT     long*
#endif
#ifndef WPARAM
    #define WPARAM     int*
#endif
#ifndef LPARAM
    #define LPARAM     int*
#endif
#endif
namespace ParaEngine
{
    struct CWinRawMsg;
    class CRefCounted;
    class Vector2;

    enum PEAppState
    {
        PEAppState_None = 0,
        PEAppState_Started,
        PEAppState_Device_Created,
        PEAppState_Device_Error,
        PEAppState_Ready,
        PEAppState_SwitchedOut,
        PEAppState_Stopped,
        PEAppState_Exiting,
        PEAppState_Exited,
        PEAppState_Unknown,
    };

    enum PE_USAGE
    {
        // standalone application
        PE_USAGE_STANDALONE = 1,
        // Used in web browser
        PE_USAGE_WEB_BROWSER = 2,
        // as a system service
        PE_USAGE_SERVICE = 4,
        // owns the d3d device, otherwise it is using external device. 
        PE_USAGE_OWN_D3D = 16, 
        // owns the main window, otherwise it renders to an external window. 
        PE_USAGE_OWN_WINDOW = 32,
    };

#define PE_WM_FIRST         WM_USER+2301

#define PE_WM_SHOWCURSOR            WM_USER+2301

#define PE_WM_QUIT                  WM_USER+2302

#define PE_WM_SETCAPTURE            WM_USER+2303

#define PE_WM_RELEASECAPTURE        WM_USER+2304

#define PE_WM_SETFOCUS      WM_USER+2305

#define PE_IME_SETOPENSTATUS        WM_USER+2306

#define PE_IME_SETFOCUS     WM_USER+2307

#define PE_APP_SWITCH       WM_USER+2308

#define PE_APP_SHOW_ERROR_MSG   WM_USER+2309

#define PE_WM_LAST          WM_USER+2399

#define PE_TIMERID_HEARTBEAT        5602

    class IParaEngineApp : public BaseInterface
    {
    public:
        virtual HRESULT StartApp(const char* sCommandLine = 0) = 0;

        virtual HRESULT StopApp() = 0;

        virtual void SetMainWindow(HWND hWnd, bool bIsExternalWindow=true) = 0;
        virtual HWND GetMainWindow() = 0;

        virtual int Run(HINSTANCE hInstance) = 0;
        
        virtual HRESULT DoWork() = 0;

        virtual HRESULT CreateFromD3D9Device(IDirect3DDevice9* pD3dDevice, IDirect3DSwapChain9* apSwapChain) = 0;

        virtual HRESULT InitDeviceObjects() = 0;

        virtual HRESULT RestoreDeviceObjects() = 0;

        virtual HRESULT InvalidateDeviceObjects() = 0;
        virtual HRESULT DeleteDeviceObjects() = 0;

        virtual HRESULT Create( HINSTANCE hInstance = 0 ) = 0;

        virtual HRESULT Init(HWND* pHWND = 0) = 0;

        virtual HRESULT Render3DEnvironment(bool bForceRender = false) = 0;

        virtual LRESULT MsgProcWinThread( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam, bool bCallDefProcedure = true) = 0;

        /*** process win thread messages without a hWnd. Such messages are usually invoked by PostWinThreadMessage() from other threads. */
        virtual LRESULT MsgProcWinThreadCustom( UINT uMsg, WPARAM wParam, LPARAM lParam) = 0;

        virtual LRESULT SendMessageToApp( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam) = 0;

        virtual bool PostWinThreadMessage(UINT uMsg, WPARAM wParam, LPARAM lParam) = 0;

        virtual bool GetMessageFromApp(CWinRawMsg* pMsg) = 0;

        virtual LRESULT MsgProcApp(HWND hWnd,  UINT uMsg, WPARAM wParam, LPARAM lParam) = 0;

        virtual void    EnablePassiveRendering( bool bEnable ) = 0;

        virtual bool    IsPassiveRenderingEnabled( ) = 0;

        virtual void Enable3DRendering(bool bEnable) = 0;

        virtual bool Is3DRenderingEnabled() = 0;


        virtual void SetFullScreenMode(bool bFullscreen) = 0;
        virtual bool IsFullScreenMode() = 0;

        virtual void BringWindowToTop() = 0;

        virtual void SetAllowWindowClosing(bool bAllowClosing) = 0;
        virtual bool IsWindowClosingAllowed() = 0;

        virtual void ShowMenu(bool bShow) = 0;

        virtual void GetResolution(float* pX, float* pY) = 0;
        virtual void SetResolution(float x, float y) = 0;

        virtual int GetMultiSampleType() = 0;
        virtual void SetMultiSampleType(int nType) = 0;

        virtual int GetMultiSampleQuality() = 0;
        virtual void SetMultiSampleQuality(int nType) = 0;

        virtual bool UpdateScreenMode() = 0;

        // ParaEngine pipeline routines
        virtual bool SetWindowedMode(bool bWindowed) = 0;
        virtual bool IsWindowedMode() = 0;
        virtual void SetWindowText(const char* pChar) = 0;
        virtual const char* GetWindowText() = 0;
        
        virtual void GetCursorPosition(int* pX,int * pY, bool bInBackbuffer = true) = 0;

        virtual void GameToClient(int& inout_x,int & inout_y, bool bInBackbuffer = true) = 0;

        virtual void ClientToGame(int& inout_x,int & inout_y, bool bInBackbuffer = true) = 0;

        virtual void WriteConfigFile(const char* sFileName) = 0;

        virtual bool HasNewConfig() = 0;

        virtual void SetHasNewConfig(bool bHasNewConfig) = 0;

        virtual void SetIgnoreWindowSizeChange(bool bIgnoreSizeChange) = 0;

        virtual bool GetIgnoreWindowSizeChange() = 0;

        virtual HINSTANCE GetModuleHandle() = 0;

        virtual void SetRefreshTimer(float fTimeInterval, int nFrameRateControl=0) = 0;
        
        virtual float GetRefreshTimer() = 0;

        virtual void GetWindowCreationSize(int * pWidth, int * pHeight) = 0;

        virtual PEAppState GetAppState() = 0;

        virtual void SetAppState(ParaEngine::PEAppState state) = 0;

        virtual void ActivateApp(bool bActivate) = 0;

        virtual bool IsAppActive() = 0;

        virtual DWORD GetCoreUsage() = 0;

        virtual void SetCoreUsage(DWORD dwUsage) = 0;

        virtual void SetMinUIResolution(int nWidth, int nHeight, bool bAutoUIScaling = true) = 0;

        virtual void Exit(int nReturnCode = 0) = 0;

        virtual void SetReturnCode(int nReturnCode) = 0;
        virtual int GetReturnCode() = 0;

        virtual NPL::INPLRuntime* GetNPLRuntime() = 0;

        virtual bool IsTouchInputting() = 0;

        virtual bool IsSlateMode() = 0;

        virtual int32 GetTouchPointX() = 0;
        virtual int32 GetTouchPointY() = 0;

        virtual void WriteToLog(const char* sFormat, ...) = 0;

        virtual void AppLog(const char* sMessage) { WriteToLog(sMessage); };

        virtual void SetTouchInputting(bool bTouchInputting){};

        virtual void SystemMessageBox(const std::string& msg) {};

        virtual void SetAppCommandLine(const char* pCommandLine) {};

        virtual const char* GetAppCommandLineByParam(const char* pParam, const char* defaultValue){ return NULL; };

        virtual const char* GetAppCommandLine() { return NULL; };


        virtual void GetScreenResolution(Vector2* pOut){ };

        virtual void SetScreenResolution(const Vector2& vSize){};

        virtual float GetFPS() { return 30.f; };

        virtual CRefCounted* AddToSingletonReleasePool(CRefCounted* pObject) { return pObject; };

        virtual bool IsServerMode() { return true; };
        

        virtual bool HasClosingRequest() { return false; };
        virtual void SetHasClosingRequest(bool val) {};

        virtual bool LoadNPLPackage(const char* sFilePath, std::string * pOutMainFile = NULL) { return false; };

        virtual bool ForceRender() { return false; };

        virtual const char* GetModuleDir() { return NULL; };

        /* whether the window size is fixed. */
        virtual void FixWindowSize(bool fixed) = 0;
    };

}