baseUndoableCommands.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/baseUndoableCommands.h"
#ifndef _baseUndoableCommands
#define _baseUndoableCommands
// ===========================================================================
// 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 "undoableCommand.h"
#include "hierarchy.h"
#include "path.h"
#include "types.h"

#include <memory>

UFE_NS_DEF
{
    //
    // Set operation commands do not hold onto a SceneItem, because that item
    // might be stale when undo or redo is executed.  This is for two reasons:
    // - redo and undo of commands later in the undo stack may make the item stale
    // - operations between the point of creation of the set command and its
    //   execution may make the item stale.
    //
    class UFE_SDK_DECL BaseUndoableCommand : public UndoableCommand
    {
    public:
        BaseUndoableCommand(const Path &path);
        ~BaseUndoableCommand() override;

        inline void setPath(const Path &path) { fPath = path; }

        inline const Path &path() const { return fPath; }

        Ufe::SceneItem::Ptr sceneItem() const { return Ufe::Hierarchy::createItem(path()); }

    private:
        Path fPath;
    };

    template <typename VALUE_TYPE>
    class UFE_SDK_DECL SetValueUndoableCommand : public BaseUndoableCommand
    {
    public:
        typedef std::shared_ptr<SetValueUndoableCommand> Ptr;
        typedef VALUE_TYPE ValueType;

        SetValueUndoableCommand(const Path &path) : BaseUndoableCommand(path) {}
        ~SetValueUndoableCommand() override {}


        virtual bool set(VALUE_TYPE v) = 0;
    };

    template <typename VALUE_TYPE>
    class UFE_SDK_DECL SetValue2UndoableCommand : public BaseUndoableCommand
    {
    public:
        typedef std::shared_ptr<SetValue2UndoableCommand> Ptr;
        typedef VALUE_TYPE ValueType;

        SetValue2UndoableCommand(const Path &path) : BaseUndoableCommand(path) {}
        ~SetValue2UndoableCommand() override {}


        virtual bool set(VALUE_TYPE x, VALUE_TYPE y) = 0;
    };

    template <typename VALUE_TYPE>
    class UFE_SDK_DECL SetValue3UndoableCommand : public BaseUndoableCommand
    {
    public:
        typedef std::shared_ptr<SetValue3UndoableCommand> Ptr;
        typedef VALUE_TYPE ValueType;

        SetValue3UndoableCommand(const Path &path) : BaseUndoableCommand(path) {}
        ~SetValue3UndoableCommand() override {}


        virtual bool set(VALUE_TYPE x, VALUE_TYPE y, VALUE_TYPE z) = 0;
    };

    template <typename VALUE_TYPE>
    class UFE_SDK_DECL SetValue4UndoableCommand : public BaseUndoableCommand
    {
    public:
        typedef std::shared_ptr<SetValue4UndoableCommand> Ptr;
        typedef VALUE_TYPE ValueType;

        SetValue4UndoableCommand(const Path &path) : BaseUndoableCommand(path) {}
        ~SetValue4UndoableCommand() override {}


        virtual bool set(VALUE_TYPE x, VALUE_TYPE y, VALUE_TYPE z, VALUE_TYPE w) = 0;
    };

    using SetFloatUndoableCommand = SetValueUndoableCommand<float>;
    using SetDoubleUndoableCommand = SetValueUndoableCommand<double>;
    using SetMatrix3dUndoableCommand = SetValueUndoableCommand<const Matrix3d &>;
    using SetMatrix4dUndoableCommand = SetValueUndoableCommand<const Matrix4d &>;
    using SetBoolUndoableCommand = SetValueUndoableCommand<bool>;
    using SetIntUndoableCommand = SetValueUndoableCommand<int>;
    using SetVector2fUndoableCommand = SetValue2UndoableCommand<float>;
    using SetVector3fUndoableCommand = SetValue3UndoableCommand<float>;
    using SetVector4fUndoableCommand = SetValue4UndoableCommand<float>;
    using SetVector3dUndoableCommand = SetValue3UndoableCommand<double>;
    using SetColor3fUndoableCommand = SetValueUndoableCommand<const Color3f &>;
    using SetColor4fUndoableCommand = SetValueUndoableCommand<const Color4f &>;
}

#endif /* _baseUndoableCommands */