KoPathPoint Class Reference

A KoPathPoint represents a point in a path. More...

#include <KoPathPoint.h>

Inheritance diagram for KoPathPoint:

Public Types
enum	PointProperty {   Normal = 0 , StartSubpath = 1 , StopSubpath = 2 , CloseSubpath = 8 ,   IsSmooth = 16 , IsSymmetric = 32 }
	property enum More...
enum	PointType {   None = 0 , Node = 1 , ControlPoint1 = 2 , ControlPoint2 = 4 ,   All = 7 }
	the type for identifying part of a KoPathPoint More...

Public Member Functions
bool	activeControlPoint1 () const
	Checks if there is a controlPoint1.
bool	activeControlPoint2 () const
	Checks if there is a controlPoint2.
QRectF	boundingRect (bool active=true) const
	Get the bounding rect of the point.
QPointF	controlPoint1 () const
	get the control point 1
QPointF	controlPoint2 () const
	get the second control point
bool	isSmooth (KoPathPoint *previous, KoPathPoint *next) const
	KoPathPoint ()
	Default constructor.
	KoPathPoint (const KoPathPoint &pathPoint)
	Copy Constructor.
	KoPathPoint (const KoPathPoint &pathPoint, KoPathShape *newParent)
	KoPathPoint (KoPathShape *path, const QPointF &point, PointProperties properties=Normal)
	Constructor.
void	map (const QTransform &matrix)
	apply matrix on the point
KoPathPoint &	operator= (const KoPathPoint &other)
	Assignment operator.
bool	operator== (const KoPathPoint &other) const
	Compare operator.
void	paint (KisHandlePainterHelper &handlesHelper, PointTypes types, bool active=true)
KoPathShape *	parent () const
	Get the path shape the point belongs to.
QPointF	point () const
	return the position relative to the shape origin
	Private ()
PointProperties	properties () const
	Get the properties of a point.
void	removeControlPoint1 ()
	Removes the first control point.
void	removeControlPoint2 ()
	Removes the second control point.
void	reverse ()
	Reverses the path point.
void	setControlPoint1 (const QPointF &point)
	Set the control point 1.
void	setControlPoint2 (const QPointF &point)
	Set the control point 2.
void	setParent (KoPathShape *parent)
	Sets the parent path shape.
void	setPoint (const QPointF &point)
	alter the point
void	setProperties (PointProperties properties)
	Set the properties of a point.
void	setProperty (PointProperty property)
	Sets a single property of a point.
void	unsetProperty (PointProperty property)
	Removes a property from the point.
	~KoPathPoint ()
	Destructor.

Public Attributes
bool	activeControlPoint1
bool	activeControlPoint2
QPointF	controlPoint1
QPointF	controlPoint2
QPointF	point
PointProperties	properties
KoPathShape *	shape

Private Attributes
Private *const	d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Friends
class	KoPathShapePrivate

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

A KoPathPoint represents a point in a path.

A KoPathPoint stores a point in a path. Additional to this point 2 control points are stored. controlPoint1 is used to describe the second point of a cubic bezier ending at the point. controlPoint2 is used to describe the first point of a cubic bezier curve starting at the point.

Definition at line 24 of file KoPathPoint.cpp.

Member Enumeration Documentation

PointProperty

enum KoPathPoint::PointProperty

property enum

Enumerator
Normal	it has no control points
StartSubpath	it starts a new subpath by a moveTo command
StopSubpath	it stops a subpath (last point of subpath)
CloseSubpath	it closes a subpath (only applicable on StartSubpath and StopSubpath)
IsSmooth	it is smooth, both control points on a line through the point
IsSymmetric	it is symmetric, like smooth but control points have same distance to point

Definition at line 36 of file KoPathPoint.h.

                       {
        Normal = 0, 
        StartSubpath = 1, 
        StopSubpath = 2, 
        CloseSubpath = 8, 
        IsSmooth = 16, 
        IsSymmetric = 32 
    };

PointType

enum KoPathPoint::PointType

the type for identifying part of a KoPathPoint

Enumerator
None
Node	the node point
ControlPoint1	the first control point
ControlPoint2	the second control point
All

Definition at line 47 of file KoPathPoint.h.

                   {
        None = 0,
        Node = 1,          
        ControlPoint1 = 2, 
        ControlPoint2 = 4,  
        All = 7
    };

