Matrix4f (jMonkeyEngine3)

java.lang.Object
- com.jme3.math.Matrix4f

All Implemented Interfaces:

Savable, java.io.Serializable, java.lang.Cloneable
```
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!

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Matrix4f`	`IDENTITY` an instance of the identity matrix (diagonals = 1, other elements = 0)
`float`	`m00` the element in row 0, column 0
`float`	`m01` the element in row 0, column 1
`float`	`m02` the element in row 0, column 2
`float`	`m03` the element in row 0, column 3
`float`	`m10` the element in row 1, column 0
`float`	`m11` the element in row 1, column 1
`float`	`m12` the element in row 1, column 2
`float`	`m13` the element in row 1, column 3
`float`	`m20` the element in row 2, column 0
`float`	`m21` the element in row 2, column 1
`float`	`m22` the element in row 2, column 2
`float`	`m23` the element in row 2, column 3
`float`	`m30` the element in row 3, column 0
`float`	`m31` the element in row 3, column 1
`float`	`m32` the element in row 0, column 2
`float`	`m33` the element in row 3, column 3
`static Matrix4f`	`ZERO` an instance of the zero matrix (all elements = 0)

Constructor Summary

Constructors
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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Matrix4f`	`add(Matrix4f mat)` Calculate the sum of this matrix and another.
`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()` Create a copy of this matrix.
`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)` Copy the elements of this matrix to a float array.
`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)` Configure this matrix to represent a perspective-view frustrum or rectangular solid with the specified clipping planes.
`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)` Multiply this matrix by a scalar.
`float[]`	`mult(float[] vec4f)` `mult` multiplies an array of 4 floats against this rotation matrix.
`Matrix4f`	`mult(float scalar, Matrix4f store)` Multiply this matrix by a scalar.
`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)` De-serialize this matrix from the specified importer, for example when loading from a J3O file.
`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)` Interpret this matrix as a 3-D coordinate transform and apply its rotation component to the specified vector.
`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)` Set this matrix to the specified 3-D coordinate transform.
`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()` Interpret this matrix as a 3-D coordinate transform and determine its rotation component.
`void`	`toRotationMatrix(Matrix3f mat)` Interpret this matrix as a 3-D coordinate transform and determine its rotation component.
`Quaternion`	`toRotationQuat()` Interpret this matrix as a 3-D coordinate transform and determine its rotation component.
`Quaternion`	`toRotationQuat(Quaternion q)` Interpret this matrix as a 3-D coordinate transform and determine its rotation component.
`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 a string representation of this matrix.
`Vector3f`	`toTranslationVector()` Interpret this matrix as a 3-D coordinate transform and determine its translation component.
`Vector3f`	`toTranslationVector(Vector3f vector)` Interpret this matrix as a 3-D coordinate transform and determine its translation component.
`void`	`translateVect(Vector3f data)` `inverseTranslateVect` translates a given Vector3f by the translation part of this matrix.
`Matrix4f`	`transpose()` Generate the transpose of this matrix.
`Matrix4f`	`transposeLocal()` `transpose` locally transposes this Matrix.
`void`	`write(JmeExporter e)` Serialize this matrix to the specified exporter, for example when saving to a J3O file.
`Matrix4f`	`zero()` Sets all of the values in this matrix to zero.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - m00
```
public float m00
```
    the element in row 0, column 0
  - m01
```
public float m01
```
    the element in row 0, column 1
  - m02
```
public float m02
```
    the element in row 0, column 2
  - m03
```
public float m03
```
    the element in row 0, column 3
  - m10
```
public float m10
```
    the element in row 1, column 0
  - m11
```
public float m11
```
    the element in row 1, column 1
  - m12
```
public float m12
```
    the element in row 1, column 2
  - m13
```
public float m13
```
    the element in row 1, column 3
  - m20
```
public float m20
```
    the element in row 2, column 0
  - m21
```
public float m21
```
    the element in row 2, column 1
  - m22
```
public float m22
```
    the element in row 2, column 2
  - m23
```
public float m23
```
    the element in row 2, column 3
  - m30
