UnitSystem.h

Go to the documentation of this file.

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

 
#include <MaterialXGenShader/Export.h>
 
#include <MaterialXGenShader/ShaderNode.h>
#include <MaterialXGenShader/ShaderNodeImpl.h>
#include <MaterialXGenShader/TypeDesc.h>
#include <MaterialXCore/Unit.h>
 
#include <MaterialXCore/Document.h>
 
MATERIALX_NAMESPACE_BEGIN
 
class ShaderGenerator;

using UnitSystemPtr = shared_ptr<class UnitSystem>;

struct MX_GENSHADER_API UnitTransform
{
    UnitTransform(const string& ss, const string& ts, TypeDesc t, const string& unittype);
 
    string sourceUnit;
    string targetUnit;
    TypeDesc type;
    string unitType;

    bool operator==(const UnitTransform& rhs) const
    {
        return sourceUnit == rhs.sourceUnit &&
               targetUnit == rhs.targetUnit &&
               type == rhs.type &&
               unitType == rhs.unitType;
    }
};

class MX_GENSHADER_API UnitSystem
{
  public:
    virtual ~UnitSystem() { }

    static UnitSystemPtr create(const string& target);

    virtual const string& getName() const
    {
        return UnitSystem::UNITSYSTEM_NAME;
    }

    virtual void setUnitConverterRegistry(UnitConverterRegistryPtr registry);

    virtual UnitConverterRegistryPtr getUnitConverterRegistry() const;

    virtual void loadLibrary(DocumentPtr document);

    bool supportsTransform(const UnitTransform& transform) const;

    ShaderNodePtr createNode(ShaderGraph* parent, const UnitTransform& transform, const string& name,
                             GenContext& context) const;

    virtual NodeDefPtr getNodeDef(const UnitTransform& transform) const;
 
    static const string UNITSYSTEM_NAME;
 
  protected:
    // Protected constructor
    UnitSystem(const string& target);
 
  protected:
    UnitConverterRegistryPtr _unitRegistry;
    DocumentPtr _document;
    string _target;
};
 
MATERIALX_NAMESPACE_END
 
#endif