Constructor & Destructor Documentation

KoPathPoint() [1/4]

KoPathPoint::KoPathPoint

(

)

Default constructor.

Definition at line 57 of file KoPathPoint.cpp.

        : d(new Private())
{
}

KoPathPoint() [2/4]

KoPathPoint::KoPathPoint	(	KoPathShape *	path,
		const QPointF &	point,
		PointProperties	properties = Normal )

Constructor.

Parameters

path	is a pointer to the path shape this point is used in
point	the position relative to the shape origin
properties	describing the point

Definition at line 62 of file KoPathPoint.cpp.

        : d(new Private())
{
    d->shape = path;
    d->point = point;
    d->controlPoint1 = point;
    d->controlPoint2 = point;
    d->properties = properties;
}

References d, point, and properties.

KoPathPoint() [3/4]

KoPathPoint::KoPathPoint

(

const KoPathPoint &

pathPoint

)

Copy Constructor.

Definition at line 39 of file KoPathPoint.cpp.

        : d(new Private())
{
    d->shape = 0;
    d->point = pathPoint.d->point;
    d->controlPoint1 = pathPoint.d->controlPoint1;
    d->controlPoint2 = pathPoint.d->controlPoint2;
    d->properties = pathPoint.d->properties;
    d->activeControlPoint1 = pathPoint.d->activeControlPoint1;
    d->activeControlPoint2 = pathPoint.d->activeControlPoint2;
}

References d.

KoPathPoint() [4/4]

KoPathPoint::KoPathPoint	(	const KoPathPoint &	pathPoint,
		KoPathShape *	newParent )

Definition at line 51 of file KoPathPoint.cpp.

    : KoPathPoint(pathPoint)
{
    d->shape = newParent;
}

References d.

~KoPathPoint()

KoPathPoint::~KoPathPoint

(

)

Destructor.

Definition at line 72 of file KoPathPoint.cpp.

{
    delete d;
}

References d.

Member Function Documentation

activeControlPoint1()

bool KoPathPoint::activeControlPoint1

(

)

const

Checks if there is a controlPoint1.

The control point is active if a control point was set by calling setControlPoint1. However a start point of a subpath (StartSubpath) can only have an active control 1 if the subpath is closed (CloseSubpath on first and last point).

Returns

true if control point is active, false otherwise

activeControlPoint2()

bool KoPathPoint::activeControlPoint2

(

)

const

Checks if there is a controlPoint2.

The control point is active if a control point was set by calling setControlPoint2. However a end point of a subpath (StopSubpath) can only have an active control point 2 if there subpath is closed (CloseSubpath on first and last point).

Returns

true if control point is active, false otherwise

boundingRect()

QRectF KoPathPoint::boundingRect

(

bool

active = true

)

const

Get the bounding rect of the point.

This takes into account if there are control points

Parameters

active

If true only the active points are used in calculation of the bounding rectangle. If false all points are used.

Returns

bounding rect in document coordinates

Definition at line 295 of file KoPathPoint.cpp.

{
    QRectF rect(d->point, QSize(1, 1));
    if (!active && activeControlPoint1()) {
        QRectF r1(d->point, QSize(1, 1));
        r1.setBottomRight(d->controlPoint1);
        rect = rect.united(r1);
    }
    if (!active && activeControlPoint2()) {
        QRectF r2(d->point, QSize(1, 1));
        r2.setBottomRight(d->controlPoint2);
        rect = rect.united(r2);
    }
    if (d->shape)
        return d->shape->shapeToDocument(rect);
    else
        return rect;
}

References activeControlPoint1, activeControlPoint2, d, r1, and r2.

controlPoint1()

QPointF KoPathPoint::controlPoint1

(

)

const

get the control point 1

This points is used for controlling a curve ending at this point

Returns

control point 1 of this point

controlPoint2()

QPointF KoPathPoint::controlPoint2

(

)

const

get the second control point

This points is used for controlling a curve starting at this point

Returns

control point 2 of this point

isSmooth()

bool KoPathPoint::isSmooth	(	KoPathPoint *	previous,
		KoPathPoint *	next ) const

Returns if this point is a smooth join of adjacent path segments.

The smoothness is defined by the parallelness of the tangents emanating from the knot point, i.e. the normalized vectors from the knot to the first and second control point. The previous and next path points are used to determine the smoothness in case this path point has not two control points.

