#include <ParallelRulerAssistant.h>

Inheritance diagram for ParallelRulerAssistant:

Public Member Functions
void	adjustLine (QPointF &point, QPointF &strokeBegin) override

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

bool	canBeLocal () const override
	canBeLocal

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

QPointF	getDefaultEditorPosition () const override

bool	isAssistantComplete () const override

bool	loadCustomXml (QXmlStreamReader *xml) override

int	numHandles () const override

	ParallelRulerAssistant ()

void	saveCustomXml (QXmlStreamWriter *xml) 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

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

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

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=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

KisPaintingAssistantHandleSP	firstLocalHandle () const override
	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.

KisPaintingAssistantHandleSP	secondLocalHandle () const override
	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)

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().

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

Private Member Functions
	ParallelRulerAssistant (const ParallelRulerAssistant &rhs, QMap< KisPaintingAssistantHandleSP, KisPaintingAssistantHandleSP > &handleMap)

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

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 20 of file ParallelRulerAssistant.h.

Constructor & Destructor Documentation

◆ ParallelRulerAssistant() [1/2]

ParallelRulerAssistant::ParallelRulerAssistant ( )

Definition at line 27 of file ParallelRulerAssistant.cc.

    : KisPaintingAssistant("parallel ruler", i18n("Parallel Ruler assistant"))
{
}

◆ ParallelRulerAssistant() [2/2]

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

explicitprivate

Definition at line 37 of file ParallelRulerAssistant.cc.

    : KisPaintingAssistant(rhs, handleMap)
{
}

Member Function Documentation

◆ adjustLine()

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

overridevirtual

Implements KisPaintingAssistant.

Definition at line 77 of file ParallelRulerAssistant.cc.

{
    point = project(point, strokeBegin, 0.0);
}

References project().

◆ adjustPosition()

QPointF ParallelRulerAssistant::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 72 of file ParallelRulerAssistant.cc.

{
    return project(pt, strokeBegin, moveThresholdPt);
}

References project().

◆ canBeLocal()

bool ParallelRulerAssistant::canBeLocal ( ) const

overridevirtual

canBeLocal

Returns: if the assistant can be potentially a "local assistant" (limited to rectangular area) or not

Reimplemented from KisPaintingAssistant.

Definition at line 180 of file ParallelRulerAssistant.cc.

{
    return true;
}

◆ clone()

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

overridevirtual

Implements KisPaintingAssistant.

Definition at line 32 of file ParallelRulerAssistant.cc.

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

References ParallelRulerAssistant().

◆ drawAssistant()

void ParallelRulerAssistant::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 82 of file ParallelRulerAssistant.cc.

{
    gc.save();
    gc.resetTransform();
 
    QTransform initialTransform = converter->documentToWidgetTransform();
    QRectF local = getLocalRect();
    QRectF localTransformed = initialTransform.mapRect(local);
    const QRect viewport= gc.viewport();
    QPolygonF viewportAndLocal = !localTransformed.isEmpty() ? QPolygonF(QRectF(viewport)).intersected(localTransformed) : QRectF(viewport);
 
 
 
    if (assistantVisible && isLocal() && isAssistantComplete()) {
        QPainterPath path;
        // note: be careful; bottom and right only work with RectF, not Rect
        path.moveTo(initialTransform.map(local.topLeft()));
 
        path.lineTo(initialTransform.map(local.topRight()));
        path.lineTo(initialTransform.map(local.bottomRight()));
        path.lineTo(initialTransform.map(local.bottomLeft()));
        path.lineTo(initialTransform.map(local.topLeft()));
        drawPath(gc, path, isSnappingActive());//and we draw the preview.
    }
 
 
    if (isAssistantComplete() && isSnappingActive() && previewVisible==true) {
        //don't draw if invalid.
        QLineF snapLine= QLineF(initialTransform.map(*handles()[0]), initialTransform.map(*handles()[1]));
 
        QPointF mousePos = effectiveBrushPosition(converter, canvas);
 
        QPointF translation = (initialTransform.map(*handles()[0])-mousePos)*-1.0;
        snapLine= snapLine.translated(translation);
 
        KisAlgebra2D::cropLineToConvexPolygon(snapLine, viewportAndLocal, true, true);
 
 
        QPainterPath path;
        path.moveTo(snapLine.p1());
        path.lineTo(snapLine.p2());
 
        drawPreview(gc, path);//and we draw the preview.
    }
    gc.restore();
 
    KisPaintingAssistant::drawAssistant(gc, updateRect, converter, cached, canvas, assistantVisible, previewVisible);
 
}

References KisAlgebra2D::cropLineToConvexPolygon(), KisCoordinatesConverter::documentToWidgetTransform(), KisPaintingAssistant::drawAssistant(), KisPaintingAssistant::drawPath(), KisPaintingAssistant::drawPreview(), KisPaintingAssistant::effectiveBrushPosition(), KisPaintingAssistant::getLocalRect(), KisPaintingAssistant::handles(), isAssistantComplete(), KisPaintingAssistant::isLocal(), and KisPaintingAssistant::isSnappingActive().

◆ drawCache()

void ParallelRulerAssistant::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 132 of file ParallelRulerAssistant.cc.

{
    if (assistantVisible == false || handles().size() < 2) {
        return;
    }
 
    QTransform initialTransform = converter->documentToWidgetTransform();
 
    // Draw the line
    QPointF p1 = *handles()[0];
    QPointF p2 = *handles()[1];
 
    gc.setTransform(initialTransform);
    QPainterPath path;
    path.moveTo(p1);
    path.lineTo(p2);
    drawPath(gc, path, isSnappingActive());
 
}

