#include <FisheyePointAssistant.h>

Inheritance diagram for FisheyePointAssistant:

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

	FisheyePointAssistant ()

QPointF	getDefaultEditorPosition () const override

bool	isAssistantComplete () const override

int	numHandles () const 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

virtual void	transform (const QTransform &transform)

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=true, KisCanvas2 canvas=0, 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
	FisheyePointAssistant (const FisheyePointAssistant &rhs, QMap< KisPaintingAssistantHandleSP, KisPaintingAssistantHandleSP > &handleMap)

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

Private Attributes
Ellipse	e

Ellipse	extraE

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 19 of file FisheyePointAssistant.h.

Constructor & Destructor Documentation

◆ FisheyePointAssistant() [1/2]

FisheyePointAssistant::FisheyePointAssistant ( )

Definition at line 27 of file FisheyePointAssistant.cc.

    : KisPaintingAssistant("fisheye-point", i18n("Fish Eye Point assistant"))
{
}

◆ FisheyePointAssistant() [2/2]

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

explicitprivate

Definition at line 32 of file FisheyePointAssistant.cc.

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

Member Function Documentation

◆ adjustLine()

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

overridevirtual

Implements KisPaintingAssistant.

Definition at line 74 of file FisheyePointAssistant.cc.

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

◆ adjustPosition()

QPointF FisheyePointAssistant::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 69 of file FisheyePointAssistant.cc.

{
    return project(pt, strokeBegin);
}

References project().

◆ boundingRect()

QRect FisheyePointAssistant::boundingRect ( ) const

overrideprotectedvirtual

Reimplemented from KisPaintingAssistant.

Definition at line 169 of file FisheyePointAssistant.cc.

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

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

◆ clone()

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

overridevirtual

Implements KisPaintingAssistant.

Definition at line 39 of file FisheyePointAssistant.cc.

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

References FisheyePointAssistant().

◆ drawAssistant()

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

overrideprotectedvirtual

Reimplemented from KisPaintingAssistant.

Definition at line 80 of file FisheyePointAssistant.cc.

{
    gc.save();
    gc.resetTransform();
 
    if (isSnappingActive() && previewVisible == true ) {
 
        if (isAssistantComplete()){
 
            QTransform initialTransform = converter->documentToWidgetTransform();
 
            if (e.set(*handles()[0], *handles()[1], *handles()[2])) {
                QPointF mousePos = effectiveBrushPosition(converter, canvas);
                if (extraE.set(*handles()[0], *handles()[1], initialTransform.inverted().map(mousePos))){
                    gc.setTransform(initialTransform);
                    gc.setTransform(e.getInverse(), true);
                    QPainterPath path;
                    // Draw the ellipse
                    path.addEllipse(QPointF(0, 0), extraE.semiMajor(), extraE.semiMinor());
                    drawPreview(gc, path);
                }
                QLineF radius(*handles()[1], *handles()[0]);
                radius.setAngle(fmod(radius.angle()+180.0,360.0));
                if (extraE.set(radius.p1(), radius.p2(), initialTransform.inverted().map(mousePos))){
                    gc.setTransform(initialTransform);
                    gc.setTransform(extraE.getInverse(), true);
                    QPainterPath path;
                    // Draw the ellipse
                    path.addEllipse(QPointF(0, 0), extraE.semiMajor(), extraE.semiMinor());
                    drawPreview(gc, path);
                }
                QLineF radius2(*handles()[0], *handles()[1]);
                radius2.setAngle(fmod(radius2.angle()+180.0,360.0));
                if (extraE.set(radius2.p1(), radius2.p2(), initialTransform.inverted().map(mousePos))){
                    gc.setTransform(initialTransform);
                    gc.setTransform(extraE.getInverse(), true);
                    QPainterPath path;
                    // Draw the ellipse
                    path.addEllipse(QPointF(0, 0), extraE.semiMajor(), extraE.semiMinor());
                    drawPreview(gc, path);
                }
 
            }
        }
    }
    gc.restore();
 
    KisPaintingAssistant::drawAssistant(gc, updateRect, converter, cached, canvas, assistantVisible, previewVisible);
 
}

