hierarchy.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/hierarchy.h"
#ifndef _hierarchy
#define _hierarchy
// ===========================================================================
// Copyright 2020 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================

#include "common/ufeExport.h"
#include "sceneItemList.h"
#include "sceneItem.h"
#include "undoableCommand.h"

#include <memory>
#include <string>

UFE_NS_DEF {

class Selection;


struct UFE_SDK_DECL ChildFilterFlag {
    ChildFilterFlag() = default;
    ChildFilterFlag(
        const std::string& filterName,
        const std::string& filterLabel,
        bool               filterValue);

    std::string name;

    std::string label;

    bool value{false};
};



class UFE_SDK_DECL Hierarchy
{
public:
    typedef std::shared_ptr<Hierarchy> Ptr;
    typedef std::list<ChildFilterFlag> ChildFilter;

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

    static SceneItem::Ptr createItem(const Path& path);

    Hierarchy();

    Hierarchy(const Hierarchy&) = default;

    virtual ~Hierarchy();

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

    virtual bool hasChildren() const = 0;

    virtual SceneItemList children() const = 0;

    virtual bool hasFilteredChildren(const ChildFilter&) const = 0;

    virtual SceneItemList filteredChildren(const ChildFilter&) const = 0;

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

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

    virtual SceneItem::Ptr insertChild(
        const SceneItem::Ptr& child, const SceneItem::Ptr& pos) = 0;

    virtual InsertChildCommand::Ptr insertChildCmd(
        const SceneItem::Ptr& child, const SceneItem::Ptr& pos) = 0;

    InsertChildCommand::Ptr appendChildCmd(const SceneItem::Ptr& child) {
        return insertChildCmd(child, nullptr);
    }

    virtual SceneItem::Ptr createGroup(const PathComponent& name) const = 0;

    virtual InsertChildCommand::Ptr createGroupCmd(const PathComponent& name) const = 0;

    virtual UndoableCommand::Ptr reorderCmd(const Ufe::SceneItemList& orderedList) const = 0;

    virtual bool reorder(const Ufe::SceneItemList& orderedList) {
        auto cmd = reorderCmd(orderedList);
        if (cmd) {
            cmd->execute();
            return true;
        }
        return false;
    }

    virtual UndoableCommand::Ptr ungroupCmd() const = 0;

    virtual bool ungroup() {
        auto cmd = ungroupCmd();
        if (cmd) {
            cmd->execute();
            return true;
        }
        return false;
    }
};

}

#endif /* _hierarchy */