The QPainterPathStroker class is used to generate fillable outlines for a given painter path. More...

#include <qpainterpath.h>

Collaboration diagram for QPainterPathStroker:

Public Member Functions
	QPainterPathStroker ()
	Creates a new stroker.

	QPainterPathStroker (const QPen &pen)
	Creates a new stroker based on pen.

	~QPainterPathStroker ()
	Destroys the stroker.

void	setWidth (qreal width)
	Sets the width of the generated outline painter path to width.

qreal	width () const
	Returns the width of the generated outlines.

void	setCapStyle (Qt::PenCapStyle style)
	Sets the cap style of the generated outlines to style.

Qt::PenCapStyle	capStyle () const
	Returns the cap style of the generated outlines.

void	setJoinStyle (Qt::PenJoinStyle style)
	Sets the join style of the generated outlines to style.

Qt::PenJoinStyle	joinStyle () const
	Returns the join style of the generated outlines.

void	setMiterLimit (qreal length)
	Sets the miter limit of the generated outlines to limit.

qreal	miterLimit () const
	Returns the miter limit for the generated outlines.

void	setCurveThreshold (qreal threshold)
	Specifies the curve flattening threshold, controlling the granularity with which the generated outlines' curve is drawn.

qreal	curveThreshold () const
	Returns the curve flattening threshold for the generated outlines.

void	setDashPattern (Qt::PenStyle)
	Sets the dash pattern for the generated outlines to style.

void	setDashPattern (const QList< qreal > &dashPattern)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the dash pattern for the generated outlines to dashPattern.

QList< qreal >	dashPattern () const
	Returns the dash pattern for the generated outlines.

void	setDashOffset (qreal offset)
	Sets the dash offset for the generated outlines to offset.

qreal	dashOffset () const
	Returns the dash offset for the generated outlines.

QPainterPath	createStroke (const QPainterPath &path) const
	Generates a new path that is a fillable area representing the outline of the given path.

Friends
class	QX11PaintEngine

Detailed Description

The QPainterPathStroker class is used to generate fillable outlines for a given painter path.

Since: 4.1

\inmodule QtGui

By calling the createStroke() function, passing a given QPainterPath as argument, a new painter path representing the outline of the given path is created. The newly created painter path can then be filled to draw the original painter path's outline.

You can control the various design aspects (width, cap styles, join styles and dash pattern) of the outlining using the following functions:

\list

setWidth()
setCapStyle()
setJoinStyle()
setDashPattern() \endlist

The setDashPattern() function accepts both a Qt::PenStyle object and a list representation of the pattern as argument.

In addition you can specify a curve's threshold, controlling the granularity with which a curve is drawn, using the setCurveThreshold() function. The default threshold is a well adjusted value (0.25), and normally you should not need to modify it. However, you can make the curve's appearance smoother by decreasing its value.

You can also control the miter limit for the generated outline using the setMiterLimit() function. The miter limit describes how far from each join the miter join can extend. The limit is specified in the units of width so the pixelwise miter limit will be {miterlimit * width}. This value is only used if the join style is Qt::MiterJoin.

The painter path generated by the createStroke() function should only be used for outlining the given painter path. Otherwise it may cause unexpected behavior. Generated outlines also require the Qt::WindingFill rule which is set by default.

See also: QPen, QBrush

Definition at line 199 of file qpainterpath.h.

Constructor & Destructor Documentation

◆ QPainterPathStroker() [1/2]

QPainterPathStroker::QPainterPathStroker ( )

Creates a new stroker.

Definition at line 2565 of file qpainterpath.cpp.

◆ QPainterPathStroker() [2/2]

QPainterPathStroker::QPainterPathStroker ( const QPen & pen )

explicit

Creates a new stroker based on pen.

Since: 5.3

Definition at line 2575 of file qpainterpath.cpp.

Referenced by QPainterPrivate::draw_helper(), and QPainterPrivate::drawStretchedGradient().

Here is the caller graph for this function:

◆ ~QPainterPathStroker()

QPainterPathStroker::~QPainterPathStroker ( )

Destroys the stroker.

Definition at line 2593 of file qpainterpath.cpp.

Member Function Documentation

◆ capStyle()

Qt::PenCapStyle QPainterPathStroker::capStyle ( ) const

Returns the cap style of the generated outlines.

Definition at line 2667 of file qpainterpath.cpp.

◆ createStroke()

QPainterPath QPainterPathStroker::createStroke ( const QPainterPath & path ) const

