attribute.h

Go to the documentation of this file.

#line 1 "D:/Jenkins/workspace/EMS/ECG/ufe/full/ufe-full-python3.13-windows/ufe/include/attribute.h"
#ifndef UFE_ATTRIBUTE_H
#define UFE_ATTRIBUTE_H
 
// ===========================================================================
// Copyright 2025 Autodesk, Inc. All rights reserved.
//
// The use of this software is subject to the Autodesk Terms of Use or other
// license agreement provided at the time of installation or download, or
// which otherwise accompanies this software.
// ===========================================================================
 
#include "common/ufeExport.h"
#include "sceneItem.h"
#include "observer.h"
#include "types.h"
#include "undoableCommand.h"    // For UndoableCommand::Ptr
#include "value.h"
#include "array.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 kUInt[] = "UInt";
    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 kBoolArray[] = "BoolArray";
    static constexpr char kIntArray[] = "IntArray";
    static constexpr char kUIntArray[] = "UIntArray";
    static constexpr char kFloatArray[] = "FloatArray";
    static constexpr char kDoubleArray[] = "DoubleArray";
    static constexpr char kStringArray[] = "StringArray";
    static constexpr char kInt2Array[] = "Int2Array";
    static constexpr char kFloat2Array[] = "Float2Array";
    static constexpr char kDouble2Array[] = "Double2Array";
    static constexpr char kInt3Array[] = "Int3Array";
    static constexpr char kFloat3Array[] = "Float3Array";
    static constexpr char kDouble3Array[] = "Double3Array";
    static constexpr char kInt4Array[] = "Int4Array";
    static constexpr char kFloat4Array[] = "Float4Array";
    static constexpr char kDouble4Array[] = "Double4Array";
    static constexpr char kColorFloat3Array[] = "ColorFloat3Array";
    static constexpr char kColorFloat4Array[] = "ColorFloat4Array";
    static constexpr char kMatrixDouble3Array[] = "MatrixDouble3Array";
    static constexpr char kMatrixDouble4Array[] = "MatrixDouble4Array";
    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;
 
    virtual Value value() const = 0;
 
    virtual UndoableCommand::Ptr setCmd(const Value& value) = 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;
    Value value() const override;
    UndoableCommand::Ptr setCmd(const Value& value) override;
 
    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;
    Value value() const override;
    UndoableCommand::Ptr setCmd(const Value& value) override;
 
    virtual std::string get() const = 0;
 
    virtual bool isDefault() const = 0;
 
    virtual void set(const std::string& value) = 0;
 
    virtual void reset() = 0;
 
    virtual UndoableCommand::Ptr setCmd(const std::string& value);
 
    virtual UndoableCommand::Ptr resetCmd();
};
 
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;
    Value value() const override;
    UndoableCommand::Ptr setCmd(const Value& value) override;
 
    virtual std::string get() const = 0;
 
    virtual bool isDefault() const = 0;
 
    virtual void set(const std::string& value) = 0;
 
    virtual void reset() = 0;
 
    virtual UndoableCommand::Ptr setCmd(const std::string& value);
 
    virtual UndoableCommand::Ptr resetCmd();
 
    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;
    Value value() const override;
    UndoableCommand::Ptr setCmd(const Value& value) override;
 
    virtual T get() const = 0;
 
    virtual bool isDefault() const = 0;
 
    virtual void set(const T& value) = 0;
 
    virtual void reset() = 0;
 
    virtual UndoableCommand::Ptr setCmd(const T& value);
 
    virtual UndoableCommand::Ptr resetCmd();
};
 
typedef TypedAttribute<bool> AttributeBool;
 
typedef TypedAttribute<int> AttributeInt;
 
typedef TypedAttribute<unsigned int> AttributeUInt;
 
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;
 
typedef TypedAttribute<BoolArray> AttributeBoolArray;
 
typedef TypedAttribute<IntArray> AttributeIntArray;
 
typedef TypedAttribute<UIntArray> AttributeUIntArray;
 
typedef TypedAttribute<FloatArray> AttributeFloatArray;
 
typedef TypedAttribute<DoubleArray> AttributeDoubleArray;
 
typedef TypedAttribute<StringArray> AttributeStringArray;
 
typedef TypedAttribute<Vector2iArray> AttributeInt2Array;
 
typedef TypedAttribute<Vector2fArray> AttributeFloat2Array;
 
typedef TypedAttribute<Vector2dArray> AttributeDouble2Array;
 
typedef TypedAttribute<Vector3iArray> AttributeInt3Array;
 
typedef TypedAttribute<Vector3fArray> AttributeFloat3Array;
 
typedef TypedAttribute<Vector3dArray> AttributeDouble3Array;
 
typedef TypedAttribute<Vector4iArray> AttributeInt4Array;
 
typedef TypedAttribute<Vector4fArray> AttributeFloat4Array;
 
typedef TypedAttribute<Vector4dArray> AttributeDouble4Array;
 
typedef TypedAttribute<Color3fArray> AttributeColorFloat3Array;
 
typedef TypedAttribute<Color4fArray> AttributeColorFloat4Array;
 
typedef TypedAttribute<Matrix3dArray> AttributeMatrixDouble3Array;
 
typedef TypedAttribute<Matrix4dArray> AttributeMatrixDouble4Array;
 
} // end namespace
 
#endif /* UFE_ATTRIBUTE_H */