Unit.h

Go to the documentation of this file.

//
// Copyright Contributors to the MaterialX Project
// SPDX-License-Identifier: Apache-2.0
//
 
#ifndef MATERIALX_UNIT_H_
#define MATERIALX_UNIT_H_
 
 
#include <MaterialXCore/Export.h>
 
#include <MaterialXCore/Document.h>
 
MATERIALX_NAMESPACE_BEGIN
 
class UnitConverter;
class LinearUnitConverter;
class UnitConverterRegistry;
 
using UnitConverterPtr = shared_ptr<UnitConverter>;
using ConstUnitConverterPtr = shared_ptr<const UnitConverter>;
 
using LinearUnitConverterPtr = shared_ptr<LinearUnitConverter>;
using ConstLinearUnitConverterPtr = shared_ptr<const LinearUnitConverter>;
 
using UnitConverterRegistryPtr = shared_ptr<UnitConverterRegistry>;
using ConstUnitConverterRegistryPtr = shared_ptr<const UnitConverterRegistry>;
 
class MX_CORE_API UnitConverter
{
  public:
    UnitConverter() { }
    virtual ~UnitConverter() { }
 
    virtual float convert(float input, const string& inputUnit, const string& outputUnit) const = 0;
 
    virtual int getUnitAsInteger(const string&) const { return -1; }
 
    virtual string getUnitFromInteger(int) const { return EMPTY_STRING; }
 
    virtual Vector2 convert(const Vector2& input, const string& inputUnit, const string& outputUnit) const = 0;
 
    virtual Vector3 convert(const Vector3& input, const string& inputUnit, const string& outputUnit) const = 0;
 
    virtual Vector4 convert(const Vector4& input, const string& inputUnit, const string& outputUnit) const = 0;
 
    virtual void write(DocumentPtr doc) const = 0;
};
 
class MX_CORE_API LinearUnitConverter : public UnitConverter
{
  public:
    virtual ~LinearUnitConverter() { }
 
    static LinearUnitConverterPtr create(UnitTypeDefPtr UnitDef);
 
    const string& getUnitType() const
    {
        return _unitType;
    }
 
    void write(DocumentPtr doc) const override;
 
 
    const std::unordered_map<string, float>& getUnitScale() const
    {
        return _unitScale;
    }
 
    float conversionRatio(const string& inputUnit, const string& outputUnit) const;
 
    float convert(float input, const string& inputUnit, const string& outputUnit) const override;
 
    Vector2 convert(const Vector2& input, const string& inputUnit, const string& outputUnit) const override;
 
    Vector3 convert(const Vector3& input, const string& inputUnit, const string& outputUnit) const override;
 
    Vector4 convert(const Vector4& input, const string& inputUnit, const string& outputUnit) const override;
 
 
    int getUnitAsInteger(const string& unitName) const override;
 
    virtual string getUnitFromInteger(int index) const override;
 
 
  private:
    LinearUnitConverter(UnitTypeDefPtr UnitDef);
 
  private:
    std::unordered_map<string, float> _unitScale;
    std::unordered_map<string, int> _unitEnumeration;
    string _unitType;
};
 
using UnitConverterPtrMap = std::unordered_map<string, UnitConverterPtr>;
 
class MX_CORE_API UnitConverterRegistry
{
  public:
    virtual ~UnitConverterRegistry() { }
 
    static UnitConverterRegistryPtr create();
 
    bool addUnitConverter(UnitTypeDefPtr def, UnitConverterPtr converter);
 
    bool removeUnitConverter(UnitTypeDefPtr def);
 
    UnitConverterPtr getUnitConverter(UnitTypeDefPtr def);
 
    void clearUnitConverters();
 
    int getUnitAsInteger(const string& unitName) const;
 
    void write(DocumentPtr doc) const;
 
    bool convertToUnit(DocumentPtr doc, const string& unitType, const string& targetUnit);
 
  private:
    UnitConverterRegistry(const UnitConverterRegistry&) = delete;
    UnitConverterRegistry() { }
 
    UnitConverterRegistry& operator=(const UnitConverterRegistry&) = delete;
 
  private:
    UnitConverterPtrMap _unitConverters;
};
 
MATERIALX_NAMESPACE_END
 
#endif