SplineAssistant Class Reference

#include <SplineAssistant.h>

Inheritance diagram for SplineAssistant:

Classes
struct	Private

Public Member Functions
void	adjustLine (QPointF &point, QPointF &strokeBegin) override
QPointF	adjustPosition (const QPointF &point, const QPointF &strokeBegin, const bool snapToAny, qreal moveThresholdPt) override
KisPaintingAssistantSP	clone (QMap< KisPaintingAssistantHandleSP, KisPaintingAssistantHandleSP > &handleMap) const override
QPointF	getDefaultEditorPosition () const override
bool	isAssistantComplete () const override
int	numHandles () const override
	SplineAssistant ()
Public Member Functions inherited from KisPaintingAssistant
void	addHandle (KisPaintingAssistantHandleSP handle, HandleType type)
bool	areTwoPointsClose (const QPointF &pointOne, const QPointF &pointTwo)
QColor	assistantCustomColor ()
KisPaintingAssistantHandleSP	bottomLeft ()
const KisPaintingAssistantHandleSP	bottomLeft () const
KisPaintingAssistantHandleSP	bottomMiddle ()
const KisPaintingAssistantHandleSP	bottomMiddle () const
KisPaintingAssistantHandleSP	bottomRight ()
const KisPaintingAssistantHandleSP	bottomRight () const
virtual bool	canBeLocal () const
	canBeLocal
KisPaintingAssistantHandleSP	closestCornerHandleFromPoint (QPointF point)
void	copySharedData (KisPaintingAssistantSP assistant)
void	drawError (QPainter &painter, const QPainterPath &path)
void	drawPath (QPainter &painter, const QPainterPath &path, bool drawActive=true)
void	drawPreview (QPainter &painter, const QPainterPath &path)
void	drawX (QPainter &painter, const QPointF &pt)
QPointF	editorWidgetOffset ()
QColor	effectiveAssistantColor () const
virtual void	endStroke ()
void	findPerspectiveAssistantHandleLocation ()
virtual QPointF	getEditorPosition () const
QList< KisPaintingAssistantHandleSP >	handles ()
const QList< KisPaintingAssistantHandleSP > &	handles () const
const QString &	id () const
bool	isDuplicating ()
	isDuplicating
bool	isLocal () const
	isLocal
bool	isLocked ()
	isLocked
bool	isSnappingActive () const
	KisPaintingAssistant (const QString &id, const QString &name)
KisPaintingAssistantHandleSP	leftMiddle ()
const KisPaintingAssistantHandleSP	leftMiddle () const
virtual bool	loadCustomXml (QXmlStreamReader *xml)
void	loadXml (KoStore *store, QMap< int, KisPaintingAssistantHandleSP > &handleMap, QString path)
const QString &	name () const
KisPaintingAssistantHandleSP	oppHandleOne ()
void	replaceHandle (KisPaintingAssistantHandleSP _handle, KisPaintingAssistantHandleSP _with)
KisPaintingAssistantHandleSP	rightMiddle ()
const KisPaintingAssistantHandleSP	rightMiddle () const
virtual void	saveCustomXml (QXmlStreamWriter *xml)
QByteArray	saveXml (QMap< KisPaintingAssistantHandleSP, int > &handleMap)
void	saveXmlList (QDomDocument &doc, QDomElement &assistantsElement, int count)
virtual void	setAdjustedBrushPosition (const QPointF position)
void	setAssistantCustomColor (QColor color)
void	setAssistantGlobalColorCache (const QColor &color)
void	setDecorationThickness (int thickness)
void	setDuplicating (bool value)
	setDuplicating
void	setEditorWidgetOffset (QPointF offset)
virtual void	setFollowBrushPosition (bool follow)
void	setLocal (bool value)
	setLocal
void	setLocked (bool value)
	setLocked
void	setSnappingActive (bool set)
void	setUseCustomColor (bool useCustomColor)
QList< KisPaintingAssistantHandleSP >	sideHandles ()
const QList< KisPaintingAssistantHandleSP > &	sideHandles () const
KisPaintingAssistantHandleSP	topLeft ()
const KisPaintingAssistantHandleSP	topLeft () const
KisPaintingAssistantHandleSP	topMiddle ()
const KisPaintingAssistantHandleSP	topMiddle () const
KisPaintingAssistantHandleSP	topRight ()
const KisPaintingAssistantHandleSP	topRight () const
virtual void	transform (const QTransform &transform)
void	uncache ()
bool	useCustomColor ()
QPointF	viewportConstrainedEditorPosition (const KisCoordinatesConverter *converter, const QSize editorSize)
virtual	~KisPaintingAssistant ()