Parameters

previous	the previous path point
next	the next path point

Definition at line 327 of file KoPathPoint.cpp.

{
    QPointF t1, t2;
 
    if (activeControlPoint1()) {
        t1 = point() - controlPoint1();
    } else {
        // we need the previous path point but there is none provided
        if (! prev)
            return false;
        if (prev->activeControlPoint2())
            t1 = point() - prev->controlPoint2();
        else
            t1 = point() - prev->point();
    }
 
    if (activeControlPoint2()) {
        t2 = controlPoint2() - point();
    } else {
        // we need the next path point but there is none provided
        if (! next)
            return false;
        if (next->activeControlPoint1())
            t2 = next->controlPoint1() - point();
        else
            t2 = next->point() - point();
    }
 
    // normalize tangent vectors
    qreal l1 = sqrt(t1.x() * t1.x() + t1.y() * t1.y());
    qreal l2 = sqrt(t2.x() * t2.x() + t2.y() * t2.y());
    if (qFuzzyCompare(l1 + 1, qreal(1.0)) || qFuzzyCompare(l2 + 1, qreal(1.0)))
        return true;
 
    t1 /= l1;
    t2 /= l2;
 
    qreal scalar = t1.x() * t2.x() + t1.y() * t2.y();
    // tangents are parallel if t1*t2 = |t1|*|t2|
    return qFuzzyCompare(scalar, qreal(1.0));
}

References activeControlPoint1, activeControlPoint2, controlPoint1, controlPoint2, point, and qFuzzyCompare().

map()

void KoPathPoint::map

(

const QTransform &

matrix

)

apply matrix on the point

This does a matrix multiplication on all points of the point

Parameters

matrix

which will be applied to all points

Definition at line 242 of file KoPathPoint.cpp.

{
    d->point = matrix.map(d->point);
    d->controlPoint1 = matrix.map(d->controlPoint1);
    d->controlPoint2 = matrix.map(d->controlPoint2);
 
    if (d->shape)
        d->shape->notifyChanged();
}

References d.

operator=()

KoPathPoint & KoPathPoint::operator=

(

const KoPathPoint &

other

)

Assignment operator.

Definition at line 77 of file KoPathPoint.cpp.

{
    if (this == &rhs)
        return (*this);
 
    d->shape = rhs.d->shape;
    d->point = rhs.d->point;
    d->controlPoint1 = rhs.d->controlPoint1;
    d->controlPoint2 = rhs.d->controlPoint2;
    d->properties = rhs.d->properties;
    d->activeControlPoint1 = rhs.d->activeControlPoint1;
    d->activeControlPoint2 = rhs.d->activeControlPoint2;
 
    return (*this);
}

References d.

operator==()

bool KoPathPoint::operator==

(

const KoPathPoint &

other

)

const

Compare operator.

Definition at line 93 of file KoPathPoint.cpp.

{
    if (d->point != rhs.d->point)
        return false;
    if (d->controlPoint1 != rhs.d->controlPoint1)
        return false;
    if (d->controlPoint2 != rhs.d->controlPoint2)
        return false;
    if (d->properties != rhs.d->properties)
        return false;
    if (d->activeControlPoint1 != rhs.d->activeControlPoint1)
        return false;
    if (d->activeControlPoint2 != rhs.d->activeControlPoint2)
        return false;
    return true;
}

References d.

paint()

void KoPathPoint::paint	(	KisHandlePainterHelper &	handlesHelper,
		PointTypes	types,
		bool	active = true )

Paints the path point with the actual brush and pen

Parameters

painter	used for painting the shape point
handleRadius	size of point handles in pixel
types	the points which should be painted
active	If true only the given active points are painted If false all given points are used.

Definition at line 252 of file KoPathPoint.cpp.

{
    bool drawControlPoint1 = types & ControlPoint1 && (!active || activeControlPoint1());
    bool drawControlPoint2 = types & ControlPoint2 && (!active || activeControlPoint2());
 
    // draw lines at the bottom
    if (drawControlPoint2) {
        handlesHelper.drawConnectionLine(point(), controlPoint2());
    }
 
    if (drawControlPoint1) {
        handlesHelper.drawConnectionLine(point(), controlPoint1());
    }
 
    // the point is lowest
    if (types & Node) {
        if (properties() & IsSmooth) {
            handlesHelper.drawHandleCircle(point());
        } else if (properties() & IsSymmetric) {
            handlesHelper.drawHandleRect(point());
        } else {
            handlesHelper.drawGradientHandle(point());
        }
    }
 
    // then comes control point 2
    if (drawControlPoint2) {
        handlesHelper.drawHandleSmallCircle(controlPoint2());
    }
 
    // then comes control point 1
    if (drawControlPoint1) {
        handlesHelper.drawHandleSmallCircle(controlPoint1());
    }
}

