#include <KoShapeStroke.h>

Inheritance diagram for KoShapeStroke:

Public Member Functions
Qt::PenCapStyle	capStyle () const
	Returns the lines cap style.

QColor	color () const
	Returns the color.

bool	compareFillTo (const KoShapeStrokeModel *other) override

bool	compareStyleTo (const KoShapeStrokeModel *other) override

qreal	dashOffset () const
	Returns the dash offset.

bool	hasTransparency () const override

bool	isVisible () const override

Qt::PenJoinStyle	joinStyle () const
	Returns the lines join style.

	KoShapeStroke ()
	Constructor for a thin line in black.

	KoShapeStroke (const KoShapeStroke &other)
	Copy constructor.

	KoShapeStroke (qreal lineWidth, const QColor &color=Qt::black)

QBrush	lineBrush () const
	Returns the strokes brush.

QVector< qreal >	lineDashes () const
	Returns the line dashes.

Qt::PenStyle	lineStyle () const
	Returns the line style.

qreal	lineWidth () const
	Returns the line width.

qreal	miterLimit () const
	Returns the miter limit.

KoShapeStroke &	operator= (const KoShapeStroke &rhs)
	Assignment operator.

void	paint (const KoShape *shape, QPainter &painter) const override

void	paintBorder (const KoShape *shape, QPainter &painter, const QPen &pen) const

void	paintMarkers (const KoShape *shape, QPainter &painter) const override
	paintMarkers Paints the markers if possible.

void	paintMarkers (const KoShape *shape, QPainter &painter, const QPen &pen) const

	Private (KoShapeStroke *_q)

QPen	resultLinePen () const

void	setCapStyle (Qt::PenCapStyle style)
	Sets the lines cap style.

void	setColor (const QColor &color)
	Sets the color.

void	setDashOffset (qreal dashOffset)
	Sets the dash offset.

void	setJoinStyle (Qt::PenJoinStyle style)
	Sets the lines join style.

void	setLineBrush (const QBrush &brush)
	Sets the strokes brush used to fill strokes of this border.

void	setLineStyle (Qt::PenStyle style, const QVector< qreal > &dashes)
	Sets the line style.

void	setLineWidth (qreal lineWidth)
	Sets the line width.

void	setMiterLimit (qreal miterLimit)
	Sets the miter limit.

void	strokeInsets (const KoShape *shape, KoInsets &insets) const override

qreal	strokeMaxMarkersInset (const KoShape *shape) const override

	~KoShapeStroke () override

Public Member Functions inherited from KoShapeStrokeModel
virtual	~KoShapeStrokeModel ()

Public Attributes
QBrush	brush

QColor	color

QPen	pen

KoShapeStroke *	q

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

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

Detailed Description

A border for shapes that draws a single line around the object.

Definition at line 36 of file KoShapeStroke.cpp.

Constructor & Destructor Documentation

◆ KoShapeStroke() [1/3]

KoShapeStroke::KoShapeStroke ( )

Constructor for a thin line in black.

Definition at line 166 of file KoShapeStroke.cpp.

        : d(new Private(this))
{
    d->color = QColor(Qt::black);
    // we are not rendering stroke with zero width anymore
    // so lets use a default width of 1.0
    d->pen.setWidthF(1.0);
}

References d.

◆ KoShapeStroke() [2/3]

KoShapeStroke::KoShapeStroke ( const KoShapeStroke & other )

Copy constructor.

Definition at line 175 of file KoShapeStroke.cpp.

        : KoShapeStrokeModel(), d(new Private(this))
{
    d->color = other.d->color;
    d->pen = other.d->pen;
    d->brush = other.d->brush;
}

References d.

◆ KoShapeStroke() [3/3]

KoShapeStroke::KoShapeStroke	(	qreal	lineWidth,
		const QColor &	color = Qt::black )

explicit

Constructor for a Stroke

Parameters

lineWidth	the width, in pt
color	the color we draw the outline in.

Definition at line 183 of file KoShapeStroke.cpp.

        : d(new Private(this))
{
    d->pen.setWidthF(qMax(qreal(0.0), lineWidth));
    d->pen.setJoinStyle(Qt::MiterJoin);
    d->color = color;
}

References color, d, and lineWidth().

◆ ~KoShapeStroke()

KoShapeStroke::~KoShapeStroke ( )

