#include <PerspectiveEllipseAssistant.h>

Inheritance diagram for PerspectiveEllipseAssistant:

Classes
class	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

bool	contains (const QPointF &point) const override

qreal	distance (const QPointF &point) const override

QPointF	getDefaultEditorPosition () const override

bool	isActive () const override

bool	isAssistantComplete () const override

int	numHandles () const override

	PerspectiveEllipseAssistant (QObject *parent=0)

	~PerspectiveEllipseAssistant ()

Public Member Functions inherited from KisAbstractPerspectiveGrid
	KisAbstractPerspectiveGrid (QObject *parent=0)

	~KisAbstractPerspectiveGrid () 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, 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
bool	getTransform (QPolygonF &polyOut, QTransform &transformOut)

bool	isEllipseValid ()

	PerspectiveEllipseAssistant (const PerspectiveEllipseAssistant &rhs, QMap< KisPaintingAssistantHandleSP, KisPaintingAssistantHandleSP > &handleMap)

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

void	updateCache ()

Private Attributes
QScopedPointer< Private >	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 13 of file PerspectiveEllipseAssistant.h.

Constructor & Destructor Documentation

◆ PerspectiveEllipseAssistant() [1/2]

PerspectiveEllipseAssistant::PerspectiveEllipseAssistant ( QObject * parent = 0 )

Definition at line 330 of file PerspectiveEllipseAssistant.cc.

    : KisAbstractPerspectiveGrid(parent)
    , KisPaintingAssistant("perspective ellipse", i18n("Perspective Ellipse assistant"))
    , d(new Private())
{
 
}

◆ ~PerspectiveEllipseAssistant()

PerspectiveEllipseAssistant::~PerspectiveEllipseAssistant ( )

Definition at line 338 of file PerspectiveEllipseAssistant.cc.

338{}

◆ PerspectiveEllipseAssistant() [2/2]

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

explicitprivate

Definition at line 340 of file PerspectiveEllipseAssistant.cc.

    : KisAbstractPerspectiveGrid(rhs.parent())
    , KisPaintingAssistant(rhs, handleMap)
    , d(new Private())
{
    updateCache();
}

References updateCache().

Member Function Documentation

◆ adjustLine()

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

overridevirtual

Implements KisPaintingAssistant.

Definition at line 368 of file PerspectiveEllipseAssistant.cc.

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

◆ adjustPosition()

QPointF PerspectiveEllipseAssistant::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 363 of file PerspectiveEllipseAssistant.cc.

{
    return project(pt, strokeBegin);
}

References project().

◆ boundingRect()

QRect PerspectiveEllipseAssistant::boundingRect ( ) const

overrideprotectedvirtual

Reimplemented from KisPaintingAssistant.

Definition at line 521 of file PerspectiveEllipseAssistant.cc.

{
     if (!isAssistantComplete()) {
       return KisPaintingAssistant::boundingRect();
    }
 
    if (d->ellipseInPolygon.setSimpleEllipseVertices(d->simpleEllipse)) {
       return d->simpleEllipse.boundingRect().adjusted(-2, -2, 2, 2).toAlignedRect();
    } else {
       return QRect();
    }
}

References KisPaintingAssistant::boundingRect(), d, and isAssistantComplete().

◆ clone()

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

overridevirtual

Implements KisPaintingAssistant.

Definition at line 348 of file PerspectiveEllipseAssistant.cc.

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

References PerspectiveEllipseAssistant().

◆ contains()

bool PerspectiveEllipseAssistant::contains ( const QPointF & point ) const

overridevirtual

Implements KisAbstractPerspectiveGrid.

Definition at line 597 of file PerspectiveEllipseAssistant.cc.

{
 
    QPolygonF poly;
    if (!PerspectiveBasedAssistantHelper::getTetragon(handles(), isAssistantComplete(), poly)) return false;
    return poly.containsPoint(point, Qt::OddEvenFill);
}

References PerspectiveBasedAssistantHelper::getTetragon(), KisPaintingAssistant::handles(), and isAssistantComplete().

◆ distance()

qreal PerspectiveEllipseAssistant::distance ( const QPointF & pt ) const

overridevirtual

Returns the reciprocal of the distance from the given point to the 'observer', in the range [0, 1] where 0 = infinite distance and 1 = closest.

Implements KisAbstractPerspectiveGrid.

Definition at line 605 of file PerspectiveEllipseAssistant.cc.

{
    KIS_SAFE_ASSERT_RECOVER_NOOP(d->cacheValid);
    return PerspectiveBasedAssistantHelper::distanceInGrid(d->cache, point);
}

References d, PerspectiveBasedAssistantHelper::distanceInGrid(), and KIS_SAFE_ASSERT_RECOVER_NOOP.

◆ drawAssistant()

void PerspectiveEllipseAssistant::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 374 of file PerspectiveEllipseAssistant.cc.

