kis_assistant_tool.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2008 Cyrille Berger <cberger@cberger.net>
 * SPDX-FileCopyrightText: 2017 Scott Petrovic <scottpetrovic@gmail.com>
 *
 *  SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
#ifndef _KIS_ASSISTANT_TOOL_H_
#define _KIS_ASSISTANT_TOOL_H_
 
#include <QPointer>
 
#include <KoToolFactoryBase.h>
#include <KoIcon.h>
 
#include <kis_tool.h>
#include "kis_painting_assistant.h"
#include <kis_icon.h>
#include <kis_canvas2.h>
 
#include "ui_AssistantsToolOptions.h"
 
/* The assistant tool allows artists to create special guides on the canvas
 * to help them with things like perspective and parallel lines
 * This tool has its own canvas decoration on it that only appears when the tool
 * is active. This decoration allows people to edit assistant points as well as delete assistants
 * Many of the operations here are forwarded on to another class (kis_painting_assistant_decoration)
 * that stores the assistant information as well as the decoration information with lines
 *
 * Drawing in two separate classes creates an issue where the editor controls in this class
 * are covered by the kis_painting_assistant_decoration class. In the future, we probably need to
 * do all the drawing in one class so we have better control of what is in front
 */
class KisAssistantTool : public KisTool
{
    Q_OBJECT
    enum PerspectiveAssistantEditionMode {
        MODE_CREATION, // This is the mode when there is not yet a perspective grid
        MODE_EDITING, // This is the mode when the grid has been created, and we are waiting for the user to click on a control box
        MODE_DRAGGING_NODE, // In this mode one node is translated
        MODE_DRAGGING_TRANSLATING_TWONODES, // This mode is used when creating a new sub perspective grid
        MODE_DRAGGING_EDITOR_WIDGET // This mode is used when dragging/moving the little editor widget
    };
public:
    KisAssistantTool(KoCanvasBase * canvas);
    ~KisAssistantTool() override;
 
    virtual quint32 priority() {
        return 3;
    }
 
 
    /* this is a very big function that has to figure out if we are adding a new assistant,
     * or editing an existing one when we click on the canvas. There is also a lot of logic
     * in here that is specific to certain assistants and how they should be handled.
     * The editor widget is not a UI file, so the move, delete, preview areas have manual
     * hitbox regions specified to know if a click is doing any of those actions.
     */
    void beginPrimaryAction(KoPointerEvent *event) override;
 
    // We will need this to allow Shift-modifier to align to axes when making new assistants
    void beginAlternateAction(KoPointerEvent *event, KisTool::AlternateAction action) override;
 
    void continuePrimaryAction(KoPointerEvent *event) override;
    void endPrimaryAction(KoPointerEvent *event) override;
    void continueAlternateAction(KoPointerEvent *event, AlternateAction action) override;
    void endAlternateAction(KoPointerEvent *event, AlternateAction action) override;
    void mouseMoveEvent(KoPointerEvent *event) override;
    void keyPressEvent(QKeyEvent *event) override;
 
 
    QWidget *createOptionWidget() override;
 
private:
    // adds and removes assistant.
    // this is event is forwarded to the kis_painting_decoration class
    // perspective grids seem to be managed in two places with these calls
    void addAssistant();
    void removeAssistant(KisPaintingAssistantSP assistant);
 
    void assistantSelected(KisPaintingAssistantSP assistant);
 
    // Handles both shift+mouse-drag or shift+mouse-move snapping
    // Returns true if snapping is successful
    // This uses m_handleDrag or m_newAssistant to figure out what handle to snap and where
    bool snap(KoPointerEvent *event);
 
