axmol/core/3d/CCSprite3DMaterial.h

/****************************************************************************
 Copyright (c) 2014-2016 Chukong Technologies Inc.
 Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.

 https://adxeproject.github.io/

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ****************************************************************************/
#pragma once

#include <string>
#include <unordered_map>
#include "base/ccTypes.h"
#include "renderer/CCMaterial.h"
#include "3d/CCBundle3DData.h"
#include "renderer/backend/Types.h"

NS_CC_BEGIN

/**
 * @addtogroup _3d
 * @{
 */

class Texture2D;

namespace backend
{
class ProgramState;
}

/**
 * @brief Sprite3DMaterial: Material for Sprite3D.
 */
class CC_DLL Sprite3DMaterial : public Material
{
public:
    /**
     * Material type, there are mainly two types of materials. Built in materials and Custom material
     */
    enum class MaterialType
    {
        // Built in material
        UNLIT,           // unlit material
        UNLIT_NOTEX,     // unlit material without texture
        VERTEX_LIT,      // vertex lit
        DIFFUSE,         // diffuse (pixel lighting)
        DIFFUSE_NOTEX,   // diffuse (without texture)
        BUMPED_DIFFUSE,  // bumped diffuse
        QUAD_TEXTURE,    // textured quad material
        QUAD_COLOR,      // colored quad material (without texture)

        // Custom material
        CUSTOM,  // Create from material file
    };

    /**
     * Get material type
     * @return Material type
     */
    MaterialType getMaterialType() const { return _type; }

    /**
     * Create built in material from material type
     * @param type Material type
     * @param skinned Has skin?
     * @return Created material
     */
    static Sprite3DMaterial* createBuiltInMaterial(MaterialType type, bool skinned);

    /**
     * Create material with file name, it creates material from cache if it is previously loaded
     * @param path Path of material file
     * @return Created material
     */
    static Sprite3DMaterial* createWithFilename(std::string_view path);

    /**
     * Create material with GLProgramState
     * @param programState GLProgramState instance
     * @return Created material
     */
    //    static Sprite3DMaterial* createWithGLStateProgram(GLProgramState* programState);
    static Sprite3DMaterial* createWithProgramState(backend::ProgramState* programState);

    void setTexture(Texture2D* tex, NTextureData::Usage usage);

    /**
     * Create all build in materials
     */
    static void createBuiltInMaterial();

    /**
     * Release all built in materials
     */
    static void releaseBuiltInMaterial();

    /**
     * Release all cached materials
     */
    static void releaseCachedMaterial();

    /**
     * Clone material
     */
    virtual Material* clone() const override;

protected:
    MaterialType _type;
    static std::unordered_map<std::string, Sprite3DMaterial*> _materials;  // cached material
    static Sprite3DMaterial* _unLitMaterial;
    static Sprite3DMaterial* _unLitNoTexMaterial;
    static Sprite3DMaterial* _vertexLitMaterial;
    static Sprite3DMaterial* _diffuseMaterial;
    static Sprite3DMaterial* _diffuseNoTexMaterial;
    static Sprite3DMaterial* _bumpedDiffuseMaterial;

    static Sprite3DMaterial* _unLitMaterialSkin;
    static Sprite3DMaterial* _vertexLitMaterialSkin;
    static Sprite3DMaterial* _diffuseMaterialSkin;
    static Sprite3DMaterial* _bumpedDiffuseMaterialSkin;

    static Sprite3DMaterial* _quadTextureMaterial;
    static Sprite3DMaterial* _quadColorMaterial;

    static backend::ProgramState* _unLitMaterialProgState;
    static backend::ProgramState* _unLitNoTexMaterialProgState;
    static backend::ProgramState* _vertexLitMaterialProgState;
    static backend::ProgramState* _diffuseMaterialProgState;
    static backend::ProgramState* _diffuseNoTexMaterialProgState;
    static backend::ProgramState* _bumpedDiffuseMaterialProgState;

    static backend::ProgramState* _unLitMaterialSkinProgState;
    static backend::ProgramState* _vertexLitMaterialSkinProgState;
    static backend::ProgramState* _diffuseMaterialSkinProgState;
    static backend::ProgramState* _bumpedDiffuseMaterialSkinProgState;

    static backend::ProgramState* _quadTextureMaterialProgState;
    static backend::ProgramState* _quadColorMaterialProgState;
};

/**
 * @brief the sprite3D material is only texture for now
 * @js NA
 * @lua NA
 */
class Sprite3DMaterialCache
{
public:
    /**get & destroy cache*/
    static Sprite3DMaterialCache* getInstance();

    /**destroy the instance*/
    static void destroyInstance();

    /**add to cache*/
    bool addSprite3DMaterial(std::string_view key, Texture2D* tex);

    /**get material from cache*/
    Texture2D* getSprite3DMaterial(std::string_view key);

    /**remove all spritematerial*/
    void removeAllSprite3DMaterial();
    /**remove unused spritematerial*/
    void removeUnusedSprite3DMaterial();

    Sprite3DMaterialCache();
    ~Sprite3DMaterialCache();

protected:
    static Sprite3DMaterialCache* _cacheInstance;  // instance
    hlookup::string_map<Texture2D*> _materials;    // cached material
};

// end of 3d group
/// @}

NS_CC_END