The QPainterPath class provides a container for painting operations, enabling graphical shapes to be constructed and reused. More...

#include <qpainterpath.h>

Classes
class	Element
	The QPainterPath::Element class specifies the position and type of a subpath. More...

Public Types
enum	ElementType { MoveToElement , LineToElement , CurveToElement , CurveToDataElement }

Public Member Functions
	QPainterPath () noexcept

	QPainterPath (const QPointF &startPoint)

	QPainterPath (const QPainterPath &other)

QPainterPath &	operator= (const QPainterPath &other)

	~QPainterPath ()

void	swap (QPainterPath &other) noexcept

void	clear ()

void	reserve (int size)

int	capacity () const

void	closeSubpath ()

void	moveTo (const QPointF &p)

void	moveTo (qreal x, qreal y)

void	lineTo (const QPointF &p)

void	lineTo (qreal x, qreal y)

void	arcMoveTo (const QRectF &rect, qreal angle)

void	arcMoveTo (qreal x, qreal y, qreal w, qreal h, qreal angle)

void	arcTo (const QRectF &rect, qreal startAngle, qreal arcLength)

void	arcTo (qreal x, qreal y, qreal w, qreal h, qreal startAngle, qreal arcLength)

void	cubicTo (const QPointF &ctrlPt1, const QPointF &ctrlPt2, const QPointF &endPt)

void	cubicTo (qreal ctrlPt1x, qreal ctrlPt1y, qreal ctrlPt2x, qreal ctrlPt2y, qreal endPtx, qreal endPty)

void	quadTo (const QPointF &ctrlPt, const QPointF &endPt)

void	quadTo (qreal ctrlPtx, qreal ctrlPty, qreal endPtx, qreal endPty)

QPointF	currentPosition () const

void	addRect (const QRectF &rect)

void	addRect (qreal x, qreal y, qreal w, qreal h)

void	addEllipse (const QRectF &rect)

void	addEllipse (qreal x, qreal y, qreal w, qreal h)

void	addEllipse (const QPointF &center, qreal rx, qreal ry)

void	addPolygon (const QPolygonF &polygon)

void	addText (const QPointF &point, const QFont &f, const QString &text)

void	addText (qreal x, qreal y, const QFont &f, const QString &text)

void	addPath (const QPainterPath &path)

void	addRegion (const QRegion &region)

void	addRoundedRect (const QRectF &rect, qreal xRadius, qreal yRadius, Qt::SizeMode mode=Qt::AbsoluteSize)

void	addRoundedRect (qreal x, qreal y, qreal w, qreal h, qreal xRadius, qreal yRadius, Qt::SizeMode mode=Qt::AbsoluteSize)

void	connectPath (const QPainterPath &path)

bool	contains (const QPointF &pt) const

bool	contains (const QRectF &rect) const

bool	intersects (const QRectF &rect) const

void	translate (qreal dx, qreal dy)

void	translate (const QPointF &offset)

QPainterPath	translated (qreal dx, qreal dy) const

QPainterPath	translated (const QPointF &offset) const

QRectF	boundingRect () const

QRectF	controlPointRect () const

Qt::FillRule	fillRule () const

void	setFillRule (Qt::FillRule fillRule)

bool	isEmpty () const

QPainterPath	toReversed () const

QList< QPolygonF >	toSubpathPolygons (const QTransform &matrix=QTransform()) const

QList< QPolygonF >	toFillPolygons (const QTransform &matrix=QTransform()) const

QPolygonF	toFillPolygon (const QTransform &matrix=QTransform()) const

int	elementCount () const

QPainterPath::Element	elementAt (int i) const

void	setElementPositionAt (int i, qreal x, qreal y)

qreal	length () const

qreal	percentAtLength (qreal t) const

QPointF	pointAtPercent (qreal t) const

qreal	angleAtPercent (qreal t) const

qreal	slopeAtPercent (qreal t) const

bool	intersects (const QPainterPath &p) const

bool	contains (const QPainterPath &p) const

QPainterPath	united (const QPainterPath &r) const

QPainterPath	intersected (const QPainterPath &r) const

QPainterPath	subtracted (const QPainterPath &r) const

QPainterPath	simplified () const

bool	operator== (const QPainterPath &other) const

bool	operator!= (const QPainterPath &other) const

QPainterPath	operator& (const QPainterPath &other) const

QPainterPath	operator\| (const QPainterPath &other) const

QPainterPath	operator+ (const QPainterPath &other) const

