QPolygon Class

The QPolygon class provides a vector of points using integer precision. More...

Header: #include <QPolygon>
qmake: QT += gui
Inherits: QVector

Note: All functions in this class are reentrant.

Public Functions

QRect boundingRect() const
QPolygon intersected(const QPolygon &r) const
bool intersects(const QPolygon &p) const
void point(int index, int *x, int *y) const
void putPoints(int index, int nPoints, int firstx, int firsty, ...)
void setPoints(int nPoints, const int *points)
void setPoints(int nPoints, int firstx, int firsty, ...)
QPolygon subtracted(const QPolygon &r) const
void translate(int dx, int dy)
QPolygon translated(int dx, int dy) const
QPolygon united(const QPolygon &r) const
QVariant operator QVariant() const

Detailed Description

A QPolygon object is a QVector<QPoint>. The easiest way to add points to a QPolygon is to use QVector's streaming operator, as illustrated below:


          QPolygon polygon;
          polygon << QPoint(10, 20) << QPoint(20, 30);

In addition to the functions provided by QVector, QPolygon provides some point-specific functions.

Each point in a polygon can be retrieved by passing its index to the point() function. To populate the polygon, QPolygon provides the setPoint() function to set the point at a given index, the setPoints() function to set all the points in the polygon (resizing it to the given number of points), and the putPoints() function which copies a number of given points into the polygon from a specified index (resizing the polygon if necessary).

QPolygon provides the boundingRect() and translate() functions for geometry functions. Use the QMatrix::map() function for more general transformations of QPolygons.

The QPolygon class is implicitly shared.

See also QVector, QPolygonF, and QLine.

Member Function Documentation

QRect QPolygon::boundingRect() const

Returns the bounding rectangle of the polygon, or QRect(0, 0, 0, 0) if the polygon is empty.

See also QVector::isEmpty().

QPolygon QPolygon::intersected(const QPolygon &r) const

Returns a polygon which is the intersection of this polygon and r.

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

This function was introduced in Qt 4.3.

See also intersects().

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

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

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

This function was introduced in Qt 5.10.

See also intersected().

void QPolygon::point(int index, int *x, int *y) const

Extracts the coordinates of the point at the given index to *x and *y (if they are valid pointers).

See also setPoint().

void QPolygon::putPoints(int index, int nPoints, int firstx, int firsty, ...)

Copies nPoints points from the variable argument list into this polygon from the given index.

The points are given as a sequence of integers, starting with firstx then firsty, and so on. The polygon is resized if index+nPoints exceeds its current size.

The example code creates a polygon with three points (4,5), (6,7) and (8,9), by expanding the polygon from 1 to 3 points:


          QPolygon polygon(1);
          polygon[0] = QPoint(4, 5);
          polygon.putPoints(1, 2, 6,7, 8,9);

The following code has the same result, but here the putPoints() function overwrites rather than extends:


          QPolygon polygon(3);
          polygon.putPoints(0, 3, 4,5, 0,0, 8,9);
          polygon.putPoints(1, 1, 6,7);

See also setPoints().

void QPolygon::setPoints(int nPoints, const int *points)

Resizes the polygon to nPoints and populates it with the given points.

The example code creates a polygon with two points (10, 20) and (30, 40):


          static const int points[] = { 10, 20, 30, 40 };
          QPolygon polygon;
          polygon.setPoints(2, points);

See also setPoint() and putPoints().

void QPolygon::setPoints(int nPoints, int firstx, int firsty, ...)

This is an overloaded function.

Resizes the polygon to nPoints and populates it with the points specified by the variable argument list. The points are given as a sequence of integers, starting with firstx then firsty, and so on.

The example code creates a polygon with two points (10, 20) and (30, 40):


          QPolygon polygon;
          polygon.setPoints(2, 10, 20, 30, 40);

QPolygon QPolygon::subtracted(const QPolygon &r) const

Returns a polygon which is r subtracted from this polygon.

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

This function was introduced in Qt 4.3.

void QPolygon::translate(int dx, int dy)

Translates all points in the polygon by (dx, dy).

See also translated().

QPolygon QPolygon::translated(int dx, int dy) const

Returns a copy of the polygon that is translated by (dx, dy).

This function was introduced in Qt 4.6.

See also translate().

QPolygon QPolygon::united(const QPolygon &r) const

Returns a polygon which is the union of this polygon and r.

Set operations on polygons, will treat the polygons as areas, and implicitly close the polygon.

This function was introduced in Qt 4.3.

See also intersected() and subtracted().

QVariant QPolygon::operator QVariant() const

Returns the polygon as a QVariant