```
public float m30
```
    the element in row 3, column 0
  - m31
```
public float m31
```
    the element in row 3, column 1
  - m32
```
public float m32
```
    the element in row 0, column 2
  - m33
```
public float m33
```
    the element in row 3, column 3
  - ZERO
```
public static final Matrix4f ZERO
```
    an instance of the zero matrix (all elements = 0)
  - IDENTITY
```
public static final Matrix4f IDENTITY
```
    an instance of the identity matrix (diagonals = 1, other elements = 0)
- Constructor Detail
  - Matrix4f
```
public Matrix4f()
```
    Constructor instantiates a new Matrix that is set to the identity matrix.
  - Matrix4f
```
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)
```
    constructs a matrix with the given values.
    
    Parameters:
    
    m00 - the desired value for row 0, column 0
    
    m01 - the desired value for row 0, column 1
    
    m02 - the desired value for row 0, column 2
    
    m03 - the desired value for row 0, column 3
    
    m10 - the desired value for row 1, column 0
    
    m11 - the desired value for row 1, column 1
    
    m12 - the desired value for row 1, column 2
    
    m13 - the desired value for row 1, column 3
    
    m20 - the desired value for row 2, column 0
    
    m21 - the desired value for row 2, column 1
    
    m22 - the desired value for row 2, column 2
    
    m23 - the desired value for row 2, column 3
    
    m30 - the desired value for row 3, column 0
    
    m31 - the desired value for row 3, column 1
    
    m32 - the desired value for row 3, column 2
    
    m33 - the desired value for row 3, column 3
  - Matrix4f
```
public Matrix4f(float[] array)
```
    Create a new Matrix4f, given data in column-major format.
    
    Parameters:
    
    array - An array of 16 floats in column-major format (translation in elements 12, 13 and 14).
  - Matrix4f
```
public Matrix4f(Matrix4f mat)
```
    Constructor instantiates a new 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.
    
    Parameters:
    
    mat - the matrix to copy.
- Method Detail
  - 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.
    
    Parameters:
    
    matrix - the matrix to copy.
  - fromFrame
```
public void fromFrame(Vector3f location,
                      Vector3f direction,
                      Vector3f up,
                      Vector3f left)
```
  - get
```
public void get(float[] matrix)
```
    get retrieves the values of this object into a float array in row-major order.
    
    Parameters:
    
    matrix - the matrix to set the values into.
  - get
```
public void get(float[] matrix,
                boolean rowMajor)
```
    set retrieves the values of this object into a float array.
    
    Parameters:
    
    matrix - the matrix to set the values into.
    
    rowMajor - whether the outgoing data is in row or column major order.
  - get
```
public float get(int i,
                 int j)
```
    get retrieves a value from the matrix at the given position.
    
    Parameters:
    
    i - the row index.
    
    j - the column index.
    
    Returns:
    
    the value at (i, j).
    
    Throws:
    
    java.lang.IllegalArgumentException - if either index is invalid
  - getColumn
```
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.
    
    Parameters:
    
    i - the column to retrieve. Must be between 0 and 3.
    
    Returns:
    
    the column specified by the index.
  - getColumn
```
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].
    
    Parameters:
    
    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.
    
    Returns:
    
    the column specified by the index.
  - setColumn
```
public void setColumn(int i,
                      float[] column)
```
    setColumn sets a particular column of this matrix to that represented by the provided vector.
    
    Parameters:
    
    i - the column to set.
    
    column - the data to set.
  - set
```
public void set(int i,
                int j,
                float value)
```
    set places a given value into the matrix at the given position.
    
    Parameters:
    
    i - the row index.
    
    j - the column index.
    
    value - the value for (i, j).
    
    Throws:
    
    java.lang.IllegalArgumentException - if either index is invalid
  - set
```
public void set(float[][] matrix)
```
    set sets the values of this matrix from an array of values.
    
    Parameters:
    
    matrix - the matrix to set the value to.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the array isn't 4x4
  - set
