#include <InfiniteRulerAssistant.h>

Inheritance diagram for InfiniteRulerAssistant:

Classes
struct	ClippingResult

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

	InfiniteRulerAssistant ()

bool	isAssistantComplete () const override

int	numHandles () const override

Public Member Functions inherited from RulerAssistant
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

void	enableFixedLength (bool enabled)

void	ensureLength ()

qreal	fixedLength () const

QString	fixedLengthUnit () const

QPointF	getDefaultEditorPosition () const override

bool	hasFixedLength () const

bool	isAssistantComplete () const override

bool	loadCustomXml (QXmlStreamReader *xml) override

int	minorSubdivisions () const

int	numHandles () const override

	RulerAssistant ()

void	saveCustomXml (QXmlStreamWriter *xml) override

void	setFixedLength (qreal length)

void	setFixedLengthUnit (QString unit)

void	setMinorSubdivisions (int subdivisions)

void	setSubdivisions (int subdivisions)

int	subdivisions () const

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

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

Protected Member Functions inherited from RulerAssistant
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

	RulerAssistant (const QString &id, const QString &name)

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

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
void	drawSubdivisions (QPainter &gc, const KisCoordinatesConverter *converter)

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

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

Static Private Member Functions
static ClippingResult	clipLineParametric (QLineF line, QRectF rect, bool extendFirst=true, bool extendSecond=true)

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 21 of file InfiniteRulerAssistant.h.

Constructor & Destructor Documentation

◆ InfiniteRulerAssistant() [1/2]

InfiniteRulerAssistant::InfiniteRulerAssistant ( )

Definition at line 26 of file InfiniteRulerAssistant.cc.

    : RulerAssistant("infinite ruler", i18n("Infinite Ruler assistant"))
{
}

◆ InfiniteRulerAssistant() [2/2]

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

explicitprivate

Definition at line 31 of file InfiniteRulerAssistant.cc.

    : RulerAssistant(rhs, handleMap)
{
}

Member Function Documentation

◆ adjustLine()

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

overridevirtual

Implements KisPaintingAssistant.

Definition at line 72 of file InfiniteRulerAssistant.cc.

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

References project().

◆ adjustPosition()

QPointF InfiniteRulerAssistant::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 67 of file InfiniteRulerAssistant.cc.

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

References project().

◆ clipLineParametric()

InfiniteRulerAssistant::ClippingResult InfiniteRulerAssistant::clipLineParametric	(	QLineF	line,
		QRectF	rect,
		bool	extendFirst = true,
		bool	extendSecond = true )

staticprivate

Definition at line 201 of file InfiniteRulerAssistant.cc.

                                                                                                                                             {
    double dx = line.x2() - line.x1();
    double dy = line.y2() - line.y1();
    
    double q1 = line.x1() - rect.x();
    double q2 = rect.x() + rect.width() - line.x1();
    double q3 = line.y1() - rect.y();
    double q4 = rect.y() + rect.height() - line.y1();
    
    QVector<double> p = QVector<double>({-dx, dx, -dy, dy});
    QVector<double> q = QVector<double>({q1, q2, q3, q4});
    
    double tmin = extendFirst ? -std::numeric_limits<double>::infinity() : 0.0;
    double tmax = extendSecond ? +std::numeric_limits<double>::infinity() : 1.0;
    
    for (int i = 0; i < p.length(); i++) {
        
        if (p[i] == 0 && q[i] < 0) {
            // Line is parallel to this boundary and outside of it
            return ClippingResult{false, 0, 0};
            
        } else if (p[i] < 0) {
            // Line moves into this boundary with increasing t
            // Set minimum t where it just comes in
            double t = q[i] / p[i];
            if (t > tmin) {
                tmin = t;
            }
          
        } else if (p[i] > 0) {
            // Line moves out of this boundary with increasing t
            // Set maximum t where it is still inside
            double t = q[i] / p[i];
            if (t < tmax) {
                tmax = t;
            }
        }
    }
    
    // The line intersects the rectangle if tmin < tmax.
    return ClippingResult{tmin < tmax, tmin, tmax};
}

