sceneItem.h

Go to the documentation of this file.

#line 1 "D:/Jenkins/workspace/EMS/ECG/ufe/full/ufe-full-python3.13-windows/ufe/include/sceneItem.h"
#ifndef UFE_SCENEITEM_H
#define UFE_SCENEITEM_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 "path.h"
#include "ufeFwd.h"
#include "value.h"
 
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
 
UFE_NS_DEF{
 
    class UndoableCommand;
 
class UFE_SDK_DECL SceneItem
{
public:
    typedef std::shared_ptr<SceneItem> Ptr;
    
    SceneItem(const Path& path);
 
    SceneItem(const SceneItem&) = default;
 
    virtual ~SceneItem();
 
    const Path& path() const;
 
    Rtid runTimeId() const;
 
    bool operator==(const SceneItem& rhs) const;
    bool operator!=(const SceneItem& rhs) const;
 
    std::string nodeName() const;
 
    virtual std::string nodeType() const = 0;
 
    virtual std::vector<std::string> ancestorNodeTypes() const;
 
    virtual bool isProperty() const;
 
    virtual Ufe::Value getMetadata(const std::string& key) const = 0;
    
    virtual UndoableCommandPtr setMetadataCmd(const std::string& key, const Ufe::Value& value) = 0;
 
    virtual void setMetadata(const std::string& key, const Ufe::Value& value);
 
    virtual UndoableCommandPtr clearMetadataCmd(const std::string& key = "") = 0;
 
    virtual void clearMetadata(const std::string& key = "");
 
    virtual Ufe::Value getGroupMetadata(const std::string& group, const std::string& key) const = 0;
    
    virtual UndoableCommandPtr setGroupMetadataCmd(const std::string& group, const std::string& key, const Ufe::Value& value) = 0;
 
    virtual void setGroupMetadata(const std::string& group, const std::string& key, const Ufe::Value& value);
    
    virtual UndoableCommandPtr clearGroupMetadataCmd(const std::string& group, const std::string& key = "") = 0;
 
    virtual void clearGroupMetadata(const std::string& group, const std::string& key = "");
 
private:
 
    Path fPath;
};
 
}
 
#endif  /* UFE_SCENEITEM_H */