QMatrix4x4¶
The QMatrix4x4
class represents a 4x4 transformation matrix in 3D space. More…
New in version 4.6.
Synopsis¶
Functions¶
def
__add__
(m2)def
__div__
(divisor)def
__dummy
(arg__1)def
__eq__
(other)def
__iadd__
(other)def
__idiv__
(divisor)def
__imul__
(factor)def
__imul__
(other)def
__isub__
(other)def
__mgetitem__
()def
__mul__
(factor)def
__mul__
(factor)def
__mul__
(m2)def
__ne__
(other)def
__reduce__
()def
__repr__
()def
__sub__
()def
__sub__
(m2)def
column
(index)def
copyDataTo
()def
determinant
()def
fill
(value)def
flags
()def
flipCoordinates
()def
frustum
(left, right, bottom, top, nearPlane, farPlane)def
inverted
()def
isAffine
()def
isIdentity
()def
lookAt
(eye, center, up)def
map
(point)def
map
(point)def
map
(point)def
map
(point)def
mapRect
(rect)def
mapRect
(rect)def
mapVector
(vector)def
normalMatrix
()def
optimize
()def
ortho
(left, right, bottom, top, nearPlane, farPlane)def
ortho
(rect)def
ortho
(rect)def
perspective
(verticalAngle, aspectRatio, nearPlane, farPlane)def
projectedRotate
(angle, x, y, z)def
rotate
(angle, vector)def
rotate
(angle, x, y[, z=0.0f])def
rotate
(quaternion)def
row
(index)def
scale
(factor)def
scale
(vector)def
scale
(x, y)def
scale
(x, y, z)def
setColumn
(index, value)def
setRow
(index, value)def
setToIdentity
()def
toTransform
()def
toTransform
(distanceToPlane)def
translate
(vector)def
translate
(x, y)def
translate
(x, y, z)def
transposed
()def
viewport
(left, bottom, width, height[, nearPlane=0.0f[, farPlane=1.0f]])def
viewport
(rect)
Detailed Description¶
The QMatrix4x4
class in general is treated as a row-major matrix, in that the constructors and operator()
functions take data in row-major format, as is familiar in C-style usage.
Internally the data is stored as column-major format, so as to be optimal for passing to OpenGL functions, which expect column-major data.
When using these functions be aware that they return data in column-major format:
data()
constData()
See also
QVector3D
QGenericMatrix
- class PySide6.QtGui.QMatrix4x4¶
PySide6.QtGui.QMatrix4x4(transform)
PySide6.QtGui.QMatrix4x4(values)
PySide6.QtGui.QMatrix4x4(m11, m12, m13, m14, m21, m22, m23, m24, m31, m32, m33, m34, m41, m42, m43, m44)
- Parameters
m13 – float
transform –
PySide6.QtGui.QTransform
m41 – float
m23 – float
m44 – float
m24 – float
m31 – float
m34 – float
m43 – float
m32 – float
values – float
m21 – float
m12 – float
m14 – float
m42 – float
m33 – float
m22 – float
m11 – float
Constructs an identity matrix.
Constructs a 4x4 matrix from the conventional Qt 2D transformation matrix transform
.
If transform
has a special type (identity, translate, scale, etc), the programmer should follow this constructor with a call to optimize()
if they wish QMatrix4x4
to optimize further calls to translate()
, scale()
, etc.
See also
Constructs a matrix from the given 16 floating-point values
. The contents of the array values
is assumed to be in row-major order.
If the matrix has a special type (identity, translate, scale, etc), the programmer should follow this constructor with a call to optimize()
if they wish QMatrix4x4
to optimize further calls to translate()
, scale()
, etc.
See also
Constructs a matrix from the 16 elements m11
, m12
, m13
, m14
, m21
, m22
, m23
, m24
, m31
, m32
, m33
, m34
, m41
, m42
, m43
, and m44
. The elements are specified in row-major order.
If the matrix has a special type (identity, translate, scale, etc), the programmer should follow this constructor with a call to optimize()
if they wish QMatrix4x4
to optimize further calls to translate()
, scale()
, etc.
See also
- PySide6.QtGui.QMatrix4x4.Flag¶
New in version 6.0.
- PySide6.QtGui.QMatrix4x4.__dummy(arg__1)¶
- Parameters
arg__1 –
- PySide6.QtGui.QMatrix4x4.__mgetitem__()¶
- Return type
object
- PySide6.QtGui.QMatrix4x4.__reduce__()¶
- Return type
object
- PySide6.QtGui.QMatrix4x4.__repr__()¶
- Return type
object
- PySide6.QtGui.QMatrix4x4.column(index)¶
- Parameters
index – int
- Return type
Returns the elements of column index
as a 4D vector.
See also
- PySide6.QtGui.QMatrix4x4.copyDataTo()¶
Retrieves the 16 items in this matrix and copies them to values
in row-major order.
- PySide6.QtGui.QMatrix4x4.determinant()¶
- Return type
double
Returns the determinant of this matrix.
- PySide6.QtGui.QMatrix4x4.fill(value)¶
- Parameters
value – float
Fills all elements of this matrx with value
.
- PySide6.QtGui.QMatrix4x4.flags()¶
- Return type
Flags
- PySide6.QtGui.QMatrix4x4.flipCoordinates()¶
Flips between right-handed and left-handed coordinate systems by multiplying the y and z coordinates by -1. This is normally used to create a left-handed orthographic view without scaling the viewport as ortho()
does.
See also
- PySide6.QtGui.QMatrix4x4.frustum(left, right, bottom, top, nearPlane, farPlane)¶
- Parameters
left – float
right – float
bottom – float
top – float
nearPlane – float
farPlane – float
Multiplies this matrix by another that applies a perspective frustum projection for a window with lower-left corner (left
, bottom
), upper-right corner (right
, top
), and the specified nearPlane
and farPlane
clipping planes.
See also
- PySide6.QtGui.QMatrix4x4.inverted()¶
- Return type
PyTuple
Returns the inverse of this matrix. Returns the identity if this matrix cannot be inverted; i.e. determinant()
is zero. If invertible
is not null, then true will be written to that location if the matrix can be inverted; false otherwise.
If the matrix is recognized as the identity or an orthonormal matrix, then this function will quickly invert the matrix using optimized routines.
See also
- PySide6.QtGui.QMatrix4x4.isAffine()¶
- Return type
bool
Returns true
if this matrix is affine matrix; false otherwise.
An affine matrix is a 4x4 matrix with row 3 equal to (0, 0, 0, 1), e.g. no projective coefficients.
See also
- PySide6.QtGui.QMatrix4x4.isIdentity()¶
- Return type
bool
Returns true
if this matrix is the identity; false otherwise.
See also
- PySide6.QtGui.QMatrix4x4.lookAt(eye, center, up)¶
- Parameters
eye –
PySide6.QtGui.QVector3D
center –
PySide6.QtGui.QVector3D
Multiplies this matrix by a viewing matrix derived from an eye point. The center
value indicates the center of the view that the eye
is looking at. The up
value indicates which direction should be considered up with respect to the eye
.
Note
The up
vector must not be parallel to the line of sight from eye
to center
.
- PySide6.QtGui.QMatrix4x4.map(point)¶
- Parameters
point –
PySide6.QtCore.QPoint
- Return type
Maps point
by multiplying this matrix by point
. The matrix is applied pre-point.
See also
- PySide6.QtGui.QMatrix4x4.map(point)
- Parameters
point –
PySide6.QtCore.QPointF
- Return type
Maps point
by post-multiplying this matrix by point
. The matrix is applied pre-point.
See also
- PySide6.QtGui.QMatrix4x4.map(point)
- Parameters
point –
PySide6.QtGui.QVector3D
- Return type
Maps point
by multiplying this matrix by point
. The matrix is applied pre-point.
See also
- PySide6.QtGui.QMatrix4x4.map(point)
- Parameters
point –
PySide6.QtGui.QVector4D
- Return type
Maps point
by multiplying this matrix by point
. The matrix is applied pre-point.
See also
- PySide6.QtGui.QMatrix4x4.mapRect(rect)¶
- Parameters
rect –
PySide6.QtCore.QRect
- Return type
Maps rect
by multiplying this matrix by the corners of rect
and then forming a new rectangle from the results. The returned rectangle will be an ordinary 2D rectangle with sides parallel to the horizontal and vertical axes.
See also
- PySide6.QtGui.QMatrix4x4.mapRect(rect)
- Parameters
rect –
PySide6.QtCore.QRectF
- Return type
Maps rect
by multiplying this matrix by the corners of rect
and then forming a new rectangle from the results. The returned rectangle will be an ordinary 2D rectangle with sides parallel to the horizontal and vertical axes.
See also
- PySide6.QtGui.QMatrix4x4.mapVector(vector)¶
- Parameters
vector –
PySide6.QtGui.QVector3D
- Return type
Maps vector
by multiplying the top 3x3 portion of this matrix by vector
. The translation and projection components of this matrix are ignored. The matrix is applied pre-vector.
See also
- PySide6.QtGui.QMatrix4x4.normalMatrix()¶
- Return type
Returns the normal matrix corresponding to this 4x4 transformation. The normal matrix is the transpose of the inverse of the top-left 3x3 part of this 4x4 matrix. If the 3x3 sub-matrix is not invertible, this function returns the identity.
See also
- PySide6.QtGui.QMatrix4x4.__ne__(other)¶
- Parameters
other –
PySide6.QtGui.QMatrix4x4
- Return type
bool
Returns true
if this matrix is not identical to other
; false otherwise. This operator uses an exact floating-point comparison.
- PySide6.QtGui.QMatrix4x4.__mul__(factor)¶
- Parameters
factor – float
- Return type
- PySide6.QtGui.QMatrix4x4.__mul__(m2)
- Parameters
- Return type
- PySide6.QtGui.QMatrix4x4.__mul__(factor)
- Parameters
factor – float
- Return type
- PySide6.QtGui.QMatrix4x4.__imul__(other)¶
- Parameters
other –
PySide6.QtGui.QMatrix4x4
- Return type
Multiplies the contents of other
by this matrix.
- PySide6.QtGui.QMatrix4x4.__imul__(factor)
- Parameters
factor – float
- Return type
This is an overloaded function.
Multiplies all elements of this matrix by factor
.
- PySide6.QtGui.QMatrix4x4.__add__(m2)¶
- Parameters
- Return type
- PySide6.QtGui.QMatrix4x4.__iadd__(other)¶
- Parameters
other –
PySide6.QtGui.QMatrix4x4
- Return type
Adds the contents of other
to this matrix.
- PySide6.QtGui.QMatrix4x4.__sub__()¶
- Return type
- PySide6.QtGui.QMatrix4x4.__sub__(m2)
- Parameters
- Return type
This is an overloaded function.
Returns the negation of matrix
.
- PySide6.QtGui.QMatrix4x4.__isub__(other)¶
- Parameters
other –
PySide6.QtGui.QMatrix4x4
- Return type
Subtracts the contents of other
from this matrix.
- PySide6.QtGui.QMatrix4x4.__div__(divisor)¶
- Parameters
divisor – float
- Return type
- PySide6.QtGui.QMatrix4x4.__idiv__(divisor)¶
- Parameters
divisor – float
- Return type
This is an overloaded function.
Divides all elements of this matrix by divisor
.
- PySide6.QtGui.QMatrix4x4.__eq__(other)¶
- Parameters
other –
PySide6.QtGui.QMatrix4x4
- Return type
bool
Returns true
if this matrix is identical to other
; false otherwise. This operator uses an exact floating-point comparison.
- PySide6.QtGui.QMatrix4x4.optimize()¶
Optimize the usage of this matrix from its current elements.
Some operations such as translate()
, scale()
, and rotate()
can be performed more efficiently if the matrix being modified is already known to be the identity, a previous translate()
, a previous scale()
, etc.
Normally the QMatrix4x4
class keeps track of this special type internally as operations are performed. However, if the matrix is modified directly with operator()
(int, int) or data()
, then QMatrix4x4
will lose track of the special type and will revert to the safest but least efficient operations thereafter.
By calling after directly modifying the matrix, the programmer can force QMatrix4x4
to recover the special type if the elements appear to conform to one of the known optimized types.
See also
operator()(int, int)
data()
translate()
- PySide6.QtGui.QMatrix4x4.ortho(rect)¶
- Parameters
rect –
PySide6.QtCore.QRect
This is an overloaded function.
Multiplies this matrix by another that applies an orthographic projection for a window with boundaries specified by rect
. The near and far clipping planes will be -1 and 1 respectively.
See also
- PySide6.QtGui.QMatrix4x4.ortho(rect)
- Parameters
rect –
PySide6.QtCore.QRectF
This is an overloaded function.
Multiplies this matrix by another that applies an orthographic projection for a window with boundaries specified by rect
. The near and far clipping planes will be -1 and 1 respectively.
See also
- PySide6.QtGui.QMatrix4x4.ortho(left, right, bottom, top, nearPlane, farPlane)
- Parameters
left – float
right – float
bottom – float
top – float
nearPlane – float
farPlane – float
Multiplies this matrix by another that applies an orthographic projection for a window with lower-left corner (left
, bottom
), upper-right corner (right
, top
), and the specified nearPlane
and farPlane
clipping planes.
See also
- PySide6.QtGui.QMatrix4x4.perspective(verticalAngle, aspectRatio, nearPlane, farPlane)¶
- Parameters
verticalAngle – float
aspectRatio – float
nearPlane – float
farPlane – float
Multiplies this matrix by another that applies a perspective projection. The vertical field of view will be verticalAngle
degrees within a window with a given aspectRatio
that determines the horizontal field of view. The projection will have the specified nearPlane
and farPlane
clipping planes which are the distances from the viewer to the corresponding planes.
- PySide6.QtGui.QMatrix4x4.projectedRotate(angle, x, y, z)¶
- Parameters
angle – float
x – float
y – float
z – float
- PySide6.QtGui.QMatrix4x4.rotate(quaternion)¶
- Parameters
quaternion –
PySide6.QtGui.QQuaternion
Multiples this matrix by another that rotates coordinates according to a specified quaternion
. The quaternion
is assumed to have been normalized.
See also
- PySide6.QtGui.QMatrix4x4.rotate(angle, x, y[, z=0.0f])
- Parameters
angle – float
x – float
y – float
z – float
This is an overloaded function.
Multiplies this matrix by another that rotates coordinates through angle
degrees about the vector (x
, y
, z
).
See also
- PySide6.QtGui.QMatrix4x4.rotate(angle, vector)
- Parameters
angle – float
vector –
PySide6.QtGui.QVector3D
Multiples this matrix by another that rotates coordinates through angle
degrees about vector
.
See also
- PySide6.QtGui.QMatrix4x4.row(index)¶
- Parameters
index – int
- Return type
Returns the elements of row index
as a 4D vector.
- PySide6.QtGui.QMatrix4x4.scale(vector)¶
- Parameters
vector –
PySide6.QtGui.QVector3D
Multiplies this matrix by another that scales coordinates by the components of vector
.
See also
- PySide6.QtGui.QMatrix4x4.scale(factor)
- Parameters
factor – float
This is an overloaded function.
Multiplies this matrix by another that scales coordinates by the given factor
.
See also
- PySide6.QtGui.QMatrix4x4.scale(x, y)
- Parameters
x – float
y – float
This is an overloaded function.
Multiplies this matrix by another that scales coordinates by the components x
, and y
.
See also
- PySide6.QtGui.QMatrix4x4.scale(x, y, z)
- Parameters
x – float
y – float
z – float
This is an overloaded function.
Multiplies this matrix by another that scales coordinates by the components x
, y
, and z
.
See also
- PySide6.QtGui.QMatrix4x4.setColumn(index, value)¶
- Parameters
index – int
value –
PySide6.QtGui.QVector4D
Sets the elements of column index
to the components of value
.
- PySide6.QtGui.QMatrix4x4.setRow(index, value)¶
- Parameters
index – int
value –
PySide6.QtGui.QVector4D
Sets the elements of row index
to the components of value
.
See also
- PySide6.QtGui.QMatrix4x4.setToIdentity()¶
Sets this matrix to the identity.
See also
- PySide6.QtGui.QMatrix4x4.toTransform()¶
- Return type
Returns the conventional Qt 2D transformation matrix that corresponds to this matrix.
The returned QTransform
is formed by simply dropping the third row and third column of the QMatrix4x4
. This is suitable for implementing orthographic projections where the z coordinate should be dropped rather than projected.
- PySide6.QtGui.QMatrix4x4.toTransform(distanceToPlane)
- Parameters
distanceToPlane – float
- Return type
Returns the conventional Qt 2D transformation matrix that corresponds to this matrix.
If distanceToPlane
is non-zero, it indicates a projection factor to use to adjust for the z coordinate. The value of 1024 corresponds to the projection factor used by rotate()
for the x and y axes.
If distanceToPlane
is zero, then the returned QTransform
is formed by simply dropping the third row and third column of the QMatrix4x4
. This is suitable for implementing orthographic projections where the z coordinate should be dropped rather than projected.
- PySide6.QtGui.QMatrix4x4.translate(vector)¶
- Parameters
vector –
PySide6.QtGui.QVector3D
Multiplies this matrix by another that translates coordinates by the components of vector
.
- PySide6.QtGui.QMatrix4x4.translate(x, y)
- Parameters
x – float
y – float
This is an overloaded function.
Multiplies this matrix by another that translates coordinates by the components x
, and y
.
- PySide6.QtGui.QMatrix4x4.translate(x, y, z)
- Parameters
x – float
y – float
z – float
This is an overloaded function.
Multiplies this matrix by another that translates coordinates by the components x
, y
, and z
.
- PySide6.QtGui.QMatrix4x4.transposed()¶
- Return type
Returns this matrix, transposed about its diagonal.
- PySide6.QtGui.QMatrix4x4.viewport(rect)¶
- Parameters
rect –
PySide6.QtCore.QRectF
This is an overloaded function.
Sets up viewport transform for viewport bounded by rect
and with near and far set to 0 and 1 respectively.
- PySide6.QtGui.QMatrix4x4.viewport(left, bottom, width, height[, nearPlane=0.0f[, farPlane=1.0f]])
- Parameters
left – float
bottom – float
width – float
height – float
nearPlane – float
farPlane – float
Multiplies this matrix by another that performs the scale and bias transformation used by OpenGL to transform from normalized device coordinates (NDC) to viewport (window) coordinates. That is it maps points from the cube ranging over [-1, 1] in each dimension to the viewport with it’s near-lower-left corner at (left
, bottom
, nearPlane
) and with size (width
, height
, farPlane
- nearPlane
).
This matches the transform used by the fixed function OpenGL viewport transform controlled by the functions glViewport() and glDepthRange().
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.