Material.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

/*
 * Copyright (C) 2006-2010 - Frictional Games
 *
 * This file is part of HPL1 Engine.
 */

#ifndef HPL_MATERIAL_H
#define HPL_MATERIAL_H

#include "common/array.h"
#include "common/list.h"
#include "hpl1/engine/graphics/GPUProgram.h"
#include "hpl1/engine/graphics/LowLevelGraphics.h"
#include "hpl1/engine/graphics/Texture.h"
#include "hpl1/engine/resources/ResourceBase.h"
#include "hpl1/engine/resources/ResourceImage.h"
#include "hpl1/engine/system/SystemTypes.h"

class TiXmlElement;

namespace hpl {

#define kMaxProgramNum (5)

enum eMaterialQuality {
    eMaterialQuality_VeryLow = 0,
    eMaterialQuality_Low = 1,
    eMaterialQuality_Medium = 2,
    eMaterialQuality_High = 3,
    eMaterialQuality_VeryHigh = 4,
    eMaterialQuality_LastEnum = 5
};

enum eMaterialTexture {
    eMaterialTexture_Diffuse,
    eMaterialTexture_NMap,
    eMaterialTexture_Specular,
    eMaterialTexture_Alpha,
    eMaterialTexture_Illumination,
    eMaterialTexture_CubeMap,
    eMaterialTexture_Refraction,
    eMaterialTexture_LastEnum
};

enum eMaterialType {
    eMaterialType_Null,

    eMaterialType_Diffuse,
    eMaterialType_DiffuseAlpha,
    eMaterialType_DiffuseAdditive,
    eMaterialType_DiffuseNMap,
    eMaterialType_DiffuseSpecular,
    eMaterialType_BumpSpec,
    eMaterialType_Smoke,

    eMaterialType_FontNormal,

    eMaterialType_LastEnum
};

enum eMaterialPicture {
    eMaterialPicture_Image,
    eMaterialPicture_Texture,
    eMaterialPicture_LastEnum
};

enum eMaterialRenderType {
    eMaterialRenderType_Z,
    eMaterialRenderType_Light,
    eMaterialRenderType_Diffuse,
    eMaterialRenderType_LastEnum
};

enum eMaterialBlendMode {
    eMaterialBlendMode_None,
    eMaterialBlendMode_Add,
    eMaterialBlendMode_Mul,
    eMaterialBlendMode_MulX2,
    eMaterialBlendMode_Replace,
    eMaterialBlendMode_Alpha,
    eMaterialBlendMode_DestAlphaAdd,
    eMaterialBlendMode_LastEnum
};

enum eMaterialAlphaMode {
    eMaterialAlphaMode_Solid,
    eMaterialAlphaMode_Trans,
    eMaterialAlphaMode_LastEnum,
};

enum eMaterialChannelMode {
    eMaterialChannelMode_RGBA,
    eMaterialChannelMode_RGB,
    eMaterialChannelMode_A,
    eMaterialChannelMode_Z,
    eMaterialChannelMode_LastEnum,
};

//---------------------------------------------------

class cRenderer2D;
class cRenderer3D;
class cRenderSettings;
class cTextureManager;
class cImageManager;
class cGpuProgramManager;
class iLight;
class iCamera;
class iLight3D;

//---------------------------------------------------

class iGLStateProgram : public iGpuProgram {
public:
    iGLStateProgram(tString asName)
        : iGpuProgram(asName) {
        mbSetUpDone = false;
    }
    virtual ~iGLStateProgram() {}

    void SetUp(iLowLevelGraphics *apLowLevelGraphics) {
        if (mbSetUpDone == false) {
            mpLowGfx = apLowLevelGraphics;
            mbSetUpDone = true;
            InitData();
        }
    }

    virtual void Bind() = 0;
    virtual void UnBind() = 0;

    bool CreateFromFile(const tString &asFile, const tString &asEntry) { return false; }
    bool SetFloat(const tString &asName, float afX) { return false; }

    bool SetVec2f(const tString &asName, float afX, float afY) { return false; }
    bool SetVec3f(const tString &asName, float afX, float afY, float afZ) { return false; }
    bool SetVec4f(const tString &asName, float afX, float afY, float afZ, float afW) { return false; }
    bool SetMatrixf(const tString &asName, const cMatrixf &mMtx) { return false; }
    bool SetMatrixf(const tString &asName, eGpuProgramMatrix mType, eGpuProgramMatrixOp mOp) { return false; }
    bool SetTexture(const tString &asName, iTexture *apTexture, bool abAutoDisable = true) { return false; }
    bool SetTextureToUnit(int alUnit, iTexture *apTexture) { return false; }

