3×3 matrices are typically used in Houdini to represent a 3D rotation (with a possible scale). Most places in Houdini use hou.Matrix4, which can store generation 3D transformations (including translations).
Note that you can construct a general transformation Matrix4 from a Matrix3
by writing hou.Matrix4(matrix3).
Methods ¶
__init__(values)
Return a new Matrix3. You can pass no parameters (the result will contain all zeros), a float (the result’s diagonal values will contain that float and the rest is all zeros), a sequence of 9 floats, or a sequence of sequences of 3 floats.
>>> hou.Matrix3() <hou.Matrix3 [[0, 0, 0], [0, 0, 0], [0, 0, 0]]> >>> hou.Matrix3(1) <hou.Matrix3 [[1, 0, 0], [0, 1, 0], [0, 0, 1]]> >>> hou.Matrix3((0, 1, 2, 3, 4, 5, 6, 7, 8)) <hou.Matrix3 [[0, 1, 2], [3, 4, 5], [6, 7, 8]]> >>> hou.Matrix3(((0, 1, 2), (3, 4, 5), (6, 7, 8))) <hou.Matrix3 [[0, 1, 2], [3, 4, 5], [6, 7, 8]]>
Note that Houdini’s matrices are stored in row-major order, so the matrix’s contents are grouped by row.
at(row, col)
→ double
Return the value of the matrix at the given row and column.
Raises IndexError if the row or column are not between 0 and 2, inclusive. Note that negative indices will not index from the end.
setAt(row, col, value)
Set the value of the matrix at the given row and column.
Raises IndexError if the row or column are not between 0 and 2, inclusive. Note that negative indices will not index from the end.
asTuple()
→ tuple
of float
Return the contents of the matrix as a tuple of 9 floats.
asTupleOfTuples()
→ tuple
of tuple
of float
Return the contents of the matrix as a tuple of tuples of 3 floats.
setTo(tuple)
Set this matrix’s contents. The sequence may contain either 9 floats or 3 sequences, each with 3 floats.
See hou.Matrix3.__init__ for examples of suitable parameter values.
setToIdentity()
Set this matrix to the multiplicative identity, having 1's in the diagonal.
The matrix will contain the values
[[1, 0, 0], [0, 1, 0], [0, 0, 1]]. Note that you can construct a new
matrix with these values using hou.Matrix3(1).
setToZero()
Set this matrix to contain all zeros.
Note that you can construct a new matrix with all zeros with
hou.Matrix3().
__add__(matrix3)
→ hou.Matrix3
Add two matrices by adding corresponding entries together and return a new
matrix. This method lets you write m1 + m2, where m1 and m2 are
Matrix3 objects.
__sub__(matrix3)
→ hou.Matrix3
Subtract another matrix from this one, subtracting corresponding entries,
and return a new matrix. This method lets you write m1 - m2, where m1
and m2 are Matrix3 objects.
__mul__(matrix3_or_scalar)
→ hou.Matrix3
Multiply this matrix by another matrix or by a scalar, returning a new
matrix. This method lets you write m1 * m2, where m1 and m2 are
Matrix3 objects, or m1 * s, where s is a float.
See Wikipedia’s matrix multiplication page for details on how each element in the result is computed. Also see hou.Matrix4.
preMult(matrix3)
→ hou.Matrix3
Returns matrix3 * self. Note that __mul__ returns self * matrix3,
which is a different result because matrix multiplication is not
commutative.
determinant()
→ double
Return the determinant of the matrix.
extractRotates(rotate_order="xyz")
→ hou.Vector3
Return a Vector3 of Euler angles, in degrees, representing the rotation component of this matrix. Rotating about the coordinate axes in the specified order by these amounts will yield the rotation contained in this matrix.
rotate_order
A string containing a permutation of the letters x, y, and z
that determines the order in which rotations are performed about
the coordinate axes.
Raises hou.OperationFailed if the matrix does not represent a valid
rotation matrix (e.g. it is singular) or the rotate order is not a
permutation of the string 'xyz'.
See also hou.Matrix4.explode and hou.Matrix4.extractRotates.
Warning
If there are scales or shears in the matrix, the results are as if they were first removed on the left side. (ie. SR → R). If you wish to control for this, first use hou.Matrix3.removeScalesAndShears with the desired transform order.
removeScalesAndShears(transform_order="srt")
→ tuple of (hou.Vector3, hou.Vector3)
Remove scales and shears from this matrix and return them as a tuple of (scales, shears).
transform_order
A 3 character string containing a permutation of the letters s, r, and t.
If s occurs before r, then the scales/shears are extracted from the
left of this matrix. Otherwise, they will be extracted from the right
instead.
Raises hou.OperationFailed if transform_order is invalid.
See also: hou.Matrix3.extractRotates, hou.Matrix4.extractRotates, hou.Matrix4.extractRotationMatrix3
inverted()
→ hou.Matrix3
Return the inverse of this matrix.
Raises hou.OperationFailed if the matrix is not invertible.
Otherwise,
(self * self.inverted()).isAlmostEqual(hou.Matrix3(1)) is True.
See Wikipedia’s invertible matrix page for more information.
transposed()
→ hou.Matrix3
Return the transpose of this matrix. The result is such that
self.at(i, j) == self.transposed().at(j, i) for 0 <= i,j <= 2.
See Wikipedia’s transpose page for more information.
isAlmostEqual(matrix3, tolerance=0.00001)
→ bool
Returns whether this matrix is equal to another, within a tolerance.