```
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)
```
    Sets the values of this matrix
    
    Parameters:
    
    m00 - the desired value for row 0, column 0
    
    m01 - the desired value for row 0, column 1
    
    m02 - the desired value for row 0, column 2
    
    m03 - the desired value for row 0, column 3
    
    m10 - the desired value for row 1, column 0
    
    m11 - the desired value for row 1, column 1
    
    m12 - the desired value for row 1, column 2
    
    m13 - the desired value for row 1, column 3
    
    m20 - the desired value for row 2, column 0
    
    m21 - the desired value for row 2, column 1
    
    m22 - the desired value for row 2, column 2
    
    m23 - the desired value for row 2, column 3
    
    m30 - the desired value for row 3, column 0
    
    m31 - the desired value for row 3, column 1
    
    m32 - the desired value for row 3, column 2
    
    m33 - the desired value for row 3, column 3
  - set
```
public Matrix4f set(Matrix4f matrix)
```
    set sets the values of this matrix from another matrix.
    
    Parameters:
    
    matrix - the matrix to read the value from.
    
    Returns:
    
    this
  - set
```
public void set(float[] matrix)
```
    set sets the values of this matrix from an array of values assuming that the data is rowMajor order;
    
    Parameters:
    
    matrix - the matrix to set the value to.
  - set
```
public void set(float[] matrix,
                boolean rowMajor)
```
    set sets the values of this matrix from an array of values;
    
    Parameters:
    
    matrix - the matrix to set the value to.
    
    rowMajor - whether the incoming data is in row or column major order.
  - transpose
```
public Matrix4f transpose()
```
    Generate the transpose of this matrix.
    
    Returns:
    
    a new Matrix4f with its rows and columns transposed
  - transposeLocal
```
public Matrix4f transposeLocal()
```
    transpose locally transposes this Matrix.
    
    Returns:
    
    this object for chaining.
  - toFloatBuffer
```
public java.nio.FloatBuffer toFloatBuffer()
```
    toFloatBuffer returns a FloatBuffer object that contains the matrix data.
    
    Returns:
    
    matrix data as a FloatBuffer.
  - toFloatBuffer
```
public java.nio.FloatBuffer toFloatBuffer(boolean columnMajor)
```
    toFloatBuffer returns a FloatBuffer object that contains the matrix data.
    
    Parameters:
    
    columnMajor - if true, this buffer should be filled with column major data, otherwise it will be filled row major.
    
    Returns:
    
    matrix data as a FloatBuffer. The position is set to 0 for convenience.
  - fillFloatBuffer
```
public java.nio.FloatBuffer fillFloatBuffer(java.nio.FloatBuffer fb)
```
    fillFloatBuffer fills a FloatBuffer object with the matrix data.
    
    Parameters:
    
    fb - the buffer to fill, must be correct size
    
    Returns:
    
    matrix data as a FloatBuffer.
  - fillFloatBuffer
```
public java.nio.FloatBuffer fillFloatBuffer(java.nio.FloatBuffer fb,
                                            boolean columnMajor)
```
    fillFloatBuffer fills a FloatBuffer object with the matrix data.
    
    Parameters:
    
    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.
    
    Returns:
    
    matrix data as a FloatBuffer. (position is advanced by 16 and any limit set is not changed).
  - fillFloatArray
```
public void fillFloatArray(float[] f,
                           boolean columnMajor)
```
    Copy the elements of this matrix to a float array.
    
    Parameters:
    
    f - the array to fill (not null, length >= 16)
    
    columnMajor - true → column-major order, false → row-major order
  - readFloatBuffer
```
public Matrix4f readFloatBuffer(java.nio.FloatBuffer fb)
```
    readFloatBuffer reads value for this matrix from a FloatBuffer.
    
    Parameters:
    
    fb - the buffer to read from, must be correct size
    
    Returns:
    
    this data as a FloatBuffer.
  - readFloatBuffer
```
public Matrix4f readFloatBuffer(java.nio.FloatBuffer fb,
                                boolean columnMajor)
```
    readFloatBuffer reads value for this matrix from a FloatBuffer.
    
    Parameters:
    
    fb - the buffer to read from, must be correct size
    
    columnMajor - if true, this buffer should be filled with column major data, otherwise it will be filled row major.
    
    Returns:
    
    this data as a FloatBuffer.
  - loadIdentity
