selectionUndoableCommands.h

Go to the documentation of this file.

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

UFE_NS_DEF {

class Selection;


class UFE_SDK_DECL SelectionAppendItem : public UndoableCommand
{
public:

    static Ptr createAndExecute(
        const GlobalSelection::Ptr& sn,
        const SceneItem::Ptr&       item
    );

    SelectionAppendItem(
        const GlobalSelection::Ptr& sn,
        const SceneItem::Ptr&       item
    );

    void undo() override;
    void redo() override;

private:

    const GlobalSelection::Ptr fSn;
    // Store path instead of scene item.
    // A valid scene item at command creation may be invalidated by a sequence
    // of undos, followed by corresponding redos.
    const Path                 fPath;
};


class UFE_SDK_DECL SelectionRemoveItem : public UndoableCommand
{
public:

    static Ptr createAndExecute(
        const GlobalSelection::Ptr& sn,
        const SceneItem::Ptr&       item
    );

    SelectionRemoveItem(
        const GlobalSelection::Ptr& sn,
        const SceneItem::Ptr&       item
    );

    void undo() override;
    void redo() override;

private:

    const GlobalSelection::Ptr fSn;
    // Store path instead of scene item.
    // A valid scene item at command creation may be invalidated by a sequence
    // of undos, followed by corresponding redos.
    const Path                 fPath;
};


class UFE_SDK_DECL SelectionClear : public UndoableCommand
{
public:

    static Ptr createAndExecute(const GlobalSelection::Ptr& sn);

    SelectionClear(const GlobalSelection::Ptr& sn);

    void undo() override;
    void redo() override;

private:

    const GlobalSelection::Ptr fSn;
    // Store paths instead of scene item.
    // A valid scene item at command creation may be invalidated by a sequence
    // of undos, followed by corresponding redos.
    const std::list<Path>      fPaths;
};


class UFE_SDK_DECL SelectionReplaceWith : public UndoableCommand
{
public:

    static Ptr createAndExecute(
        const GlobalSelection::Ptr& sn,
        const Selection&            replacementSn
    );

    SelectionReplaceWith(
        const GlobalSelection::Ptr& sn,
        const Selection&            replacementSn
    );

    void undo() override;
    void redo() override;

private:

    const GlobalSelection::Ptr fSn;
    // Store paths instead of scene item.
    // A valid scene item at command creation may be invalidated by a sequence
    // of undos, followed by corresponding redos.
    const std::list<Path>      fSnPaths;
    const std::list<Path>      fReplacementSnPaths;
};

}

#endif /* _selectionUndoableCommands */