QPoint¶

The QPoint class defines a point in the plane using integer precision. More…

Synopsis¶

Functions¶

def __add__ ()
def __add__ (p2)
def __div__ (c)
def __eq__ (p2)
def __iadd__ (p)
def __idiv__ (divisor)
def __imul__ (factor)
def __imul__ (factor)
def __imul__ (factor)
def __isub__ (p)
def __mul__ (factor)
def __mul__ (factor)
def __mul__ (factor)
def __mul__ (factor)
def __mul__ (factor)
def __mul__ (factor)
def __mul__ (m)
def __mul__ (matrix)
def __mul__ (matrix)
def __ne__ (p2)
def __reduce__ ()
def __repr__ ()
def __sub__ ()
def __sub__ (p2)
def isNull ()
def manhattanLength ()
def setX (x)
def setY (y)
def toTuple ()
def transposed ()
def x ()
def y ()

Static functions¶

def dotProduct (p1, p2)

Detailed Description¶

A point is specified by a x coordinate and an y coordinate which can be accessed using the x() and y() functions. The isNull() function returns true if both x and y are set to 0. The coordinates can be set (or altered) using the setX() and setY() functions, or alternatively the rx() and ry() functions which return references to the coordinates (allowing direct manipulation).

Given a point p, the following statements are all equivalent:

p = QPoint()
p.setX(p.x() + 1)
p += QPoint(1, 0)
p.rx() = p.rx() + 1

A QPoint object can also be used as a vector: Addition and subtraction are defined as for vectors (each component is added separately). A QPoint object can also be divided or multiplied by an int or a qreal.

In addition, the QPoint class provides the manhattanLength() function which gives an inexpensive approximation of the length of the QPoint object interpreted as a vector. Finally, QPoint objects can be streamed as well as compared.

See also

QPointF QPolygon

class PySide6.QtCore.QPoint¶

PySide6.QtCore.QPoint(QPoint)

PySide6.QtCore.QPoint(xpos, ypos)

Parameters

QPoint – PySide6.QtCore.QPoint
xpos – int
ypos – int

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

See also

isNull()

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

See also

setX() setY()

PySide6.QtCore.QPoint.__reduce__()¶

Return type: object

PySide6.QtCore.QPoint.__repr__()¶

Return type: object

static PySide6.QtCore.QPoint.dotProduct(p1, p2)¶

Parameters

p1 – PySide6.QtCore.QPoint
p2 – PySide6.QtCore.QPoint

Return type

int

p = QPoint( 3, 7)
q = QPoint(-1, 4)
lengthSquared = QPoint.dotProduct(p, q) # lengthSquared becomes 25()

Returns the dot product of p1 and p2.

PySide6.QtCore.QPoint.isNull()¶

Return type: bool

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

PySide6.QtCore.QPoint.manhattanLength()¶

Return type: int

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:

oldPosition = QPoint()
MyWidget::mouseMoveEvent(QMouseEvent event)

    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:

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.

PySide6.QtCore.QPoint.__ne__(p2)¶

Parameters: p2 – PySide6.QtCore.QPoint
Return type: bool

PySide6.QtCore.QPoint.__mul__(m)¶

Parameters: m – PySide6.QtGui.QTransform
Return type: PySide6.QtCore.QPoint