#include <EllipseAssistant.h>

Inheritance diagram for EllipseAssistant:

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

	EllipseAssistant ()

QPointF	getDefaultEditorPosition () const override

bool	isAssistantComplete () const override

int	numHandles () const override

void	transform (const QTransform &transform) override

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

void	uncache ()

bool	useCustomColor ()

QPointF	viewportConstrainedEditorPosition (const KisCoordinatesConverter *converter, const QSize editorSize)

virtual	~KisPaintingAssistant ()

Protected Member Functions
QRect	boundingRect () const override

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
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
	EllipseAssistant (const EllipseAssistant &rhs, QMap< KisPaintingAssistantHandleSP, KisPaintingAssistantHandleSP > &handleMap)

QPointF	project (const QPointF &pt) const

Private Attributes
Ellipse	e

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 16 of file EllipseAssistant.h.

Constructor & Destructor Documentation

◆ EllipseAssistant() [1/2]

EllipseAssistant::EllipseAssistant ( )

Definition at line 24 of file EllipseAssistant.cc.

        : KisPaintingAssistant("ellipse", i18n("Ellipse assistant"))
{
}

◆ EllipseAssistant() [2/2]

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

explicitprivate

Definition at line 29 of file EllipseAssistant.cc.

    : KisPaintingAssistant(rhs, handleMap)
    , e(rhs.e)
{
}

Member Function Documentation

◆ adjustLine()

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

overridevirtual

Implements KisPaintingAssistant.

Definition at line 53 of file EllipseAssistant.cc.

{
    const QPointF p1 = point;
    const QPointF p2 = strokeBegin;
 
    Q_ASSERT(isAssistantComplete());
    e.set(*handles()[0], *handles()[1], *handles()[2]);
 
    QPointF p3 = e.project(p1);
    QPointF p4 = e.project(p2);
    point = p3;
    strokeBegin = p4;
}

References e, KisPaintingAssistant::handles(), isAssistantComplete(), p1, p2, p3, Ellipse::project(), and Ellipse::set().

◆ adjustPosition()

QPointF EllipseAssistant::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 47 of file EllipseAssistant.cc.

{
    return project(pt);
 
}

References project().

◆ boundingRect()

QRect EllipseAssistant::boundingRect ( ) const

overrideprotectedvirtual

Reimplemented from KisPaintingAssistant.

Definition at line 139 of file EllipseAssistant.cc.

{
    if (!isAssistantComplete()) {
        return KisPaintingAssistant::boundingRect();
    }
 
    if (e.set(*handles()[0], *handles()[1], *handles()[2])) {
        return e.boundingRect().adjusted(-2, -2, 2, 2).toAlignedRect();
    } else {
        return QRect();
    }
}

References KisPaintingAssistant::boundingRect(), Ellipse::boundingRect(), e, KisPaintingAssistant::handles(), isAssistantComplete(), and Ellipse::set().

◆ clone()

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

overridevirtual

Implements KisPaintingAssistant.

Definition at line 35 of file EllipseAssistant.cc.

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

References EllipseAssistant().

◆ drawAssistant()

void EllipseAssistant::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 67 of file EllipseAssistant.cc.

{
    gc.save();
    gc.resetTransform();
    QPoint mousePos;
    
    if (canvas){
        //simplest, cheapest way to get the mouse-position//
        mousePos= canvas->canvasWidget()->mapFromGlobal(QCursor::pos());
    }
    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 the ellipse assistant, you may have passed arguments incorrectly:"<<canvas;
    }
 
    QTransform initialTransform = converter->documentToWidgetTransform();
 
    if (isSnappingActive() && boundingRect().contains(initialTransform.inverted().map(mousePos), false) && previewVisible==true){
 
        if (isAssistantComplete()){
            if (e.set(*handles()[0], *handles()[1], *handles()[2])) {
                // valid ellipse
                gc.setTransform(initialTransform);
                gc.setTransform(e.getInverse(), true);
                QPainterPath path;
                //path.moveTo(QPointF(-e.semiMajor(), 0)); path.lineTo(QPointF(e.semiMajor(), 0));
                //path.moveTo(QPointF(0, -e.semiMinor())); path.lineTo(QPointF(0, e.semiMinor()));
                // Draw the ellipse
                path.addEllipse(QPointF(0, 0), e.semiMajor(), e.semiMinor());
                drawPreview(gc, path);
            }
        }
    }
    gc.restore();
    KisPaintingAssistant::drawAssistant(gc, updateRect, converter, cached, canvas, assistantVisible, previewVisible);
 
}

References boundingRect(), KisCanvas2::canvasWidget, dbgFile, KisCoordinatesConverter::documentToWidgetTransform(), KisPaintingAssistant::drawAssistant(), KisPaintingAssistant::drawPreview(), e, Ellipse::getInverse(), KisPaintingAssistant::handles(), isAssistantComplete(), KisPaintingAssistant::isSnappingActive(), Ellipse::semiMajor(), Ellipse::semiMinor(), and Ellipse::set().

