undoableCommand.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.11-windows/ufe/include/undoableCommand.h"
#ifndef _undoableCommand
#define _undoableCommand
// ===========================================================================
// Copyright 2018 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 <memory>
#include <list>
#include <initializer_list>
#include <string>
 
UFE_NS_DEF {
 
// Forward declarations
class Connection;
 
 
class UFE_SDK_DECL UndoableCommand
{
public:
    typedef std::shared_ptr<UndoableCommand> Ptr;
 
    virtual ~UndoableCommand();
 
    virtual std::string commandString() const { return ""; }
 
    virtual void execute();
 
    virtual void undo() = 0;
    virtual void redo() = 0;
 
protected:
    UndoableCommand();
    UndoableCommand(const UndoableCommand&) = delete;
};
 
 
class UFE_SDK_DECL CompositeUndoableCommand : public UndoableCommand
{
public:
    typedef std::list<Ptr> CmdList;
 
 
    static std::shared_ptr<CompositeUndoableCommand> create(
        std::initializer_list<Ptr> undoableCommands
    );
    static std::shared_ptr<CompositeUndoableCommand> create(
        const std::list<Ptr>& undoableCommands
    );
    static std::shared_ptr<CompositeUndoableCommand> create(
        const Ptr& undoableCommand
    );
 
 
    CompositeUndoableCommand();
    CompositeUndoableCommand(std::initializer_list<Ptr> undoableCommands);
    CompositeUndoableCommand(const std::list<Ptr>& undoableCommands);
    CompositeUndoableCommand(const Ptr& undoableCommand);
 
    ~CompositeUndoableCommand() override;
 
    void execute() override;
 
    void undo() override;
 
    void redo() override;
 
    void append(const Ptr& cmd);
 
    const CmdList& cmdsList() const;
 
private:
    CompositeUndoableCommand(const CompositeUndoableCommand&) = delete;
 
    CmdList fCmds;
};
 
 
class UFE_SDK_DECL InsertChildCommand : public UndoableCommand
{
public:
    typedef std::shared_ptr<InsertChildCommand> Ptr;
 
    InsertChildCommand() = default;
 
    ~InsertChildCommand() override;
 
    virtual SceneItem::Ptr insertedChild() const = 0;
};
 
class UFE_SDK_DECL SceneItemResultUndoableCommand : public UndoableCommand
{
public:
    typedef std::shared_ptr<SceneItemResultUndoableCommand> Ptr;
 
    SceneItemResultUndoableCommand() = default;
 
    ~SceneItemResultUndoableCommand() override;
 
    virtual SceneItem::Ptr sceneItem() const = 0;
};
 
class UFE_SDK_DECL ConnectionResultUndoableCommand : public UndoableCommand
{
public:
    typedef std::shared_ptr<ConnectionResultUndoableCommand> Ptr;
 
    ConnectionResultUndoableCommand() = default;
 
    ~ConnectionResultUndoableCommand() override;
 
    virtual std::shared_ptr<Connection> connection() const = 0;
};
 
 
class UFE_SDK_DECL SelectionUndoableCommand : public UndoableCommand
{
public:
    typedef std::shared_ptr<SelectionUndoableCommand> Ptr;
 
    SelectionUndoableCommand() = default;
 
    ~SelectionUndoableCommand() override;
 
    virtual SceneItem::Ptr targetItem(const Path& sourcePath) const = 0;
};
 
}
 
#endif /* _undoableCommand */