Protected Member Functions
void	drawAssistant (QPainter &gc, const QRectF &updateRect, const KisCoordinatesConverter *converter, bool cached, KisCanvas2 *canvas, bool assistantVisible=true, bool previewVisible=true) override
void	drawCache (QPainter &gc, const KisCoordinatesConverter *converter, bool assistantVisible=true) override
	performance layer where the graphics can be drawn from a cache instead of generated every render update
Protected Member Functions inherited from KisPaintingAssistant
virtual QRect	boundingRect () const
QPointF	effectiveBrushPosition (const KisCoordinatesConverter *converter, KisCanvas2 *canvas) const
	Query the effective brush position to be used for preview lines. This is intended to be used for painting the dynamic preview lines for assistants that feature them. Affected by setAdjustedBrushPosition() and setFollowBrushPosition().
virtual KisPaintingAssistantHandleSP	firstLocalHandle () const
	firstLocalHandle Note: this doesn't guarantee it will be the topleft corner! For that, use getLocalRect().topLeft() The only purpose of those functions to exist is to be able to put getLocalRect() function in the KisPaintingAssistant instead of reimplementing it in every specific assistant.
QRectF	getLocalRect () const
	getLocalRect The function deals with local handles not being topLeft and bottomRight gracefully and returns a correct rectangle. Thanks to that the user can place handles in a "wrong" order or move them around but the local rectangle will still be correct.
void	initHandles (QList< KisPaintingAssistantHandleSP > _handles)
	KisPaintingAssistant (const KisPaintingAssistant &rhs, QMap< KisPaintingAssistantHandleSP, KisPaintingAssistantHandleSP > &handleMap)
QPointF	pixelToView (const QPoint pixelCoords) const
virtual KisPaintingAssistantHandleSP	secondLocalHandle () const
	secondLocalHandle Note: this doesn't guarantee it will be the bottomRight corner! For that, use getLocalRect().bottomRight() (and remember that for QRect bottomRight() works differently than for QRectF, so don't convert to QRect before accessing the corner)

Private Member Functions
QPointF	project (const QPointF &pt, const QPointF &strokeBegin) const
	SplineAssistant (const SplineAssistant &rhs, QMap< KisPaintingAssistantHandleSP, KisPaintingAssistantHandleSP > &handleMap)

Private Attributes
KisCanvas2 *	m_canvas {nullptr}
	used for getting the decoration so the bezier handles aren't drawn while editing
const QScopedPointer< Private >	m_d

Additional Inherited Members
Static Public Member Functions inherited from KisPaintingAssistant
static QList< KisPaintingAssistantSP >	cloneAssistantList (const QList< KisPaintingAssistantSP > &list)
static double	norm2 (const QPointF &p)
Protected Attributes inherited from KisPaintingAssistant
QList< KisPaintingAssistantHandleSP >	m_handles
bool	m_hasBeenInsideLocalRect {false}

Detailed Description

Definition at line 15 of file SplineAssistant.h.

Constructor & Destructor Documentation

SplineAssistant() [1/2]

SplineAssistant::SplineAssistant

(

)

Definition at line 74 of file SplineAssistant.cc.

    : KisPaintingAssistant("spline", i18n("Spline assistant"))
    , m_d(new Private)
{
}

SplineAssistant() [2/2]

SplineAssistant::SplineAssistant ( const SplineAssistant & rhs, QMap< KisPaintingAssistantHandleSP, KisPaintingAssistantHandleSP > & handleMap )

explicitprivate

Definition at line 80 of file SplineAssistant.cc.

    : KisPaintingAssistant(rhs, handleMap)
    , m_canvas(rhs.m_canvas)
    , m_d(new Private)
{
}

Member Function Documentation

adjustLine()

void SplineAssistant::adjustLine ( QPointF & point, QPointF & strokeBegin )

overridevirtual

Implements KisPaintingAssistant.

Definition at line 215 of file SplineAssistant.cc.

{
    point = QPointF();
    strokeBegin = QPointF();
}

adjustPosition()

QPointF SplineAssistant::adjustPosition ( const QPointF & point, const QPointF & strokeBegin, const bool snapToAny, qreal moveThresholdPt )

overridevirtual

Adjust the position given in parameter.

Parameters

