DesignCommand.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Design
File: DesignCommand
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/UUID.h>
#include <NDEVR/Resource.h>
#include <NDEVR/Pointer.h>
#include <NDEVR/String.h>
#include <NDEVR/Time.h>
#include <NDEVR/InfoPipe.h>
#include <NDEVR/TranslatedString.h>
namespace NDEVR
{
 
    class RWLock; 
    class DesignObjectLookup; 

    class DesignCommand
    {
    public:
        NDEVR_DESIGN_API DesignCommand();
        NDEVR_DESIGN_API DesignCommand(const DesignCommand& command) = default;
        virtual ~DesignCommand(){};
        virtual void execute(DesignObjectLookup*) {};
        virtual bool canGroupWith(const DynamicPointer<DesignCommand>&) { return false; }
        virtual bool canCombineWith(const DynamicPointer<DesignCommand>&) { return false; };
        virtual bool isAsyncExecution() const { return false; };
        virtual bool addTarget(UUID) { return false; }
        NDEVR_DESIGN_API virtual void combineWith(const DynamicPointer<DesignCommand>& command);
        NDEVR_DESIGN_API void setUndoRedoID(UUID undo_redo_group);
        NDEVR_DESIGN_API UUID undoRedoID() const;
        virtual TranslatedString name() const = 0;
        virtual StringView icon() const = 0;
    public:
        LogPtr log; 
        Time time = Constant<Time>::Invalid; 
        UUID id; 
        bool has_executed = false; 
        bool is_undo = false; 
        bool can_undo = true; 
        bool update_project_modified = true; 
    protected:
        UUID m_undo_redo_group; 
    };

    class DesignCommandGroup : public DesignCommand
    {
    public:
        DesignCommandGroup()
        {}

        virtual ~DesignCommandGroup() {};
        NDEVR_DESIGN_API DesignCommandGroup(const TranslatedString& name, StringView icon = StringView());
        NDEVR_DESIGN_API DesignCommandGroup(std::initializer_list<DynamicPointer<DesignCommand>> l);
        NDEVR_DESIGN_API DesignCommandGroup(const Buffer<DynamicPointer<DesignCommand>>& buffer);
        NDEVR_DESIGN_API virtual TranslatedString name() const override;
        NDEVR_DESIGN_API virtual StringView icon() const override;
        NDEVR_DESIGN_API virtual void execute(DesignObjectLookup* lookup) override;
        template<class t_type>
        void add(const DynamicPointer<t_type>& val)
        {
            m_group.add(val.template as<DesignCommand>());
        }

        template<class t_type>
        void add(t_type&& val)
        {
            add(DynamicPointer<t_type>(std::move(val)));
        }

        NDEVR_DESIGN_API virtual bool addTarget(UUID id) override;
        NDEVR_DESIGN_API virtual bool isAsyncExecution() const override;
    private:
        TranslatedString m_name; 
        String m_icon; 
        Buffer<DynamicPointer<DesignCommand>> m_group; 
    };
}