QPainterPath	operator- (const QPainterPath &other) const

QPainterPath &	operator&= (const QPainterPath &other)

QPainterPath &	operator\|= (const QPainterPath &other)

QPainterPath &	operator+= (const QPainterPath &other)

QPainterPath &	operator-= (const QPainterPath &other)

Friends
class	QPainterPathStroker

class	QPainterPathStrokerPrivate

class	QTransform

class	QVectorPath

Q_GUI_EXPORT const QVectorPath &	qtVectorPathForPath (const QPainterPath &)

Q_GUI_EXPORT QDataStream &	operator<< (QDataStream &, const QPainterPath &)

Q_GUI_EXPORT QDataStream &	operator>> (QDataStream &, QPainterPath &)

Related Functions
(Note that these are not member functions.)
QDataStream &	operator<< (QDataStream &stream, const QPainterPath &path)

QDataStream &	operator>> (QDataStream &stream, QPainterPath &path)

Detailed Description

The QPainterPath class provides a container for painting operations, enabling graphical shapes to be constructed and reused.

\inmodule QtGui

A painter path is an object composed of a number of graphical building blocks, such as rectangles, ellipses, lines, and curves. Building blocks can be joined in closed subpaths, for example as a rectangle or an ellipse. A closed path has coinciding start and end points. Or they can exist independently as unclosed subpaths, such as lines and curves.

A QPainterPath object can be used for filling, outlining, and clipping. To generate fillable outlines for a given painter path, use the QPainterPathStroker class. The main advantage of painter paths over normal drawing operations is that complex shapes only need to be created once; then they can be drawn many times using only calls to the QPainter::drawPath() function.

QPainterPath provides a collection of functions that can be used to obtain information about the path and its elements. In addition it is possible to reverse the order of the elements using the toReversed() function. There are also several functions to convert this painter path object into a polygon representation.

Definition at line 64 of file qpainterpath.h.

Member Enumeration Documentation

◆ ElementType

enum QPainterPath::ElementType

This enum describes the types of elements used to connect vertices in subpaths.

Note that elements added as closed subpaths using the addEllipse(), addPath(), addPolygon(), addRect(), addRegion() and addText() convenience functions, is actually added to the path as a collection of separate elements using the moveTo(), lineTo() and cubicTo() functions.

\value MoveToElement A new subpath. See also moveTo(). \value LineToElement A line. See also lineTo(). \value CurveToElement A curve. See also cubicTo() and quadTo(). \value CurveToDataElement The extra data required to describe a curve in a CurveToElement element.

See also: elementAt(), elementCount()

Enumerator
MoveToElement
LineToElement
CurveToElement
CurveToDataElement

Definition at line 67 of file qpainterpath.h.

Constructor & Destructor Documentation

◆ QPainterPath() [1/3]

QPainterPath::QPainterPath ( )

noexcept

Constructs an empty QPainterPath object.

Definition at line 536 of file qpainterpath.cpp.

Here is the caller graph for this function:

◆ QPainterPath() [2/3]

QPainterPath::QPainterPath ( const QPointF & startPoint )

explicit

Creates a QPainterPath object with the given startPoint as its current position.

Definition at line 555 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ QPainterPath() [3/3]

QPainterPath::QPainterPath ( const QPainterPath & other )

default

Creates a QPainterPath object that is a copy of the given path.

See also: operator=()

◆ ~QPainterPath()

QPainterPath::~QPainterPath ( )

Destroys this QPainterPath object.

Definition at line 614 of file qpainterpath.cpp.

Member Function Documentation

◆ addEllipse() [1/3]

void QPainterPath::addEllipse	(	const QPointF &	center,
		qreal	rx,
		qreal	ry
	)

inline

Since: 4.4

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Creates an ellipse positioned at {center} with radii {rx} and {ry}, and adds it to the painter path as a closed subpath.

Definition at line 308 of file qpainterpath.h.

Here is the call graph for this function:

◆ addEllipse() [2/3]

void QPainterPath::addEllipse ( const QRectF & boundingRectangle )

Creates an ellipse within the specified boundingRectangle and adds it to the painter path as a closed subpath.

