vdrawtool.h

Go to the documentation of this file.

/**************************************************************************
 **
 **  @file   vdrawtool.h
 **  @author Roman Telezhynskyi <dismine(at)gmail.com>
 **  @date   November 15, 2013
 **
 **  @author Douglas S Caskey
 **  @date   7.23.2022
 **
 **  @brief
 **  @copyright
 **  This source code is part of the Valentine project, a pattern making
 **  program, whose allow create and modeling patterns of clothing.
 **  Copyright (C) 2013-2022 Seamly2D project
 **  <https://github.com/fashionfreedom/seamly2d> All Rights Reserved.
 **
 **  Seamly2D is free software: you can redistribute it and/or modify
 **  it under the terms of the GNU General Public License as published by
 **  the Free Software Foundation, either version 3 of the License, or
 **  (at your option) any later version.
 **
 **  Seamly2D is distributed in the hope that it will be useful,
 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 **  GNU General Public License for more details.
 **
 **  You should have received a copy of the GNU General Public License
 **  along with Seamly2D.  If not, see <http://www.gnu.org/licenses/>.
 **
 *************************************************************************/
#ifndef VDRAWTOOL_H
#define VDRAWTOOL_H
 
 
#include "../vinteractivetool.h"
#include "../ifc/exception/vexceptionbadid.h"
#include "../vdatatool.h"
#include "../vgeometry/vpointf.h"
#include "../vmisc/vabstractapplication.h"
#include "../vmisc/def.h"
#include "../vmisc/vabstractapplication.h"
#include "../vwidgets/vabstractmainwindow.h"
#include "../vwidgets/vmaingraphicsscene.h"
#include "../vwidgets/vmaingraphicsview.h"
#include "../vtools/undocommands/addgroup.h"
#include "../vtools/undocommands/add_groupitem.h"
#include "../vtools/undocommands/remove_groupitem.h"
 
#include <qcompilerdetection.h>
#include <QAction>
#include <QByteArray>
#include <QColor>
#include <QDomElement>
#include <QGraphicsSceneContextMenuEvent>
#include <QIcon>
#include <QMenu>
#include <QMetaObject>
#include <QObject>
#include <QString>
#include <QtGlobal>
 
template <class T> class QSharedPointer;
 
/**
 * @brief The VDrawTool abstract class for all draw tool.
 */
class VDrawTool : public VInteractiveTool
{
    Q_OBJECT
 
public:
                     VDrawTool(VAbstractPattern *doc, VContainer *data, quint32 id, QObject *parent = nullptr);
    virtual         ~VDrawTool() Q_DECL_EQ_DEFAULT;
 
    QString          getLineType() const;
    virtual void     setLineType(const QString &value);
 
    QString          getLineWeight() const;
    virtual void     setLineWeight(const QString &value);
 
    virtual bool     isPointNameVisible(quint32 id) const;
 
signals:
    void             ChangedToolSelection(bool selected, quint32 object, quint32 tool);
 
public slots:
    virtual void     ShowTool(quint32 id, bool enable);
    virtual void     activeBlockChanged(const QString &newName);
    void             blockNameChanged(const QString &oldName, const QString &newName);
    virtual void     EnableToolMove(bool move);
    virtual void     Disable(bool disable, const QString &draftBlockName)=0;
    virtual void     piecesMode(bool mode);
 
protected slots:
    virtual void     showContextMenu(QGraphicsSceneContextMenuEvent *event, quint32 id=NULL_ID)=0;
 
protected:
    enum class       RemoveOption : bool {Disable = false, Enable = true};
    enum class       Referens : bool {Follow = true, Ignore = false};
 
 
    QString          activeBlockName;   /** @brief activeBlockName name of tool's pattern peace. */
    QString          m_lineType;      /** @brief typeLine line type. */
    QString          m_lineWeight;    /** @brief typeLine line weight. */
 
    void             AddToCalculation(const QDomElement &domElement);
    void             addDependence(QList<quint32> &list, quint32 objectId) const;
 
    /** @brief SaveDialog save options into file after change in dialog. */
    virtual void     SaveDialog(QDomElement &domElement)=0;
    virtual void     SaveDialogChange() Q_DECL_FINAL;
    virtual void     AddToFile() Q_DECL_OVERRIDE;
    void             SaveOption(QSharedPointer<VGObject> &obj);
    virtual void     SaveOptions(QDomElement &tag, QSharedPointer<VGObject> &obj);
    virtual QString  makeToolTip() const;
 
    bool             CorrectDisable(bool disable, const QString &draftBlockName) const;
 
    void             ReadAttributes();
    virtual void     ReadToolAttributes(const QDomElement &domElement)=0;
    virtual void     updatePointNameVisibility(quint32 id, bool visible);
 