◆ drawCache()

void EllipseAssistant::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 107 of file EllipseAssistant.cc.

{
 
    if (assistantVisible == false || handles().size() < 2){
        return;
    }
 
    QTransform initialTransform = converter->documentToWidgetTransform();
 
    if (handles().size() == 2) {
        // just draw the axis
        gc.setTransform(initialTransform);
        QPainterPath path;
        path.moveTo(*handles()[0]);
        path.lineTo(*handles()[1]);
        drawPath(gc, path, isSnappingActive());
        return;
    }
    if (e.set(*handles()[0], *handles()[1], *handles()[2])) {
        // valid ellipse
 
        gc.setTransform(initialTransform);
        gc.setTransform(e.getInverse(), true);
        QPainterPath path;
        path.moveTo(QPointF(-e.semiMajor(), 0)); path.lineTo(QPointF(e.semiMajor(), 0));
        path.moveTo(QPointF(0, -e.semiMinor())); path.lineTo(QPointF(0, e.semiMinor()));
        // Draw the ellipse
        path.addEllipse(QPointF(0, 0), e.semiMajor(), e.semiMinor());
        drawPath(gc, path, isSnappingActive());
    }
}

References KisCoordinatesConverter::documentToWidgetTransform(), KisPaintingAssistant::drawPath(), e, Ellipse::getInverse(), KisPaintingAssistant::handles(), KisPaintingAssistant::isSnappingActive(), Ellipse::semiMajor(), Ellipse::semiMinor(), and Ellipse::set().

◆ getDefaultEditorPosition()

QPointF EllipseAssistant::getDefaultEditorPosition ( ) const

overridevirtual

Implements KisPaintingAssistant.

Definition at line 152 of file EllipseAssistant.cc.

{
    return (*handles()[0] + *handles()[1]) * 0.5;
}

References KisPaintingAssistant::handles().

◆ isAssistantComplete()

bool EllipseAssistant::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 157 of file EllipseAssistant.cc.

{
    return handles().size() >= 3;
}

References KisPaintingAssistant::handles().

◆ numHandles()

int EllipseAssistant::numHandles ( ) const

inlineoverridevirtual

Implements KisPaintingAssistant.

Definition at line 24 of file EllipseAssistant.h.

24{ return 3; }

◆ project()

QPointF EllipseAssistant::project ( const QPointF & pt ) const

private

Definition at line 40 of file EllipseAssistant.cc.

{
    Q_ASSERT(isAssistantComplete());
    e.set(*handles()[0], *handles()[1], *handles()[2]);
    return e.project(pt);
}

References e, KisPaintingAssistant::handles(), isAssistantComplete(), Ellipse::project(), and Ellipse::set().

◆ transform()

void EllipseAssistant::transform ( const QTransform & transform )

overridevirtual

Transform the assistant using the given transform. Please note that transform should be in 'document' coordinate system. Used with image-wide transformations.

Reimplemented from KisPaintingAssistant.

Definition at line 162 of file EllipseAssistant.cc.

{
    e.set(*handles()[0], *handles()[1], *handles()[2]);
 
    QPointF newAxes;
    QTransform newTransform;
 
    std::tie(newAxes, newTransform) = KisAlgebra2D::transformEllipse(QPointF(e.semiMajor(), e.semiMinor()), e.getInverse() * transform);
 
    const QPointF p1 = newTransform.map(QPointF(newAxes.x(), 0));
    const QPointF p2 = newTransform.map(QPointF(-newAxes.x(), 0));
    const QPointF p3 = newTransform.map(QPointF(0, newAxes.y()));
 
    *handles()[0] = p1;
    *handles()[1] = p2;
    *handles()[2] = p3;
 
    uncache();
}

References e, Ellipse::getInverse(), KisPaintingAssistant::handles(), p1, p2, p3, Ellipse::semiMajor(), Ellipse::semiMinor(), Ellipse::set(), transform(), KisAlgebra2D::transformEllipse(), and KisPaintingAssistant::uncache().

Member Data Documentation

◆ e

Ellipse EllipseAssistant::e

mutableprivate

Definition at line 36 of file EllipseAssistant.h.

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

plugins/assistants/Assistants/EllipseAssistant.h
plugins/assistants/Assistants/EllipseAssistant.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EllipseAssistant() [1/2]

◆ EllipseAssistant() [2/2]

Member Function Documentation

◆ adjustLine()

◆ adjustPosition()

◆ boundingRect()

◆ clone()

◆ drawAssistant()

◆ drawCache()

◆ getDefaultEditorPosition()

◆ isAssistantComplete()

◆ numHandles()

◆ project()

◆ transform()

Member Data Documentation

◆ e