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>
 
MATERIALX_NAMESPACE_BEGIN
 
using ChannelMap = std::unordered_map<char, int>;
 
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
    };
 
    static const TypeDesc* registerType(const string& name, unsigned char basetype, unsigned char semantic = SEMANTIC_NONE,
                                        size_t size = 1, bool editable = true, const ChannelMap& channelMapping = ChannelMap());
 
    bool operator==(const TypeDesc& rhs) const;
 
    bool operator!=(const TypeDesc& rhs) const;
 
    static const TypeDesc* get(const string& name);
 
    const string& getName() const { return _name; }
 
    unsigned char getBaseType() const { return _basetype; }
 
    int getChannelIndex(char channel) const;
 
    unsigned char getSemantic() const { return _semantic; }
 
    size_t getSize() const { return _size; }
 
    bool isEditable() const { return _editable; }
 
    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); }
 
  private:
    TypeDesc(const string& name, unsigned char basetype, unsigned char semantic, size_t size,
             bool editable, const ChannelMap& channelMapping);
 
    const string _name;
    const unsigned char _basetype;
    const unsigned char _semantic;
    const size_t _size;
    const bool _editable;
    const ChannelMap _channelMapping;
};
 
namespace Type
{
 
extern MX_GENSHADER_API const TypeDesc* NONE;
extern MX_GENSHADER_API const TypeDesc* BOOLEAN;
extern MX_GENSHADER_API const TypeDesc* INTEGER;
extern MX_GENSHADER_API const TypeDesc* INTEGERARRAY;
extern MX_GENSHADER_API const TypeDesc* FLOAT;
extern MX_GENSHADER_API const TypeDesc* FLOATARRAY;
extern MX_GENSHADER_API const TypeDesc* VECTOR2;
extern MX_GENSHADER_API const TypeDesc* VECTOR3;
extern MX_GENSHADER_API const TypeDesc* VECTOR4;
extern MX_GENSHADER_API const TypeDesc* COLOR3;
extern MX_GENSHADER_API const TypeDesc* COLOR4;
extern MX_GENSHADER_API const TypeDesc* MATRIX33;
extern MX_GENSHADER_API const TypeDesc* MATRIX44;
extern MX_GENSHADER_API const TypeDesc* STRING;
extern MX_GENSHADER_API const TypeDesc* FILENAME;
extern MX_GENSHADER_API const TypeDesc* BSDF;
extern MX_GENSHADER_API const TypeDesc* EDF;
extern MX_GENSHADER_API const TypeDesc* VDF;
extern MX_GENSHADER_API const TypeDesc* SURFACESHADER;
extern MX_GENSHADER_API const TypeDesc* VOLUMESHADER;
extern MX_GENSHADER_API const TypeDesc* DISPLACEMENTSHADER;
extern MX_GENSHADER_API const TypeDesc* LIGHTSHADER;
extern MX_GENSHADER_API const TypeDesc* MATERIAL;
 
} // namespace Type
 
MATERIALX_NAMESPACE_END
 
#endif