QTransform Class

Member Function Documentation

QTransform::QTransform()

Constructs an identity matrix.

All elements are set to zero except m11 and m22 (specifying the scale) and m33 which are set to 1.

See also reset().

QTransform::QTransform(qreal m11, qreal m12, qreal m21, qreal m22, qreal dx, qreal dy)

Constructs a matrix with the elements, m11, m12, m21, m22, dx and dy.

See also setMatrix().

QTransform::QTransform(qreal m11, qreal m12, qreal m13, qreal m21, qreal m22, qreal m23, qreal m31, qreal m32, qreal m33)

Constructs a matrix with the elements, m11, m12, m13, m21, m22, m23, m31, m32, m33.

See also setMatrix().

qreal QTransform::m11() const

Returns the horizontal scaling factor.

See also scale() and Basic Matrix Operations.

qreal QTransform::m12() const

Returns the vertical shearing factor.

See also shear() and Basic Matrix Operations.

qreal QTransform::m13() const

Returns the horizontal projection factor.

See also translate() and Basic Matrix Operations.

qreal QTransform::m21() const

Returns the horizontal shearing factor.

See also shear() and Basic Matrix Operations.

qreal QTransform::m22() const

Returns the vertical scaling factor.

See also scale() and Basic Matrix Operations.

qreal QTransform::m23() const

Returns the vertical projection factor.

See also translate() and Basic Matrix Operations.

qreal QTransform::m31() const

Returns the horizontal translation factor.

See also dx(), translate(), and Basic Matrix Operations.

qreal QTransform::m32() const

Returns the vertical translation factor.

See also dy(), translate(), and Basic Matrix Operations.

qreal QTransform::m33() const

Returns the division factor.

See also translate() and Basic Matrix Operations.

QTransform QTransform::adjoint() const

Returns the adjoint of this matrix.

qreal QTransform::determinant() const

Returns the matrix's determinant.

qreal QTransform::dx() const

Returns the horizontal translation factor.

See also m31(), translate(), and Basic Matrix Operations.

qreal QTransform::dy() const

Returns the vertical translation factor.

See also translate() and Basic Matrix Operations.

[static] QTransform QTransform::fromScale(qreal sx, qreal sy)

Creates a matrix which corresponds to a scaling of sx horizontally and sy vertically. This is the same as QTransform().scale(sx, sy) but slightly faster.

[static] QTransform QTransform::fromTranslate(qreal dx, qreal dy)

Creates a matrix which corresponds to a translation of dx along the x axis and dy along the y axis. This is the same as QTransform().translate(dx, dy) but slightly faster.

QTransform QTransform::inverted(bool *invertible = nullptr) const

Returns an inverted copy of this matrix.

If the matrix is singular (not invertible), the returned matrix is the identity matrix. If invertible is valid (i.e. not 0), its value is set to true if the matrix is invertible, otherwise it is set to false.

See also isInvertible().

bool QTransform::isAffine() const

Returns true if the matrix represent an affine transformation, otherwise returns false.

bool QTransform::isIdentity() const

Returns true if the matrix is the identity matrix, otherwise returns false.

See also reset().

bool QTransform::isInvertible() const

Returns true if the matrix is invertible, otherwise returns false.

See also inverted().

bool QTransform::isRotating() const

Returns true if the matrix represents some kind of a rotating transformation, otherwise returns false.

See also reset().

bool QTransform::isScaling() const

Returns true if the matrix represents a scaling transformation, otherwise returns false.

See also reset().

bool QTransform::isTranslating() const

Returns true if the matrix represents a translating transformation, otherwise returns false.

See also reset().

void QTransform::map(qreal x, qreal y, qreal *tx, qreal *ty) const

Maps the given coordinates x and y into the coordinate system defined by this matrix. The resulting values are put in *tx and *ty, respectively.

The coordinates are transformed using the following formulas:

x' = m11*x + m21*y + dx
y' = m22*y + m12*x + dy
if (!isAffine()) {
    w' = m13*x + m23*y + m33
    x' /= w'
    y' /= w'
}

The point (x, y) is the original point, and (x', y') is the transformed point.

See also Basic Matrix Operations.

QLine QTransform::map(const QLine &l) const

This is an overloaded function.

Creates and returns a QLineF object that is a copy of the given line, l, mapped into the coordinate system defined by this matrix.

QLineF QTransform::map(const QLineF &line) const

This is an overloaded function.

Creates and returns a QLine object that is a copy of the given line, mapped into the coordinate system defined by this matrix. Note that the transformed coordinates are rounded to the nearest integer.

QPainterPath QTransform::map(const QPainterPath &path) const

This is an overloaded function.

