attributes.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/attributes.h"
#ifndef _ufe_attributes
#define _ufe_attributes

// =======================================================================
// 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 "attribute.h"
#include "attributesUndoableCommands.h"
#include "sceneItem.h"
#include "observer.h"
#include "attributesNotification.h"
#include "undoableCommand.h"

#include <memory>
#include <vector>
#include <string>

UFE_NS_DEF {

class UFE_SDK_DECL Attributes
{
public:
    typedef std::shared_ptr<Attributes> Ptr;

    static Ptr attributes(const SceneItem::Ptr& item);

    static bool addObserver(
        const SceneItem::Ptr& item, const Observer::Ptr& obs);
    static bool addObserver(const Observer::Ptr& obs);
    static bool removeObserver(
        const SceneItem::Ptr& item, const Observer::Ptr& obs);

    static bool removeObserver(const Observer::Ptr& obs);

    static std::size_t nbObservers(const SceneItem::Ptr& item);

    static std::size_t nbObservers();

    static bool hasObserver(
        const SceneItem::Ptr& item, const Observer::Ptr& obs);

    static bool hasObserver(const Observer::Ptr& obs);

    static bool hasObservers(const Path& path);

    static bool hasObservers(Rtid runTimeId);

    static void notify(const AttributeChanged& notification);

    Attributes();
    Attributes(const Attributes&) = default;
    virtual ~Attributes();

    virtual SceneItem::Ptr sceneItem() const = 0;

    virtual Attribute::Type attributeType(const std::string& name) = 0;

    virtual Attribute::Ptr attribute(const std::string& name) = 0;

    virtual std::vector<std::string> attributeNames() const = 0;

    virtual bool hasAttribute(const std::string& name) const = 0;

    virtual Attribute::Ptr addAttribute(const std::string& name,
                                        const Attribute::Type& type);

    virtual AddAttributeUndoableCommand::Ptr
    addAttributeCmd(const std::string& name,
                    const Attribute::Type& type) = 0;

    virtual bool removeAttribute(const std::string& name);

    virtual UndoableCommand::Ptr
    removeAttributeCmd(const std::string& name) = 0;

    virtual Attribute::Ptr 
    renameAttribute(const std::string& originalName,
                    const std::string& newName);

    virtual RenameAttributeUndoableCommand::Ptr 
    renameAttributeCmd(const std::string& originalName,
                       const std::string& newName) = 0;

}; // end class Attributes

class UFE_SDK_DECL Attributes_v4_2 : public Attributes
{
public:
    typedef std::shared_ptr<Attributes_v4_2> Ptr;
    typedef std::vector< std::pair< std::string, std::string> > Enums;

    ~Attributes_v4_2() override;

    virtual Enums getEnums(const std::string& attrName) const = 0;

}; // end class Attributes_v4_2

} // end namespace

#endif /* _ufe_attributes */