override

Definition at line 191 of file KoShapeStroke.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ capStyle()

Qt::PenCapStyle KoShapeStroke::capStyle ( ) const

Returns the lines cap style.

Definition at line 326 of file KoShapeStroke.cpp.

{
    return d->pen.capStyle();
}

References d.

◆ color()

QColor KoShapeStroke::color ( ) const

Returns the color.

◆ compareFillTo()

bool KoShapeStroke::compareFillTo ( const KoShapeStrokeModel * other )

overridevirtual

Implements KoShapeStrokeModel.

Definition at line 287 of file KoShapeStroke.cpp.

{
    if (!other) return false;
 
    const KoShapeStroke *stroke = dynamic_cast<const KoShapeStroke*>(other);
    if (!stroke) return false;
 
    return (d->brush.gradient() && d->brush == stroke->d->brush) ||
            (!d->brush.gradient() && d->color == stroke->d->color);
}

References d.

◆ compareStyleTo()

bool KoShapeStroke::compareStyleTo ( const KoShapeStrokeModel * other )

overridevirtual

Implements KoShapeStrokeModel.

Definition at line 298 of file KoShapeStroke.cpp.

{
    if (!other) return false;
 
    const KoShapeStroke *stroke = dynamic_cast<const KoShapeStroke*>(other);
    if (!stroke) return false;
 
    QPen pen1 = d->pen;
    QPen pen2 = stroke->d->pen;
 
    // just a random color top avoid comparison of that property
    pen1.setColor(Qt::magenta);
    pen2.setColor(Qt::magenta);
 
    return pen1 == pen2;
}

References d.

◆ dashOffset()

qreal KoShapeStroke::dashOffset ( ) const

Returns the dash offset.

Definition at line 395 of file KoShapeStroke.cpp.

{
    return d->pen.dashOffset();
}

References d.

◆ hasTransparency()

bool KoShapeStroke::hasTransparency ( ) const

overridevirtual

Returns true if there is some transparency, false if the stroke is fully opaque.

Returns: if the stroke is transparent.

Implements KoShapeStrokeModel.

Definition at line 255 of file KoShapeStroke.cpp.

{
    return d->color.alpha() > 0;
}

References d.

◆ isVisible()

bool KoShapeStroke::isVisible ( ) const

overridevirtual

Implements KoShapeStrokeModel.

Definition at line 315 of file KoShapeStroke.cpp.

{
    return d->pen.widthF() > 0 &&
        (d->brush.gradient() || d->color.alpha() > 0);
}

References d.

◆ joinStyle()

Qt::PenJoinStyle KoShapeStroke::joinStyle ( ) const

Returns the lines join style.

Definition at line 336 of file KoShapeStroke.cpp.

{
    return d->pen.joinStyle();
}

References d.

◆ lineBrush()

QBrush KoShapeStroke::lineBrush ( ) const

Returns the strokes brush.

Definition at line 405 of file KoShapeStroke.cpp.

{
    return d->brush;
}

References d.

◆ lineDashes()

QVector< qreal > KoShapeStroke::lineDashes ( ) const

Returns the line dashes.

Definition at line 385 of file KoShapeStroke.cpp.

{
    return d->pen.dashPattern();
}

References d.

◆ lineStyle()

Qt::PenStyle KoShapeStroke::lineStyle ( ) const

Returns the line style.

Definition at line 380 of file KoShapeStroke.cpp.

{
    return d->pen.style();
}

References d.

◆ lineWidth()

qreal KoShapeStroke::lineWidth ( ) const

Returns the line width.

Definition at line 346 of file KoShapeStroke.cpp.

{
    return d->pen.widthF();
}

References d.

◆ miterLimit()

qreal KoShapeStroke::miterLimit ( ) const

Returns the miter limit.

Definition at line 356 of file KoShapeStroke.cpp.

{
    return d->pen.miterLimit();
}

References d.

◆ operator=()

KoShapeStroke & KoShapeStroke::operator= ( const KoShapeStroke & rhs )

Assignment operator.

Definition at line 196 of file KoShapeStroke.cpp.

{
    if (this == &rhs)
        return *this;
 
    d->pen = rhs.d->pen;
    d->color = rhs.d->color;
    d->brush = rhs.d->brush;
 
    return *this;
}

References d.

◆ paint()