```
public void loadIdentity()
```
    loadIdentity sets this matrix to the identity matrix, namely all zeros with ones along the diagonal.
  - fromFrustum
```
public void fromFrustum(float near,
                        float far,
                        float left,
                        float right,
                        float top,
                        float bottom,
                        boolean parallel)
```
    Configure this matrix to represent a perspective-view frustrum or rectangular solid with the specified clipping planes.
    
    Parameters:
    
    near - the coordinate of the near plane
    
    far - the coordinate of the far plane
    
    left - the coordinate of the left plane
    
    right - the coordinate of the right plane
    
    top - the coordinate of the top plane
    
    bottom - the coordinate of the bottom plane
    
    parallel - true → parallel sides, false → perspective
  - fromAngleAxis
```
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.
    
    Parameters:
    
    angle - the angle to rotate (in radians).
    
    axis - the axis of rotation.
  - fromAngleNormalAxis
```
public void fromAngleNormalAxis(float angle,
                                Vector3f axis)
```
    fromAngleNormalAxis sets this matrix4f to the values specified by an angle and a normalized axis of rotation.
    
    Parameters:
    
    angle - the angle to rotate (in radians).
    
    axis - the axis of rotation (already normalized).
  - multLocal
```
public void multLocal(float scalar)
```
    mult multiplies this matrix by a scalar.
    
    Parameters:
    
    scalar - the scalar to multiply this matrix by.
  - mult
```
public Matrix4f mult(float scalar)
```
    Multiply this matrix by a scalar.
    
    Parameters:
    
    scalar - the scaling factor
    
    Returns:
    
    a new Matrix4f with every element scaled
  - mult
```
public Matrix4f mult(float scalar,
                     Matrix4f store)
```
    Multiply this matrix by a scalar.
    
    Parameters:
    
    scalar - the scaling factor
    
    store - storage for the result (not null, modified)
    
    Returns:
    
    a scaled matrix (store)
  - mult
```
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.
    
    Parameters:
    
    in2 - the matrix to multiply this matrix by.
    
    Returns:
    
    the resultant matrix
  - mult
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    the resultant matrix
  - multLocal
```
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.
    
    Parameters:
    
    in2 - the matrix to multiply this matrix by.
    
    Returns:
    
    the resultant matrix
  - mult
```
public Vector3f mult(Vector3f vec)
```
    mult multiplies a vector about a rotation matrix. The resulting vector is returned as a new Vector3f.
    
    Parameters:
    
    vec - vec to multiply against.
    
    Returns:
    
    the rotated vector.
  - mult
```
public Vector3f mult(Vector3f vec,
                     Vector3f store)
```
    mult multiplies a vector about a rotation matrix and adds translation. The resulting vector is returned.
    
    Parameters:
    
    vec - vec to multiply against.
    
    store - a vector to store the result in. Created if null is passed.
    
    Returns:
    
    the rotated vector.
  - mult
```
public Vector4f mult(Vector4f vec)
```
    mult multiplies a Vector4f about a rotation matrix. The resulting vector is returned as a new Vector4f.
    
    Parameters:
    
    vec - vec to multiply against.
    
    Returns:
    
    the rotated vector.
  - mult
```
public Vector4f mult(Vector4f vec,
                     Vector4f store)
```
    mult multiplies a Vector4f about a rotation matrix. The resulting vector is returned.
    
    Parameters:
    
    vec - vec to multiply against.
    
    store - a vector to store the result in. Created if null is passed.
    
    Returns:
    
    the rotated vector.
  - multAcross
```
public Vector4f multAcross(Vector4f vec)
```
    mult multiplies a vector about a rotation matrix. The resulting vector is returned.
    
    Parameters:
    
    vec - vec to multiply against.
    
    Returns:
    
    the rotated vector.
  - multAcross
```
public Vector4f multAcross(Vector4f vec,
                           Vector4f store)