    //Recorded state for toggle panel for docker tool options visibility
    bool ToggleDockToolOptionsVisible = false;
    void beginActionImpl(KoPointerEvent *event);
    void continueActionImpl(KoPointerEvent *event);
    void endActionImpl(KoPointerEvent *event);
    //function to calculate new button positions for editor widget
    void updateEditorWidgetData();
public Q_SLOTS:
    void activate(const QSet<KoShape*> &shapes) override;
    void deactivate() override;
 
 
    void slotChangeVanishingPointAngle(double value);
    void slotChangeTwoPointDensity(double value);
    void slotChangeTwoPointUseVertical(int value);
    void slotChangeSubdivisions(int value);
    void slotChangeMinorSubdivisions(int value);
    void slotEnableFixedLength(int enabled);
    void slotChangeFixedLength(double value);
 
private Q_SLOTS:
    void removeAllAssistants();
    void saveAssistants();
    void loadAssistants();
    void updateToolOptionsUI();
 
    void slotGlobalAssistantsColorChanged(const QColor&);
    void slotGlobalAssistantOpacityChanged();
 
    void slotUpdateCustomColor();
    void slotCustomOpacityChanged();
    void slotLocalAssistantCheckboxChanged();
 
    void slotSelectedAssistantTypeChanged();
    void slotChangeFixedLengthUnit(int index);
 
    void slotToggleDockToolOptionsVisible();
 
    //When the user checks an editor widget button checkbox, update the AssistantEditorData
    //struct within the current document's KisPaintingAssistantsDecoration instance
    void slotToggleMoveButton(int index);
    void slotToggleSnapButton(int index);
    void slotToggleLockButton(int index);
    void slotToggleDuplicateButton(int index);
    void slotToggleDeleteButton(int index);
    
protected:
    void paint(QPainter& gc, const KoViewConverter &converter) override;
 
protected:
    QPointer<KisCanvas2> m_canvas;
 
    QList<KisPaintingAssistantHandleSP> m_handles;
    QList<KisPaintingAssistantHandleSP> m_sideHandles;
    KisPaintingAssistantHandleSP m_handleDrag;
    KisPaintingAssistantHandleSP m_handleCombine;
    KisPaintingAssistantHandleSP m_handleHover;
    KisPaintingAssistantSP m_assistantDrag;
 
    KisPaintingAssistantSP m_newAssistant;
 
    QPointF m_cursorStart;
    QPointF m_currentAdjustment;
    QPointF m_previousHandlePos;
    Ui::AssistantsToolOptions m_options;
    QWidget* m_optionsWidget {0};
    QPointF m_dragStart;
    QLineF m_radius;
    bool m_snapIsRadial {false};
    QPointF m_dragEnd;
    int m_handleSize {17}; // how large the editor handles will appear
    int m_handleMaxDist {81}; // how far away the user can click and still select a handle
    bool assistantDuplicatingFlag {false}; // this flag is set during an assistant duplication
 
private:
    void drawEditorWidget(KisPaintingAssistantSP assistant, QPainter& _gc);
    PerspectiveAssistantEditionMode m_internalMode { MODE_CREATION };
    KisPaintingAssistantHandleSP m_selectedNode1, m_selectedNode2, m_highlightedNode;
    int m_assistantHelperYOffset {10}; // used by the assistant editor icons for placement on the canvas.
    QList<KisPaintingAssistantSP> m_origAssistantList;
    KisSpinBoxUnitManager* m_unitManager {0};
};
 
 
class KisAssistantToolFactory : public KoToolFactoryBase
{
public:
    KisAssistantToolFactory()
            : KoToolFactoryBase("KisAssistantTool") {
        setToolTip(i18n("Assistant Tool"));
        setSection(ToolBoxSection::View);
        setIconName(koIconNameCStr("krita_tool_assistant"));
        setPriority(0);
        setActivationShapeId(KRITA_TOOL_ACTIVATION_ID);
    }
 
 
    ~KisAssistantToolFactory() override {}
 
    KoToolBase * createTool(KoCanvasBase * canvas) override {
        return new KisAssistantTool(canvas);
    }
 
};
 
 
#endif