References p, q1, q2, and q3.

◆ clone()

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

overridevirtual

Implements KisPaintingAssistant.

Definition at line 36 of file InfiniteRulerAssistant.cc.

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

References InfiniteRulerAssistant().

◆ drawAssistant()

void InfiniteRulerAssistant::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 169 of file InfiniteRulerAssistant.cc.

{
    gc.save();
    gc.resetTransform();
    
    if (isAssistantComplete() && isSnappingActive() && previewVisible) {
      
        // Extend the line to the full viewport
        QTransform initialTransform = converter->documentToWidgetTransform();
        QLineF snapLine = QLineF(initialTransform.map(*handles()[0]), initialTransform.map(*handles()[1]));
        QRect viewport = gc.viewport();
        KisAlgebra2D::intersectLineRect(snapLine, viewport, true);
  
        // Draw as preview (thin lines)
        QPainterPath path;
        path.moveTo(snapLine.p1());
        path.lineTo(snapLine.p2());
        drawPreview(gc, path);
        
        // Add the extended subdivisions, if active
        // When the number of subdivisions (or minor subdivisions) is set to
        // 0, the respective feature is turned off and won't be rendered.
        if (subdivisions() > 0) {
            drawSubdivisions(gc, converter);
        }
    }
    
    gc.restore();
    
    RulerAssistant::drawAssistant(gc, updateRect, converter, cached, canvas, assistantVisible, previewVisible);
}

References KisCoordinatesConverter::documentToWidgetTransform(), RulerAssistant::drawAssistant(), KisPaintingAssistant::drawPreview(), drawSubdivisions(), KisPaintingAssistant::handles(), KisAlgebra2D::intersectLineRect(), isAssistantComplete(), KisPaintingAssistant::isSnappingActive(), and RulerAssistant::subdivisions().

◆ drawSubdivisions()

void InfiniteRulerAssistant::drawSubdivisions	(	QPainter &	gc,
		const KisCoordinatesConverter *	converter )

private

Definition at line 79 of file InfiniteRulerAssistant.cc.

                                                                                                    {
    if (subdivisions() == 0) {
        return;
    }
    
    // Get handle positions
    QTransform document2widget = converter->documentToWidgetTransform();
    
    QPointF p1 = document2widget.map(*handles()[0]);
    QPointF p2 = document2widget.map(*handles()[1]);
    
    const qreal scale = 16.0 / 2;
    const qreal minorScale = scale / 2;
    const QRectF clipping = QRectF(gc.viewport()).adjusted(-scale, -scale, scale, scale);
    // If the lines would end up closer to each other than this threshold (in
    // screen coordinates), they are not rendered, as they wouldn't be
    // distinguishable anymore.
    const qreal threshold = 3.0;
    
    // Calculate line direction and normal vector
    QPointF delta = p2 - p1;
    qreal length = sqrt(KisPaintingAssistant::norm2(delta));
    qreal stepsize = length / subdivisions();
    
    // Only draw if lines are far enough apart
    if (stepsize >= threshold) {
        QPointF normal = QPointF(delta.y(), -delta.x());
        normal /= length;
        
        // Clip the line to the viewport and find the t parameters for these
        // points
        ClippingResult res = clipLineParametric(QLineF(p1, p2), clipping);
        // Abort if line is outside clipping area
        if (!res.intersects) {
            return;
        }
        // Calculate indices to start and end the subdivisions on screen by
        // rounding further "away" from the visible area, ensuring that all
        // divisions that could be visible are actually drawn
        int istart = (int) floor(res.tmin * subdivisions());
        int iend =   (int)  ceil(res.tmax * subdivisions());
  
        QPainterPath path;
        QPainterPath highlight;
        
        // Draw the major subdivisions
        for (int ii = istart; ii < iend; ++ii) {
            QPointF pos = p1 + delta * ((qreal)ii / subdivisions());
            // No additional clipping check needed, since we're already
            // constrained inside it by the ii values.
            // However, don't draw over the thicker lines where the actual
            // ruler is located and already drawn!
            if (0 <= ii && ii < subdivisions()) {
                continue;
            }
            // Special case at ii == subdivs: minor subdivisions are needed
            // here, but not the major one, as this is the last line drawn of
            // the main ruler.
            if (ii != subdivisions()) {
                // Highlight the integer multiples of the ruler length
                if (ii % subdivisions() == 0) {
                    highlight.moveTo(pos - normal * scale);
                    highlight.lineTo(pos + normal * scale);
                } else {
                    path.moveTo(pos - normal * scale);
                    path.lineTo(pos + normal * scale);
                }
            }
  
            // Draw minor subdivisions, if they exist (implicit check due to
            // the loop bounds)
            // Skip if major subdivisions are too close already
            if (stepsize / minorSubdivisions() < threshold)
                continue;
            // Draw minor marks in between the major ones
            for (int jj = 1; jj < minorSubdivisions(); ++jj) {
                QPointF mpos = pos + delta * ((qreal)jj / (subdivisions() * minorSubdivisions()));
        
                path.moveTo(mpos - normal * minorScale);
                path.lineTo(mpos + normal * minorScale);
            }
        }
  
        // Draw highlight as regular path (2 px wide)
        drawPath(gc, highlight);
        // Draw normal lines as preview (1 px wide)
        drawPreview(gc, path);
    }
}