The ellipse is composed of a clockwise curve, starting and finishing at zero degrees (the 3 o'clock position).

\table 100% \row

\inlineimage qpainterpath-addellipse.png
\endtable

See also: arcTo(), QPainter::drawEllipse(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 1135 of file qpainterpath.cpp.

Here is the caller graph for this function:

◆ addEllipse() [3/3]

void QPainterPath::addEllipse	(	qreal	x,
		qreal	y,
		qreal	width,
		qreal	height
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Creates an ellipse within the bounding rectangle defined by its top-left corner at (x, y), width and height, and adds it to the painter path as a closed subpath.

Definition at line 303 of file qpainterpath.h.

◆ addPath()

void QPainterPath::addPath ( const QPainterPath & path )

Adds the given path to this path as a closed subpath.

See also: connectPath(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 1258 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addPolygon()

void QPainterPath::addPolygon ( const QPolygonF & polygon )

Adds the given polygon to the path as an (unclosed) subpath.

Note that the current position after the polygon has been added, is the last point in polygon. To draw a line back to the first point, use the closeSubpath() function.

\table 100% \row

\inlineimage qpainterpath-addpolygon.png
\endtable

See also: lineTo(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 1101 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addRect() [1/2]

void QPainterPath::addRect ( const QRectF & rectangle )

Adds the given rectangle to this path as a closed subpath.

The rectangle is added as a clockwise set of lines. The painter path's current position after the rectangle has been added is at the top-left corner of the rectangle.

\table 100% \row

\inlineimage qpainterpath-addrectangle.png
\endtable

See also: addRegion(), lineTo(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 1055 of file qpainterpath.cpp.

Here is the caller graph for this function:

◆ addRect() [2/2]

void QPainterPath::addRect	(	qreal	x,
		qreal	y,
		qreal	width,
		qreal	height
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Adds a rectangle at position ({x}, {y}), with the given width and height, as a closed subpath.

Definition at line 313 of file qpainterpath.h.

Here is the call graph for this function:

◆ addRegion()

void QPainterPath::addRegion ( const QRegion & region )

Adds the given region to the path by adding each rectangle in the region as a separate closed subpath.

See also: addRect(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 1327 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ addRoundedRect() [1/2]

void QPainterPath::addRoundedRect	(	const QRectF &	rect,
		qreal	xRadius,
		qreal	yRadius,
		Qt::SizeMode	mode = `Qt::AbsoluteSize`
	)

Since: 4.4

Adds the given rectangle rect with rounded corners to the path.

The xRadius and yRadius arguments specify the radii of the ellipses defining the corners of the rounded rectangle. When mode is Qt::RelativeSize, xRadius and yRadius are specified in percentage of half the rectangle's width and height respectively, and should be in the range 0.0 to 100.0.

See also: addRect()

Definition at line 3145 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addRoundedRect() [2/2]

void QPainterPath::addRoundedRect	(	qreal	x,
		qreal	y,
		qreal	w,
		qreal	h,
		qreal	xRadius,
		qreal	yRadius,
		Qt::SizeMode	mode = `Qt::AbsoluteSize`
	)

inline

Since: 4.4 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Adds the given rectangle x, y, w, h with rounded corners to the path.

Definition at line 318 of file qpainterpath.h.

◆ addText() [1/2]

void QPainterPath::addText	(	const QPointF &	point,
		const QFont &	font,
		const QString &	text
	)

Adds the given text to this path as a set of closed subpaths created from the font supplied. The subpaths are positioned so that the left end of the text's baseline lies at the specified point.

\table 100% \row

\inlineimage qpainterpath-addtext.png
\endtable

See also: QPainter::drawText(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 1184 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addText() [2/2]

void QPainterPath::addText	(	qreal	x,
		qreal	y,
		const QFont &	font,
		const QString &	text
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Adds the given text to this path as a set of closed subpaths created from the font supplied. The subpaths are positioned so that the left end of the text's baseline lies at the point specified by (x, y).

Definition at line 325 of file qpainterpath.h.

Here is the call graph for this function:

◆ angleAtPercent()

qreal QPainterPath::angleAtPercent ( qreal t ) const

Returns the angle of the path tangent at the percentage t. The argument t has to be between 0 and 1.

Positive values for the angles mean counter-clockwise while negative values mean the clockwise direction. Zero degrees is at the 3 o'clock position.

Note that similarly to the other percent methods, the percentage measurement is not linear with regards to the length if curves are present in the path. When curves are present the percentage argument is mapped to the t parameter of the Bezier equations.

Definition at line 3067 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ arcMoveTo() [1/2]

void QPainterPath::arcMoveTo	(	const QRectF &	rectangle,
		qreal	angle
	)

Since: 4.2

Creates a move to that lies on the arc that occupies the given rectangle at angle.

Angles are specified in degrees. Clockwise arcs can be specified using negative angles.

See also: moveTo(), arcTo()

Definition at line 1002 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ arcMoveTo() [2/2]

void QPainterPath::arcMoveTo	(	qreal	x,
		qreal	y,
		qreal	width,
		qreal	height,
		qreal	angle
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since: 4.2

Creates a move to that lies on the arc that occupies the QRectF(x, y, width, height) at angle.

Definition at line 286 of file qpainterpath.h.

◆ arcTo() [1/2]

void QPainterPath::arcTo	(	const QRectF &	rectangle,
		qreal	startAngle,
		qreal	sweepLength
	)

Creates an arc that occupies the given rectangle, beginning at the specified startAngle and extending sweepLength degrees counter-clockwise.

Angles are specified in degrees. Clockwise arcs can be specified using negative angles.

Note that this function connects the starting point of the arc to the current position if they are not already connected. After the arc has been added, the current position is the last point in arc. To draw a line back to the first point, use the closeSubpath() function.

\table 100% \row

\inlineimage qpainterpath-arcto.png
\endtable

See also: arcMoveTo(), addEllipse(), QPainter::drawArc(), QPainter::drawPie(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 945 of file qpainterpath.cpp.

Here is the caller graph for this function:

◆ arcTo() [2/2]

void QPainterPath::arcTo	(	qreal	x,
		qreal	y,
		qreal	w,
		qreal	h,
		qreal	startAngle,
		qreal	arcLength
	)

inline

Definition at line 281 of file qpainterpath.h.

◆ boundingRect()

QRectF QPainterPath::boundingRect ( ) const

Returns the bounding rectangle of this painter path as a rectangle with floating point precision.

See also: controlPointRect()

Definition at line 1483 of file qpainterpath.cpp.

Here is the caller graph for this function:

◆ capacity()

int QPainterPath::capacity ( ) const

Returns the number of elements allocated by the QPainterPath.

See also: clear(), reserve()

Since: 5.13

Definition at line 660 of file qpainterpath.cpp.

◆ clear()

void QPainterPath::clear ( )

Clears the path elements stored.

This allows the path to reuse previous memory allocations.

See also: reserve(), capacity()

Since: 5.13

Definition at line 626 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ closeSubpath()

void QPainterPath::closeSubpath ( )

Closes the current subpath by drawing a line to the beginning of the subpath, automatically starting a new path. The current point of the new path is (0, 0).

If the subpath does not contain any elements, this function does nothing.

See also: moveTo(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 680 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ connectPath()

void QPainterPath::connectPath ( const QPainterPath & path )

Connects the given path to this path by adding a line from the last element of this path to the first element of the given path.

See also: addPath(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 1289 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ contains() [1/3]

bool QPainterPath::contains ( const QPainterPath & p ) const

Since: 4.3

Returns true if the given path p is contained within the current path. Returns false if any edges of the current path and p intersect.

Set operations on paths will treat the paths as areas. Non-closed paths will be treated as implicitly closed.

See also: intersects()

Definition at line 3314 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ contains() [2/3]

bool QPainterPath::contains ( const QPointF & point ) const

Returns true if the given point is inside the path, otherwise returns false.

See also: intersects()

Definition at line 1830 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ contains() [3/3]

bool QPainterPath::contains ( const QRectF & rectangle ) const

Returns true if the given rectangle is inside the path, otherwise returns false.

Definition at line 2203 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ controlPointRect()

QRectF QPainterPath::controlPointRect ( ) const

Returns the rectangle containing all the points and control points in this path.

This function is significantly faster to compute than the exact boundingRect(), and the returned rectangle is always a superset of the rectangle returned by boundingRect().

See also: boundingRect()

Definition at line 1504 of file qpainterpath.cpp.

Here is the caller graph for this function:

◆ cubicTo() [1/2]

void QPainterPath::cubicTo	(	const QPointF &	c1,
		const QPointF &	c2,
		const QPointF &	endPoint
	)

Adds a cubic Bezier curve between the current position and the given endPoint using the control points specified by c1, and c2.

After the curve is added, the current position is updated to be at the end point of the curve.

\table 100% \row

\inlineimage qpainterpath-cubicto.png
\endtable

See also: quadTo(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 818 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cubicTo() [2/2]

void QPainterPath::cubicTo	(	qreal	c1X,
		qreal	c1Y,
		qreal	c2X,
		qreal	c2Y,
		qreal	endPointX,
		qreal	endPointY
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Adds a cubic Bezier curve between the current position and the end point ({endPointX}, {endPointY}) with control points specified by ({c1X}, {c1Y}) and ({c2X}, {c2Y}).

Definition at line 291 of file qpainterpath.h.

◆ currentPosition()

QPointF QPainterPath::currentPosition ( ) const

Returns the current position of the path.

Definition at line 1019 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ elementAt()

QPainterPath::Element QPainterPath::elementAt ( int index ) const

Returns the element at the given index in the painter path.

See also: ElementType, elementCount(), isEmpty()

Definition at line 500 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ elementCount()

int QPainterPath::elementCount ( ) const

Returns the number of path elements in the painter path.

See also: ElementType, elementAt(), isEmpty()

Definition at line 487 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillRule()

Qt::FillRule QPainterPath::fillRule ( ) const

Returns the painter path's currently set fill rule.

See also: setFillRule()

Definition at line 1342 of file qpainterpath.cpp.

Here is the caller graph for this function:

◆ intersected()

QPainterPath QPainterPath::intersected ( const QPainterPath & p ) const

Since: 4.3

Returns a path which is the intersection of this path's fill area and p's fill area. Bezier curves may be flattened to line segments due to numerical instability of doing bezier curve intersections.

Definition at line 3238 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ intersects() [1/2]

bool QPainterPath::intersects ( const QPainterPath & p ) const

Since: 4.3

Returns true if the current path intersects at any point the given path p. Also returns true if the current path contains or is contained by any part of p.

Set operations on paths will treat the paths as areas. Non-closed paths will be treated as implicitly closed.

See also: contains()

Definition at line 3292 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ intersects() [2/2]

bool QPainterPath::intersects ( const QRectF & rectangle ) const

Returns true if any point in the given rectangle intersects the path; otherwise returns false.

There is an intersection if any of the lines making up the rectangle crosses a part of the path or if any part of the rectangle overlaps with any area enclosed by the path. This function respects the current fillRule to determine what is considered inside the path.

See also: contains()

Definition at line 2102 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEmpty()

bool QPainterPath::isEmpty ( ) const

Returns true if either there are no elements in this path, or if the only element is a MoveToElement; otherwise returns false.

See also: elementCount()

Definition at line 1525 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ length()

qreal QPainterPath::length ( ) const

Returns the length of the current path.

Definition at line 2873 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lineTo() [1/2]

void QPainterPath::lineTo ( const QPointF & endPoint )

Adds a straight line from the current position to the given endPoint. After the line is drawn, the current position is updated to be at the end point of the line.

See also: addPolygon(), addRect(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 760 of file qpainterpath.cpp.

Here is the caller graph for this function:

◆ lineTo() [2/2]

void QPainterPath::lineTo	(	qreal	x,
		qreal	y
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Draws a line from the current position to the point ({x}, {y}).

Definition at line 276 of file qpainterpath.h.

◆ moveTo() [1/2]

void QPainterPath::moveTo ( const QPointF & point )

Moves the current point to the given point, implicitly starting a new subpath and closing the previous one.

See also: closeSubpath(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 710 of file qpainterpath.cpp.

Here is the caller graph for this function:

◆ moveTo() [2/2]

void QPainterPath::moveTo	(	qreal	x,
		qreal	y
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Moves the current position to ({x}, {y}) and starts a new subpath, implicitly closing the previous path.

Definition at line 271 of file qpainterpath.h.

◆ operator!=()

bool QPainterPath::operator!= ( const QPainterPath & path ) const

Returns true if this painter path differs from the given path.

Note that comparing paths may involve a per element comparison which can be slow for complex paths.

See also: operator==()

Definition at line 2333 of file qpainterpath.cpp.

◆ operator&()

QPainterPath QPainterPath::operator& ( const QPainterPath & other ) const

Since: 4.5

Returns the intersection of this path and the other path.

See also: intersected(), operator&=(), united(), operator|()

Definition at line 2345 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ operator&=()

QPainterPath & QPainterPath::operator&= ( const QPainterPath & other )

Since: 4.5

Intersects this path with other and returns a reference to this path.

See also: intersected(), operator&(), operator|=()

Definition at line 2394 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ operator+()

QPainterPath QPainterPath::operator+ ( const QPainterPath & other ) const

Since: 4.5

Returns the union of this path and the other path. This function is equivalent to operator|().

See also: united(), operator+=(), operator-()

Definition at line 2370 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ operator+=()

QPainterPath & QPainterPath::operator+= ( const QPainterPath & other )

Since: 4.5

Unites this path with other, and returns a reference to this path. This is equivalent to operator|=().

See also: united(), operator+(), operator-=()

Definition at line 2419 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ operator-()

QPainterPath QPainterPath::operator- ( const QPainterPath & other ) const

Since: 4.5

Subtracts the other path from a copy of this path, and returns the copy.

See also: subtracted(), operator-=(), operator+()

Definition at line 2382 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ operator-=()

QPainterPath & QPainterPath::operator-= ( const QPainterPath & other )

Since: 4.5

Subtracts other from this path, and returns a reference to this path.

See also: subtracted(), operator-(), operator+=()

Definition at line 2432 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ operator=()

QPainterPath & QPainterPath::operator= ( const QPainterPath & path )

Assigns the given path to this painter path.

See also: QPainterPath()

Move-assigns other to this QPainterPath instance.

Since: 5.2

Definition at line 588 of file qpainterpath.cpp.

◆ operator==()

bool QPainterPath::operator== ( const QPainterPath & path ) const

Returns true if this painterpath is equal to the given path.

Note that comparing paths may involve a per element comparison which can be slow for complex paths.

See also: operator!=()

Definition at line 2292 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ operator|()

QPainterPath QPainterPath::operator| ( const QPainterPath & other ) const

Since: 4.5

Returns the union of this path and the other path.

See also: united(), operator|=(), intersected(), operator&()

Definition at line 2357 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ operator|=()

QPainterPath & QPainterPath::operator|= ( const QPainterPath & other )

Since: 4.5

Unites this path with other and returns a reference to this path.

See also: united(), operator|(), operator&=()

Definition at line 2406 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ percentAtLength()

qreal QPainterPath::percentAtLength ( qreal len ) const

Returns percentage of the whole path at the specified length len.

Note that similarly to other percent methods, the percentage measurement is not linear with regards to the length, if curves are present in the path. When curves are present the percentage argument is mapped to the t parameter of the Bezier equations.

Definition at line 2916 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ pointAtPercent()

QPointF QPainterPath::pointAtPercent ( qreal t ) const

Returns the point at at the percentage t of the current path. The argument t has to be between 0 and 1.

Note that similarly to other percent methods, the percentage measurement is not linear with regards to the length, if curves are present in the path. When curves are present the percentage argument is mapped to the t parameter of the Bezier equations.

Definition at line 3033 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ quadTo() [1/2]

void QPainterPath::quadTo	(	const QPointF &	c,
		const QPointF &	endPoint
	)

Adds a quadratic Bezier curve between the current position and the given endPoint with the control point specified by c.

After the curve is added, the current point is updated to be at the end point of the curve.

See also: cubicTo(), {QPainterPath::Composing a QPainterPath}{Composing a QPainterPath}

Definition at line 874 of file qpainterpath.cpp.

◆ quadTo() [2/2]

void QPainterPath::quadTo	(	qreal	cx,
		qreal	cy,
		qreal	endPointX,
		qreal	endPointY
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Adds a quadratic Bezier curve between the current point and the endpoint ({endPointX}, {endPointY}) with the control point specified by ({cx}, {cy}).

Definition at line 298 of file qpainterpath.h.

◆ reserve()

void QPainterPath::reserve ( int size )

Reserves a given amount of elements in QPainterPath's internal memory.

Attempts to allocate memory for at least size elements.

See also: clear(), capacity(), QList::reserve()

Since: 5.13

Definition at line 644 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ setElementPositionAt()

void QPainterPath::setElementPositionAt	(	int	index,
		qreal	x,
		qreal	y
	)

Since: 4.2

Sets the x and y coordinate of the element at index index to x and y.

Definition at line 515 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ setFillRule()

void QPainterPath::setFillRule ( Qt::FillRule fillRule )

Sets the fill rule of the painter path to the given fillRule. Qt provides two methods for filling paths:

\table \header

Qt::OddEvenFill (default)
Qt::WindingFill \row
\inlineimage qt-fillrule-oddeven.png
\inlineimage qt-fillrule-winding.png \endtable

See also: fillRule()

Definition at line 1364 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ simplified()

QPainterPath QPainterPath::simplified ( ) const

Since: 4.4

Returns a simplified version of this path. This implies merging all subpaths that intersect, and returning a path containing no intersecting edges. Consecutive parallel lines will also be merged. The simplified path will always use the default fill rule, Qt::OddEvenFill. Bezier curves may be flattened to line segments due to numerical instability of doing bezier curve intersections.

Definition at line 3273 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ slopeAtPercent()

qreal QPainterPath::slopeAtPercent ( qreal t ) const

Returns the slope of the path at the percentage t. The argument t has to be between 0 and 1.

Note that similarly to other percent methods, the percentage measurement is not linear with regards to the length, if curves are present in the path. When curves are present the percentage argument is mapped to the t parameter of the Bezier equations.

Definition at line 3096 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ subtracted()

QPainterPath QPainterPath::subtracted ( const QPainterPath & p ) const

Since: 4.3

Returns a path which is p's fill area subtracted from this path's fill area.

Set operations on paths will treat the paths as areas. Non-closed paths will be treated as implicitly closed. Bezier curves may be flattened to line segments due to numerical instability of doing bezier curve intersections.

Definition at line 3256 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ swap()

void QPainterPath::swap ( QPainterPath & other )

inlinenoexcept

Since: 4.8

Swaps painter path other with this painter path. This operation is very fast and never fails.

Definition at line 98 of file qpainterpath.h.

Here is the call graph for this function:

◆ toFillPolygon()

QPolygonF QPainterPath::toFillPolygon ( const QTransform & matrix = QTransform() ) const

Converts the path into a polygon using the QTransform matrix, and returns the polygon.

The polygon is created by first converting all subpaths to polygons, then using a rewinding technique to make sure that overlapping subpaths can be filled using the correct fill rule.

Note that rewinding inserts addition lines in the polygon so the outline of the fill polygon does not match the outline of the path.

See also: toSubpathPolygons(), toFillPolygons(), {QPainterPath::QPainterPath Conversion}{QPainterPath Conversion}

Definition at line 2847 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toFillPolygons()

QList< QPolygonF > QPainterPath::toFillPolygons ( const QTransform & matrix = QTransform() ) const

Converts the path into a list of polygons using the QTransform matrix, and returns the list.

The function differs from the toFillPolygon() function in that it creates several polygons. It is provided because it is usually faster to draw several small polygons than to draw one large polygon, even though the total number of points drawn is the same.

The toFillPolygons() function differs from the toSubpathPolygons() function in that it create only polygon for subpaths that have overlapping bounding rectangles.

Like the toFillPolygon() function, this function uses a rewinding technique to make sure that overlapping subpaths can be filled using the correct fill rule. Note that rewinding inserts addition lines in the polygons so the outline of the fill polygon does not match the outline of the path.

See also: toSubpathPolygons(), toFillPolygon(), {QPainterPath::QPainterPath Conversion}{QPainterPath Conversion}

Definition at line 1659 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ toReversed()

QPainterPath QPainterPath::toReversed ( ) const

Creates and returns a reversed copy of the path.

It is the order of the elements that is reversed: If a QPainterPath is composed by calling the moveTo(), lineTo() and cubicTo() functions in the specified order, the reversed copy is composed by calling cubicTo(), lineTo() and moveTo().

Definition at line 1538 of file qpainterpath.cpp.

Here is the call graph for this function:

◆ toSubpathPolygons()

QList< QPolygonF > QPainterPath::toSubpathPolygons ( const QTransform & matrix = QTransform() ) const

Converts the path into a list of polygons using the QTransform matrix, and returns the list.

This function creates one polygon for each subpath regardless of intersecting subpaths (i.e. overlapping bounding rectangles). To make sure that such overlapping subpaths are filled correctly, use the toFillPolygons() function instead.

See also: toFillPolygons(), toFillPolygon(), {QPainterPath::QPainterPath Conversion}{QPainterPath Conversion}

Definition at line 1592 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ translate() [1/2]

void QPainterPath::translate ( const QPointF & offset )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since: 4.6

Translates all elements in the path by the given offset.

See also: translated()

Definition at line 330 of file qpainterpath.h.

◆ translate() [2/2]

void QPainterPath::translate	(	qreal	dx,
		qreal	dy
	)

Translates all elements in the path by ({dx}, {dy}).

Since: 4.6

See also: translated()

Definition at line 2145 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ translated() [1/2]

QPainterPath QPainterPath::translated ( const QPointF & offset ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since: 4.6

Returns a copy of the path that is translated by the given offset.

See also: translate()

Definition at line 333 of file qpainterpath.h.

◆ translated() [2/2]

QPainterPath QPainterPath::translated	(	qreal	dx,
		qreal	dy
	)		const

Returns a copy of the path that is translated by ({dx}, {dy}).

Since: 4.6

See also: translate()

Definition at line 2180 of file qpainterpath.cpp.

Here is the caller graph for this function:

◆ united()

QPainterPath QPainterPath::united ( const QPainterPath & p ) const

Since: 4.3

Returns a path which is the union of this path's fill area and p's fill area.

Set operations on paths will treat the paths as areas. Non-closed paths will be treated as implicitly closed. Bezier curves may be flattened to line segments due to numerical instability of doing bezier curve intersections.

See also: intersected(), subtracted()

Definition at line 3223 of file qpainterpath.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<< [1/2]

QDataStream & operator<<	(	QDataStream &	stream,
		const QPainterPath &	path
	)

friend

Writes the given painter path to the given stream, and returns a reference to the stream.

See also: {Serializing Qt Data Types}

Definition at line 2447 of file qpainterpath.cpp.

◆ operator<<() [2/2]

QDataStream & operator<<	(	QDataStream &	stream,
		const QPainterPath &	path
	)

See also: {Serializing Qt Data Types}

Definition at line 2447 of file qpainterpath.cpp.

◆ operator>> [1/2]

QDataStream & operator>>	(	QDataStream &	stream,
		QPainterPath &	path
	)

friend

Reads a painter path from the given stream into the specified path, and returns a reference to the stream.

See also: {Serializing Qt Data Types}

Definition at line 2474 of file qpainterpath.cpp.

◆ operator>>() [2/2]

QDataStream & operator>>	(	QDataStream &	stream,
		QPainterPath &	path
	)

See also: {Serializing Qt Data Types}

Definition at line 2474 of file qpainterpath.cpp.

◆ QPainterPathStroker

friend class QPainterPathStroker

friend

Definition at line 211 of file qpainterpath.h.

◆ QPainterPathStrokerPrivate

friend class QPainterPathStrokerPrivate

friend

Definition at line 212 of file qpainterpath.h.

◆ QTransform

friend class QTransform

friend

Definition at line 213 of file qpainterpath.h.

◆ qtVectorPathForPath

Q_GUI_EXPORT const QVectorPath& qtVectorPathForPath ( const QPainterPath & )

friend

Definition at line 131 of file qpaintengineex.cpp.

◆ QVectorPath

friend class QVectorPath

friend

Definition at line 214 of file qpainterpath.h.

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

src/gui/painting/qpainterpath.h
src/gui/painting/qpainterpath.cpp

Classes

Public Types

Public Member Functions

Friends

Related Functions

Detailed Description

Member Enumeration Documentation

◆ ElementType

Constructor & Destructor Documentation

◆ QPainterPath() [1/3]

◆ QPainterPath() [2/3]

◆ QPainterPath() [3/3]

◆ ~QPainterPath()

Member Function Documentation

◆ addEllipse() [1/3]

◆ addEllipse() [2/3]

◆ addEllipse() [3/3]

◆ addPath()

◆ addPolygon()

◆ addRect() [1/2]

◆ addRect() [2/2]

◆ addRegion()

◆ addRoundedRect() [1/2]

◆ addRoundedRect() [2/2]

◆ addText() [1/2]

◆ addText() [2/2]

◆ angleAtPercent()

◆ arcMoveTo() [1/2]

◆ arcMoveTo() [2/2]

◆ arcTo() [1/2]

◆ arcTo() [2/2]

◆ boundingRect()

◆ capacity()

◆ clear()

◆ closeSubpath()

◆ connectPath()

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ controlPointRect()

◆ cubicTo() [1/2]

◆ cubicTo() [2/2]

◆ currentPosition()

◆ elementAt()

◆ elementCount()

◆ fillRule()

◆ intersected()

◆ intersects() [1/2]

◆ intersects() [2/2]

◆ isEmpty()

◆ length()

◆ lineTo() [1/2]

◆ lineTo() [2/2]

◆ moveTo() [1/2]

◆ moveTo() [2/2]

◆ operator!=()

◆ operator&()

◆ operator&=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator=()

◆ operator==()

◆ operator|()

◆ operator|=()

◆ percentAtLength()

◆ pointAtPercent()

◆ quadTo() [1/2]

◆ quadTo() [2/2]

◆ reserve()

◆ setElementPositionAt()

◆ setFillRule()

◆ simplified()

◆ slopeAtPercent()

◆ subtracted()

◆ swap()

◆ toFillPolygon()

◆ toFillPolygons()

◆ toReversed()