Property.h

Go to the documentation of this file.

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

 
#include <MaterialXCore/Export.h>
 
#include <MaterialXCore/Geom.h>
 
MATERIALX_NAMESPACE_BEGIN
 
class Property;
class PropertyAssign;
class PropertySet;
class PropertySetAssign;

using PropertyPtr = shared_ptr<Property>;
using ConstPropertyPtr = shared_ptr<const Property>;

using PropertyAssignPtr = shared_ptr<PropertyAssign>;
using ConstPropertyAssignPtr = shared_ptr<const PropertyAssign>;

using PropertySetPtr = shared_ptr<PropertySet>;
using ConstPropertySetPtr = shared_ptr<const PropertySet>;

using PropertySetAssignPtr = shared_ptr<PropertySetAssign>;
using ConstPropertySetAssignPtr = shared_ptr<const PropertySetAssign>;

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

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


    void setProperty(const string& property)
    {
        setAttribute(PROPERTY_ATTRIBUTE, property);
    }

    bool hasProperty() const
    {
        return hasAttribute(PROPERTY_ATTRIBUTE);
    }

    const string& getProperty() const
    {
        return getAttribute(PROPERTY_ATTRIBUTE);
    }


    void setGeom(const string& geom)
    {
        setAttribute(GEOM_ATTRIBUTE, geom);
    }

    bool hasGeom() const
    {
        return hasAttribute(GEOM_ATTRIBUTE);
    }

    const string& getGeom() const
    {
        return getAttribute(GEOM_ATTRIBUTE);
    }


    void setCollectionString(const string& collection)
    {
        setAttribute(COLLECTION_ATTRIBUTE, collection);
    }

    bool hasCollectionString() const
    {
        return hasAttribute(COLLECTION_ATTRIBUTE);
    }

    const string& getCollectionString() const
    {
        return getAttribute(COLLECTION_ATTRIBUTE);
    }

    void setCollection(ConstCollectionPtr collection);

    CollectionPtr getCollection() const;

 
  public:
    static const string CATEGORY;
    static const string PROPERTY_ATTRIBUTE;
    static const string GEOM_ATTRIBUTE;
    static const string COLLECTION_ATTRIBUTE;
};

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


    PropertyPtr addProperty(const string& name)
    {
        return addChild<Property>(name);
    }

    PropertyPtr getProperty(const string& name) const
    {
        return getChildOfType<Property>(name);
    }

    vector<PropertyPtr> getProperties() const
    {
        return getChildrenOfType<Property>();
    }

    void removeProperty(const string& name)
    {
        removeChildOfType<Property>(name);
    }


    template <class T> PropertyPtr setPropertyValue(const string& name,
                                                    const T& value,
                                                    const string& type = EMPTY_STRING)
    {
        PropertyPtr property = getChildOfType<Property>(name);
        if (!property)
            property = addProperty(name);
        property->setValue(value, type);
        return property;
    }

    ValuePtr getPropertyValue(const string& name) const
    {
        PropertyPtr property = getProperty(name);
        return property ? property->getValue() : ValuePtr();
    }

 
  public:
    static const string CATEGORY;
};

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


    void setPropertySetString(const string& propertySet)
    {
        setAttribute(PROPERTY_SET_ATTRIBUTE, propertySet);
    }

    bool hasPropertySetString() const
    {
        return hasAttribute(PROPERTY_SET_ATTRIBUTE);
    }

    const string& getPropertySetString() const
    {
        return getAttribute(PROPERTY_SET_ATTRIBUTE);
    }

    void setPropertySet(ConstPropertySetPtr propertySet);

    PropertySetPtr getPropertySet() const;

 
  public:
    static const string CATEGORY;
    static const string PROPERTY_SET_ATTRIBUTE;
};
 
MATERIALX_NAMESPACE_END
 
#endif