Generates a new path that is a fillable area representing the outline of the given path.

The various design aspects of the outline are based on the stroker's properties: width(), capStyle(), joinStyle(), dashPattern(), curveThreshold() and miterLimit().

The generated path should only be used for outlining the given painter path. Otherwise it may cause unexpected behavior. Generated outlines also require the Qt::WindingFill rule which is set by default.

Definition at line 2611 of file qpainterpath.cpp.

◆ curveThreshold()

qreal QPainterPathStroker::curveThreshold ( ) const

Returns the curve flattening threshold for the generated outlines.

Definition at line 2729 of file qpainterpath.cpp.

◆ dashOffset()

qreal QPainterPathStroker::dashOffset ( ) const

Returns the dash offset for the generated outlines.

Definition at line 2776 of file qpainterpath.cpp.

◆ dashPattern()

QList< qreal > QPainterPathStroker::dashPattern ( ) const

Returns the dash pattern for the generated outlines.

Definition at line 2768 of file qpainterpath.cpp.

◆ joinStyle()

Qt::PenJoinStyle QPainterPathStroker::joinStyle ( ) const

Returns the join style of the generated outlines.

Definition at line 2683 of file qpainterpath.cpp.

◆ miterLimit()

qreal QPainterPathStroker::miterLimit ( ) const

Returns the miter limit for the generated outlines.

Definition at line 2706 of file qpainterpath.cpp.

◆ setCapStyle()

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

Sets the cap style of the generated outlines to style.

If a dash pattern is set, each segment of the pattern is subject to the cap style.

Definition at line 2658 of file qpainterpath.cpp.

◆ setCurveThreshold()

void QPainterPathStroker::setCurveThreshold ( qreal threshold )

Specifies the curve flattening threshold, controlling the granularity with which the generated outlines' curve is drawn.

The default threshold is a well adjusted value (0.25), and normally you should not need to modify it. However, you can make the curve's appearance smoother by decreasing its value.

Definition at line 2720 of file qpainterpath.cpp.

◆ setDashOffset()

void QPainterPathStroker::setDashOffset ( qreal offset )

Sets the dash offset for the generated outlines to offset.

See the documentation for QPen::setDashOffset() for a description of the dash offset.

Definition at line 2787 of file qpainterpath.cpp.

◆ setDashPattern() [1/2]

void QPainterPathStroker::setDashPattern ( const QList< qreal > & dashPattern )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the dash pattern for the generated outlines to dashPattern.

This function makes it possible to specify custom dash patterns.

Each element in the list contains the lengths of the dashes and spaces in the stroke, beginning with the first dash in the first element, the first space in the second element, and alternating between dashes and spaces for each following pair of elements.

The list can contain an odd number of elements, in which case the last element will be extended by the length of the first element when the pattern repeats.

Definition at line 2758 of file qpainterpath.cpp.

◆ setDashPattern() [2/2]

void QPainterPathStroker::setDashPattern ( Qt::PenStyle style )

Sets the dash pattern for the generated outlines to style.

Definition at line 2737 of file qpainterpath.cpp.

◆ setJoinStyle()

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

Sets the join style of the generated outlines to style.

Definition at line 2675 of file qpainterpath.cpp.

◆ setMiterLimit()

void QPainterPathStroker::setMiterLimit ( qreal limit )

Sets the miter limit of the generated outlines to limit.

The miter limit describes how far from each join the miter join can extend. The limit is specified in units of the currently set width. So the pixelwise miter limit will be { miterlimit * width}.

This value is only used if the join style is Qt::MiterJoin.

Definition at line 2698 of file qpainterpath.cpp.

◆ setWidth()

void QPainterPathStroker::setWidth ( qreal width )

Sets the width of the generated outline painter path to width.

The generated outlines will extend approximately 50% of width to each side of the given input path's original outline.

Definition at line 2636 of file qpainterpath.cpp.

◆ width()

qreal QPainterPathStroker::width ( ) const

Returns the width of the generated outlines.

Definition at line 2647 of file qpainterpath.cpp.

Friends And Related Symbol Documentation

◆ QX11PaintEngine

friend class QX11PaintEngine

friend

Definition at line 234 of file qpainterpath.h.

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

qtbase/src/gui/painting/qpainterpath.h (91f502a7d65d76f4a376903c4058385a62dad277)
qtbase/src/gui/painting/qpainterpath.cpp (91f502a7d65d76f4a376903c4058385a62dad277)

Public Member Functions

Friends