```
    mult multiplies a vector about a rotation matrix. The resulting vector is returned.
    
    Parameters:
    
    vec - vec to multiply against.
    
    store - a vector to store the result in. created if null is passed.
    
    Returns:
    
    the rotated vector.
  - multNormal
```
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.
    
    Parameters:
    
    vec - vec to multiply against.
    
    store - a vector to store the result in. Created if null is passed.
    
    Returns:
    
    the rotated vector.
  - multNormalAcross
```
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.
    
    Parameters:
    
    vec - vec to multiply against.
    
    store - a vector to store the result in. Created if null is passed.
    
    Returns:
    
    the rotated vector.
  - multProj
```
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.0
    
    Parameters:
    
    vec - vec to multiply against.
    
    store - a vector to store the result in.
    
    Returns:
    
    the W value
  - multAcross
```
public Vector3f multAcross(Vector3f vec,
                           Vector3f store)
```
    mult multiplies a vector about a rotation matrix. The resulting vector is returned.
    
    Parameters:
    
    vec - vec to multiply against.
    
    store - a vector to store the result in. created if null is passed.
    
    Returns:
    
    the rotated vector.
  - mult
```
public Quaternion mult(Quaternion vec,
                       Quaternion store)
```
    mult multiplies a quaternion about a matrix. The resulting vector is returned.
    
    Parameters:
    
    vec - vec to multiply against.
    
    store - a quaternion to store the result in. created if null is passed.
    
    Returns:
    
    store = this * vec
  - mult
```
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)
    
    Parameters:
    
    vec4f - float array (size 4) to multiply against the matrix.
    
    Returns:
    
    the vec4f for chaining.
  - multAcross
```
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)
    
    Parameters:
    
    vec4f - float array (size 4) to multiply against the matrix.
    
    Returns:
    
    the vec4f for chaining.
  - invert
```
public Matrix4f invert()
```
    Inverts this matrix as a new Matrix4f.
    
    Returns:
    
    The new inverse matrix
  - invert
```
public Matrix4f invert(Matrix4f store)
```
    Inverts this matrix and stores it in the given store.
    
    Parameters:
    
    store - storage for the result (modified if not null)
    
    Returns:
    
    The store
  - invertLocal
```
public Matrix4f invertLocal()
```
    Inverts this matrix locally.
    
    Returns:
    
    this
  - adjoint
```
public Matrix4f adjoint()
```
    Returns a new matrix representing the adjoint of this matrix.
    
    Returns:
    
    The adjoint matrix
  - setTransform
```
public void setTransform(Vector3f position,
                         Vector3f scale,
                         Matrix3f rotMat)
```
    Set this matrix to the specified 3-D coordinate transform. The effective sequence of operations is: scale, then rotate, then translate.
    
    Parameters:
    
    position - the desired translation (not null, unaffected)
    
    scale - the desired scaling (not null, unaffected)
    
    rotMat - the desired rotation (not null, unaffected)
  - adjoint
```
public Matrix4f adjoint(Matrix4f store)
```
    Places the adjoint of this matrix in store (creates store if null.)
    
    Parameters:
    
    store - The matrix to store the result in. If null, a new matrix is created.
    
    Returns:
    
    store
  - determinant
```
public float determinant()
```
    determinant generates the determinate of this matrix.
    
    Returns:
    
    the determinate
  - zero
```
public Matrix4f zero()
```
    Sets all of the values in this matrix to zero.
    
    Returns:
    
    this matrix
  - add
```
public Matrix4f add(Matrix4f mat)
```
    Calculate the sum of this matrix and another.
    
    Parameters:
    
    mat - the Matrix4f to add (not null, unaffected)
    
    Returns:
    
    a new Matrix4f
  - addLocal
```
public void addLocal(Matrix4f mat)
```
    add adds the values of a parameter matrix to this matrix.
    
    Parameters:
    
    mat - the matrix to add to this.
  - toTranslationVector
```
public Vector3f toTranslationVector()
```
    Interpret this matrix as a 3-D coordinate transform and determine its translation component.
    
    Returns:
    
    a new translation vector
  - toTranslationVector