{
    gc.save();
    gc.resetTransform();
 
    bool isEditing = false;
    
    if (canvas) {
        isEditing = canvas->paintingAssistantsDecoration()->isEditingAssistants();
    }
    
    QTransform initialTransform = converter->documentToWidgetTransform();
 
    // need to update ellipse cache
    updateCache();
 
    QPolygonF poly = d->ellipseInPolygon.polygon;
    QTransform transform = d->ellipseInPolygon.originalTransform; // unused, but computed for caching purposes
 
 
    if (isEllipseValid() && assistantVisible==true) {
        // draw vanishing points
        if (d->cache.vanishingPoint1) {
            drawX(gc, initialTransform.map(d->cache.vanishingPoint1.get()));
        }
        if (d->cache.vanishingPoint2) {
            drawX(gc, initialTransform.map(d->cache.vanishingPoint2.get()));
        }
    }
 
    // draw ellipse and axes
    if (isEllipseValid() && (assistantVisible || previewVisible || isEditing)) { // ensure that you only draw the ellipse if it's valid - otherwise it would just show some outdated one
        QPointF mousePos = effectiveBrushPosition(converter, canvas);
        gc.setTransform(initialTransform);
        gc.setTransform(d->simpleEllipse.getTransform().inverted(), true);
 
        QPainterPath path;
        path.addEllipse(QPointF(0.0, 0.0), d->simpleEllipse.semiMajor(), d->simpleEllipse.semiMinor());
 
        if (assistantVisible || isEditing) {
            drawPath(gc, path, isSnappingActive());
        } else if (previewVisible && isSnappingActive() && boundingRect().contains(initialTransform.inverted().map(mousePos.toPoint()), false)) {
            drawPreview(gc, path);
        }
 
        if (isEditing) {
            QPainterPath axes;
            axes.moveTo(QPointF(-d->simpleEllipse.semiMajor(), 0));
            axes.lineTo(QPointF(d->simpleEllipse.semiMajor(), 0));
 
            axes.moveTo(QPointF(0, -d->simpleEllipse.semiMinor()));
            axes.lineTo(QPointF(0, d->simpleEllipse.semiMinor()));
 
            gc.save();
 
            QPen p(gc.pen());
            p.setCosmetic(true);
            p.setStyle(Qt::DotLine);
            QColor color = effectiveAssistantColor();
            if (!isSnappingActive()) {
                color.setAlpha(color.alpha()*0.2);
            }
            p.setWidthF(1.5);
            p.setColor(color);
            gc.setPen(p);
 
            gc.drawPath(axes);
 
            gc.restore();
        }
 
        gc.setTransform(converter->documentToWidgetTransform());
        gc.setTransform(d->ellipseInPolygon.originalTransform, true);
 
        // drawing original axes ("lines to touching points")
        QPointF pt1 = QPointF(0.5, 1.0);
        QPointF pt2 = QPointF(1.0, 0.5);
        QPointF pt3 = QPointF(0.5, 0.0);
        QPointF pt4 = QPointF(0.0, 0.5);
 
        QPainterPath touchingLine;
 
        touchingLine.moveTo(pt1);
        touchingLine.lineTo(pt3);
 
        touchingLine.moveTo(pt2);
        touchingLine.lineTo(pt4);
 
        if (assistantVisible) {
            drawPath(gc, touchingLine, isSnappingActive());
        }
    }
 
 
    gc.setTransform(converter->documentToWidgetTransform());
 
    if (assistantVisible || isEditing) {
        if (!isEllipseValid()) {
            // color red for an invalid transform, but not for an incomplete one
            if(isAssistantComplete()) {
                QPainterPath path;
                QPolygonF polyAllConnected;
                // that will create a triangle with a point inside connected to all vertices of the triangle
                polyAllConnected << *handles()[0] << *handles()[1] << *handles()[2] << *handles()[3] << *handles()[0] << *handles()[2] << *handles()[1] << *handles()[3];
                path.addPolygon(polyAllConnected);
                drawError(gc, path);
            } else {
                QPainterPath path;
                path.addPolygon(poly);
                drawPath(gc, path, isSnappingActive());
            }
        } else {
            gc.setPen(QColor(0, 0, 0, 125));
            gc.setTransform(transform, true);
            QPainterPath path;
            for (int y = 0; y <= 1; ++y)
            {
                QLineF line = QLineF(QPointF(0.0, y), QPointF(1.0, y));
                KisAlgebra2D::cropLineToRect(line, gc.window(), false, false);
                path.moveTo(line.p1());
                path.lineTo(line.p2());
            }
            for (int x = 0; x <= 1; ++x)
            {
                QLineF line = QLineF(QPointF(x, 0.0), QPointF(x, 1.0));
                KisAlgebra2D::cropLineToRect(line, gc.window(), false, false);
                path.moveTo(line.p1());
                path.lineTo(line.p2());
            }
 
            drawPath(gc, path, isSnappingActive());
        }
    }
    
    gc.restore();
    KisPaintingAssistant::drawAssistant(gc, updateRect, converter, cached, canvas, assistantVisible, previewVisible);
 
}

◆ drawCache()

