QPainterPathStroker¶

PyQt5.QtGui.QPainterPathStroker

Description¶

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

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:

The setDashPattern() function accepts both a PenStyle object and a vector 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 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 WindingFill rule which is set by default.

See also

QPen, QBrush.

Methods¶

__init__()

Creates a new stroker.

__init__(Union[QPen, QColor, GlobalColor, QGradient])

TODO

capStyle() → PenCapStyle

Returns the cap style of the generated outlines.

See also

setCapStyle().

createStroke(QPainterPath) → QPainterPath

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 WindingFill rule which is set by default.

curveThreshold() → float

Returns the curve flattening threshold for the generated outlines.

See also

setCurveThreshold().

dashOffset() → float

Returns the dash offset for the generated outlines.

See also

setDashOffset().

dashPattern() → List[float]

Returns the dash pattern for the generated outlines.

See also

setDashPattern().

joinStyle() → PenJoinStyle

Returns the join style of the generated outlines.

See also

setJoinStyle().

miterLimit() → float

Returns the miter limit for the generated outlines.

See also

setMiterLimit().

setCapStyle(PenCapStyle)

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.

See also

capStyle().

setCurveThreshold(float)

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.

See also

curveThreshold().

setDashOffset(float)

Sets the dash offset for the generated outlines to offset.

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

See also

dashOffset().

setDashPattern(PenStyle)

Sets the dash pattern for the generated outlines to style.

See also

dashPattern().

setDashPattern(Iterable[float])

This is an overloaded function.

Sets the dash pattern for the generated outlines to dashPattern. This function makes it possible to specify custom dash patterns.

Each element in the vector 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 vector 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.

setJoinStyle(PenJoinStyle)

Sets the join style of the generated outlines to style.

See also

joinStyle().

setMiterLimit(float)

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 MiterJoin.

See also

miterLimit().

setWidth(float)

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.

See also

width().

width() → float

Returns the width of the generated outlines.

See also

setWidth().