QPainterPathStroker¶
The
QPainterPathStroker
class is used to generate fillable outlines for a given painter path. More…
Synopsis¶
Functions¶
def
capStyle
()def
createStroke
(path)def
curveThreshold
()def
dashOffset
()def
dashPattern
()def
joinStyle
()def
miterLimit
()def
setCapStyle
(style)def
setCurveThreshold
(threshold)def
setDashOffset
(offset)def
setDashPattern
(arg__1)def
setDashPattern
(dashPattern)def
setJoinStyle
(style)def
setMiterLimit
(length)def
setWidth
(width)def
width
()
Detailed Description¶
By calling the
createStroke()
function, passing a givenQPainterPath
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 aPenStyle
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 bemiterlimit * width
. This value is only used if the join style isMiterJoin
.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 theWindingFill
rule which is set by default.
- class PySide2.QtGui.QPainterPathStroker¶
PySide2.QtGui.QPainterPathStroker(pen)
- param pen:
Creates a new stroker.
- PySide2.QtGui.QPainterPathStroker.capStyle()¶
- Return type:
Returns the cap style of the generated outlines.
See also
- PySide2.QtGui.QPainterPathStroker.createStroke(path)¶
- Parameters:
path –
PySide2.QtGui.QPainterPath
- Return type:
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()
andmiterLimit()
.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.
- PySide2.QtGui.QPainterPathStroker.curveThreshold()¶
- Return type:
float
Returns the curve flattening threshold for the generated outlines.
See also
- PySide2.QtGui.QPainterPathStroker.dashOffset()¶
- Return type:
float
Returns the dash offset for the generated outlines.
See also
- PySide2.QtGui.QPainterPathStroker.dashPattern()¶
- Return type:
Returns the dash pattern for the generated outlines.
See also
- PySide2.QtGui.QPainterPathStroker.joinStyle()¶
- Return type:
Returns the join style of the generated outlines.
See also
- PySide2.QtGui.QPainterPathStroker.miterLimit()¶
- Return type:
float
Returns the miter limit for the generated outlines.
See also
- PySide2.QtGui.QPainterPathStroker.setCapStyle(style)¶
- Parameters:
style –
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 capstyle
.See also
- PySide2.QtGui.QPainterPathStroker.setCurveThreshold(threshold)¶
- Parameters:
threshold – 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
- PySide2.QtGui.QPainterPathStroker.setDashOffset(offset)¶
- Parameters:
offset – 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
- PySide2.QtGui.QPainterPathStroker.setDashPattern(arg__1)¶
- Parameters:
arg__1 –
PenStyle
Sets the dash pattern for the generated outlines to
style
.See also
- PySide2.QtGui.QPainterPathStroker.setDashPattern(dashPattern)
- Parameters:
dashPattern –
- PySide2.QtGui.QPainterPathStroker.setJoinStyle(style)¶
- Parameters:
style –
PenJoinStyle
Sets the join style of the generated outlines to
style
.See also
- PySide2.QtGui.QPainterPathStroker.setMiterLimit(length)¶
- Parameters:
length – 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
- PySide2.QtGui.QPainterPathStroker.setWidth(width)¶
- Parameters:
width – 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
- PySide2.QtGui.QPainterPathStroker.width()¶
- Return type:
float
Returns the width of the generated outlines.
See also
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.