GameCodingCompleteLinux/Source/GCC4/GameCode4/interfaces.h

#pragma once
//========================================================================
// Interfaces.h : Defines interface classes defined throughout the book
//
// Part of the GameCode4 Application
//
// GameCode4 is the sample application that encapsulates much of the source code
// discussed in "Game Coding Complete - 4th Edition" by Mike McShaffry and David
// "Rez" Graham, published by Charles River Media. 
// ISBN-10: 1133776574 | ISBN-13: 978-1133776574
//
// If this source code has found it's way to you, and you think it has helped you
// in any way, do the authors a favor and buy a new copy of the book - there are 
// detailed explanations in it that compliment this code well. Buy a copy at Amazon.com
// by clicking here: 
//    http://www.amazon.com/gp/product/1133776574/ref=olp_product_details?ie=UTF8&me=&seller=
//
// There's a companion web site at http://www.mcshaffry.com/GameCode/
// 
// The source code is managed and maintained through Google Code: 
//    http://code.google.com/p/gamecode4/
//
// (c) Copyright 2012 Michael L. McShaffry and David Graham
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser GPL v3
// as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See 
// http://www.gnu.org/licenses/lgpl-3.0.txt for more details.
//
// You should have received a copy of the GNU Lesser GPL v3
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
//========================================================================

#include "../Graphics3D/Geometry.h"
#include "../Utilities/types.h"

#include <memory>
#include <list>
#include <optional>
#include <SDL3/SDL.h>

class Actor;
class ActorComponent;

typedef unsigned int ActorId;
typedef unsigned int ComponentId;

const ActorId INVALID_ACTOR_ID = 0;
const ComponentId INVALID_COMPONENT_ID = 0;

typedef std::shared_ptr<Actor> StrongActorPtr;
typedef std::weak_ptr<Actor> WeakActorPtr;
typedef std::shared_ptr<ActorComponent> StrongActorComponentPtr;
typedef std::weak_ptr<ActorComponent> WeakActorComponentPtr;

template<class T>
struct SortBy_SharedPtr_Content
{
    bool operator()(const std::shared_ptr<T> &lhs, const std::shared_ptr<T> &rhs) const
        { return *lhs < *rhs; }
};

//
// class IScreenElement							- Chapter 10, page 285
//
class IScreenElement
{
public:
	virtual int VOnRestore() = 0;
	// virtual int VOnLostDevice() = 0;
	virtual int VOnRender(double fTime, float fElapsedTime) = 0;
	virtual void VOnUpdate(int deltaMilliseconds) = 0;

	virtual int VGetZOrder() const = 0;
	virtual void VSetZOrder(int const zOrder) = 0;
	virtual bool VIsVisible() const = 0;
	virtual void VSetVisible(bool visible) = 0;

	virtual int VOnMsgProc( SDL_Event &e )=0;

	virtual ~IScreenElement() { };
	virtual bool const operator <(IScreenElement const &other) { return VGetZOrder() < other.VGetZOrder(); }
};

class IGamePhysics;

class IGameLogic
{
public:
	// virtual WeakActorPtr VGetActor(const ActorId id)=0;
	// virtual StrongActorPtr VCreateActor(const std::string &actorResource, TiXmlElement *overrides, const glm::mat4 *initialTransform=NULL, const ActorId serversActorId=INVALID_ACTOR_ID)=0;
	// virtual void VDestroyActor(const ActorId actorId)=0;
	virtual bool VLoadGame(const char* levelResource)=0;
	virtual void VSetProxy()=0;				
	virtual void VOnUpdate(float time, float elapsedTime)=0;
	// virtual void VChangeState(enum BaseGameState newState)=0;
	// virtual void VMoveActor(const ActorId id, glm::mat4 const &mat)=0;
	// virtual shared_ptr<IGamePhysics> VGetGamePhysics(void) = 0;
};

enum GameViewType
{
	GameView_Human,
	GameView_Remote,
	GameView_AI,
	GameView_Recorder,
	GameView_Other
};

typedef unsigned int GameViewId;
extern const GameViewId gc_InvalidGameViewId;

class IGameView 
{
public:
	virtual int VOnRestore()=0;
	virtual void VOnRender(double fTime, float fElapsedTime)=0;
	// virtual HRESULT VOnLostDevice()=0;
	virtual GameViewType VGetType()=0;
	virtual GameViewId VGetId() const=0;
	virtual void VOnAttach(GameViewId vid, ActorId aid)=0;

	virtual int VOnMsgProc( SDL_Event &e )=0;
	virtual void VOnUpdate(unsigned long deltaMs)=0;

	virtual ~IGameView() { };
};

typedef std::list<std::shared_ptr<IScreenElement> > ScreenElementList;
typedef std::list<std::shared_ptr<IGameView>> GameViewList;


////////////////////////////////////////////////////
//
// IKeyboardHandler Description		- Chapter 9, page 242
// IPointerHandler Description		- Chapter 9, page 242
// IJoystickHandler Description		- Chapter 9, page 242
// IGamepadHandler Description		- Chapter 9, page 242
//
// These are the public APIs for any object that implements reactions
// to events sent by hardware user interface devices.
//
// Note: IJoystickHandler and IGamepadHandler are not currently
//       implemented anywhere in the codebase. They are here
//       as examples, and could require modification to actually work!
//
////////////////////////////////////////////////////

class IKeyboardHandler
{
public:
	virtual bool VOnKeyDown(const unsigned char c) = 0;
	virtual bool VOnKeyUp(const unsigned char c) = 0;
};