Creates and returns a QPainterPath object that is a copy of the given path, mapped into the coordinate system defined by this matrix.

QPoint QTransform::map(const QPoint &point) const

This is an overloaded function.

Creates and returns a QPoint object that is a copy of the given point, mapped into the coordinate system defined by this matrix. Note that the transformed coordinates are rounded to the nearest integer.

QPointF QTransform::map(const QPointF &p) const

This is an overloaded function.

Creates and returns a QPointF object that is a copy of the given point, p, mapped into the coordinate system defined by this matrix.

QPolygon QTransform::map(const QPolygon &polygon) const

This is an overloaded function.

Creates and returns a QPolygon object that is a copy of the given polygon, mapped into the coordinate system defined by this matrix. Note that the transformed coordinates are rounded to the nearest integer.

QPolygonF QTransform::map(const QPolygonF &polygon) const

This is an overloaded function.

Creates and returns a QPolygonF object that is a copy of the given polygon, mapped into the coordinate system defined by this matrix.

QRegion QTransform::map(const QRegion &region) const

This is an overloaded function.

Creates and returns a QRegion object that is a copy of the given region, mapped into the coordinate system defined by this matrix.

Calling this method can be rather expensive if rotations or shearing are used.

void QTransform::map(int x, int y, int *tx, int *ty) const

This is an overloaded function.

Maps the given coordinates x and y into the coordinate system defined by this matrix. The resulting values are put in *tx and *ty, respectively. Note that the transformed coordinates are rounded to the nearest integer.

QRectF QTransform::mapRect(const QRectF &rectangle) const

Creates and returns a QRectF object that is a copy of the given rectangle, mapped into the coordinate system defined by this matrix.

The rectangle's coordinates are transformed using the following formulas:

x' = m11*x + m21*y + dx
y' = m22*y + m12*x + dy
if (!isAffine()) {
    w' = m13*x + m23*y + m33
    x' /= w'
    y' /= w'
}

If rotation or shearing has been specified, this function returns the bounding rectangle. To retrieve the exact region the given rectangle maps to, use the mapToPolygon() function instead.

See also mapToPolygon() and Basic Matrix Operations.

QRect QTransform::mapRect(const QRect &rectangle) const

This is an overloaded function.

Creates and returns a QRect object that is a copy of the given rectangle, mapped into the coordinate system defined by this matrix. Note that the transformed coordinates are rounded to the nearest integer.

QPolygon QTransform::mapToPolygon(const QRect &rectangle) const

Creates and returns a QPolygon representation of the given rectangle, mapped into the coordinate system defined by this matrix.

The rectangle's coordinates are transformed using the following formulas:

x' = m11*x + m21*y + dx
y' = m22*y + m12*x + dy
if (!isAffine()) {
    w' = m13*x + m23*y + m33
    x' /= w'
    y' /= w'
}

Polygons and rectangles behave slightly differently when transformed (due to integer rounding), so matrix.map(QPolygon(rectangle)) is not always the same as matrix.mapToPolygon(rectangle).

See also mapRect() and Basic Matrix Operations.

[static] bool QTransform::quadToQuad(const QPolygonF &one, const QPolygonF &two, QTransform &trans)

Creates a transformation matrix, trans, that maps a four-sided polygon, one, to another four-sided polygon, two. Returns true if the transformation is possible; otherwise returns false.

This is a convenience method combining quadToSquare() and squareToQuad() methods. It allows the input quad to be transformed into any other quad.

See also squareToQuad() and quadToSquare().

[static] bool QTransform::quadToSquare(const QPolygonF &quad, QTransform &trans)

Creates a transformation matrix, trans, that maps a four-sided polygon, quad, to a unit square. Returns true if the transformation is constructed or false if such a transformation does not exist.

See also squareToQuad() and quadToQuad().

void QTransform::reset()

Resets the matrix to an identity matrix, i.e. all elements are set to zero, except m11 and m22 (specifying the scale) and m33 which are set to 1.

See also QTransform(), isIdentity(), and Basic Matrix Operations.

[since 6.5] QTransform &QTransform::rotate(qreal a, Qt::Axis axis, qreal distanceToPlane)

Rotates the coordinate system counterclockwise by the given angle a about the specified axis at distance distanceToPlane from the screen and returns a reference to the matrix.

Note that if you apply a QTransform to a point defined in widget coordinates, the direction of the rotation will be clockwise because the y-axis points downwards.

The angle is specified in degrees.

If distanceToPlane is zero, it will be ignored. This is suitable for implementing orthographic projections where the z coordinate should be dropped rather than projected.

This function was introduced in Qt 6.5.

See also setMatrix().

