KoSnapStrategy Class Reference

#include <KoSnapStrategy.h>

Inheritance diagram for KoSnapStrategy:

Public Types
enum	SnapType { ToPoint = 0 , ToLine }

Public Member Functions
virtual QPainterPath	decoration (const KoViewConverter &converter) const =0
	returns the current snap strategy decoration
	KoSnapStrategy (KoSnapGuide::Strategy type)
virtual bool	snap (const QPointF &mousePosition, KoSnapProxy *proxy, qreal maxSnapDistance)=0
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 ()

Static Public Member Functions
static qreal	scalarProduct (const QPointF &p1, const QPointF &p2)
static qreal	squareDistance (const QPointF &p1, const QPointF &p2)

Protected Member Functions
void	setSnappedPosition (const QPointF &position, SnapType snapType)
	sets the current snapped position

Private Attributes
QPointF	m_snappedPosition
SnapType	m_snappedType = ToPoint
KoSnapGuide::Strategy	m_snapStrategyType

Detailed Description

Definition at line 22 of file KoSnapStrategy.h.

Member Enumeration Documentation

SnapType

enum KoSnapStrategy::SnapType

Enumerator
ToPoint
ToLine

Definition at line 25 of file KoSnapStrategy.h.

                  {
        ToPoint = 0,
        ToLine
    };

Constructor & Destructor Documentation

KoSnapStrategy()

KoSnapStrategy::KoSnapStrategy

(

KoSnapGuide::Strategy

type

)

Definition at line 25 of file KoSnapStrategy.cpp.

    : m_snapStrategyType(type)
{
}

~KoSnapStrategy()

virtual KoSnapStrategy::~KoSnapStrategy ( )

inlinevirtual

Definition at line 32 of file KoSnapStrategy.h.

{};

Member Function Documentation

decoration()

virtual QPainterPath KoSnapStrategy::decoration ( const KoViewConverter & converter ) const

pure virtual

returns the current snap strategy decoration

Implemented in AngleSnapStrategy, OrthogonalSnapStrategy, NodeSnapStrategy, ExtensionSnapStrategy, IntersectionSnapStrategy, GridSnapStrategy, BoundingBoxSnapStrategy, KisSnapLineStrategy, KisSnapPixelStrategy, and KisSnapPointStrategy.

scalarProduct()

qreal KoSnapStrategy::scalarProduct ( const QPointF & p1, const QPointF & p2 )

static

Definition at line 59 of file KoSnapStrategy.cpp.

{
    return p1.x() * p2.x() + p1.y() * p2.y();
}

References p1, and p2.

setSnappedPosition()

void KoSnapStrategy::setSnappedPosition ( const QPointF & position, SnapType snapType )

protected

sets the current snapped position

Definition at line 40 of file KoSnapStrategy.cpp.

{
    m_snappedPosition = position;
    m_snappedType = snapType;
}

References m_snappedPosition, and m_snappedType.

snap()

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

pure virtual

Implemented in AngleSnapStrategy, OrthogonalSnapStrategy, NodeSnapStrategy, ExtensionSnapStrategy, IntersectionSnapStrategy, GridSnapStrategy, BoundingBoxSnapStrategy, KisSnapLineStrategy, KisSnapPixelStrategy, and KisSnapPointStrategy.

snappedPosition()

QPointF KoSnapStrategy::snappedPosition

(

)

const

returns the snapped position form the last call to snapToPoints

Definition at line 30 of file KoSnapStrategy.cpp.

{
    return m_snappedPosition;
}

References m_snappedPosition.

snappedType()

KoSnapStrategy::SnapType KoSnapStrategy::snappedType

(

)

const

Definition at line 35 of file KoSnapStrategy.cpp.

{
    return m_snappedType;
}

References m_snappedType.

squareDistance()

qreal KoSnapStrategy::squareDistance ( const QPointF & p1, const QPointF & p2 )

static

Definition at line 51 of file KoSnapStrategy.cpp.

{
    const qreal dx = p1.x() - p2.x();
    const qreal dy = p1.y() - p2.y();
 
    return dx*dx + dy*dy;
}

References p1, and p2.

type()

KoSnapGuide::Strategy KoSnapStrategy::type

(

)

const

returns the strategies type

Definition at line 46 of file KoSnapStrategy.cpp.

{
    return m_snapStrategyType;
}

References m_snapStrategyType.

Member Data Documentation

m_snappedPosition

QPointF KoSnapStrategy::m_snappedPosition

private

Definition at line 55 of file KoSnapStrategy.h.

m_snappedType

SnapType KoSnapStrategy::m_snappedType = ToPoint

private

Definition at line 56 of file KoSnapStrategy.h.

m_snapStrategyType

KoSnapGuide::Strategy KoSnapStrategy::m_snapStrategyType

private

Definition at line 54 of file KoSnapStrategy.h.

---

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

• libs/flake/KoSnapStrategy.h
• libs/flake/KoSnapStrategy.cpp