KisSnapPointStrategy Class Reference

#include <KisSnapPointStrategy.h>

Inheritance diagram for KisSnapPointStrategy:

Classes
struct	Private

Public Member Functions
void	addPoint (const QPointF &pt)
QPainterPath	decoration (const KoViewConverter &converter) const override
	returns the current snap strategy decoration
	KisSnapPointStrategy (KoSnapGuide::Strategy type=KoSnapGuide::CustomSnapping)
bool	snap (const QPointF &mousePosition, KoSnapProxy *proxy, qreal maxSnapDistance) override
	~KisSnapPointStrategy () override
Public Member Functions inherited from KoSnapStrategy
	KoSnapStrategy (KoSnapGuide::Strategy type)
QPointF	snappedPosition () const
	returns the snapped position form the last call to snapToPoints
SnapType	snappedType () const
KoSnapGuide::Strategy	type () const
	returns the strategies type
virtual	~KoSnapStrategy ()

Private Attributes
const QScopedPointer< Private >	m_d

Additional Inherited Members
Public Types inherited from KoSnapStrategy
enum	SnapType { ToPoint = 0 , ToLine }
Static Public Member Functions inherited from KoSnapStrategy
static qreal	scalarProduct (const QPointF &p1, const QPointF &p2)
static qreal	squareDistance (const QPointF &p1, const QPointF &p2)
Protected Member Functions inherited from KoSnapStrategy
void	setSnappedPosition (const QPointF &position, SnapType snapType)
	sets the current snapped position

Detailed Description

The KisSnapPointStrategy class is a custom strategy that allows snapping to arbitrary points on canvas, not linked to any real objects. It can be used, for example, for snapping to the previous position of the handle, while it is dragging by the user.

Definition at line 22 of file KisSnapPointStrategy.h.

Constructor & Destructor Documentation

KisSnapPointStrategy()

KisSnapPointStrategy::KisSnapPointStrategy

(

KoSnapGuide::Strategy

type = KoSnapGuide::CustomSnapping

)

Definition at line 18 of file KisSnapPointStrategy.cpp.

    : KoSnapStrategy(type),
      m_d(new Private)
{
}

~KisSnapPointStrategy()

KisSnapPointStrategy::~KisSnapPointStrategy ( )

override

Definition at line 24 of file KisSnapPointStrategy.cpp.

{
}

Member Function Documentation

addPoint()

void KisSnapPointStrategy::addPoint

(

const QPointF &

pt

)

Definition at line 57 of file KisSnapPointStrategy.cpp.

{
    m_d->points << pt;
}

References m_d.

decoration()

QPainterPath KisSnapPointStrategy::decoration ( const KoViewConverter & converter ) const

overridevirtual

returns the current snap strategy decoration

Implements KoSnapStrategy.

Definition at line 48 of file KisSnapPointStrategy.cpp.

{
    QRectF unzoomedRect = converter.viewToDocument(QRectF(0, 0, 11, 11));
    unzoomedRect.moveCenter(snappedPosition());
    QPainterPath decoration;
    decoration.addEllipse(unzoomedRect);
    return decoration;
}

References decoration(), KoSnapStrategy::snappedPosition(), and KoViewConverter::viewToDocument().

snap()

bool KisSnapPointStrategy::snap ( const QPointF & mousePosition, KoSnapProxy * proxy, qreal maxSnapDistance )

overridevirtual

Implements KoSnapStrategy.

Definition at line 28 of file KisSnapPointStrategy.cpp.

{
    Q_UNUSED(proxy);
 
    QPointF snappedPoint = mousePosition;
    qreal minDistance = std::numeric_limits<qreal>::max();
 
    Q_FOREACH (const QPointF &pt, m_d->points) {
        const qreal dist = kisDistance(mousePosition, pt);
 
        if (dist < maxSnapDistance && dist < minDistance) {
            minDistance = dist;
            snappedPoint = pt;
        }
    }
 
    setSnappedPosition(snappedPoint, ToPoint);
    return minDistance < std::numeric_limits<qreal>::max();
}

References kisDistance(), m_d, KoSnapStrategy::setSnappedPosition(), and KoSnapStrategy::ToPoint.

Member Data Documentation

m_d

const QScopedPointer<Private> KisSnapPointStrategy::m_d

private

Definition at line 35 of file KisSnapPointStrategy.h.

---

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

• libs/ui/canvas/KisSnapPointStrategy.h
• libs/ui/canvas/KisSnapPointStrategy.cpp