contextOps.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/contextOps.h"
#ifndef _contextOps
#define _contextOps
// ===========================================================================
// 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 "sceneItem.h"
#include "undoableCommand.h"

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

UFE_NS_DEF {


struct UFE_SDK_DECL ContextItem {

    enum HasChildren { kNoChildren = false, kHasChildren = true };
    enum Checkable { kNotCheckable = false, kCheckable = true };
    enum Checked { kNotChecked = false, kChecked = true };
    enum Exclusive { kNotExclusive = false, kExclusive = true };
    enum Enabled { kDisabled = false, kEnabled = true };

    enum SeparatorTag { kSeparator };

    ContextItem() = default;
    ContextItem(
        const std::string& argItem,
        const std::string& argLabel,
        bool               argHasChildren = false,
        bool               argCheckable = false,
        bool               argChecked = false,
        bool               argExclusive = false,
        bool               argEnabled = true
    );
    ContextItem(
        const std::string& argItem,
        const std::string& argLabel,
        const std::string& argImage,
        bool               argHasChildren = false,
        bool               argCheckable = false,
        bool               argChecked = false,
        bool               argExclusive = false,
        bool               argEnabled = true
    );
    ContextItem(SeparatorTag, const std::string& argLabel = "");

    std::string item{};

    std::string label{};

    std::string image{};

    bool hasChildren{false};

    bool checkable{false};

    bool checked{false};

    bool exclusive{false};

    bool enabled{true};

    bool separator{false};
};


class UFE_SDK_DECL ContextOps
{
public:
    typedef std::shared_ptr<ContextOps> Ptr;
    typedef std::vector<std::string>    ItemPath;
    typedef std::vector<ContextItem>    Items;
    
    static Ptr contextOps(const SceneItem::Ptr& item);

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

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

    virtual Items getItems(const ItemPath& itemPath) const = 0;

    virtual void doOp(const ItemPath& itemPath);

    virtual UndoableCommand::Ptr doOpCmd(const ItemPath& itemPath) = 0;
};

}

#endif /* _contextOps */