Package javax.vecmath
Class Matrix3f
java.lang.Object
javax.vecmath.Matrix3f
- All Implemented Interfaces:
Serializable
,Cloneable
A single precision floating point 3 by 3 matrix.
Primarily to support 3D rotations.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionfloat
The first matrix element in the first row.float
The second matrix element in the first row.float
The third matrix element in the first row.float
The first matrix element in the second row.float
The second matrix element in the second row.float
The third matrix element in the second row.float
The first matrix element in the third row.float
The second matrix element in the third row.float
The third matrix element in the third row. -
Constructor Summary
ConstructorsConstructorDescriptionMatrix3f()
Constructs and initializes a Matrix3f to all zeros.Matrix3f
(float[] v) Constructs and initializes a Matrix3f from the specified nine-element array.Matrix3f
(float m00, float m01, float m02, float m10, float m11, float m12, float m20, float m21, float m22) Constructs and initializes a Matrix3f from the specified nine values.Constructs a new matrix with the same values as the Matrix3d parameter.Constructs a new matrix with the same values as the Matrix3f parameter. -
Method Summary
Modifier and TypeMethodDescriptionfinal void
add
(float scalar) Adds a scalar to each component of this matrix.final void
Adds a scalar to each component of the matrix m1 and places the result into this.final void
Sets the value of this matrix to the matrix sum of itself and matrix m1.final void
Sets the value of this matrix to the matrix sum of matrices m1 and m2.clone()
Creates a new object of the same class as this object.final float
Computes the determinant of this matrix.boolean
epsilonEquals
(Matrix3f m1, float epsilon) Returns true if the L-infinite distance between this matrix and matrix m1 is less than or equal to the epsilon parameter, otherwise returns false.boolean
Returns true if the Object o1 is of type Matrix3f and all of the data members of o1 are equal to the corresponding data members in this Matrix3f.boolean
Returns true if all of the data members of Matrix3f m1 are equal to the corresponding data members in this Matrix3f.final void
getColumn
(int column, float[] v) Copies the matrix values in the specified column into the array parameter.final void
Copies the matrix values in the specified column into the vector parameter.final float
getElement
(int row, int column) Retrieves the value at the specified row and column of this matrix.final float
getM00()
Get the first matrix element in the first row.final float
getM01()
Get the second matrix element in the first row.final float
getM02()
Get the third matrix element in the first row.final float
getM10()
Get first matrix element in the second row.final float
getM11()
Get second matrix element in the second row.final float
getM12()
Get the third matrix element in the second row.final float
getM20()
Get the first matrix element in the third row.final float
getM21()
Get the second matrix element in the third row.final float
getM22()
Get the third matrix element in the third row .final void
getRow
(int row, float[] v) Copies the matrix values in the specified row into the array parameter.final void
Copies the matrix values in the specified row into the vector parameter.final float
getScale()
Performs an SVD normalization of this matrix to calculate and return the uniform scale factor.int
hashCode()
Returns a hash code value based on the data values in this object.final void
invert()
Inverts this matrix in place.final void
Sets the value of this matrix to the matrix inverse of the passed matrix m1.final void
mul
(float scalar) Multiplies each element of this matrix by a scalar.final void
Multiplies each element of matrix m1 by a scalar and places the result into this.final void
Sets the value of this matrix to the result of multiplying itself with matrix m1.final void
Sets the value of this matrix to the result of multiplying the two argument matrices together.final void
mulNormalize
(Matrix3f m1) Multiplies this matrix by matrix m1, does an SVD normalization of the result, and places the result back into this matrix.final void
mulNormalize
(Matrix3f m1, Matrix3f m2) Multiplies matrix m1 by matrix m2, does an SVD normalization of the result, and places the result into this matrix.final void
mulTransposeBoth
(Matrix3f m1, Matrix3f m2) Multiplies the transpose of matrix m1 times the transpose of matrix m2, and places the result into this.final void
mulTransposeLeft
(Matrix3f m1, Matrix3f m2) Multiplies the transpose of matrix m1 times matrix m2, and places the result into this.final void
mulTransposeRight
(Matrix3f m1, Matrix3f m2) Multiplies matrix m1 times the transpose of matrix m2, and places the result into this.final void
negate()
Negates the value of this matrix: this = -this.final void
Sets the value of this matrix equal to the negation of of the Matrix3f parameter.final void
Performs singular value decomposition normalization of this matrix.final void
Perform singular value decomposition normalization of matrix m1 and place the normalized values into this.final void
Perform cross product normalization of this matrix.final void
normalizeCP
(Matrix3f m1) Perform cross product normalization of matrix m1 and place the normalized values into this.final void
rotX
(float angle) Sets the value of this matrix to a counter clockwise rotation about the x axis.final void
rotY
(float angle) Sets the value of this matrix to a counter clockwise rotation about the y axis.final void
rotZ
(float angle) Sets the value of this matrix to a counter clockwise rotation about the z axis.final void
set
(float scale) Sets the value of this matrix to a scale matrix with the passed scale amount.final void
set
(float[] m) Sets the values in this Matrix3f equal to the row-major array parameter (ie, the first three elements of the array will be copied into the first row of this matrix, etc.).final void
set
(AxisAngle4d a1) Sets the value of this matrix to the matrix conversion of the (double precision) axis and angle argument.final void
set
(AxisAngle4f a1) Sets the value of this matrix to the matrix conversion of the (single precision) axis and angle argument.final void
Sets the value of this matrix to the float value of the Matrix3d argument.final void
Sets the value of this matrix to the value of the Matrix3f argument.final void
Sets the value of this matrix to the matrix conversion of the (single precision) quaternion argument.final void
Sets the value of this matrix to the matrix conversion of the (single precision) quaternion argument.final void
setColumn
(int column, float[] v) Sets the specified column of this matrix3f to the three values provided.final void
setColumn
(int column, float x, float y, float z) Sets the specified column of this matrix3f to the three values provided.final void
Sets the specified column of this matrix3f to the vector provided.final void
setElement
(int row, int column, float value) Sets the specified element of this matrix3f to the value provided.final void
Sets this Matrix3f to identity.final void
setM00
(float m00) Set the first matrix element in the first row.final void
setM01
(float m01) Set the second matrix element in the first row.final void
setM02
(float m02) Set the third matrix element in the first row.final void
setM10
(float m10) Set first matrix element in the second row.final void
setM11
(float m11) Set the second matrix element in the second row.final void
setM12
(float m12) Set the third matrix element in the second row.final void
setM20
(float m20) Set the first matrix element in the third row.final void
setM21
(float m21) Set the second matrix element in the third row.final void
setM22
(float m22) Set the third matrix element in the third row.final void
setRow
(int row, float[] v) Sets the specified row of this matrix3f to the three values provided.final void
setRow
(int row, float x, float y, float z) Sets the specified row of this matrix3f to the three values provided.final void
Sets the specified row of this matrix3f to the Vector provided.final void
setScale
(float scale) Sets the scale component of the current matrix by factoring out the current scale (by doing an SVD) and multiplying by the new scale.final void
setZero()
Sets this matrix to all zeros.final void
Sets the value of this matrix to the matrix difference of itself and matrix m1 (this = this - m1).final void
Sets the value of this matrix to the matrix difference of matrices m1 and m2.toString()
Returns a string that contains the values of this Matrix3f.final void
Multiply this matrix by the tuple t and place the result back into the tuple (t = this*t).final void
Multiply this matrix by the tuple t and and place the result into the tuple "result" (result = this*t).final void
Sets the value of this matrix to its transpose.final void
Sets the value of this matrix to the transpose of the argument matrix.
-
Field Details
-
m00
public float m00The first matrix element in the first row. -
m01
public float m01The second matrix element in the first row. -
m02
public float m02The third matrix element in the first row. -
m10
public float m10The first matrix element in the second row. -
m11
public float m11The second matrix element in the second row. -
m12
public float m12The third matrix element in the second row. -
m20
public float m20The first matrix element in the third row. -
m21
public float m21The second matrix element in the third row. -
m22
public float m22The third matrix element in the third row.
-
-
Constructor Details
-
Matrix3f
public Matrix3f(float m00, float m01, float m02, float m10, float m11, float m12, float m20, float m21, float m22) Constructs and initializes a Matrix3f from the specified nine values.- Parameters:
m00
- the [0][0] elementm01
- the [0][1] elementm02
- the [0][2] elementm10
- the [1][0] elementm11
- the [1][1] elementm12
- the [1][2] elementm20
- the [2][0] elementm21
- the [2][1] elementm22
- the [2][2] element
-
Matrix3f
public Matrix3f(float[] v) Constructs and initializes a Matrix3f from the specified nine-element array. this.m00 =v[0], this.m01=v[1], etc.- Parameters:
v
- the array of length 9 containing in order
-
Matrix3f
Constructs a new matrix with the same values as the Matrix3d parameter.- Parameters:
m1
- the source matrix
-
Matrix3f
Constructs a new matrix with the same values as the Matrix3f parameter.- Parameters:
m1
- the source matrix
-
Matrix3f
public Matrix3f()Constructs and initializes a Matrix3f to all zeros.
-
-
Method Details
-
toString
Returns a string that contains the values of this Matrix3f. -
setIdentity
public final void setIdentity()Sets this Matrix3f to identity. -
setScale
public final void setScale(float scale) Sets the scale component of the current matrix by factoring out the current scale (by doing an SVD) and multiplying by the new scale.- Parameters:
scale
- the new scale amount
-
setElement
public final void setElement(int row, int column, float value) Sets the specified element of this matrix3f to the value provided.- Parameters:
row
- the row number to be modified (zero indexed)column
- the column number to be modified (zero indexed)value
- the new value
-
getRow
Copies the matrix values in the specified row into the vector parameter.- Parameters:
row
- the matrix rowv
- the vector into which the matrix row values will be copied
-
getRow
public final void getRow(int row, float[] v) Copies the matrix values in the specified row into the array parameter.- Parameters:
row
- the matrix rowv
- the array into which the matrix row values will be copied
-
getColumn
Copies the matrix values in the specified column into the vector parameter.- Parameters:
column
- the matrix columnv
- the vector into which the matrix row values will be copied
-
getColumn
public final void getColumn(int column, float[] v) Copies the matrix values in the specified column into the array parameter.- Parameters:
column
- the matrix columnv
- the array into which the matrix row values will be copied
-
getElement
public final float getElement(int row, int column) Retrieves the value at the specified row and column of this matrix.- Parameters:
row
- the row number to be retrieved (zero indexed)column
- the column number to be retrieved (zero indexed)- Returns:
- the value at the indexed element.
-
setRow
public final void setRow(int row, float x, float y, float z) Sets the specified row of this matrix3f to the three values provided.- Parameters:
row
- the row number to be modified (zero indexed)x
- the first column elementy
- the second column elementz
- the third column element
-
setRow
Sets the specified row of this matrix3f to the Vector provided.- Parameters:
row
- the row number to be modified (zero indexed)v
- the replacement row
-
setRow
public final void setRow(int row, float[] v) Sets the specified row of this matrix3f to the three values provided.- Parameters:
row
- the row number to be modified (zero indexed)v
- the replacement row
-
setColumn
public final void setColumn(int column, float x, float y, float z) Sets the specified column of this matrix3f to the three values provided.- Parameters:
column
- the column number to be modified (zero indexed)x
- the first row elementy
- the second row elementz
- the third row element
-
setColumn
Sets the specified column of this matrix3f to the vector provided.- Parameters:
column
- the column number to be modified (zero indexed)v
- the replacement column
-
setColumn
public final void setColumn(int column, float[] v) Sets the specified column of this matrix3f to the three values provided.- Parameters:
column
- the column number to be modified (zero indexed)v
- the replacement column
-
getScale
public final float getScale()Performs an SVD normalization of this matrix to calculate and return the uniform scale factor. If the matrix has non-uniform scale factors, the largest of the x, y, and z scale factors will be returned. This matrix is not modified.- Returns:
- the scale factor of this matrix
-
add
public final void add(float scalar) Adds a scalar to each component of this matrix.- Parameters:
scalar
- the scalar adder
-
add
Adds a scalar to each component of the matrix m1 and places the result into this. Matrix m1 is not modified.- Parameters:
scalar
- the scalar adder.m1
- the original matrix values
-
add
Sets the value of this matrix to the matrix sum of matrices m1 and m2.- Parameters:
m1
- the first matrixm2
- the second matrix
-
add
Sets the value of this matrix to the matrix sum of itself and matrix m1.- Parameters:
m1
- the other matrix
-
sub
Sets the value of this matrix to the matrix difference of matrices m1 and m2.- Parameters:
m1
- the first matrixm2
- the second matrix
-
sub
Sets the value of this matrix to the matrix difference of itself and matrix m1 (this = this - m1).- Parameters:
m1
- the other matrix
-
transpose
public final void transpose()Sets the value of this matrix to its transpose. -
transpose
Sets the value of this matrix to the transpose of the argument matrix.- Parameters:
m1
- the matrix to be transposed
-
set
Sets the value of this matrix to the matrix conversion of the (single precision) quaternion argument.- Parameters:
q1
- the quaternion to be converted
-
set
Sets the value of this matrix to the matrix conversion of the (single precision) axis and angle argument.- Parameters:
a1
- the axis and angle to be converted
-
set
Sets the value of this matrix to the matrix conversion of the (double precision) axis and angle argument.- Parameters:
a1
- the axis and angle to be converted
-
set
Sets the value of this matrix to the matrix conversion of the (single precision) quaternion argument.- Parameters:
q1
- the quaternion to be converted
-
set
public final void set(float[] m) Sets the values in this Matrix3f equal to the row-major array parameter (ie, the first three elements of the array will be copied into the first row of this matrix, etc.).- Parameters:
m
- the single precision array of length 9
-
set
Sets the value of this matrix to the value of the Matrix3f argument.- Parameters:
m1
- the source matrix3f
-
set
Sets the value of this matrix to the float value of the Matrix3d argument.- Parameters:
m1
- the source matrix3d
-
invert
Sets the value of this matrix to the matrix inverse of the passed matrix m1.- Parameters:
m1
- the matrix to be inverted
-
invert
public final void invert()Inverts this matrix in place. -
determinant
public final float determinant()Computes the determinant of this matrix.- Returns:
- the determinant of this matrix
-
set
public final void set(float scale) Sets the value of this matrix to a scale matrix with the passed scale amount.- Parameters:
scale
- the scale factor for the matrix
-
rotX
public final void rotX(float angle) Sets the value of this matrix to a counter clockwise rotation about the x axis.- Parameters:
angle
- the angle to rotate about the X axis in radians
-
rotY
public final void rotY(float angle) Sets the value of this matrix to a counter clockwise rotation about the y axis.- Parameters:
angle
- the angle to rotate about the Y axis in radians
-
rotZ
public final void rotZ(float angle) Sets the value of this matrix to a counter clockwise rotation about the z axis.- Parameters:
angle
- the angle to rotate about the Z axis in radians
-
mul
public final void mul(float scalar) Multiplies each element of this matrix by a scalar.- Parameters:
scalar
- the scalar multiplier
-
mul
Multiplies each element of matrix m1 by a scalar and places the result into this. Matrix m1 is not modified.- Parameters:
scalar
- the scalar multiplierm1
- the original matrix
-
mul
Sets the value of this matrix to the result of multiplying itself with matrix m1.- Parameters:
m1
- the other matrix
-
mul
Sets the value of this matrix to the result of multiplying the two argument matrices together.- Parameters:
m1
- the first matrixm2
- the second matrix
-
mulNormalize
Multiplies this matrix by matrix m1, does an SVD normalization of the result, and places the result back into this matrix. this = SVDnorm(this*m1).- Parameters:
m1
- the matrix on the right hand side of the multiplication
-
mulNormalize
Multiplies matrix m1 by matrix m2, does an SVD normalization of the result, and places the result into this matrix. this = SVDnorm(m1*m2).- Parameters:
m1
- the matrix on the left hand side of the multiplicationm2
- the matrix on the right hand side of the multiplication
-
mulTransposeBoth
Multiplies the transpose of matrix m1 times the transpose of matrix m2, and places the result into this.- Parameters:
m1
- the matrix on the left hand side of the multiplicationm2
- the matrix on the right hand side of the multiplication
-
mulTransposeRight
Multiplies matrix m1 times the transpose of matrix m2, and places the result into this.- Parameters:
m1
- the matrix on the left hand side of the multiplicationm2
- the matrix on the right hand side of the multiplication
-
mulTransposeLeft
Multiplies the transpose of matrix m1 times matrix m2, and places the result into this.- Parameters:
m1
- the matrix on the left hand side of the multiplicationm2
- the matrix on the right hand side of the multiplication
-
normalize
public final void normalize()Performs singular value decomposition normalization of this matrix. -
normalize
Perform singular value decomposition normalization of matrix m1 and place the normalized values into this.- Parameters:
m1
- the matrix values to be normalized
-
normalizeCP
public final void normalizeCP()Perform cross product normalization of this matrix. -
normalizeCP
Perform cross product normalization of matrix m1 and place the normalized values into this.- Parameters:
m1
- Provides the matrix values to be normalized
-
equals
Returns true if all of the data members of Matrix3f m1 are equal to the corresponding data members in this Matrix3f.- Parameters:
m1
- the matrix with which the comparison is made- Returns:
- true or false
-
equals
Returns true if the Object o1 is of type Matrix3f and all of the data members of o1 are equal to the corresponding data members in this Matrix3f. -
epsilonEquals
Returns true if the L-infinite distance between this matrix and matrix m1 is less than or equal to the epsilon parameter, otherwise returns false. The L-infinite distance is equal to MAX[i=0,1,2 ; j=0,1,2 ; abs(this.m(i,j) - m1.m(i,j)]- Parameters:
m1
- the matrix to be compared to this matrixepsilon
- the threshold value
-
hashCode
public int hashCode()Returns a hash code value based on the data values in this object. Two different Matrix3f objects with identical data values (i.e., Matrix3f.equals returns true) will return the same hash code value. Two objects with different data members may return the same hash value, although this is not likely. -
setZero
public final void setZero()Sets this matrix to all zeros. -
negate
public final void negate()Negates the value of this matrix: this = -this. -
negate
Sets the value of this matrix equal to the negation of of the Matrix3f parameter.- Parameters:
m1
- the source matrix
-
transform
Multiply this matrix by the tuple t and place the result back into the tuple (t = this*t).- Parameters:
t
- the tuple to be multiplied by this matrix and then replaced
-
transform
Multiply this matrix by the tuple t and and place the result into the tuple "result" (result = this*t).- Parameters:
t
- the tuple to be multiplied by this matrixresult
- the tuple into which the product is placed
-
clone
Creates a new object of the same class as this object.- Overrides:
clone
in classObject
- Returns:
- a clone of this instance.
- Throws:
OutOfMemoryError
- if there is not enough memory.- Since:
- vecmath 1.3
- See Also:
-
getM00
public final float getM00()Get the first matrix element in the first row.- Returns:
- Returns the m00.
- Since:
- vecmath 1.5
-
setM00
public final void setM00(float m00) Set the first matrix element in the first row.- Parameters:
m00
- The m00 to set.- Since:
- vecmath 1.5
-
getM01
public final float getM01()Get the second matrix element in the first row.- Returns:
- Returns the m01.
- Since:
- vecmath 1.5
-
setM01
public final void setM01(float m01) Set the second matrix element in the first row.- Parameters:
m01
- The m01 to set.- Since:
- vecmath 1.5
-
getM02
public final float getM02()Get the third matrix element in the first row.- Returns:
- Returns the m02.
- Since:
- vecmath 1.5
-
setM02
public final void setM02(float m02) Set the third matrix element in the first row.- Parameters:
m02
- The m02 to set.- Since:
- vecmath 1.5
-
getM10
public final float getM10()Get first matrix element in the second row.- Returns:
- Returns the m10.
- Since:
- vecmath 1.5
-
setM10
public final void setM10(float m10) Set first matrix element in the second row.- Parameters:
m10
- The m10 to set.- Since:
- vecmath 1.5
-
getM11
public final float getM11()Get second matrix element in the second row.- Returns:
- Returns the m11.
- Since:
- vecmath 1.5
-
setM11
public final void setM11(float m11) Set the second matrix element in the second row.- Parameters:
m11
- The m11 to set.- Since:
- vecmath 1.5
-
getM12
public final float getM12()Get the third matrix element in the second row.- Returns:
- Returns the m12.
- Since:
- vecmath 1.5
-
setM12
public final void setM12(float m12) Set the third matrix element in the second row.- Parameters:
m12
- The m12 to set.- Since:
- vecmath 1.5
-
getM20
public final float getM20()Get the first matrix element in the third row.- Returns:
- Returns the m20.
- Since:
- vecmath 1.5
-
setM20
public final void setM20(float m20) Set the first matrix element in the third row.- Parameters:
m20
- The m20 to set.- Since:
- vecmath 1.5
-
getM21
public final float getM21()Get the second matrix element in the third row.- Returns:
- Returns the m21.
- Since:
- vecmath 1.5
-
setM21
public final void setM21(float m21) Set the second matrix element in the third row.- Parameters:
m21
- The m21 to set.- Since:
- vecmath 1.5
-
getM22
public final float getM22()Get the third matrix element in the third row .- Returns:
- Returns the m22.
- Since:
- vecmath 1.5
-
setM22
public final void setM22(float m22) Set the third matrix element in the third row.- Parameters:
m22
- The m22 to set.- Since:
- vecmath 1.5
-