attribute.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.11-windows/ufe/include/attribute.h"
#ifndef _ufe_attribute
#define _ufe_attribute
 
// =======================================================================
// Copyright 2019 Autodesk, Inc. All rights reserved.
//
// This computer source code and related instructions and comments are the
// unpublished confidential  and proprietary information of Autodesk, Inc.
// and are protected under applicable copyright and trade secret law. They 
// may not be disclosed to, copied  or used by any third party without the 
// prior written consent of Autodesk, Inc.
// =======================================================================
 
#include "common/ufeExport.h"
#include "sceneItem.h"
#include "observer.h"
#include "types.h"
#include "undoableCommand.h"    // For UndoableCommand::Ptr
#include "value.h"
 
#include <memory>
#include <vector>
#include <string>
 
UFE_NS_DEF {
 
class UFE_SDK_DECL Attribute : public std::enable_shared_from_this<Attribute>
{
public:
    typedef std::shared_ptr<Attribute> Ptr;
    typedef std::string Type;
 
    static constexpr char kInvalid[] = "Invalid";
    static constexpr char kBool[] = "Bool";
    static constexpr char kInt[] = "Int";
    static constexpr char kFloat[] = "Float";
    static constexpr char kDouble[] = "Double";
    static constexpr char kString[] = "String";
    static constexpr char kColorFloat3[] = "ColorFloat3";
    static constexpr char kColorFloat4[] = "ColorFloat4";
    static constexpr char kFilename[] = "Filename";
    static constexpr char kEnumString[] = "EnumString";
    static constexpr char kInt3[] = "Int3";
    static constexpr char kFloat2[] = "Float2";
    static constexpr char kFloat3[] = "Float3";
    static constexpr char kFloat4[] = "Float4";
    static constexpr char kDouble3[] = "Double3";
    static constexpr char kMatrix3d[] = "Matrix3d";
    static constexpr char kMatrix4d[] = "Matrix4d";
    static constexpr char kGeneric[] = "Generic";
 
    Attribute(const SceneItem::Ptr&);
    virtual ~Attribute();
 
 
    Attribute(const Attribute&) = delete;
    Attribute& operator=(const Attribute&) = delete;
    Attribute(Attribute&&) = delete;
    Attribute& operator=(Attribute&&) = delete;
 
 
    bool operator==(const Attribute& rhs) const;
    bool operator!=(const Attribute& rhs) const;
 
    SceneItem::Ptr sceneItem() const;
 
    virtual bool hasValue() const = 0;
 
    virtual std::string name() const = 0;
 
    virtual std::string displayName() const;
 
    virtual std::string documentation() const = 0;
 
    virtual Type type() const = 0;
 
    virtual std::string string() const = 0;
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
    static constexpr char kLocked[] = "Locked";
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
    virtual Value getMetadata(const std::string& key) const = 0;
 
    virtual bool setMetadata(const std::string& key, const Value& value) = 0;
 
    virtual UndoableCommand::Ptr setMetadataCmd(const std::string& key, const Value& value);
 
    virtual bool clearMetadata(const std::string& key) = 0;
 
    virtual UndoableCommand::Ptr clearMetadataCmd(const std::string &key);
 
    virtual bool hasMetadata(const std::string& key) const = 0;
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
private:
    const SceneItem::Ptr fItem;
 
}; // end class Attribute
 
class UFE_SDK_DECL AttributeGeneric : public Attribute
{
public:
    typedef std::shared_ptr<AttributeGeneric> Ptr;
 
    using Attribute::Attribute;
 
    // Ufe::Attribute overrides
    Type type() const final;
 
    virtual std::string nativeType() const = 0;
};
 
class UFE_SDK_DECL AttributeFilename :
    public Attribute
{
public:
    typedef std::shared_ptr<AttributeFilename> Ptr;
 
    using Attribute::Attribute;
 
    // Ufe::Attribute overrides
    Type type() const final;
 
    virtual std::string get() const = 0;
 
    virtual void set(const std::string& value) = 0;
 
    virtual UndoableCommand::Ptr setCmd(const std::string& value);
};
 
class UFE_SDK_DECL AttributeEnumString :
    public Attribute
{
public:
    typedef std::shared_ptr<AttributeEnumString> Ptr;
    typedef std::vector< std::string > EnumValues;
 
    using Attribute::Attribute;
 
    // Ufe::Attribute overrides
    Type type() const final;
 
    virtual std::string get() const = 0;
 
    virtual void set(const std::string& value) = 0;
 
    virtual UndoableCommand::Ptr setCmd(const std::string& value);
 
    virtual EnumValues getEnumValues() const = 0;
};
 
template<typename T>
class UFE_SDK_DECL TypedAttribute :
    public Attribute
{
public:
    typedef std::shared_ptr<TypedAttribute<T>> Ptr;
 
    using Attribute::Attribute;
 
    // Ufe::Attribute overrides
    Type type() const final;
 
    virtual T get() const = 0;
 
    virtual void set(const T& value) = 0;
 
    virtual UndoableCommand::Ptr setCmd(const T& value);
};
 
typedef TypedAttribute<bool> AttributeBool;
 
typedef TypedAttribute<int> AttributeInt;
 
typedef TypedAttribute<float> AttributeFloat;
 
typedef TypedAttribute<double> AttributeDouble;
 
typedef TypedAttribute<std::string> AttributeString;
 
typedef TypedAttribute<Color3f> AttributeColorFloat3;
 
typedef TypedAttribute<Color4f> AttributeColorFloat4;
 
typedef TypedAttribute<Vector3i> AttributeInt3;
 
typedef TypedAttribute<Vector2f> AttributeFloat2;
 
typedef TypedAttribute<Vector3f> AttributeFloat3;
 
typedef TypedAttribute<Vector4f> AttributeFloat4;
 
typedef TypedAttribute<Vector3d> AttributeDouble3;
 
 
typedef TypedAttribute<Matrix3d> AttributeMatrix3d;
 
 
typedef TypedAttribute<Matrix4d> AttributeMatrix4d;
 
} // end namespace
 
#endif /* _ufe_attribute */