point	the coordinates in point in the document reference
strokeBegin	the coordinates of the beginning of the stroke
snapToAny	because now assistants can be composited out of multiple inside assistants. snapToAny true means that you can use any of the inside assistant, while it being false means you should use the last used one. The logic determining when it happens (first stroke etc.) is in the decoration, so those two options are enough.
moveThresholdPt	the threshold for the "move" of the cursor measured in pt (usually equals to 2px in screen coordinates converted to pt)

Implements KisPaintingAssistant.

Definition at line 210 of file SplineAssistant.cc.

{
    return project(pt, strokeBegin);
}

References project().

clone()

KisPaintingAssistantSP SplineAssistant::clone ( QMap< KisPaintingAssistantHandleSP, KisPaintingAssistantHandleSP > & handleMap ) const

overridevirtual

Implements KisPaintingAssistant.

Definition at line 87 of file SplineAssistant.cc.

{
    return KisPaintingAssistantSP(new SplineAssistant(*this, handleMap));
}

References SplineAssistant().

drawAssistant()

void SplineAssistant::drawAssistant ( QPainter & gc, const QRectF & updateRect, const KisCoordinatesConverter * converter, bool cached, KisCanvas2 * canvas, bool assistantVisible = true, bool previewVisible = true )

overrideprotectedvirtual

Reimplemented from KisPaintingAssistant.

Definition at line 221 of file SplineAssistant.cc.

{
    gc.save();
    gc.resetTransform();
    QPoint mousePos;
    
    if (canvas){
        //simplest, cheapest way to get the mouse-position//
        mousePos= canvas->canvasWidget()->mapFromGlobal(QCursor::pos());
        m_canvas = canvas;
    }
    else {
        //...of course, you need to have access to a canvas-widget for that.//
        mousePos = QCursor::pos();//this'll give an offset//
        dbgFile<<"canvas does not exist in spline, you may have passed arguments incorrectly:"<<canvas;
    }
    
 
    if (handles().size() > 1) {
 
        QTransform initialTransform = converter->documentToWidgetTransform();
 
        // first we find the path that our point create.
        QPointF pts[4];
        pts[0] = *handles()[0];
        pts[1] = *handles()[1];
        pts[2] = (handles().size() >= 3) ? (*handles()[2]) : (*handles()[0]);
        pts[3] = (handles().size() >= 4) ? (*handles()[3]) : (handles().size() >= 3) ? (*handles()[2]) : (*handles()[1]);
        gc.setTransform(initialTransform);
 
        // Draw the spline
        QPainterPath path;
        path.moveTo(pts[0]);
        path.cubicTo(pts[2], pts[3], pts[1]);
        
        //then we use this path to check the bounding rectangle//
        if (isSnappingActive() && path.boundingRect().contains(initialTransform.inverted().map(mousePos)) && previewVisible==true){
            drawPreview(gc, path);//and we draw the preview.
        }
    }
    gc.restore();
 
   // there is some odd rectangle that is getting rendered when there is only one point, so don't start rendering the line until after 2
   // this issue only exists with this spline assistant...none of the others
   if (handles().size() > 2) {
      KisPaintingAssistant::drawAssistant(gc, updateRect, converter, cached, canvas, assistantVisible, previewVisible);
   }
}

References KisCanvas2::canvasWidget, dbgFile, KisCoordinatesConverter::documentToWidgetTransform(), KisPaintingAssistant::drawAssistant(), KisPaintingAssistant::drawPreview(), KisPaintingAssistant::handles(), KisPaintingAssistant::isSnappingActive(), and m_canvas.

drawCache()

void SplineAssistant::drawCache ( QPainter & gc, const KisCoordinatesConverter * converter, bool assistantVisible = true )

overrideprotectedvirtual

performance layer where the graphics can be drawn from a cache instead of generated every render update

Implements KisPaintingAssistant.

Definition at line 270 of file SplineAssistant.cc.