void KoShapeStroke::paint	(	const KoShape *	shape,
		QPainter &	painter ) const

overridevirtual

Paint the stroke. This method should paint the stroke around shape.

Parameters

shape	the shape to paint around
painter	the painter to paint to, the painter will have the topleft of the shape as its start coordinate.

Implements KoShapeStrokeModel.

Definition at line 273 of file KoShapeStroke.cpp.

{
    KisQPainterStateSaver saver(&painter);
 
    d->paintBorder(shape, painter, resultLinePen());
}

References d, and resultLinePen().

◆ paintBorder()

void KoShapeStroke::paintBorder	(	const KoShape *	shape,
		QPainter &	painter,
		const QPen &	pen ) const

◆ paintMarkers() [1/2]

void KoShapeStroke::paintMarkers	(	const KoShape *	shape,
		QPainter &	painter ) const

overridevirtual

paintMarkers Paints the markers if possible.

See also: paint()

Implements KoShapeStrokeModel.

Definition at line 280 of file KoShapeStroke.cpp.

{
    KisQPainterStateSaver saver(&painter);
 
    d->paintMarkers(shape, painter, resultLinePen());
}

References d, and resultLinePen().

◆ paintMarkers() [2/2]

void KoShapeStroke::paintMarkers	(	const KoShape *	shape,
		QPainter &	painter,
		const QPen &	pen ) const

◆ Private()

KoShapeStroke::Private ( KoShapeStroke * _q )

inline

Definition at line 39 of file KoShapeStroke.cpp.

39: q(_q) {}

KoShapeStroke::q

KoShapeStroke * q

Definition KoShapeStroke.cpp:40

◆ resultLinePen()

QPen KoShapeStroke::resultLinePen ( ) const

Definition at line 260 of file KoShapeStroke.cpp.

{
    QPen pen = d->pen;
 
    if (d->brush.gradient()) {
        pen.setBrush(d->brush);
    } else {
        pen.setColor(d->color.isValid() ? d->color : Qt::transparent);
    }
 
    return pen;
}

References d, and pen.

◆ setCapStyle()

void KoShapeStroke::setCapStyle ( Qt::PenCapStyle style )

Sets the lines cap style.

Definition at line 321 of file KoShapeStroke.cpp.

{
    d->pen.setCapStyle(style);
}

References d.

◆ setColor()

void KoShapeStroke::setColor ( const QColor & color )

Sets the color.

Definition at line 366 of file KoShapeStroke.cpp.

{
    d->color = color;
}

References color, and d.

◆ setDashOffset()

void KoShapeStroke::setDashOffset ( qreal dashOffset )

Sets the dash offset.

Definition at line 390 of file KoShapeStroke.cpp.

{
    d->pen.setDashOffset(dashOffset);
}

References d, and dashOffset().

◆ setJoinStyle()

void KoShapeStroke::setJoinStyle ( Qt::PenJoinStyle style )

Sets the lines join style.

Definition at line 331 of file KoShapeStroke.cpp.

{
    d->pen.setJoinStyle(style);
}

References d.

◆ setLineBrush()

void KoShapeStroke::setLineBrush ( const QBrush & brush )

Sets the strokes brush used to fill strokes of this border.

Definition at line 400 of file KoShapeStroke.cpp.

{
    d->brush = brush;
}

References brush, and d.

◆ setLineStyle()

void KoShapeStroke::setLineStyle	(	Qt::PenStyle	style,
		const QVector< qreal > &	dashes )

Sets the line style.

Definition at line 371 of file KoShapeStroke.cpp.

{
    if (style < Qt::CustomDashLine) {
        d->pen.setStyle(style);
    } else {
        d->pen.setDashPattern(dashes);
    }
}

References d.

◆ setLineWidth()

void KoShapeStroke::setLineWidth ( qreal lineWidth )

Sets the line width.

Definition at line 341 of file KoShapeStroke.cpp.

{
    d->pen.setWidthF(qMax(qreal(0.0), lineWidth));
}

References d, and lineWidth().

◆ setMiterLimit()

void KoShapeStroke::setMiterLimit ( qreal miterLimit )

Sets the miter limit.

Definition at line 351 of file KoShapeStroke.cpp.

{
    d->pen.setMiterLimit(miterLimit);
}

References d, and miterLimit().

◆ strokeInsets()