References KisCoordinatesConverter::documentToWidgetTransform(), KisPaintingAssistant::drawAssistant(), KisPaintingAssistant::drawPreview(), e, KisPaintingAssistant::effectiveBrushPosition(), extraE, Ellipse::getInverse(), KisPaintingAssistant::handles(), isAssistantComplete(), KisPaintingAssistant::isSnappingActive(), Ellipse::semiMajor(), Ellipse::semiMinor(), and Ellipse::set().

◆ drawCache()

void FisheyePointAssistant::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 131 of file FisheyePointAssistant.cc.

{
    if (assistantVisible == false){
        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(), -e.semiMinor())); path.lineTo(QPointF(e.semiMajor(), -e.semiMinor()));
        path.moveTo(QPointF(-e.semiMajor(), -e.semiMinor())); path.lineTo(QPointF(-e.semiMajor(), e.semiMinor()));
        //path.moveTo(QPointF(-e.semiMajor(), e.semiMinor())); path.lineTo(QPointF(e.semiMajor(), e.semiMinor()));
        path.moveTo(QPointF(e.semiMajor(), -e.semiMinor())); path.lineTo(QPointF(e.semiMajor(), e.semiMinor()));
        path.moveTo(QPointF(-(e.semiMajor()*3), -e.semiMinor())); path.lineTo(QPointF(-(e.semiMajor()*3), e.semiMinor()));
        path.moveTo(QPointF((e.semiMajor()*3), -e.semiMinor())); path.lineTo(QPointF((e.semiMajor()*3), e.semiMinor()));
        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 FisheyePointAssistant::getDefaultEditorPosition ( ) const

overridevirtual

Implements KisPaintingAssistant.

Definition at line 182 of file FisheyePointAssistant.cc.

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

References KisPaintingAssistant::handles().

◆ isAssistantComplete()

bool FisheyePointAssistant::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 187 of file FisheyePointAssistant.cc.

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

References KisPaintingAssistant::handles().

◆ numHandles()

int FisheyePointAssistant::numHandles ( ) const

inlineoverridevirtual

Implements KisPaintingAssistant.

Definition at line 29 of file FisheyePointAssistant.h.

29{ return 3; }

◆ project()

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

private

Definition at line 44 of file FisheyePointAssistant.cc.

{
    const static QPointF nullPoint(std::numeric_limits<qreal>::quiet_NaN(), std::numeric_limits<qreal>::quiet_NaN());
    Q_ASSERT(isAssistantComplete());
    e.set(*handles()[0], *handles()[1], *handles()[2]);
 
    //set the extrapolation ellipse.
    if (e.set(*handles()[0], *handles()[1], *handles()[2])){
        QLineF radius(*handles()[1], *handles()[0]);
        radius.setAngle(fmod(radius.angle()+180.0,360.0));
        QLineF radius2(*handles()[0], *handles()[1]);
        radius2.setAngle(fmod(radius2.angle()+180.0,360.0));
        if ( extraE.set(*handles()[0], *handles()[1],strokeBegin ) ) {
            return extraE.project(pt);
        } else if (extraE.set(radius.p1(), radius.p2(),strokeBegin)) {
            return extraE.project(pt);
        } else if (extraE.set(radius2.p1(), radius2.p2(),strokeBegin)){
            return extraE.project(pt);
        }
    }
 
    return nullPoint;
 
}

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

Member Data Documentation

◆ e

Ellipse FisheyePointAssistant::e

mutableprivate

Definition at line 40 of file FisheyePointAssistant.h.

◆ extraE

Ellipse FisheyePointAssistant::extraE

mutableprivate

Definition at line 41 of file FisheyePointAssistant.h.

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

plugins/assistants/Assistants/FisheyePointAssistant.h
plugins/assistants/Assistants/FisheyePointAssistant.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FisheyePointAssistant() [1/2]

◆ FisheyePointAssistant() [2/2]

Member Function Documentation

◆ adjustLine()

◆ adjustPosition()

◆ boundingRect()

◆ clone()

◆ drawAssistant()

◆ drawCache()

◆ getDefaultEditorPosition()

◆ isAssistantComplete()

◆ numHandles()

◆ project()

Member Data Documentation

◆ e

◆ extraE