TypeDesc.h

Go to the documentation of this file.

//
// Copyright Contributors to the MaterialX Project
// SPDX-License-Identifier: Apache-2.0
//
 
#ifndef MATERIALX_TYPEDESC_H
#define MATERIALX_TYPEDESC_H

 
#include <MaterialXGenShader/Export.h>
#include <MaterialXCore/Value.h>
 
#include <string_view>
 
MATERIALX_NAMESPACE_BEGIN

class MX_GENSHADER_API TypeDesc
{
  public:
    enum BaseType
    {
        BASETYPE_NONE,
        BASETYPE_BOOLEAN,
        BASETYPE_INTEGER,
        BASETYPE_FLOAT,
        BASETYPE_STRING,
        BASETYPE_STRUCT,
        BASETYPE_LAST
    };
 
    enum Semantic
    {
        SEMANTIC_NONE,
        SEMANTIC_COLOR,
        SEMANTIC_VECTOR,
        SEMANTIC_MATRIX,
        SEMANTIC_FILENAME,
        SEMANTIC_CLOSURE,
        SEMANTIC_SHADER,
        SEMANTIC_MATERIAL,
        SEMANTIC_ENUM,
        SEMANTIC_LAST
    };

    constexpr TypeDesc() noexcept :
        _id(0),
        _basetype(BASETYPE_NONE),
        _semantic(SEMANTIC_NONE),
        _size(0),
        _structIndex(0)
    {
    }

    constexpr TypeDesc(std::string_view name, uint8_t basetype, uint8_t semantic = SEMANTIC_NONE, uint16_t size = 1, uint16_t structIndex = 0) noexcept :
        _id(constexpr_hash(name)), // Note: We only store the hash to keep the class size minimal.
        _basetype(basetype),
        _semantic(semantic),
        _size(size),
        _structIndex(structIndex)
    {
    }

    uint32_t typeId() const { return _id; }

    const string& getName() const;

    unsigned char getBaseType() const { return _basetype; }

    unsigned char getSemantic() const { return _semantic; }

    size_t getSize() const { return _size; }

    bool isScalar() const { return _size == 1; }

    bool isAggregate() const { return _size > 1; }

    bool isArray() const { return _size == 0; }

    bool isFloat2() const { return _size == 2 && (_semantic == SEMANTIC_COLOR || _semantic == SEMANTIC_VECTOR); }

    bool isFloat3() const { return _size == 3 && (_semantic == SEMANTIC_COLOR || _semantic == SEMANTIC_VECTOR); }

    bool isFloat4() const { return _size == 4 && (_semantic == SEMANTIC_COLOR || _semantic == SEMANTIC_VECTOR); }

    bool isClosure() const { return (_semantic == SEMANTIC_CLOSURE || _semantic == SEMANTIC_SHADER || _semantic == SEMANTIC_MATERIAL); }

    bool isStruct() const { return _basetype == BASETYPE_STRUCT; }

    uint16_t getStructIndex() const { return _structIndex; }

    bool operator==(TypeDesc rhs) const
    {
        return _id == rhs._id;
    }

    bool operator!=(TypeDesc rhs) const
    {
        return _id != rhs._id;
    }

    bool operator<(TypeDesc rhs) const
    {
        return _id < rhs._id;
    }

    struct Hasher
    {
        size_t operator()(const TypeDesc& t) const
        {
            return t._id;
        }
    };

    static TypeDesc get(const string& name);

    static void remove(const string& name);
 
    static const string NONE_TYPE_NAME;

    ValuePtr createValueFromStrings(const string& value) const;
 
  private:
    constexpr uint32_t constexpr_hash(std::string_view str, uint32_t n = 0, uint32_t h = 2166136261)
    {
        return n == uint32_t(str.size()) ? h : constexpr_hash(str, n + 1, (h * 16777619) ^ (str[n]));
    }
 
    uint32_t _id;
    uint8_t _basetype;
    uint8_t _semantic;
    uint16_t _size;
    uint16_t _structIndex;
};

class MX_GENSHADER_API TypeDescRegistry
{
  public:
    TypeDescRegistry(TypeDesc type, const string& name);
};

#define TYPEDESC_DEFINE_TYPE(T, name, basetype, semantic, size) \
    static constexpr TypeDesc T(name, basetype, semantic, size);

#define TYPEDESC_REGISTER_TYPE(T, name) \
    TypeDescRegistry register_##T(T, name);
 