    eGpuProgramType GetType() { return eGpuProgramType_LastEnum; }

    bool reload() { return false; }
    void unload() {}
    void destroy() {}

protected:
    iLowLevelGraphics *mpLowGfx;

    bool mbSetUpDone;

    virtual void InitData() = 0;
};

//---------------------------------------------------------------

class iMaterialProgramSetup {
public:
    virtual ~iMaterialProgramSetup() = default;
    virtual void Setup(iGpuProgram *apProgram, cRenderSettings *apRenderSettings) = 0;
    virtual void SetupMatrix(cMatrixf *apModelMatrix, cRenderSettings *apRenderSettings) {}
};

//---------------------------------------------------

class cTextureType {
public:
    cTextureType(tString asSuffix, eMaterialTexture aType) : msSuffix(asSuffix), mType(aType) {}

    tString msSuffix;
    eMaterialTexture mType;
};

typedef Common::List<cTextureType> tTextureTypeList;
typedef tTextureTypeList::iterator tTextureTypeListIt;

//---------------------------------------------------

class iMaterial : public iResourceBase {
public:
    iMaterial(const tString &asName, iLowLevelGraphics *apLowLevelGraphics,
              cImageManager *apImageManager, cTextureManager *apTextureManager,
              cRenderer2D *apRenderer, cGpuProgramManager *apProgramManager,
              eMaterialPicture aPicture, cRenderer3D *apRenderer3D);
    virtual ~iMaterial();

    // resources stuff.
    bool reload() { return false; }
    void unload() {}
    void destroy() {}

    virtual void Compile() = 0;

    virtual void Update(float afTimeStep) {}

    // The new render system stuff
    virtual iGpuProgram *getGpuProgram(const eMaterialRenderType aType, const int alPass, iLight3D *apLight) { return nullptr; }
    virtual iMaterialProgramSetup *getGpuProgramSetup(const eMaterialRenderType aType, const int alPass, iLight3D *apLight) { return nullptr; };

    virtual iGpuProgram *GetVertexProgram(eMaterialRenderType aType, int alPass, iLight3D *apLight) { return NULL; }
    virtual bool VertexProgramUsesLight(eMaterialRenderType aType, int alPass, iLight3D *apLight) { return false; }
    virtual bool VertexProgramUsesEye(eMaterialRenderType aType, int alPass, iLight3D *apLight) { return false; }
    virtual iMaterialProgramSetup *GetVertexProgramSetup(eMaterialRenderType aType, int alPass, iLight3D *apLight) { return NULL; }

    virtual iGpuProgram *GetFragmentProgram(eMaterialRenderType aType, int alPass, iLight3D *apLight) { return NULL; }
    virtual iMaterialProgramSetup *GetFragmentProgramSetup(eMaterialRenderType aType, int alPass, iLight3D *apLight) { return NULL; }

    virtual eMaterialAlphaMode GetAlphaMode(eMaterialRenderType aType, int alPass, iLight3D *apLight) { return eMaterialAlphaMode_Solid; }
    virtual eMaterialBlendMode GetBlendMode(eMaterialRenderType aType, int alPass, iLight3D *apLight) { return eMaterialBlendMode_Replace; }
    virtual eMaterialChannelMode GetChannelMode(eMaterialRenderType aType, int alPass, iLight3D *apLight) { return eMaterialChannelMode_RGBA; }

    virtual iTexture *GetTexture(int alUnit, eMaterialRenderType aType, int alPass, iLight3D *apLight) { return NULL; }
    virtual eMaterialBlendMode GetTextureBlend(int alUnit, eMaterialRenderType aType, int alPass, iLight3D *apLight) { return eMaterialBlendMode_None; }

    virtual int GetNumOfPasses(eMaterialRenderType aType, iLight3D *apLight) { return 0; }

    virtual bool UsesType(eMaterialRenderType aType) { return false; }

    bool HasAlpha() { return mbHasAlpha; }
    void SetHasAlpha(bool abX) { mbHasAlpha = abX; }

    bool GetDepthTest() { return mbDepthTest; }
    void SetDepthTest(bool abX) { mbDepthTest = abX; }

    float GetValue() { return mfValue; }
    void SetValue(float afX) { mfValue = afX; }

    virtual bool LoadData(TiXmlElement *apRootElem) { return true; }

