DesignCommand.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
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/ProgressInfo.h>
namespace NDEVR
{
 
    class RWLock;
    class DesignObjectLookup;
 
    /**--------------------------------------------------------------------------------------------------
    \brief A command for safely modifying something in a DesignObjectLookup. Modifications will be done
        in a seperate thread from the UI and will be recorded for undo-redo. Most user modifications of
        data should occur via a DesignCommand.
    **/
    class NDEVR_DESIGN_API DesignCommand
    {
    public:
        DesignCommand();
        virtual ~DesignCommand(){};
        virtual void execute(DesignObjectLookup*) {};
        virtual bool canGroupWith(const DynamicPointer<DesignCommand>&) { return false; }
        virtual bool canCombineWith(const DynamicPointer<DesignCommand>& command) { return targets == command->targets; };
        virtual void combineWith(const DynamicPointer<DesignCommand>& command);
        virtual bool isAsyncExecution() const { return false; };
        void setUndoRedoID(UUID undo_redo_group);
        UUID undoRedoID() const;
        virtual TranslatedString name() const = 0;
        virtual String icon() const = 0;
    public:
        ProgressInfo* log = nullptr;
        Time time = Constant<Time>::Invalid;
        Buffer<UUID> targets;
        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;
    };
}