QPoint Class

Member Function Documentation

[constexpr noexcept] QPoint::QPoint()

Constructs a null point, i.e. with coordinates (0, 0)

See also isNull().

[constexpr noexcept] QPoint::QPoint(int xpos, int ypos)

Constructs a point with the given coordinates (xpos, ypos).

See also setX() and setY().

[static constexpr] int QPoint::dotProduct(const QPoint &p1, const QPoint &p2)

QPoint p( 3, 7);
QPoint q(-1, 4);
int dotProduct = QPoint::dotProduct(p, q);   // dotProduct becomes 25

Returns the dot product of p1 and p2.

[constexpr noexcept] bool QPoint::isNull() const

Returns true if both the x and y coordinates are set to 0, otherwise returns false.

[constexpr] int QPoint::manhattanLength() const

Returns the sum of the absolute values of x() and y(), traditionally known as the "Manhattan length" of the vector from the origin to the point. For example:

QPoint oldPosition;

MyWidget::mouseMoveEvent(QMouseEvent *event)
{
    QPoint point = event->pos() - oldPosition;
    if (point.manhattanLength() > 3)
        // the mouse has moved more than 3 pixels since the oldPosition
}

This is a useful, and quick to calculate, approximation to the true length:

double trueLength = std::sqrt(std::pow(x(), 2) + std::pow(y(), 2));

The tradition of "Manhattan length" arises because such distances apply to travelers who can only travel on a rectangular grid, like the streets of Manhattan.

[constexpr noexcept] int &QPoint::rx()

Returns a reference to the x coordinate of this point.

Using a reference makes it possible to directly manipulate x. For example:

QPoint p(1, 2);
p.rx()--;   // p becomes (0, 2)

See also x() and setX().

[constexpr noexcept] int &QPoint::ry()

Returns a reference to the y coordinate of this point.

Using a reference makes it possible to directly manipulate y. For example:

QPoint p(1, 2);
p.ry()++;   // p becomes (1, 3)

See also y() and setY().

[constexpr noexcept] void QPoint::setX(int x)

Sets the x coordinate of this point to the given x coordinate.

See also x() and setY().

[constexpr noexcept] void QPoint::setY(int y)

Sets the y coordinate of this point to the given y coordinate.

See also y() and setX().

[noexcept] CGPoint QPoint::toCGPoint() const

Creates a CGPoint from a QPoint.

See also QPointF::fromCGPoint().

[constexpr noexcept, since 6.4] QPointF QPoint::toPointF() const

Returns this point as a point with floating point accuracy.

This function was introduced in Qt 6.4.

See also QPointF::toPoint().

[constexpr noexcept] QPoint QPoint::transposed() const

Returns a point with x and y coordinates exchanged:

QPoint{1, 2}.transposed() // {2, 1}

See also x(), y(), setX(), and setY().

[constexpr noexcept] int QPoint::x() const

Returns the x coordinate of this point.

See also setX() and rx().

[constexpr noexcept] int QPoint::y() const

Returns the y coordinate of this point.

See also setY() and ry().

[constexpr] QPoint &QPoint::operator*=(double factor)

Multiplies this point's coordinates by the given factor, and returns a reference to this point. For example:

QPoint p(-1, 4);
p *= 2.5;    // p becomes (-3, 10)

Note that the result is rounded to the nearest integer as points are held as integers. Use QPointF for floating point accuracy.

See also operator/=().

[constexpr] QPoint &QPoint::operator*=(float factor)

Multiplies this point's coordinates by the given factor, and returns a reference to this point.

Note that the result is rounded to the nearest integer as points are held as integers. Use QPointF for floating point accuracy.

See also operator/=().

[constexpr] QPoint &QPoint::operator*=(int factor)

Multiplies this point's coordinates by the given factor, and returns a reference to this point.

See also operator/=().

[constexpr] QPoint &QPoint::operator+=(const QPoint &point)

Adds the given point to this point and returns a reference to this point. For example:

QPoint p( 3, 7);
QPoint q(-1, 4);
p += q;    // p becomes (2, 11)

See also operator-=().

[constexpr] QPoint &QPoint::operator-=(const QPoint &point)

Subtracts the given point from this point and returns a reference to this point. For example:

QPoint p( 3, 7);
QPoint q(-1, 4);
p -= q;    // p becomes (4, 3)

See also operator+=().

[constexpr] QPoint &QPoint::operator/=(qreal divisor)

This is an overloaded function.

Divides both x and y by the given divisor, and returns a reference to this point. For example:

QPoint p(-3, 10);
p /= 2.5;           // p becomes (-1, 4)

Note that the result is rounded to the nearest integer as points are held as integers. Use QPointF for floating point accuracy.

See also operator*=().