    template <typename Dialog>
    void             ContextMenu(QGraphicsSceneContextMenuEvent *event, quint32 itemId = NULL_ID,
                                 const RemoveOption &showRemove = RemoveOption::Enable,
                                 const Referens &ref = Referens::Follow);
 
    template <typename Item>
    void             ShowItem(Item *item, quint32 id, bool enable);
 
    template <typename T>
    QString          ObjectName(quint32 id) const;
 
    template <typename T>
    static void      InitDrawToolConnections(VMainGraphicsScene *scene, T *tool);
 
private:
    Q_DISABLE_COPY(VDrawTool)
};
 
//---------------------------------------------------------------------------------------------------------------------
template <typename Dialog>
/**
 * @brief ContextMenu show context menu for tool.
 * @param itemId id of point. 
 * @param event context menu event.
 * @param showRemove true - tool enable option delete.
 * @param ref true - do not ignore referens value.
 */
void VDrawTool::ContextMenu(QGraphicsSceneContextMenuEvent *event, quint32 itemId,
                            const RemoveOption &showRemove, const Referens &ref)
{
    SCASSERT(event != nullptr)
 
    if (m_suppressContextMenu)
    {
        return;
    }
 
    GOType itemType =  GOType::Unknown;
    if(itemId != NULL_ID)
    {
        try
        {
            itemType = data.GetGObject(itemId)->getType();
        }
        catch (const VExceptionBadId &e)
        { // Possible case. Parent was deleted, but the node object is still here.
            qWarning() << qUtf8Printable(e.ErrorMessage());
        }
    }
 
    qCDebug(vTool, "Creating tool context menu.");
    QMenu menu;
    QAction *actionOption = menu.addAction(QIcon::fromTheme("preferences-other"), tr("Properties"));
 
    // Show object name menu item
    QAction *actionShowPointName = menu.addAction(QIcon("://icon/16x16/open_eye.png"), tr("Show Point Name"));
    actionShowPointName->setCheckable(true);
 
    if (itemType == GOType::Point)
    {
        actionShowPointName->setChecked(isPointNameVisible(itemId));
    }
    else
    {
       actionShowPointName->setVisible(false);
    }
 
    QAction *actionDelete = menu.addAction(QIcon::fromTheme("edit-delete"), tr("Delete"));
    if (showRemove == RemoveOption::Enable)
    {
        if (ref == Referens::Follow)
        {
            if (_referens > 1)
            {
                qCDebug(vTool, "Delete disabled. Tool has children.");
                actionDelete->setEnabled(false);
            }
            else
            {
                qCDebug(vTool, "Delete enabled. Tool has no children.");
                actionDelete->setEnabled(true);
            }
        }
        else
        {
            qCDebug(vTool, "Delete enabled. Ignore referens value.");
            actionDelete->setEnabled(true);
        }
    }
    else
    {
        qCDebug(vTool, "Delete disabled.");
        actionDelete->setEnabled(false);
    }
 
    // Add Group Item menu item
    QMap<quint32,QString> groupsNotContainingItem =  doc->getGroupsContainingItem(this->getId(), itemId, false);
    QActionGroup* actionAddGroupMenu= new QActionGroup(this);
 
    if(not groupsNotContainingItem.empty())
    {
        QMenu *menuAddGroupItem = menu.addMenu(QIcon("://icon/32x32/add.png"), tr("Add Group Object"));
        QStringList list = QStringList(groupsNotContainingItem.values());
        list.sort(Qt::CaseInsensitive);
 
        for(int i=0; i<list.count(); ++i)
        {
            QAction *actionAddGroupItem = menuAddGroupItem->addAction(list[i]);
            actionAddGroupMenu->addAction(actionAddGroupItem);
            const quint32 groupId = groupsNotContainingItem.key(list[i]);
            actionAddGroupItem->setData(groupId);
            groupsNotContainingItem.remove(groupId);   // delete any duplicate groups
        }
    }
 
    // Remove Group Item menu item
    QMap<quint32,QString> groupsContainingItem =  doc->getGroupsContainingItem(this->getId(), itemId, true);
    QActionGroup* actionDeleteGroupMenu = new QActionGroup(this);
 
    if(not groupsContainingItem.empty())
    {
        QMenu *menuRemoveGroupItem = menu.addMenu(QIcon("://icon/32x32/remove.png"), tr("Remove Group Object"));
 
        QStringList list = QStringList(groupsContainingItem.values());
        list.sort(Qt::CaseInsensitive);
 
        for(int i=0; i<list.count(); ++i)
        {
            QAction *actionRemoveGroupItem = menuRemoveGroupItem->addAction(list[i]);
            actionDeleteGroupMenu->addAction(actionRemoveGroupItem);
            const quint32 groupId = groupsContainingItem.key(list[i]);
            actionRemoveGroupItem->setData(groupId);
            groupsContainingItem.remove(groupId);
        }
    }
 
    QAction *selectedAction = menu.exec(event->screenPos());
    if(selectedAction == nullptr)
    {
        return;
    }
    if (selectedAction == actionOption)
    {
        qCDebug(vTool, "Show options.");
        qApp->getSceneView()->itemClicked(nullptr);
        m_dialog = QSharedPointer<Dialog>(new Dialog(getData(), m_id, qApp->getMainWindow()));
        m_dialog->setModal(true);
 
        connect(m_dialog.data(), &DialogTool::DialogClosed, this, &VDrawTool::FullUpdateFromGuiOk);
        connect(m_dialog.data(), &DialogTool::DialogApplied, this, &VDrawTool::FullUpdateFromGuiApply);
 
        this->setDialog();
 
        m_dialog->show();
    }
    else if (selectedAction == actionDelete)
    {
        qCDebug(vTool, "Deleting Object.");
        deleteTool(); // do not catch exception here
        return; //Leave this method immediately after call!!!
    }
    else if (selectedAction == actionShowPointName)
    {
        updatePointNameVisibility(itemId, selectedAction->isChecked());
    }
    else if (selectedAction->actionGroup() == actionAddGroupMenu)
    {
        quint32 groupId = selectedAction->data().toUInt();
        QDomElement item = doc->addGroupItem(this->getId(), itemId, groupId);
 
        VMainGraphicsScene *scene = qobject_cast<VMainGraphicsScene *>(qApp->getCurrentScene());
        SCASSERT(scene != nullptr)
        scene->clearSelection();
 
        VAbstractMainWindow *window = qobject_cast<VAbstractMainWindow *>(qApp->getMainWindow());
        SCASSERT(window != nullptr)
        {
            AddGroupItem *command = new AddGroupItem(item, doc, groupId);
            connect(command, &AddGroupItem::updateGroups, window, &VAbstractMainWindow::updateGroups);
            qApp->getUndoStack()->push(command);
        }
    }
    else if (selectedAction->actionGroup() == actionDeleteGroupMenu)
    {
        quint32 groupId = selectedAction->data().toUInt();
        QDomElement item = doc->removeGroupItem(this->getId(), itemId, groupId);
 
        VMainGraphicsScene *scene = qobject_cast<VMainGraphicsScene *>(qApp->getCurrentScene());
        SCASSERT(scene != nullptr)
        scene->clearSelection();
 
        VAbstractMainWindow *window = qobject_cast<VAbstractMainWindow *>(qApp->getMainWindow());
        SCASSERT(window != nullptr)
        {
            RemoveGroupItem *command = new RemoveGroupItem(item, doc, groupId);
            connect(command, &RemoveGroupItem::updateGroups, window, &VAbstractMainWindow::updateGroups);
            qApp->getUndoStack()->push(command);
        }
    }
}
 