namespace Type
{
 
//
//
TYPEDESC_DEFINE_TYPE(NONE, "none", TypeDesc::BASETYPE_NONE, TypeDesc::SEMANTIC_NONE, 1)
TYPEDESC_DEFINE_TYPE(BOOLEAN, "boolean", TypeDesc::BASETYPE_BOOLEAN, TypeDesc::SEMANTIC_NONE, 1)
TYPEDESC_DEFINE_TYPE(INTEGER, "integer", TypeDesc::BASETYPE_INTEGER, TypeDesc::SEMANTIC_NONE, 1)
TYPEDESC_DEFINE_TYPE(FLOAT, "float", TypeDesc::BASETYPE_FLOAT, TypeDesc::SEMANTIC_NONE, 1)
TYPEDESC_DEFINE_TYPE(INTEGERARRAY, "integerarray", TypeDesc::BASETYPE_INTEGER, TypeDesc::SEMANTIC_NONE, 0)
TYPEDESC_DEFINE_TYPE(FLOATARRAY, "floatarray", TypeDesc::BASETYPE_FLOAT, TypeDesc::SEMANTIC_NONE, 0)
TYPEDESC_DEFINE_TYPE(VECTOR2, "vector2", TypeDesc::BASETYPE_FLOAT, TypeDesc::SEMANTIC_VECTOR, 2)
TYPEDESC_DEFINE_TYPE(VECTOR3, "vector3", TypeDesc::BASETYPE_FLOAT, TypeDesc::SEMANTIC_VECTOR, 3)
TYPEDESC_DEFINE_TYPE(VECTOR4, "vector4", TypeDesc::BASETYPE_FLOAT, TypeDesc::SEMANTIC_VECTOR, 4)
TYPEDESC_DEFINE_TYPE(COLOR3, "color3", TypeDesc::BASETYPE_FLOAT, TypeDesc::SEMANTIC_COLOR, 3)
TYPEDESC_DEFINE_TYPE(COLOR4, "color4", TypeDesc::BASETYPE_FLOAT, TypeDesc::SEMANTIC_COLOR, 4)
TYPEDESC_DEFINE_TYPE(MATRIX33, "matrix33", TypeDesc::BASETYPE_FLOAT, TypeDesc::SEMANTIC_MATRIX, 9)
TYPEDESC_DEFINE_TYPE(MATRIX44, "matrix44", TypeDesc::BASETYPE_FLOAT, TypeDesc::SEMANTIC_MATRIX, 16)
TYPEDESC_DEFINE_TYPE(STRING, "string", TypeDesc::BASETYPE_STRING, TypeDesc::SEMANTIC_NONE, 1)
TYPEDESC_DEFINE_TYPE(FILENAME, "filename", TypeDesc::BASETYPE_STRING, TypeDesc::SEMANTIC_FILENAME, 1)
TYPEDESC_DEFINE_TYPE(BSDF, "BSDF", TypeDesc::BASETYPE_NONE, TypeDesc::SEMANTIC_CLOSURE, 1)
TYPEDESC_DEFINE_TYPE(EDF, "EDF", TypeDesc::BASETYPE_NONE, TypeDesc::SEMANTIC_CLOSURE, 1)
TYPEDESC_DEFINE_TYPE(VDF, "VDF", TypeDesc::BASETYPE_NONE, TypeDesc::SEMANTIC_CLOSURE, 1)
TYPEDESC_DEFINE_TYPE(SURFACESHADER, "surfaceshader", TypeDesc::BASETYPE_NONE, TypeDesc::SEMANTIC_SHADER, 1)
TYPEDESC_DEFINE_TYPE(VOLUMESHADER, "volumeshader", TypeDesc::BASETYPE_NONE, TypeDesc::SEMANTIC_SHADER, 1)
TYPEDESC_DEFINE_TYPE(DISPLACEMENTSHADER, "displacementshader", TypeDesc::BASETYPE_NONE, TypeDesc::SEMANTIC_SHADER, 1)
TYPEDESC_DEFINE_TYPE(LIGHTSHADER, "lightshader", TypeDesc::BASETYPE_NONE, TypeDesc::SEMANTIC_SHADER, 1)
TYPEDESC_DEFINE_TYPE(MATERIAL, "material", TypeDesc::BASETYPE_NONE, TypeDesc::SEMANTIC_MATERIAL, 1)
 
} // namespace Type
 

class MX_GENSHADER_API StructTypeDesc
{
  public:
    struct StructMemberTypeDesc
    {
        StructMemberTypeDesc(string name, TypeDesc typeDesc, string defaultValueStr) :
            _name(name), _typeDesc(typeDesc), _defaultValueStr(defaultValueStr)
        {
        }
        string _name;
        TypeDesc _typeDesc;
        string _defaultValueStr;
    };

    StructTypeDesc() noexcept{}
 
    void addMember(const string& name, TypeDesc type, const string& defaultValueStr);
    void setTypeDesc(TypeDesc typedesc) { _typedesc = typedesc; }

    static StructTypeDesc& get(unsigned int index);
    static vector<string> getStructTypeNames();
    static uint16_t emplace_back(StructTypeDesc structTypeDesc);
    static void clear();
 
    TypeDesc typeDesc() const { return _typedesc; }
 
    const string& getName() const;
 
    const vector<StructMemberTypeDesc>& getMembers() const;
 
  private:
    TypeDesc _typedesc;
    vector<StructMemberTypeDesc> _members;
};

class MX_GENSHADER_API StructTypeDescRegistry
{
  public:
    StructTypeDescRegistry();
};
 
MATERIALX_NAMESPACE_END
 
#endif