void KoShapeStroke::strokeInsets	(	const KoShape *	shape,
		KoInsets &	insets ) const

overridevirtual

Return a strokeInsets object filled with the size inside the shape that this stroke takes.

Parameters

shape	the shape the insets will be calculated for
insets	the insets object that will be filled and returned.

Implements KoShapeStrokeModel.

Definition at line 208 of file KoShapeStroke.cpp.

{
    Q_UNUSED(shape);
 
    // '0.5' --- since we draw a line half inside, and half outside the object.
    qreal extent = 0.5 * (d->pen.widthF() >= 0 ? d->pen.widthF() : 1.0);
 
    // if we have square cap, we need a little more space
    // -> sqrt((0.5*penWidth)^2 + (0.5*penWidth)^2)
    if (capStyle() == Qt::SquareCap) {
        extent *= M_SQRT2;
    }
 
    if (joinStyle() == Qt::MiterJoin) {
        // miter limit in Qt is normalized by the line width (and not half-width)
        extent = qMax(extent, d->pen.widthF() * miterLimit());
    }
 
    insets.top = extent;
    insets.bottom = extent;
    insets.left = extent;
    insets.right = extent;
}

References KoInsets::bottom, capStyle(), d, joinStyle(), KoInsets::left, miterLimit(), KoInsets::right, and KoInsets::top.

◆ strokeMaxMarkersInset()

qreal KoShapeStroke::strokeMaxMarkersInset ( const KoShape * shape ) const

overridevirtual

Return a maximum distance that the markers of the shape can take outside the shape itself

Implements KoShapeStrokeModel.

Definition at line 232 of file KoShapeStroke.cpp.

{
    qreal result = 0.0;
 
    const KoPathShape *pathShape = dynamic_cast<const KoPathShape *>(shape);
    if (pathShape && pathShape->hasMarkers()) {
        const qreal lineWidth = d->pen.widthF();
 
        QVector<const KoMarker*> markers;
        markers << pathShape->marker(KoFlake::StartMarker);
        markers << pathShape->marker(KoFlake::MidMarker);
        markers << pathShape->marker(KoFlake::EndMarker);
 
        Q_FOREACH (const KoMarker *marker, markers) {
            if (marker) {
                result = qMax(result, marker->maxInset(lineWidth));
            }
        }
    }
 
    return result;
}

References d, KoFlake::EndMarker, KoPathShape::hasMarkers(), lineWidth(), KoPathShape::marker(), KoMarker::maxInset(), KoFlake::MidMarker, and KoFlake::StartMarker.

Member Data Documentation

◆ brush

QBrush KoShapeStroke::brush

Definition at line 46 of file KoShapeStroke.cpp.

◆ color

QColor KoShapeStroke::color

Definition at line 44 of file KoShapeStroke.cpp.

◆ d

Private* const KoShapeStroke::d

private

Definition at line 104 of file KoShapeStroke.h.

◆ pen

QPen KoShapeStroke::pen

Definition at line 45 of file KoShapeStroke.cpp.

◆ q

KoShapeStroke* KoShapeStroke::q

Definition at line 40 of file KoShapeStroke.cpp.

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

libs/flake/KoShapeStroke.cpp
libs/flake/KoShapeStroke.h

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KoShapeStroke() [1/3]

◆ KoShapeStroke() [2/3]

◆ KoShapeStroke() [3/3]

◆ ~KoShapeStroke()

Member Function Documentation

◆ capStyle()

◆ color()

◆ compareFillTo()

◆ compareStyleTo()

◆ dashOffset()

◆ hasTransparency()

◆ isVisible()

◆ joinStyle()

◆ lineBrush()

◆ lineDashes()

◆ lineStyle()

◆ lineWidth()

◆ miterLimit()

◆ operator=()

◆ paint()

◆ paintBorder()

◆ paintMarkers() [1/2]

◆ paintMarkers() [2/2]

◆ Private()

◆ resultLinePen()

◆ setCapStyle()

◆ setColor()

◆ setDashOffset()

◆ setJoinStyle()

◆ setLineBrush()

◆ setLineStyle()

◆ setLineWidth()

◆ setMiterLimit()

◆ strokeInsets()

◆ strokeMaxMarkersInset()

Member Data Documentation

◆ brush

◆ color

◆ d

◆ pen

◆ q