QTransform &QTransform::rotate(qreal a, Qt::Axis axis = Qt::ZAxis)

This is an overloaded function.

Rotates the coordinate system counterclockwise by the given angle a about the specified axis at distance 1024.0 from the screen and returns a reference to the matrix.

Note that if you apply a QTransform to a point defined in widget coordinates, the direction of the rotation will be clockwise because the y-axis points downwards.

The angle is specified in degrees.

See also setMatrix.

[since 6.5] QTransform &QTransform::rotateRadians(qreal a, Qt::Axis axis, qreal distanceToPlane)

Rotates the coordinate system counterclockwise by the given angle a about the specified axis at distance distanceToPlane from the screen and returns a reference to the matrix.

Note that if you apply a QTransform to a point defined in widget coordinates, the direction of the rotation will be clockwise because the y-axis points downwards.

The angle is specified in radians.

If distanceToPlane is zero, it will be ignored. This is suitable for implementing orthographic projections where the z coordinate should be dropped rather than projected.

This function was introduced in Qt 6.5.

See also setMatrix().

QTransform &QTransform::rotateRadians(qreal a, Qt::Axis axis = Qt::ZAxis)

This is an overloaded function.

Rotates the coordinate system counterclockwise by the given angle a about the specified axis at distance 1024.0 from the screen and returns a reference to the matrix.

Note that if you apply a QTransform to a point defined in widget coordinates, the direction of the rotation will be clockwise because the y-axis points downwards.

The angle is specified in radians.

See also setMatrix().

QTransform &QTransform::scale(qreal sx, qreal sy)

Scales the coordinate system by sx horizontally and sy vertically, and returns a reference to the matrix.

See also setMatrix().

void QTransform::setMatrix(qreal m11, qreal m12, qreal m13, qreal m21, qreal m22, qreal m23, qreal m31, qreal m32, qreal m33)

Sets the matrix elements to the specified values, m11, m12, m13 m21, m22, m23 m31, m32 and m33. Note that this function replaces the previous values. QTransform provides the translate(), rotate(), scale() and shear() convenience functions to manipulate the various matrix elements based on the currently defined coordinate system.

See also QTransform().

QTransform &QTransform::shear(qreal sh, qreal sv)

Shears the coordinate system by sh horizontally and sv vertically, and returns a reference to the matrix.

See also setMatrix().

[static] bool QTransform::squareToQuad(const QPolygonF &quad, QTransform &trans)

Creates a transformation matrix, trans, that maps a unit square to a four-sided polygon, quad. Returns true if the transformation is constructed or false if such a transformation does not exist.

See also quadToSquare() and quadToQuad().

QTransform &QTransform::translate(qreal dx, qreal dy)

Moves the coordinate system dx along the x axis and dy along the y axis, and returns a reference to the matrix.

See also setMatrix().

QTransform QTransform::transposed() const

Returns the transpose of this matrix.

QTransform::TransformationType QTransform::type() const

Returns the transformation type of this matrix.

The transformation type is the highest enumeration value capturing all of the matrix's transformations. For example, if the matrix both scales and shears, the type would be TxShear, because TxShear has a higher enumeration value than TxScale.

Knowing the transformation type of a matrix is useful for optimization: you can often handle specific types more optimally than handling the generic case.

QVariant QTransform::operator QVariant() const

Returns the transform as a QVariant.

bool QTransform::operator!=(const QTransform &matrix) const

Returns true if this matrix is not equal to the given matrix, otherwise returns false.

QTransform QTransform::operator*(const QTransform &matrix) const

Returns the result of multiplying this matrix by the given matrix.

Note that matrix multiplication is not commutative, i.e. a*b != b*a.

QTransform &QTransform::operator*=(const QTransform &matrix)

This is an overloaded function.

Returns the result of multiplying this matrix by the given matrix.

QTransform &QTransform::operator*=(qreal scalar)

This is an overloaded function.

Returns the result of performing an element-wise multiplication of this matrix with the given scalar.

QTransform &QTransform::operator+=(qreal scalar)

This is an overloaded function.

Returns the matrix obtained by adding the given scalar to each element of this matrix.

QTransform &QTransform::operator-=(qreal scalar)

This is an overloaded function.

Returns the matrix obtained by subtracting the given scalar from each element of this matrix.

QTransform &QTransform::operator/=(qreal scalar)

This is an overloaded function.

Returns the result of performing an element-wise division of this matrix by the given scalar.

[noexcept] QTransform &QTransform::operator=(const QTransform &matrix)

Assigns the given matrix's values to this matrix.

bool QTransform::operator==(const QTransform &matrix) const

Returns true if this matrix is equal to the given matrix, otherwise returns false.