{
    if (assistantVisible == false || handles().size() < 2 ){
        return;
    }
 
    QTransform initialTransform = converter->documentToWidgetTransform();
 
    QPointF pts[4];
    pts[0] = *handles()[0];
    pts[1] = *handles()[1];
    pts[2] = (handles().size() >= 3) ? (*handles()[2]) : (*handles()[0]);
    pts[3] = (handles().size() >= 4) ? (*handles()[3]) : (handles().size() >= 3) ? (*handles()[2]) : (*handles()[1]);
 
    gc.setTransform(initialTransform);
 
 
    {  // Draw bezier handles control lines only if we are editing the assistant
        gc.save();
        QColor assistantColor = effectiveAssistantColor();
        QPen bezierlinePen(assistantColor);
        bezierlinePen.setStyle(Qt::DotLine);
        bezierlinePen.setWidth(2);
 
        if (m_canvas->paintingAssistantsDecoration()->isEditingAssistants()) {
 
            if (!isSnappingActive()) {
                QColor snappingColor = assistantColor;
                snappingColor.setAlpha(snappingColor.alpha() * 0.2);
 
                bezierlinePen.setColor(snappingColor);
            }
            bezierlinePen.setCosmetic(true);
 
            gc.setPen(bezierlinePen);
            gc.drawLine(pts[0], pts[2]);
 
            if (isAssistantComplete()) {
                gc.drawLine(pts[1], pts[3]);
            }
            gc.setPen(QColor(0, 0, 0, 125));
        }
        gc.restore();
    }
 
 
    // Draw the spline
    QPainterPath path;
    path.moveTo(pts[0]);
    path.cubicTo(pts[2], pts[3], pts[1]);
    drawPath(gc, path, isSnappingActive());
 
 
}

References KisCoordinatesConverter::documentToWidgetTransform(), KisPaintingAssistant::drawPath(), KisPaintingAssistant::effectiveAssistantColor(), KisPaintingAssistant::handles(), isAssistantComplete(), KisPaintingAssistantsDecoration::isEditingAssistants(), KisPaintingAssistant::isSnappingActive(), m_canvas, and KisCanvas2::paintingAssistantsDecoration().

getDefaultEditorPosition()

QPointF SplineAssistant::getDefaultEditorPosition ( ) const

overridevirtual

Implements KisPaintingAssistant.

Definition at line 325 of file SplineAssistant.cc.

{
    return B(0.5, *handles()[0], *handles()[2], *handles()[3], *handles()[1]);
}

References B, and KisPaintingAssistant::handles().

isAssistantComplete()

bool SplineAssistant::isAssistantComplete ( ) const

overridevirtual

determines if the assistant has enough handles to be considered created new assistants get in a "creation" phase where they are currently being made on the canvas it will return false if we are in the middle of creating the assistant.

Reimplemented from KisPaintingAssistant.

Definition at line 330 of file SplineAssistant.cc.

{
    return handles().size() >= 4; // specify 4 corners to make assistant complete
}

References KisPaintingAssistant::handles().

numHandles()

int SplineAssistant::numHandles ( ) const

inlineoverridevirtual

Implements KisPaintingAssistant.

Definition at line 23 of file SplineAssistant.h.

{ return 4; }

project()

QPointF SplineAssistant::project ( const QPointF & pt, const QPointF & strokeBegin ) const

private

Definition at line 176 of file SplineAssistant.cc.

{
    Q_ASSERT(isAssistantComplete());
 
    // minimize d(t), but keep t in the same neighbourhood as before (unless starting a new stroke)
    bool stayClose = (m_d->prevStrokebegin == strokeBegin)? true : false;
    qreal min_t;
 
    QList<QPointF> refs;
    QVector<int> hindex = {0,2,3,1}; // order handles as expected by KisBezierUtils
    Q_FOREACH(int i, hindex) {
        refs.append(*handles()[i]);
    }
 
    if (stayClose){
        // Search in the vicinity of previous t value.
        // This ensure unimodality for proper goldenSearch algorithm
        qreal delta = 1/10.0;
        qreal lbound = qBound(0.0,1.0, m_d->prev_t - delta);
        qreal ubound = qBound(0.0,1.0, m_d->prev_t + delta);
        min_t = goldenSearch(pt,handles(), lbound , ubound, 1e-6,1e+2);
 
    } else {
        min_t = KisBezierUtils::nearestPoint(refs,pt);
    }
 
    QPointF draw_pos = B(min_t, *handles()[0], *handles()[2], *handles()[3], *handles()[1]);
 
    m_d->prev_t = min_t;
    m_d->prevStrokebegin = strokeBegin;
 
    return draw_pos;
}

References B, goldenSearch(), KisPaintingAssistant::handles(), isAssistantComplete(), m_d, and KisBezierUtils::nearestPoint().

Member Data Documentation

m_canvas

KisCanvas2* SplineAssistant::m_canvas {nullptr}

private

used for getting the decoration so the bezier handles aren't drawn while editing

Definition at line 34 of file SplineAssistant.h.

{nullptr};

m_d

const QScopedPointer<Private> SplineAssistant::m_d

private

Definition at line 38 of file SplineAssistant.h.

---

The documentation for this class was generated from the following files:

• plugins/assistants/Assistants/SplineAssistant.h
• plugins/assistants/Assistants/SplineAssistant.cc