```
public Vector3f toTranslationVector(Vector3f vector)
```
    Interpret this matrix as a 3-D coordinate transform and determine its translation component.
    
    Parameters:
    
    vector - storage for the result (not null, modified)
    
    Returns:
    
    the translation vector (vector)
  - toRotationQuat
```
public Quaternion toRotationQuat()
```
    Interpret this matrix as a 3-D coordinate transform and determine its rotation component.
    
    Returns:
    
    a new rotation Quaternion
  - toRotationQuat
```
public Quaternion toRotationQuat(Quaternion q)
```
    Interpret this matrix as a 3-D coordinate transform and determine its rotation component.
    
    Parameters:
    
    q - storage for the result (not null, modified)
    
    Returns:
    
    the rotation Quaternion (q)
  - toRotationMatrix
```
public Matrix3f toRotationMatrix()
```
    Interpret this matrix as a 3-D coordinate transform and determine its rotation component.
    
    Returns:
    
    a new rotation matrix
  - toRotationMatrix
```
public void toRotationMatrix(Matrix3f mat)
```
    Interpret this matrix as a 3-D coordinate transform and determine its rotation component.
    
    Parameters:
    
    mat - storage for the result (not null, modified)
  - toScaleVector
```
public Vector3f toScaleVector()
```
    Retrieves the scale vector from the matrix.
    
    Returns:
    
    the scale vector
  - toScaleVector
```
public Vector3f toScaleVector(Vector3f store)
```
    Retrieves the scale vector from the matrix and stores it into a given vector.
    
    Parameters:
    
    store - the vector where the scale will be stored
    
    Returns:
    
    the store vector
  - setScale
```
public void setScale(float x,
                     float y,
                     float z)
```
    Sets the scale.
    
    Parameters:
    
    x - the X scale
    
    y - the Y scale
    
    z - the Z scale
  - setScale
```
public void setScale(Vector3f scale)
```
    Sets the scale.
    
    Parameters:
    
    scale - the scale vector to set
  - setTranslation
```
public void setTranslation(float[] translation)
```
    setTranslation will set the matrix's translation values.
    
    Parameters:
    
    translation - the new values for the translation.
    
    Throws:
    
    java.lang.IllegalArgumentException - if translation is not size 3.
  - setTranslation
```
public void setTranslation(float x,
                           float y,
                           float z)
```
    setTranslation will set the matrix's translation values.
    
    Parameters:
    
    x - value of the translation on the x axis
    
    y - value of the translation on the y axis
    
    z - value of the translation on the z axis
  - setTranslation
```
public void setTranslation(Vector3f translation)
```
    setTranslation will set the matrix's translation values.
    
    Parameters:
    
    translation - the new values for the translation.
  - setInverseTranslation
```
public void setInverseTranslation(float[] translation)
```
    setInverseTranslation will set the matrix's inverse translation values.
    
    Parameters:
    
    translation - the new values for the inverse translation.
    
    Throws:
    
    java.lang.IllegalArgumentException - if translation is not size 3.
  - angleRotation