References KisCoordinatesConverter::documentToWidgetTransform(), KisPaintingAssistant::drawPath(), KisPaintingAssistant::handles(), KisPaintingAssistant::isSnappingActive(), p1, and p2.

◆ firstLocalHandle()

KisPaintingAssistantHandleSP ParallelRulerAssistant::firstLocalHandle ( ) const

overrideprotectedvirtual

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.

Returns: the first handle of the rectangle of the limited area

Reimplemented from KisPaintingAssistant.

Definition at line 152 of file ParallelRulerAssistant.cc.

{
    return handles().size() > 2 ? handles()[2] : 0;
}

References KisPaintingAssistant::handles().

◆ getDefaultEditorPosition()

QPointF ParallelRulerAssistant::getDefaultEditorPosition ( ) const

overridevirtual

Implements KisPaintingAssistant.

Definition at line 162 of file ParallelRulerAssistant.cc.

{
    if (handles().size() > 1) {
        return (*handles()[0] + *handles()[1]) * 0.5;
    } else if (handles().size() > 0) {
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(false, *handles()[0]);
        return *handles()[0];
    } else {
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(false, QPointF(0, 0));
        return QPointF(0, 0);
    }
}

References KisPaintingAssistant::handles(), and KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE.

◆ isAssistantComplete()

bool ParallelRulerAssistant::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 175 of file ParallelRulerAssistant.cc.

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

References KisPaintingAssistant::handles(), and numHandles().

◆ loadCustomXml()

bool ParallelRulerAssistant::loadCustomXml ( QXmlStreamReader * xml )

overridevirtual

Reimplemented from KisPaintingAssistant.

Definition at line 192 of file ParallelRulerAssistant.cc.

{
    if (xml && xml->name() == "isLocal") {
        this->setLocal((bool)KisDomUtils::toInt(xml->attributes().value("value").toString()));
    }
    return true;
}

References KisPaintingAssistant::setLocal(), and KisDomUtils::toInt().

◆ numHandles()

int ParallelRulerAssistant::numHandles ( ) const

inlineoverridevirtual

Implements KisPaintingAssistant.

Definition at line 28 of file ParallelRulerAssistant.h.

28{ return isLocal() ? 4 : 2; }

References KisPaintingAssistant::isLocal().

◆ project()

QPointF ParallelRulerAssistant::project	(	const QPointF &	pt,
		const QPointF &	strokeBegin,
		qreal	moveThresholdPt )

private

Definition at line 42 of file ParallelRulerAssistant.cc.

{
    Q_ASSERT(isAssistantComplete());
 
    if (isLocal() && isAssistantComplete()) {
        if (getLocalRect().contains(pt)) {
            m_hasBeenInsideLocalRect = true;
        } else if (isLocal() && !m_hasBeenInsideLocalRect) {
            return QPointF(qQNaN(), qQNaN());
        }
    }
 
    //dbgKrita<<strokeBegin<< ", " <<*handles()[0];
    QLineF snapLine = QLineF(*handles()[0], *handles()[1]);
    QPointF translation = (*handles()[0]-strokeBegin)*-1.0;
    snapLine = snapLine.translated(translation);
 
    qreal dx = snapLine.dx();
    qreal dy = snapLine.dy();
 
    const qreal
            dx2 = dx * dx,
            dy2 = dy * dy,
            invsqrlen = 1.0 / (dx2 + dy2);
    QPointF r(dx2 * pt.x() + dy2 * snapLine.x1() + dx * dy * (pt.y() - snapLine.y1()),
              dx2 * snapLine.y1() + dy2 * pt.y() + dx * dy * (pt.x() - snapLine.x1()));
    r *= invsqrlen;
    return r;
}

References KisPaintingAssistant::getLocalRect(), KisPaintingAssistant::handles(), isAssistantComplete(), KisPaintingAssistant::isLocal(), and KisPaintingAssistant::m_hasBeenInsideLocalRect.

◆ saveCustomXml()

void ParallelRulerAssistant::saveCustomXml ( QXmlStreamWriter * xml )

overridevirtual

Reimplemented from KisPaintingAssistant.

Definition at line 185 of file ParallelRulerAssistant.cc.

{
    xml->writeStartElement("isLocal");
    xml->writeAttribute("value", KisDomUtils::toString( (int)this->isLocal()));
    xml->writeEndElement();
}

References KisPaintingAssistant::isLocal(), and KisDomUtils::toString().

◆ secondLocalHandle()

KisPaintingAssistantHandleSP ParallelRulerAssistant::secondLocalHandle ( ) const

overrideprotectedvirtual

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)

Returns

Reimplemented from KisPaintingAssistant.

Definition at line 157 of file ParallelRulerAssistant.cc.

{
    return handles().size() > 3 ? handles()[3] : 0;
}

References KisPaintingAssistant::handles().

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

plugins/assistants/Assistants/ParallelRulerAssistant.h
plugins/assistants/Assistants/ParallelRulerAssistant.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParallelRulerAssistant() [1/2]

◆ ParallelRulerAssistant() [2/2]

Member Function Documentation

◆ adjustLine()

◆ adjustPosition()

◆ canBeLocal()

◆ clone()

◆ drawAssistant()

◆ drawCache()

◆ firstLocalHandle()

◆ getDefaultEditorPosition()

◆ isAssistantComplete()

◆ loadCustomXml()

◆ numHandles()

◆ project()

◆ saveCustomXml()

◆ secondLocalHandle()