Variant.h

Go to the documentation of this file.

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

 
#include <MaterialXCore/Export.h>
 
#include <MaterialXCore/Interface.h>
 
MATERIALX_NAMESPACE_BEGIN
 
class Variant;
class VariantSet;
class VariantAssign;

using VariantPtr = shared_ptr<Variant>;
using ConstVariantPtr = shared_ptr<const Variant>;

using VariantSetPtr = shared_ptr<VariantSet>;
using ConstVariantSetPtr = shared_ptr<const VariantSet>;

using VariantAssignPtr = shared_ptr<VariantAssign>;
using ConstVariantAssignPtr = shared_ptr<const VariantAssign>;

class MX_CORE_API Variant : public InterfaceElement
{
  public:
    Variant(ElementPtr parent, const string& name) :
        InterfaceElement(parent, CATEGORY, name)
    {
    }
    virtual ~Variant() { }
 
  public:
    static const string CATEGORY;
};

class MX_CORE_API VariantSet : public Element
{
  public:
    VariantSet(ElementPtr parent, const string& name) :
        Element(parent, CATEGORY, name)
    {
    }
    virtual ~VariantSet() { }


    VariantPtr addVariant(const string& name = EMPTY_STRING)
    {
        return addChild<Variant>(name);
    }

    VariantPtr getVariant(const string& name) const
    {
        return getChildOfType<Variant>(name);
    }

    vector<VariantPtr> getVariants() const
    {
        return getChildrenOfType<Variant>();
    }

    void removeVariant(const string& name)
    {
        removeChildOfType<Variant>(name);
    }

 
  public:
    static const string CATEGORY;
};

class MX_CORE_API VariantAssign : public Element
{
  public:
    VariantAssign(ElementPtr parent, const string& name) :
        Element(parent, CATEGORY, name)
    {
    }
    virtual ~VariantAssign() { }


    void setVariantSetString(const string& variantSet)
    {
        setAttribute(VARIANT_SET_ATTRIBUTE, variantSet);
    }

    bool hasVariantSetString() const
    {
        return hasAttribute(VARIANT_SET_ATTRIBUTE);
    }

    const string& getVariantSetString() const
    {
        return getAttribute(VARIANT_SET_ATTRIBUTE);
    }


    void setVariantString(const string& variant)
    {
        setAttribute(VARIANT_ATTRIBUTE, variant);
    }

    bool hasVariantString() const
    {
        return hasAttribute(VARIANT_ATTRIBUTE);
    }

    const string& getVariantString() const
    {
        return getAttribute(VARIANT_ATTRIBUTE);
    }

 
  public:
    static const string CATEGORY;
    static const string VARIANT_SET_ATTRIBUTE;
    static const string VARIANT_ATTRIBUTE;
};
 
MATERIALX_NAMESPACE_END
 
#endif