References activeControlPoint1, activeControlPoint2, controlPoint1, ControlPoint1, controlPoint2, ControlPoint2, KisHandlePainterHelper::drawConnectionLine(), KisHandlePainterHelper::drawGradientHandle(), KisHandlePainterHelper::drawHandleCircle(), KisHandlePainterHelper::drawHandleRect(), KisHandlePainterHelper::drawHandleSmallCircle(), IsSmooth, IsSymmetric, point, and properties.

parent()

KoPathShape * KoPathPoint::parent

(

)

const

Get the path shape the point belongs to.

Returns

the path shape the point belongs to

Definition at line 389 of file KoPathPoint.cpp.

{
    return d->shape;
}

References d.

point()

QPointF KoPathPoint::point

(

)

const

return the position relative to the shape origin

Returns

point

Private()

KoPathPoint::Private ( )

inline

Definition at line 27 of file KoPathPoint.cpp.

            : shape(0), properties(Normal)
            , activeControlPoint1(false), activeControlPoint2(false) {}

properties()

PointProperties KoPathPoint::properties

(

)

const

Get the properties of a point.

Returns

properties of the point

removeControlPoint1()

void KoPathPoint::removeControlPoint1

(

)

Removes the first control point.

Definition at line 137 of file KoPathPoint.cpp.

{
    d->activeControlPoint1 = false;
    d->properties &= ~IsSmooth;
    d->properties &= ~IsSymmetric;
    if (d->shape)
        d->shape->notifyChanged();
}

References d.

removeControlPoint2()

void KoPathPoint::removeControlPoint2

(

)

Removes the second control point.

Definition at line 146 of file KoPathPoint.cpp.

{
    d->activeControlPoint2 = false;
    d->properties &= ~IsSmooth;
    d->properties &= ~IsSymmetric;
    if (d->shape)
        d->shape->notifyChanged();
}

References d.

reverse()

void KoPathPoint::reverse

(

)

Reverses the path point.

The control points are swapped and the point properties are adjusted. The position dependent properties like StartSubpath and CloseSubpath are not changed.

Definition at line 314 of file KoPathPoint.cpp.

{
    std::swap(d->controlPoint1, d->controlPoint2);
    std::swap(d->activeControlPoint1, d->activeControlPoint2);
    PointProperties newProps = Normal;
    newProps |= d->properties & IsSmooth;
    newProps |= d->properties & IsSymmetric;
    newProps |= d->properties & StartSubpath;
    newProps |= d->properties & StopSubpath;
    newProps |= d->properties & CloseSubpath;
    d->properties = newProps;
}

References CloseSubpath, d, IsSmooth, IsSymmetric, Normal, StartSubpath, and StopSubpath.

setControlPoint1()

void KoPathPoint::setControlPoint1

(

const QPointF &

point

)

Set the control point 1.

Parameters

point

to set

Definition at line 117 of file KoPathPoint.cpp.

{
    if (qIsNaNPoint(point)) return;
 
    d->controlPoint1 = point;
    d->activeControlPoint1 = true;
    if (d->shape)
        d->shape->notifyChanged();
}

References d, point, and qIsNaNPoint().

setControlPoint2()

void KoPathPoint::setControlPoint2

(

const QPointF &

point

)

Set the control point 2.

Parameters

point

to set

Definition at line 127 of file KoPathPoint.cpp.

{
    if (qIsNaNPoint(point)) return;
 
    d->controlPoint2 = point;
    d->activeControlPoint2 = true;
    if (d->shape)
        d->shape->notifyChanged();
}

References d, point, and qIsNaNPoint().

setParent()

void KoPathPoint::setParent

(

KoPathShape *

parent

)

Sets the parent path shape.

Parameters

parent

the new parent path shape

Definition at line 288 of file KoPathPoint.cpp.

{
    // don't set to zero
    //Q_ASSERT(parent);
    d->shape = parent;
}