class IPointerHandler
{
public:
	virtual bool VOnPointerMove(const Point &pos, const int radius) = 0;
	virtual bool VOnPointerButtonDown(const Point &pos, const int radius, const std::string &buttonName) = 0;
	virtual bool VOnPointerButtonUp(const Point &pos, const int radius, const std::string &buttonName) = 0;
};

class IJoystickHandler
{
	virtual bool VOnButtonDown(const std::string &buttonName, int const pressure) = 0;
	virtual bool VOnButtonUp(const std::string &buttonName) = 0;
	virtual bool VOnJoystick(float const x, float const y) = 0;
};

class IGamepadHandler
{
	virtual bool VOnTrigger(const std::string &triggerName, float const pressure)=0;
	virtual bool VOnButtonDown(const std::string &buttonName, int const pressure)=0;
	virtual bool VOnButtonUp(const std::string &buttonName)=0;
	virtual bool VOnDirectionalPad(const std::string &direction)=0;
	virtual bool VOnThumbstick(const std::string &stickName, float const x, float const y)=0;
};

////////////////////////////////////////////////////
//
// class IResourceFile						- Chapter 8, page 222
// The core of a resource cache system
// 
////////////////////////////////////////////////////

class Resource;
class IResourceFile;
class ResHandle;

//
// class IResourceLoader					- Chapter 8, page 224
//
class IResourceLoader
{
public:
	virtual std::string VGetPattern()=0;
	virtual bool VUseRawFile()=0;
	virtual bool VDiscardRawBufferAfterLoad()=0;
	virtual bool VAddNullZero() { return false; }
	virtual unsigned int VGetLoadedResourceSize(char *rawBuffer, unsigned int rawSize)=0;
	virtual bool VLoadResource(char *rawBuffer, unsigned int rawSize, std::shared_ptr<ResHandle> handle)=0;
};

class IResourceFile
{
public:
	virtual bool VOpen()=0;
	virtual int VGetRawResourceSize(const Resource &r)=0;
	virtual int VGetRawResource(const Resource &r, char *buffer)=0;
	virtual int VGetNumResources() const = 0;
	virtual std::string VGetResourceName(int num) const = 0;
	virtual bool VIsUsingDevelopmentDirectories(void) const = 0;
	virtual ~IResourceFile() { }
};




/////////////////////////////////////////////////////////////////////////////
// enum RenderPass							- Chapter 16, page 529
//
//   3D scenes are drawn in passes - this enum defines the render passes
//   supported by the 3D scene graph created by class Scene.
/////////////////////////////////////////////////////////////////////////////

enum RenderPass
{
	RenderPass_0,
	RenderPass_Static = RenderPass_0,
	RenderPass_Actor,
	RenderPass_Sky,
	RenderPass_NotRendered,
	RenderPass_Last
};




class Scene;
class SceneNodeProperties;
// class RayCast;
class LightNode;

typedef std::list<std::shared_ptr<LightNode> > Lights;


class IRenderState
{
public:
	virtual std::string VToString()=0;
};

//
// class IRenderer				- not described in the 4th edition
//
// class IRenderer abstracts the renderer implementation so the engine
//   can use D3D9 or D3D11.
//
class IRenderer
{
public:
	virtual void VSetBackgroundColor(unsigned char bgA, unsigned char bgR, unsigned char bgG, unsigned char bgB)=0; 
	virtual int VOnRestore()=0;
	virtual void VShutdown()=0;
	virtual bool VPreRender()=0;
	virtual bool VPostRender()=0;
	virtual void VCalcLighting(Lights *lights, int maximumLights)=0;
	virtual void VSetWorldTransform(const glm::mat4 m)=0;
	virtual void VSetViewTransform(const glm::mat4 m)=0;
	virtual void VSetProjectionTransform(const glm::mat4 m)=0;
	virtual std::shared_ptr<IRenderState> VPrepareAlphaPass()=0;
	virtual std::shared_ptr<IRenderState> VPrepareSkyBoxPass()=0;
	// virtual void VDrawLine(const Vec3& from,const Vec3& to,const Color& color)=0;
};

/////////////////////////////////////////////////////////////////////////////
// class ISceneNode					- Chapter 16, page 524
//
//   This is the public interface for nodes in a 3D scene graph.
/////////////////////////////////////////////////////////////////////////////

class ISceneNode
{
public:
	virtual const SceneNodeProperties * const VGet() const=0;

	virtual void VSetTransform(const glm::mat4 toWorld, std::optional<const glm::mat4> fromWorld=std::nullopt)=0;

	virtual int VOnUpdate(Scene *pScene, uint64_t const elapsedMs)=0;
	virtual int VOnRestore(Scene *pScene)=0;

	virtual int VPreRender(Scene *pScene)=0;
	virtual bool VIsVisible(Scene *pScene) const=0;
	virtual int VRender(Scene *pScene)=0;
	virtual int VRenderChildren(Scene *pScene)=0;
	virtual int VPostRender(Scene *pScene)=0;

	virtual bool VAddChild(std::shared_ptr<ISceneNode> kid)=0;
	virtual bool VRemoveChild(ActorId id)=0;
	// virtual HRESULT VOnLostDevice(Scene *pScene)=0;
	// virtual HRESULT VPick(Scene *pScene, RayCast *pRayCast)=0;


	virtual ~ISceneNode() { };
};

/////////////////////////////////////////////////////////////////////////////
// IScriptManager Description
//
//   This is the public interface for the scripting system.
/////////////////////////////////////////////////////////////////////////////
class IScriptManager
{
public:
    virtual ~IScriptManager(void) {}
    virtual bool VInit(void) = 0;
    virtual void VExecuteFile(const char* resource) = 0;
    virtual void VExecuteString(const char* str) = 0;
};