public final class Matrix4f extends java.lang.Object implements Savable, java.lang.Cloneable, java.io.Serializable
Matrix4f
defines and maintains a 4x4 matrix in row major order.
This matrix is intended for use in a translation and rotational capacity.
It provides convenience methods for creating the matrix from a multitude
of sources.
Matrices are stored assuming column vectors on the right, with the translation
in the rightmost column. Element numbering is row,column, so m03 is the zeroth
row, third column, which is the "x" translation part. This means that the implicit
storage order is column major. However, the get() and set() functions on float
arrays default to row major order!Modifier and Type | Field and Description |
---|---|
static Matrix4f |
IDENTITY |
float |
m00 |
float |
m01 |
float |
m02 |
float |
m03 |
float |
m10 |
float |
m11 |
float |
m12 |
float |
m13 |
float |
m20 |
float |
m21 |
float |
m22 |
float |
m23 |
float |
m30 |
float |
m31 |
float |
m32 |
float |
m33 |
static Matrix4f |
ZERO |
Constructor and Description |
---|
Matrix4f()
Constructor instantiates a new
Matrix that is set to the
identity matrix. |
Matrix4f(float[] array)
Create a new Matrix4f, given data in column-major format.
|
Matrix4f(float m00,
float m01,
float m02,
float m03,
float m10,
float m11,
float m12,
float m13,
float m20,
float m21,
float m22,
float m23,
float m30,
float m31,
float m32,
float m33)
constructs a matrix with the given values.
|
Matrix4f(Matrix4f mat)
Constructor instantiates a new
Matrix that is set to the
provided matrix. |
Modifier and Type | Method and Description |
---|---|
Matrix4f |
add(Matrix4f mat) |
void |
addLocal(Matrix4f mat)
add adds the values of a parameter matrix to this matrix. |
Matrix4f |
adjoint()
Returns a new matrix representing the adjoint of this matrix.
|
Matrix4f |
adjoint(Matrix4f store)
Places the adjoint of this matrix in store (creates store if null.)
|
void |
angleRotation(Vector3f angles)
angleRotation sets this matrix to that of a rotation about
three axes (x, y, z). |
Matrix4f |
clone() |
void |
copy(Matrix4f matrix)
copy transfers the contents of a given matrix to this
matrix. |
float |
determinant()
determinant generates the determinate of this matrix. |
boolean |
equals(java.lang.Object o)
are these two matrices the same? they are is they both have the same mXX values.
|
void |
fillFloatArray(float[] f,
boolean columnMajor) |
java.nio.FloatBuffer |
fillFloatBuffer(java.nio.FloatBuffer fb)
fillFloatBuffer fills a FloatBuffer object with
the matrix data. |
java.nio.FloatBuffer |
fillFloatBuffer(java.nio.FloatBuffer fb,
boolean columnMajor)
fillFloatBuffer fills a FloatBuffer object with the matrix
data. |
void |
fromAngleAxis(float angle,
Vector3f axis)
fromAngleAxis sets this matrix4f to the values specified
by an angle and an axis of rotation. |
void |
fromAngleNormalAxis(float angle,
Vector3f axis)
fromAngleNormalAxis sets this matrix4f to the values
specified by an angle and a normalized axis of rotation. |
void |
fromFrame(Vector3f location,
Vector3f direction,
Vector3f up,
Vector3f left) |
void |
fromFrustum(float near,
float far,
float left,
float right,
float top,
float bottom,
boolean parallel) |
void |
get(float[] matrix)
get retrieves the values of this object into
a float array in row-major order. |
void |
get(float[] matrix,
boolean rowMajor)
set retrieves the values of this object into
a float array. |
float |
get(int i,
int j)
get retrieves a value from the matrix at the given
position. |
float[] |
getColumn(int i)
getColumn returns one of three columns specified by the
parameter. |
float[] |
getColumn(int i,
float[] store)
getColumn returns one of three columns specified by the
parameter. |
int |
hashCode()
hashCode returns the hash code value as an integer and is
supported for the benefit of hashing based collection classes such as
Hashtable, HashMap, HashSet etc. |
void |
inverseRotateVect(Vector3f vec)
inverseRotateVect rotates a given Vector3f by the rotation
part of this matrix. |
void |
inverseTranslateVect(float[] vec)
inverseTranslateVect translates a given Vector3f by the
translation part of this matrix. |
void |
inverseTranslateVect(Vector3f data)
inverseTranslateVect translates a given Vector3f by the
translation part of this matrix. |
Matrix4f |
invert()
Inverts this matrix as a new Matrix4f.
|
Matrix4f |
invert(Matrix4f store)
Inverts this matrix and stores it in the given store.
|
Matrix4f |
invertLocal()
Inverts this matrix locally.
|
boolean |
isIdentity() |
void |
loadIdentity()
loadIdentity sets this matrix to the identity matrix,
namely all zeros with ones along the diagonal. |
Matrix4f |
mult(float scalar) |
float[] |
mult(float[] vec4f)
mult multiplies an array of 4 floats against this rotation
matrix. |
Matrix4f |
mult(float scalar,
Matrix4f store) |
Matrix4f |
mult(Matrix4f in2)
mult multiplies this matrix with another matrix. |
Matrix4f |
mult(Matrix4f in2,
Matrix4f store)
mult multiplies this matrix with another matrix. |
Quaternion |
mult(Quaternion vec,
Quaternion store)
mult multiplies a quaternion about a matrix. |
Vector3f |
mult(Vector3f vec)
mult multiplies a vector about a rotation matrix. |
Vector3f |
mult(Vector3f vec,
Vector3f store)
mult multiplies a vector about a rotation matrix and adds
translation. |
Vector4f |
mult(Vector4f vec)
mult multiplies a Vector4f about a rotation
matrix. |
Vector4f |
mult(Vector4f vec,
Vector4f store)
mult multiplies a Vector4f about a rotation
matrix. |
float[] |
multAcross(float[] vec4f)
mult multiplies an array of 4 floats against this rotation
matrix. |
Vector3f |
multAcross(Vector3f vec,
Vector3f store)
mult multiplies a vector about a rotation matrix. |
Vector4f |
multAcross(Vector4f vec)
mult multiplies a vector about a rotation matrix. |
Vector4f |
multAcross(Vector4f vec,
Vector4f store)
mult multiplies a vector about a rotation matrix. |
void |
multLocal(float scalar)
mult multiplies this matrix by a scalar. |
Matrix4f |
multLocal(Matrix4f in2)
mult multiplies this matrix with another matrix. |
void |
multLocal(Quaternion rotation) |
Vector3f |
multNormal(Vector3f vec,
Vector3f store)
multNormal multiplies a vector about a rotation matrix, but
does not add translation. |
Vector3f |
multNormalAcross(Vector3f vec,
Vector3f store)
multNormal multiplies a vector about a rotation matrix, but
does not add translation. |
float |
multProj(Vector3f vec,
Vector3f store)
mult multiplies a vector about a rotation matrix and adds
translation. |
void |
read(JmeImporter e) |
Matrix4f |
readFloatBuffer(java.nio.FloatBuffer fb)
readFloatBuffer reads value for this matrix from a FloatBuffer. |
Matrix4f |
readFloatBuffer(java.nio.FloatBuffer fb,
boolean columnMajor)
readFloatBuffer reads value for this matrix from a FloatBuffer. |
void |
rotateVect(Vector3f vec) |
void |
scale(Vector3f scale)
Apply a scale to this matrix.
|
void |
set(float[] matrix)
set sets the values of this matrix from an array of
values assuming that the data is rowMajor order; |
void |
set(float[][] matrix)
set sets the values of this matrix from an array of
values. |
void |
set(float[] matrix,
boolean rowMajor)
set sets the values of this matrix from an array of
values; |
void |
set(float m00,
float m01,
float m02,
float m03,
float m10,
float m11,
float m12,
float m13,
float m20,
float m21,
float m22,
float m23,
float m30,
float m31,
float m32,
float m33)
Sets the values of this matrix
|
void |
set(int i,
int j,
float value)
set places a given value into the matrix at the given
position. |
Matrix4f |
set(Matrix4f matrix)
set sets the values of this matrix from another matrix. |
void |
setColumn(int i,
float[] column)
setColumn sets a particular column of this matrix to that
represented by the provided vector. |
void |
setInverseRotationDegrees(float[] angles)
setInverseRotationDegrees builds an inverted rotation from
Euler angles that are in degrees. |
void |
setInverseRotationRadians(float[] angles)
setInverseRotationRadians builds an inverted rotation from
Euler angles that are in radians. |
void |
setInverseTranslation(float[] translation)
setInverseTranslation will set the matrix's inverse
translation values. |
void |
setRotationQuaternion(Quaternion quat)
setRotationQuaternion builds a rotation from a
Quaternion . |
void |
setScale(float x,
float y,
float z)
Sets the scale.
|
void |
setScale(Vector3f scale)
Sets the scale.
|
void |
setTransform(Vector3f position,
Vector3f scale,
Matrix3f rotMat) |
void |
setTranslation(float[] translation)
setTranslation will set the matrix's translation values. |
void |
setTranslation(float x,
float y,
float z)
setTranslation will set the matrix's translation values. |
void |
setTranslation(Vector3f translation)
setTranslation will set the matrix's translation values. |
java.nio.FloatBuffer |
toFloatBuffer()
toFloatBuffer returns a FloatBuffer object that contains
the matrix data. |
java.nio.FloatBuffer |
toFloatBuffer(boolean columnMajor)
toFloatBuffer returns a FloatBuffer object that contains the
matrix data. |
Matrix3f |
toRotationMatrix() |
void |
toRotationMatrix(Matrix3f mat) |
Quaternion |
toRotationQuat() |
Quaternion |
toRotationQuat(Quaternion q) |
Vector3f |
toScaleVector()
Retrieves the scale vector from the matrix.
|
Vector3f |
toScaleVector(Vector3f store)
Retrieves the scale vector from the matrix and stores it into a given
vector.
|
java.lang.String |
toString()
toString returns the string representation of this object. |
Vector3f |
toTranslationVector() |
Vector3f |
toTranslationVector(Vector3f vector) |
void |
translateVect(Vector3f data)
inverseTranslateVect translates a given Vector3f by the
translation part of this matrix. |
Matrix4f |
transpose() |
Matrix4f |
transposeLocal()
transpose locally transposes this Matrix. |
void |
write(JmeExporter e) |
Matrix4f |
zero()
Sets all of the values in this matrix to zero.
|
public float m00
public float m01
public float m02
public float m03
public float m10
public float m11
public float m12
public float m13
public float m20
public float m21
public float m22
public float m23
public float m30
public float m31
public float m32
public float m33
public static final Matrix4f ZERO
public static final Matrix4f IDENTITY
public Matrix4f()
Matrix
that is set to the
identity matrix.public Matrix4f(float m00, float m01, float m02, float m03, float m10, float m11, float m12, float m13, float m20, float m21, float m22, float m23, float m30, float m31, float m32, float m33)
public Matrix4f(float[] array)
array
- An array of 16 floats in column-major format (translation in elements 12, 13 and 14).public Matrix4f(Matrix4f mat)
Matrix
that is set to the
provided matrix. This constructor copies a given Matrix. If the provided
matrix is null, the constructor sets the matrix to the identity.mat
- the matrix to copy.public void copy(Matrix4f matrix)
copy
transfers the contents of a given matrix to this
matrix. If a null matrix is supplied, this matrix is set to the identity
matrix.matrix
- the matrix to copy.public void get(float[] matrix)
get
retrieves the values of this object into
a float array in row-major order.matrix
- the matrix to set the values into.public void get(float[] matrix, boolean rowMajor)
set
retrieves the values of this object into
a float array.matrix
- the matrix to set the values into.rowMajor
- whether the outgoing data is in row or column major order.public float get(int i, int j)
get
retrieves a value from the matrix at the given
position. If the position is invalid a JmeException
is
thrown.i
- the row index.j
- the colum index.public float[] getColumn(int i)
getColumn
returns one of three columns specified by the
parameter. This column is returned as a float array of length 4.i
- the column to retrieve. Must be between 0 and 3.public float[] getColumn(int i, float[] store)
getColumn
returns one of three columns specified by the
parameter. This column is returned as a float[4].i
- the column to retrieve. Must be between 0 and 3.store
- the float array to store the result in. if null, a new one
is created.public void setColumn(int i, float[] column)
setColumn
sets a particular column of this matrix to that
represented by the provided vector.i
- the column to set.column
- the data to set.public void set(int i, int j, float value)
set
places a given value into the matrix at the given
position. If the position is invalid a JmeException
is
thrown.i
- the row index.j
- the colum index.value
- the value for (i, j).public void set(float[][] matrix)
set
sets the values of this matrix from an array of
values.matrix
- the matrix to set the value to.JmeException
- if the array is not of size 16.public void set(float m00, float m01, float m02, float m03, float m10, float m11, float m12, float m13, float m20, float m21, float m22, float m23, float m30, float m31, float m32, float m33)
public Matrix4f set(Matrix4f matrix)
set
sets the values of this matrix from another matrix.matrix
- the matrix to read the value from.public void set(float[] matrix)
set
sets the values of this matrix from an array of
values assuming that the data is rowMajor order;matrix
- the matrix to set the value to.public void set(float[] matrix, boolean rowMajor)
set
sets the values of this matrix from an array of
values;matrix
- the matrix to set the value to.rowMajor
- whether the incoming data is in row or column major order.public Matrix4f transpose()
public Matrix4f transposeLocal()
transpose
locally transposes this Matrix.public java.nio.FloatBuffer toFloatBuffer()
toFloatBuffer
returns a FloatBuffer object that contains
the matrix data.public java.nio.FloatBuffer toFloatBuffer(boolean columnMajor)
toFloatBuffer
returns a FloatBuffer object that contains the
matrix data.columnMajor
- if true, this buffer should be filled with column major data,
otherwise it will be filled row major.public java.nio.FloatBuffer fillFloatBuffer(java.nio.FloatBuffer fb)
fillFloatBuffer
fills a FloatBuffer object with
the matrix data.fb
- the buffer to fill, must be correct sizepublic java.nio.FloatBuffer fillFloatBuffer(java.nio.FloatBuffer fb, boolean columnMajor)
fillFloatBuffer
fills a FloatBuffer object with the matrix
data.fb
- the buffer to fill, starting at current position. Must have
room for 16 more floats.columnMajor
- if true, this buffer should be filled with column major data,
otherwise it will be filled row major.public void fillFloatArray(float[] f, boolean columnMajor)
public Matrix4f readFloatBuffer(java.nio.FloatBuffer fb)
readFloatBuffer
reads value for this matrix from a FloatBuffer.fb
- the buffer to read from, must be correct sizepublic Matrix4f readFloatBuffer(java.nio.FloatBuffer fb, boolean columnMajor)
readFloatBuffer
reads value for this matrix from a FloatBuffer.fb
- the buffer to read from, must be correct sizecolumnMajor
- if true, this buffer should be filled with column
major data, otherwise it will be filled row major.public void loadIdentity()
loadIdentity
sets this matrix to the identity matrix,
namely all zeros with ones along the diagonal.public void fromFrustum(float near, float far, float left, float right, float top, float bottom, boolean parallel)
public void fromAngleAxis(float angle, Vector3f axis)
fromAngleAxis
sets this matrix4f to the values specified
by an angle and an axis of rotation. This method creates an object, so
use fromAngleNormalAxis if your axis is already normalized.angle
- the angle to rotate (in radians).axis
- the axis of rotation.public void fromAngleNormalAxis(float angle, Vector3f axis)
fromAngleNormalAxis
sets this matrix4f to the values
specified by an angle and a normalized axis of rotation.angle
- the angle to rotate (in radians).axis
- the axis of rotation (already normalized).public void multLocal(float scalar)
mult
multiplies this matrix by a scalar.scalar
- the scalar to multiply this matrix by.public Matrix4f mult(float scalar)
public Matrix4f mult(Matrix4f in2)
mult
multiplies this matrix with another matrix. The
result matrix will then be returned. This matrix will be on the left hand
side, while the parameter matrix will be on the right.in2
- the matrix to multiply this matrix by.public Matrix4f mult(Matrix4f in2, Matrix4f store)
mult
multiplies this matrix with another matrix. The
result matrix will then be returned. This matrix will be on the left hand
side, while the parameter matrix will be on the right.in2
- the matrix to multiply this matrix by.store
- where to store the result. It is safe for in2 and store to be
the same object.public Matrix4f multLocal(Matrix4f in2)
mult
multiplies this matrix with another matrix. The
results are stored internally and a handle to this matrix will
then be returned. This matrix will be on the left hand
side, while the parameter matrix will be on the right.in2
- the matrix to multiply this matrix by.public Vector3f mult(Vector3f vec)
mult
multiplies a vector about a rotation matrix. The
resulting vector is returned as a new Vector3f.vec
- vec to multiply against.public Vector3f mult(Vector3f vec, Vector3f store)
mult
multiplies a vector about a rotation matrix and adds
translation. The resulting vector is returned.vec
- vec to multiply against.store
- a vector to store the result in. Created if null is passed.public Vector4f mult(Vector4f vec)
mult
multiplies a Vector4f
about a rotation
matrix. The resulting vector is returned as a new Vector4f
.vec
- vec to multiply against.public Vector4f mult(Vector4f vec, Vector4f store)
mult
multiplies a Vector4f
about a rotation
matrix. The resulting vector is returned.vec
- vec to multiply against.store
- a vector to store the result in. Created if null is passed.public Vector4f multAcross(Vector4f vec)
mult
multiplies a vector about a rotation matrix. The
resulting vector is returned.vec
- vec to multiply against.public Vector4f multAcross(Vector4f vec, Vector4f store)
mult
multiplies a vector about a rotation matrix. The
resulting vector is returned.vec
- vec to multiply against.store
- a vector to store the result in. created if null is passed.public Vector3f multNormal(Vector3f vec, Vector3f store)
multNormal
multiplies a vector about a rotation matrix, but
does not add translation. The resulting vector is returned.vec
- vec to multiply against.store
- a vector to store the result in. Created if null is passed.public Vector3f multNormalAcross(Vector3f vec, Vector3f store)
multNormal
multiplies a vector about a rotation matrix, but
does not add translation. The resulting vector is returned.vec
- vec to multiply against.store
- a vector to store the result in. Created if null is passed.public float multProj(Vector3f vec, Vector3f store)
mult
multiplies a vector about a rotation matrix and adds
translation. The w value is returned as a result of
multiplying the last column of the matrix by 1.0vec
- vec to multiply against.store
- a vector to store the result in.public Vector3f multAcross(Vector3f vec, Vector3f store)
mult
multiplies a vector about a rotation matrix. The
resulting vector is returned.vec
- vec to multiply against.store
- a vector to store the result in. created if null is passed.public Quaternion mult(Quaternion vec, Quaternion store)
mult
multiplies a quaternion about a matrix. The
resulting vector is returned.vec
- vec to multiply against.store
- a quaternion to store the result in. created if null is passed.public float[] mult(float[] vec4f)
mult
multiplies an array of 4 floats against this rotation
matrix. The results are stored directly in the array. (vec4f x mat4f)vec4f
- float array (size 4) to multiply against the matrix.public float[] multAcross(float[] vec4f)
mult
multiplies an array of 4 floats against this rotation
matrix. The results are stored directly in the array. (vec4f x mat4f)vec4f
- float array (size 4) to multiply against the matrix.public Matrix4f invert()
public Matrix4f invert(Matrix4f store)
public Matrix4f invertLocal()
public Matrix4f adjoint()
public Matrix4f adjoint(Matrix4f store)
store
- The matrix to store the result in. If null, a new matrix is created.public float determinant()
determinant
generates the determinate of this matrix.public Matrix4f zero()
public void addLocal(Matrix4f mat)
add
adds the values of a parameter matrix to this matrix.mat
- the matrix to add to this.public Vector3f toTranslationVector()
public Quaternion toRotationQuat()
public Quaternion toRotationQuat(Quaternion q)
public Matrix3f toRotationMatrix()
public void toRotationMatrix(Matrix3f mat)
public Vector3f toScaleVector()
public Vector3f toScaleVector(Vector3f store)
store
- the vector where the scale will be storedpublic void setScale(float x, float y, float z)
x
- the X scaley
- the Y scalez
- the Z scalepublic void setScale(Vector3f scale)
scale
- the scale vector to setpublic void setTranslation(float[] translation)
setTranslation
will set the matrix's translation values.translation
- the new values for the translation.JmeException
- if translation is not size 3.public void setTranslation(float x, float y, float z)
setTranslation
will set the matrix's translation values.x
- value of the translation on the x axisy
- value of the translation on the y axisz
- value of the translation on the z axispublic void setTranslation(Vector3f translation)
setTranslation
will set the matrix's translation values.translation
- the new values for the translation.public void setInverseTranslation(float[] translation)
setInverseTranslation
will set the matrix's inverse
translation values.translation
- the new values for the inverse translation.JmeException
- if translation is not size 3.public void angleRotation(Vector3f angles)
angleRotation
sets this matrix to that of a rotation about
three axes (x, y, z). Where each axis has a specified rotation in
degrees. These rotations are expressed in a single Vector3f
object.angles
- the angles to rotate.public void setRotationQuaternion(Quaternion quat)
setRotationQuaternion
builds a rotation from a
Quaternion
.quat
- the quaternion to build the rotation from.java.lang.NullPointerException
- if quat is null.public void setInverseRotationRadians(float[] angles)
setInverseRotationRadians
builds an inverted rotation from
Euler angles that are in radians.angles
- the Euler angles in radians.JmeException
- if angles is not size 3.public void setInverseRotationDegrees(float[] angles)
setInverseRotationDegrees
builds an inverted rotation from
Euler angles that are in degrees.angles
- the Euler angles in degrees.JmeException
- if angles is not size 3.public void inverseTranslateVect(float[] vec)
inverseTranslateVect
translates a given Vector3f by the
translation part of this matrix.vec
- the Vector3f data to be translated.JmeException
- if the size of the Vector3f is not 3.public void inverseTranslateVect(Vector3f data)
inverseTranslateVect
translates a given Vector3f by the
translation part of this matrix.data
- the Vector3f to be translated.JmeException
- if the size of the Vector3f is not 3.public void translateVect(Vector3f data)
inverseTranslateVect
translates a given Vector3f by the
translation part of this matrix.data
- the Vector3f to be translated.JmeException
- if the size of the Vector3f is not 3.public void inverseRotateVect(Vector3f vec)
inverseRotateVect
rotates a given Vector3f by the rotation
part of this matrix.vec
- the Vector3f to be rotated.public void rotateVect(Vector3f vec)
public java.lang.String toString()
toString
returns the string representation of this object.
It is in a format of a 4x4 matrix. For example, an identity matrix would
be represented by the following string. com.jme.math.Matrix3f toString
in class java.lang.Object
public int hashCode()
hashCode
returns the hash code value as an integer and is
supported for the benefit of hashing based collection classes such as
Hashtable, HashMap, HashSet etc.hashCode
in class java.lang.Object
Object.hashCode()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- the object to compare for equalitypublic void write(JmeExporter e) throws java.io.IOException
public void read(JmeImporter e) throws java.io.IOException
public boolean isIdentity()
public void scale(Vector3f scale)
scale
- the scale to applypublic void multLocal(Quaternion rotation)
public Matrix4f clone()
clone
in class java.lang.Object