void PerspectiveEllipseAssistant::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 514 of file PerspectiveEllipseAssistant.cc.

{
    Q_UNUSED(converter);
    Q_UNUSED(gc);
    Q_UNUSED(assistantVisible);
}

◆ getDefaultEditorPosition()

QPointF PerspectiveEllipseAssistant::getDefaultEditorPosition ( ) const

overridevirtual

Implements KisPaintingAssistant.

Definition at line 534 of file PerspectiveEllipseAssistant.cc.

{
    QPointF centroid(0, 0);
    for (int i = 0; i < 4; ++i) {
        centroid += *handles()[i];
    }
 
    return centroid * 0.25;
}

References KisPaintingAssistant::handles().

◆ getTransform()

bool PerspectiveEllipseAssistant::getTransform	(	QPolygonF &	polyOut,
		QTransform &	transformOut )

private

◆ isActive()

bool PerspectiveEllipseAssistant::isActive ( ) const

overridevirtual

Implements KisAbstractPerspectiveGrid.

Definition at line 611 of file PerspectiveEllipseAssistant.cc.

{
    return isSnappingActive();
}

References KisPaintingAssistant::isSnappingActive().

◆ isAssistantComplete()

bool PerspectiveEllipseAssistant::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 592 of file PerspectiveEllipseAssistant.cc.

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

References KisPaintingAssistant::handles().

◆ isEllipseValid()

bool PerspectiveEllipseAssistant::isEllipseValid ( )

private

Definition at line 544 of file PerspectiveEllipseAssistant.cc.

{
    return isAssistantComplete() && d->ellipseInPolygon.isValid();
}

References d, and isAssistantComplete().

◆ numHandles()

int PerspectiveEllipseAssistant::numHandles ( ) const

inlineoverridevirtual

Implements KisPaintingAssistant.

Definition at line 26 of file PerspectiveEllipseAssistant.h.

26{ return 4; }

◆ project()

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

private

Definition at line 353 of file PerspectiveEllipseAssistant.cc.

{
    Q_UNUSED(strokeBegin);
    Q_ASSERT(isAssistantComplete());
 
    d->ellipseInPolygon.setSimpleEllipseVertices(d->simpleEllipse);
 
    return d->simpleEllipse.project(pt);
}

References d, and isAssistantComplete().

◆ updateCache()

void PerspectiveEllipseAssistant::updateCache ( )

private

Definition at line 549 of file PerspectiveEllipseAssistant.cc.

{
    // handles -> points -> polygon
    d->cacheValid = false;
    // check the cached points, whether they are the same as handles
    if (d->cachedPoints.size() == handles().size()) {
        for (int i = 0; i < handles().size(); ++i) {
            if (d->cachedPoints[i] != *handles()[i]) break;
            if (i == handles().size() - 1) {
                // that means the cache is up to date, because the loop was still going
                d->cacheValid = true;
                return;
            }
        }
    }
 
    d->cachedPoints = QVector<QPointF>();
    for (int i = 0; i < handles().size(); ++i) {
        d->cachedPoints << *handles()[i];
    }
 
 
    QPolygonF poly = QPolygonF(d->cachedPoints);
 
    if (!PerspectiveBasedAssistantHelper::getTetragon(handles(), isAssistantComplete(), poly)) { // this function changes poly to some "standardized" version, or a triangle when it cannot be achieved
 
        poly = QPolygonF(d->cachedPoints);
        poly << d->cachedPoints[0];
        d->ellipseInPolygon.updateToPolygon(poly);
        d->cacheValid = true;
        return;
    }
 
    d->ellipseInPolygon.updateToPolygon(poly);
    if (d->ellipseInPolygon.isValid()) {
        d->ellipseInPolygon.setSimpleEllipseVertices(d->simpleEllipse);
    }
 
    PerspectiveBasedAssistantHelper::updateCacheData(d->cache, poly);
    d->cacheValid = true;
 
}

References d, PerspectiveBasedAssistantHelper::getTetragon(), KisPaintingAssistant::handles(), isAssistantComplete(), and PerspectiveBasedAssistantHelper::updateCacheData().

Member Data Documentation

◆ d

QScopedPointer<Private> PerspectiveEllipseAssistant::d

private

Definition at line 54 of file PerspectiveEllipseAssistant.h.

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

plugins/assistants/Assistants/PerspectiveEllipseAssistant.h
plugins/assistants/Assistants/PerspectiveEllipseAssistant.cc

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PerspectiveEllipseAssistant() [1/2]

◆ ~PerspectiveEllipseAssistant()

◆ PerspectiveEllipseAssistant() [2/2]

Member Function Documentation

◆ adjustLine()

◆ adjustPosition()

◆ boundingRect()

◆ clone()

◆ contains()

◆ distance()

◆ drawAssistant()

◆ drawCache()

◆ getDefaultEditorPosition()

◆ getTransform()

◆ isActive()

◆ isAssistantComplete()

◆ isEllipseValid()

◆ numHandles()

◆ project()

◆ updateCache()

Member Data Documentation

◆ d