```
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.
    
    Parameters:
    
    angles - the angles to rotate.
  - setRotationQuaternion
```
public void setRotationQuaternion(Quaternion quat)
```
    setRotationQuaternion builds a rotation from a Quaternion.
    
    Parameters:
    
    quat - the quaternion to build the rotation from.
    
    Throws:
    
    java.lang.NullPointerException - if quat is null.
  - setInverseRotationRadians
```
public void setInverseRotationRadians(float[] angles)
```
    setInverseRotationRadians builds an inverted rotation from Euler angles that are in radians.
    
    Parameters:
    
    angles - the Euler angles in radians.
    
    Throws:
    
    java.lang.IllegalArgumentException - if angles is not size 3.
  - setInverseRotationDegrees
```
public void setInverseRotationDegrees(float[] angles)
```
    setInverseRotationDegrees builds an inverted rotation from Euler angles that are in degrees.
    
    Parameters:
    
    angles - the Euler angles in degrees.
    
    Throws:
    
    java.lang.IllegalArgumentException - if angles is not size 3.
  - inverseTranslateVect
```
public void inverseTranslateVect(float[] vec)
```
    inverseTranslateVect translates a given Vector3f by the translation part of this matrix.
    
    Parameters:
    
    vec - the Vector3f data to be translated.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the size of the Vector3f is not 3.
  - inverseTranslateVect
```
public void inverseTranslateVect(Vector3f data)
```
    inverseTranslateVect translates a given Vector3f by the translation part of this matrix.
    
    Parameters:
    
    data - the Vector3f to be translated.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the size of the Vector3f is not 3.
  - translateVect
```
public void translateVect(Vector3f data)
```
    inverseTranslateVect translates a given Vector3f by the translation part of this matrix.
    
    Parameters:
    
    data - the Vector3f to be translated.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the size of the Vector3f is not 3.
  - inverseRotateVect
```
public void inverseRotateVect(Vector3f vec)
```
    inverseRotateVect rotates a given Vector3f by the rotation part of this matrix.
    
    Parameters:
    
    vec - the Vector3f to be rotated.
  - rotateVect
```
public void rotateVect(Vector3f vec)
```
    Interpret this matrix as a 3-D coordinate transform and apply its rotation component to the specified vector.
    
    Parameters:
    
    vec - the vector to rotate (not null, modified)
  - toString
```
public java.lang.String toString()
```
    toString returns a string representation of this matrix. For example, an identity matrix would be represented by:
```
 Matrix4f
 [
  1.0  0.0  0.0  0.0
  0.0  1.0  0.0  0.0
  0.0  0.0  1.0  0.0
  0.0  0.0  0.0  1.0
 ]
 
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string representation of this object.
  - hashCode
```
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.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hashcode for this instance of Matrix4f.
    
    See Also:
    
    Object.hashCode()
  - equals
```
public boolean equals(java.lang.Object o)
```
    are these two matrices the same? they are is they both have the same mXX values.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the object to compare for equality
    
    Returns:
    
    true if they are equal
  - write
```
public void write(JmeExporter e)
           throws java.io.IOException
```
    Serialize this matrix to the specified exporter, for example when saving to a J3O file.
    
    Specified by:
    
    write in interface Savable
    
    Parameters:
    
    e - (not null)
    
    Throws:
    
    java.io.IOException - from the exporter
  - read
```
public void read(JmeImporter e)
          throws java.io.IOException
```
    De-serialize this matrix from the specified importer, for example when loading from a J3O file.
    
    Specified by:
    
    read in interface Savable
    
    Parameters:
    
    e - (not null)
    
    Throws:
    
    java.io.IOException - from the importer
  - isIdentity
```
public boolean isIdentity()
```
    Returns:
    
    true if this matrix is identity
  - scale
```
public void scale(Vector3f scale)
```
    Apply a scale to this matrix.
    
    Parameters:
    
    scale - the scale to apply
  - multLocal
```
public void multLocal(Quaternion rotation)
```
  - clone
```
public Matrix4f clone()
```
    Create a copy of this matrix.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a new instance, equivalent to this one

Class Matrix4f

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m00

m01

m02

m03

m10

m11

m12

m13

m20

m21

m22

m23

m30

m31

m32

m33

ZERO

IDENTITY

Constructor Detail

Matrix4f

Matrix4f

Matrix4f

Matrix4f

Method Detail

copy

fromFrame

get

get

get

getColumn

getColumn

setColumn

set

set

set

set

set

set

transpose

transposeLocal

toFloatBuffer

toFloatBuffer

fillFloatBuffer

fillFloatBuffer

fillFloatArray

readFloatBuffer

readFloatBuffer

loadIdentity

fromFrustum

fromAngleAxis

fromAngleNormalAxis

multLocal

mult

mult

mult

mult

multLocal

mult

mult

mult

mult

multAcross

multAcross

multNormal

multNormalAcross

multProj

multAcross

mult

mult

multAcross

invert

invert

invertLocal

adjoint