References d, and parent().

setPoint()

void KoPathPoint::setPoint

(

const QPointF &

point

)

alter the point

Parameters

point

to set

Definition at line 110 of file KoPathPoint.cpp.

{
    d->point = point;
    if (d->shape)
        d->shape->notifyChanged();
}

References d, and point.

setProperties()

void KoPathPoint::setProperties

(

PointProperties

properties

)

Set the properties of a point.

Parameters

properties

the new properties

Definition at line 155 of file KoPathPoint.cpp.

{
    d->properties = properties;
    // CloseSubpath only allowed with StartSubpath or StopSubpath
    if ((d->properties & StartSubpath) == 0 && (d->properties & StopSubpath) == 0)
        d->properties &= ~CloseSubpath;
 
    if (! activeControlPoint1() || ! activeControlPoint2()) {
        // strip smooth and symmetric flags if point has not two control points
        d->properties &= ~IsSmooth;
        d->properties &= ~IsSymmetric;
    }
 
    if (d->shape)
        d->shape->notifyChanged();
}

References activeControlPoint1, activeControlPoint2, d, properties, StartSubpath, and StopSubpath.

setProperty()

void KoPathPoint::setProperty

(

PointProperty

property

)

Sets a single property of a point.

Parameters

property

the property to set

Definition at line 172 of file KoPathPoint.cpp.

{
    switch (property) {
    case StartSubpath:
    case StopSubpath:
    case CloseSubpath:
        // nothing special to do here
        break;
    case IsSmooth:
        d->properties &= ~IsSymmetric;
        break;
    case IsSymmetric:
        d->properties &= ~IsSmooth;
        break;
    default: return;
    }
 
    d->properties |= property;
 
    if (! activeControlPoint1() || ! activeControlPoint2()) {
        // strip smooth and symmetric flags if point has not two control points
        d->properties &= ~IsSymmetric;
        d->properties &= ~IsSmooth;
    }
}

References activeControlPoint1, activeControlPoint2, CloseSubpath, d, IsSmooth, IsSymmetric, StartSubpath, and StopSubpath.

unsetProperty()

void KoPathPoint::unsetProperty

(

PointProperty

property

)

Removes a property from the point.

Parameters

property

the property to remove

Definition at line 198 of file KoPathPoint.cpp.

{
    switch (property) {
    case StartSubpath:
        if (d->properties & StartSubpath && (d->properties & StopSubpath) == 0)
            d->properties &= ~CloseSubpath;
        break;
    case StopSubpath:
        if (d->properties & StopSubpath && (d->properties & StartSubpath) == 0)
            d->properties &= ~CloseSubpath;
        break;
    case CloseSubpath:
        if (d->properties & StartSubpath || d->properties & StopSubpath) {
            d->properties &= ~IsSmooth;
            d->properties &= ~IsSymmetric;
        }
        break;
    case IsSmooth:
    case IsSymmetric:
        // no others depend on these
        break;
    default: return;
    }
    d->properties &= ~property;
}

References CloseSubpath, d, IsSmooth, IsSymmetric, StartSubpath, and StopSubpath.

Friends And Related Symbol Documentation

KoPathShapePrivate

friend class KoPathShapePrivate

friend

Definition at line 255 of file KoPathPoint.h.

Member Data Documentation

activeControlPoint1

bool KoPathPoint::activeControlPoint1

Definition at line 35 of file KoPathPoint.cpp.

activeControlPoint2

bool KoPathPoint::activeControlPoint2

Definition at line 36 of file KoPathPoint.cpp.

controlPoint1

QPointF KoPathPoint::controlPoint1

Definition at line 32 of file KoPathPoint.cpp.

controlPoint2

QPointF KoPathPoint::controlPoint2

Definition at line 33 of file KoPathPoint.cpp.

d

Private* const KoPathPoint::d

private

Definition at line 258 of file KoPathPoint.h.

point

QPointF KoPathPoint::point

Definition at line 31 of file KoPathPoint.cpp.

properties

KoPathPoint::PointProperties KoPathPoint::properties

Definition at line 34 of file KoPathPoint.cpp.

shape

KoPathShape* KoPathPoint::shape

Definition at line 30 of file KoPathPoint.cpp.

---

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

• libs/flake/KoPathPoint.cpp
• libs/flake/KoPathPoint.h