Material.h

/*
  COPYRIGHT (c) 2012-2024 Esri R&D Center Zurich
  TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
  Unpublished material - all rights reserved under the
  Copyright Laws of the United States and applicable international
  laws, treaties, and conventions.

  For additional information, contact:
  Environmental Systems Research Institute, Inc.
  Attn: Contracts and Legal Services Department
  380 New York Street
  Redlands, California, 92373
  USA

  email: contracts@esri.com
*/

#ifndef PRTX_MATERIAL_H_
#define PRTX_MATERIAL_H_

#include "prtx/prtx.h"
#include "prtx/Types.h"
#include "prtx/Attributable.h"
#include "prtx/Builder.h"
#include "prtx/Content.h"
#include "prtx/Shader.h"
#include "prtx/Texture.h"
#include "prtx/generated/BuiltinMaterialAttributes.h"

#include <vector>
#include <memory>

#ifdef _MSC_VER
#   pragma warning(push)
#   pragma warning(disable : 4275)
#endif


class MaterialImpl;


namespace prtx {


class Material;
typedef std::shared_ptr<Material> MaterialPtr;          
typedef std::vector<MaterialPtr>  MaterialPtrVector;        

class PRTX_EXPORTS_API Material : public Attributable, public ComparableContent, public BuiltinMaterialAttributes {
public:
    static constexpr PrimitiveType PT_TEXTURE       = PT_BLIND_DATA_ARRAY + 1;
    static constexpr PrimitiveType PT_TEXTURE_ARRAY = PT_TEXTURE + 1;
    static constexpr PrimitiveType PT_COUNT         = prtx::Attributable::PT_COUNT + 2;

    virtual ~Material();

    virtual const WStringVector&    getKeys()                                       const = 0;
    virtual bool                    hasKey              (const std::wstring& key)   const = 0;
    virtual PrimitiveType           getType             (const std::wstring& key)   const = 0;
    virtual Bool                    getBool             (const std::wstring& key)   const = 0;
    virtual int32_t                 getInt              (const std::wstring& key)   const = 0;
    virtual double                  getFloat            (const std::wstring& key)   const = 0;
    virtual const std::wstring&     getString           (const std::wstring& key)   const = 0;
    virtual const BoolVector&       getBoolArray        (const std::wstring& key)   const = 0;
    virtual const Int32Vector&      getIntArray         (const std::wstring& key)   const = 0;
    virtual const DoubleVector&     getFloatArray       (const std::wstring& key)   const = 0;
    virtual const WStringVector&    getStringArray      (const std::wstring& key)   const = 0;
    virtual void*                   getBlindData        (const std::wstring& key)   const = 0;
    virtual ShaderPtr getShader() const = 0;

    virtual TexturePtr getTexture(const std::wstring& key) const = 0;

    virtual const TexturePtrVector& getTextureArray(const std::wstring& key) const = 0;

    virtual TexturePtr getTextureArrayItem(const std::wstring& key, size_t index) const = 0;

    virtual const WStringVector& getBlindDataKeys() const = 0;


    static std::pair<std::wstring, size_t> getShaderTextureArrayKeyAndIndexFromCGAMapName(const std::wstring& cgaMapName);

protected:
    // @cond
    Material();
    // @endcond
};


class MaterialBuilder;
typedef std::shared_ptr<MaterialBuilder> MaterialBuilderPtr;

class PRTX_EXPORTS_API MaterialBuilder : public SharedPtrBuilder<Material>, public AttributableSetter, public BuiltinMaterialAttributesBuilder {
public:
    MaterialBuilder();

    MaterialBuilder(const ShaderPtr& shader);

    MaterialBuilder(const MaterialPtr& material);

    virtual ~MaterialBuilder();

    // SharedPtrBuilder interface implementation
    virtual MaterialPtr createSharedAndReset(std::wstring* warnings = 0);
    virtual MaterialPtr createShared(std::wstring* warnings = 0) const;


    virtual void setBool        (const std::wstring& key, Bool                  val);
    virtual void setInt         (const std::wstring& key, int32_t               val);
    virtual void setFloat       (const std::wstring& key, double                val);
    virtual void setString      (const std::wstring& key, const std::wstring&   val);
    virtual void setBoolArray   (const std::wstring& key, const BoolVector&     val);
    virtual void setIntArray    (const std::wstring& key, const Int32Vector&    val);
    virtual void setFloatArray  (const std::wstring& key, const DoubleVector&   val);
    virtual void setStringArray (const std::wstring& key, const WStringVector&  val);
    virtual void setBlindData   (const std::wstring& key, void*                 val);
    virtual void setTexture(const std::wstring& key, const TexturePtr& val, const std::wstring& resolveMapKey);

    virtual void setTextureArray(const std::wstring& key, const TexturePtrVector& val, const WStringVector& resolveMapKeys);

    virtual void setTextureArrayItem(const std::wstring& key, size_t index, const TexturePtr& val, const std::wstring& resolveMapKey);

private:
    #include "prtx/generated/BuiltinMaterialAttributesBuilder_impl_decl.h"

private:
    MaterialImpl* mMaterial;
};


} // namespace prtx


#ifdef _MSC_VER
#   pragma warning(pop)
#endif


#endif /* PRTX_MATERIAL_H_ */