References clipLineParametric(), KisCoordinatesConverter::documentToWidgetTransform(), KisPaintingAssistant::drawPath(), KisPaintingAssistant::drawPreview(), KisPaintingAssistant::handles(), InfiniteRulerAssistant::ClippingResult::intersects, length(), RulerAssistant::minorSubdivisions(), KisPaintingAssistant::norm2(), p1, p2, RulerAssistant::subdivisions(), InfiniteRulerAssistant::ClippingResult::tmax, and InfiniteRulerAssistant::ClippingResult::tmin.

◆ getDefaultEditorPosition()

QPointF InfiniteRulerAssistant::getDefaultEditorPosition ( ) const

overridevirtual

Implements KisPaintingAssistant.

Definition at line 244 of file InfiniteRulerAssistant.cc.

{
    return (*handles()[0]);
}

References KisPaintingAssistant::handles().

◆ isAssistantComplete()

bool InfiniteRulerAssistant::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 249 of file InfiniteRulerAssistant.cc.

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

References KisPaintingAssistant::handles().

◆ numHandles()

int InfiniteRulerAssistant::numHandles ( ) const

inlineoverridevirtual

Implements KisPaintingAssistant.

Definition at line 29 of file InfiniteRulerAssistant.h.

29{ return 2; }

◆ project()

QPointF InfiniteRulerAssistant::project	(	const QPointF &	pt,
		const QPointF &	strokeBegin,
		const bool	checkForInitialMovement,
		qreal	moveThresholdPt )

private

Definition at line 41 of file InfiniteRulerAssistant.cc.

{
    Q_ASSERT(isAssistantComplete());
    //code nicked from the perspective ruler.
    qreal dx = pt.x() - strokeBegin.x();
    qreal dy = pt.y() - strokeBegin.y();
    if (checkForInitialMovement && KisAlgebra2D::norm(QPointF(dx, dy)) < moveThresholdPt) {
        // allow some movement before snapping
        return strokeBegin;
    }
 
    QLineF snapLine = QLineF(*handles()[0], *handles()[1]);
    
        dx = snapLine.dx();
        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;
    //return pt;
}

References KisPaintingAssistant::handles(), isAssistantComplete(), and KisAlgebra2D::norm().

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

plugins/assistants/Assistants/InfiniteRulerAssistant.h
plugins/assistants/Assistants/InfiniteRulerAssistant.cc

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InfiniteRulerAssistant() [1/2]

◆ InfiniteRulerAssistant() [2/2]

Member Function Documentation

◆ adjustLine()

◆ adjustPosition()

◆ clipLineParametric()

◆ clone()

◆ drawAssistant()

◆ drawSubdivisions()

◆ getDefaultEditorPosition()

◆ isAssistantComplete()

◆ numHandles()

◆ project()