//---------------------------------------------------------------------------------------------------------------------
template <typename Item>
/**
 * @brief ShowItem highlight tool.
 * @param item tool.
 * @param id object id in container.
 * @param enable enable or disable highlight.
 */
void VDrawTool::ShowItem(Item *item, quint32 id, bool enable)
{
    SCASSERT(item != nullptr)
    if (id == item->m_id)
    {
        ShowVisualization(enable);
    }
}
 
//---------------------------------------------------------------------------------------------------------------------
template <typename T>
/**
 * @brief ObjectName get object (point, curve, arc) name.
 * @param id object id in container.
 */
QString VDrawTool::ObjectName(quint32 id) const
{
    try
    {
        return data.GeometricObject<T>(id)->name();
    }
    catch (const VExceptionBadId &e)
    {
        qCDebug(vTool, "Error! Couldn't get object name by id = %s. %s %s", qUtf8Printable(QString().setNum(id)),
                qUtf8Printable(e.ErrorMessage()),
                qUtf8Printable(e.DetailedInformation()));
        return QString("");// Return empty string for property browser
    }
}
 
//---------------------------------------------------------------------------------------------------------------------
template <typename T>
void VDrawTool::InitDrawToolConnections(VMainGraphicsScene *scene, T *tool)
{
    SCASSERT(scene != nullptr)
    SCASSERT(tool != nullptr)
 
    QObject::connect(tool, &T::chosenTool, scene, &VMainGraphicsScene::chosenItem);
    QObject::connect(tool, &T::ChangedToolSelection, scene, &VMainGraphicsScene::SelectedItem);
    QObject::connect(scene, &VMainGraphicsScene::DisableItem, tool, &T::Disable);
    QObject::connect(scene, &VMainGraphicsScene::EnableToolMove, tool, &T::EnableToolMove);
    QObject::connect(scene, &VMainGraphicsScene::curvePiecesMode, tool, &T::piecesMode);
    QObject::connect(scene, &VMainGraphicsScene::ItemSelection, tool, &T::ToolSelectionType);
}
 
#endif // VDRAWTOOL_H