    virtual bool StartRendering(eMaterialRenderType aType, iCamera *apCam, iLight *pLight) = 0;
    virtual void EndRendering(eMaterialRenderType mType) = 0;
    virtual tVtxBatchFlag GetBatchFlags(eMaterialRenderType mType) = 0;

    virtual bool NextPass(eMaterialRenderType mType) = 0;
    virtual bool HasMultiplePasses(eMaterialRenderType mType) = 0;

    virtual eMaterialType GetType(eMaterialRenderType mType) = 0;
    virtual void EditVertexes(eMaterialRenderType mType, iCamera *apCam, iLight *pLight,
                              tVertexVec *apVtxVec, cVector3f *apTransform, unsigned int alIndexAdd) = 0;

    iTexture *GetTexture(eMaterialTexture aType);
    cRect2f GetTextureOffset(eMaterialTexture aType);

    void SetTexture(iTexture *apTex, eMaterialTexture aType) { mvTexture[aType] = apTex; }
    void SetImage(cResourceImage *apImg, eMaterialTexture aType) {
        mvImage[aType] = apImg;
    }
    cResourceImage *GetImage(eMaterialTexture aType) { return mvImage[aType]; }

    void SetProgram(iGpuProgram *apProgram, eGpuProgramType aType, unsigned int alNum) {
        mpProgram[aType][alNum] = apProgram;
    }
    iGpuProgram *GetProgram(eGpuProgramType aType, unsigned int alNum) {
        return mpProgram[aType][alNum];
    }

    virtual bool IsTransperant() { return mbIsTransperant; }
    virtual bool IsGlowing() { return mbIsGlowing; }
    virtual bool UsesLights() { return mbUsesLights; }

    virtual tTextureTypeList GetTextureTypes() {
        tTextureTypeList vTypes;
        vTypes.push_back(cTextureType("", eMaterialTexture_Diffuse));
        return vTypes;
    }

    void SetId(int alId) { mlId = alId; }
    int GetId() { return mlId; }

    virtual iGpuProgram *getRefractionProgram() { return nullptr; }

    virtual bool GetRefractionUsesDiffuse() { return false; }
    virtual eMaterialTexture GetRefractionDiffuseTexture() { return eMaterialTexture_Diffuse; }

    virtual bool GetRefractionUsesEye() { return false; }
    virtual bool GetRefractionUsesTime() { return false; }
    virtual bool GetRefractionSkipsStandardTrans() { return false; }

    const tString &GetPhysicsMaterial() { return msPhysicsMaterial; }
    void SetPhysicsMaterial(const tString &asName) { msPhysicsMaterial = asName; }

    static void SetQuality(eMaterialQuality aQuality) { mQuality = aQuality; }
    static eMaterialQuality GetQuality() { return mQuality; }

protected:
    iLowLevelGraphics *mpLowLevelGraphics;
    cImageManager *mpImageManager;
    cTextureManager *mpTextureManager;
    cRenderer2D *mpRenderer;
    cRenderer3D *mpRenderer3D;
    cRenderSettings *mpRenderSettings;
    cGpuProgramManager *mpProgramManager;

    static eMaterialQuality mQuality;

    bool mbIsTransperant;
    bool mbIsGlowing;
    bool mbUsesLights;
    bool mbHasAlpha;
    bool mbDepthTest;
    float mfValue;

    int mlId;

    tString msPhysicsMaterial;

    tTextureVec mvTexture;
    tResourceImageVec mvImage;

    eMaterialType mType;
    eMaterialPicture mPicture;

    iGpuProgram *mpProgram[2][kMaxProgramNum];

    int mlPassCount;

    // void Destroy();
};

typedef Common::Array<iMaterial *> tMaterialVec;
typedef tMaterialVec::iterator tMaterialVecIt;

class iMaterialType {
public:
    virtual ~iMaterialType() = default;
    virtual bool IsCorrect(tString asName) = 0;
    virtual iMaterial *Create(const tString &asName, iLowLevelGraphics *apLowLevelGraphics,
                              cImageManager *apImageManager, cTextureManager *apTextureManager,
                              cRenderer2D *apRenderer, cGpuProgramManager *apProgramManager,
                              eMaterialPicture aPicture, cRenderer3D *apRenderer3D) = 0;
};

typedef Common::List<iMaterialType *> tMaterialTypeList;
typedef tMaterialTypeList::iterator tMaterialTypeListIt;

} // namespace hpl

#endif // HPL_MATERIAL_H