Matrix3f (jMonkeyEngine3)

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

All Implemented Interfaces:

Savable, java.io.Serializable, java.lang.Cloneable
```
public final class Matrix3f
extends java.lang.Object
implements Savable, java.lang.Cloneable, java.io.Serializable
```
Matrix3f defines a 3x3 matrix. Matrix data is maintained internally and is accessible via the get and set methods. Convenience methods are used for matrix operations as well as generating a matrix from a given set of values.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Matrix3f`	`IDENTITY` an instance of the identity matrix (diagonals = 1, other elements = 0)
`protected float`	`m00` the element in row 0, column 0
`protected float`	`m01` the element in row 0, column 1
`protected float`	`m02` the element in row 0, column 2
`protected float`	`m10` the element in row 1, column 0
`protected float`	`m11` the element in row 1, column 1
`protected float`	`m12` the element in row 1, column 2
`protected float`	`m20` the element in row 2, column 0
`protected float`	`m21` the element in row 2, column 1
`protected float`	`m22` the element in row 2, column 2
`static Matrix3f`	`ZERO` an instance of the zero matrix (all elements = 0)

Constructor Summary

Constructors
Constructor and Description
`Matrix3f()` Constructor instantiates a new `Matrix3f` object.
`Matrix3f(float m00, float m01, float m02, float m10, float m11, float m12, float m20, float m21, float m22)` constructs a matrix with the given values.
`Matrix3f(Matrix3f mat)` Copy constructor that creates a new `Matrix3f` object that is the same as the provided matrix.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`absoluteLocal()` Takes the absolute value of all matrix fields locally.
`Matrix3f`	`adjoint()` Returns a new matrix representing the adjoint of this matrix.
`Matrix3f`	`adjoint(Matrix3f store)` Places the adjoint of this matrix in store (creates store if null.)
`Matrix3f`	`clone()` Create a copy of this matrix.
`float`	`determinant()` `determinant` generates the determinant 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 all elements of this matrix to a float array.
`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`	`fromAxes(Vector3f uAxis, Vector3f vAxis, Vector3f wAxis)` Recreate Matrix using the provided axis.
`void`	`fromStartEndVectors(Vector3f start, Vector3f end)` A function for creating a rotation matrix that rotates a vector called "start" into another vector called "end".
`void`	`get(float[] data, boolean rowMajor)` `get(float[])` returns the matrix in row-major or column-major order.
`float`	`get(int i, int j)` `get` retrieves a value from the matrix at the given position.
`Vector3f`	`getColumn(int i)` `getColumn` returns one of three columns specified by the parameter.
`Vector3f`	`getColumn(int i, Vector3f store)` `getColumn` returns one of three columns specified by the parameter.
`Vector3f`	`getRow(int i)` `getColumn` returns one of three rows as specified by the parameter.
`Vector3f`	`getRow(int i, Vector3f store)` `getRow` returns one of three rows as 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.
`Matrix3f`	`invert()` Inverts this matrix as a new Matrix3f.
`Matrix3f`	`invert(Matrix3f store)` Inverts this matrix and stores it in the given store.
`Matrix3f`	`invertLocal()` Inverts this matrix locally.
`boolean`	`isIdentity()`
`void`	`loadIdentity()` `loadIdentity` sets this matrix to the identity matrix.
`Matrix3f`	`mult(Matrix3f mat)` `mult` multiplies this matrix by a given matrix.
`Matrix3f`	`mult(Matrix3f mat, Matrix3f product)` `mult` multiplies this matrix by a given matrix.
`Vector3f`	`mult(Vector3f vec)` `mult` multiplies this matrix by a given `Vector3f` object.
`Vector3f`	`mult(Vector3f vec, Vector3f product)` Multiplies this 3x3 matrix by the 1x3 Vector vec and stores the result in product.
`Matrix3f`	`multLocal(float scale)` `multLocal` multiplies this matrix internally by a given float scale factor.
`Matrix3f`	`multLocal(Matrix3f mat)` `mult` multiplies this matrix by a given matrix.
`Vector3f`	`multLocal(Vector3f vec)` `multLocal` multiplies this matrix by a given `Vector3f` object.
`Matrix3f`	`normalize(Matrix3f store)` Normalize this matrix and store the result in the store parameter that is returned.
`Matrix3f`	`normalizeLocal()` Normalize this matrix
`void`	`read(JmeImporter e)` De-serialize this matrix from the specified importer, for example when loading from a J3O file.
`void`	`scale(Vector3f scale)` `scale` scales the operation performed by this matrix on a per-component basis.
`Matrix3f`	`set(float[] matrix)` `set` sets the values of this matrix from an array of values assuming that the data is rowMajor order;
`Matrix3f`	`set(float[][] matrix)` `set` sets the values of the matrix to those supplied by the 3x3 two-dimensional array.
`Matrix3f`	`set(float[] matrix, boolean rowMajor)` `set` sets the values of this matrix from an array of values;
`Matrix3f`	`set(int i, int j, float value)` `set` places a given value into the matrix at the given position.
`Matrix3f`	`set(Matrix3f matrix)` `copy` transfers the contents of a given matrix to this matrix.
`Matrix3f`	`set(Quaternion quaternion)` `set` defines the values of the matrix based on a supplied `Quaternion`.
`Matrix3f`	`setColumn(int i, Vector3f column)` `setColumn` sets a particular column of this matrix to that represented by the provided vector.
`Matrix3f`	`setRow(int i, Vector3f row)` `setRow` sets a particular row of this matrix to that represented by the provided vector.
`java.nio.FloatBuffer`	`toFloatBuffer()` `toFloatBuffer` returns a FloatBuffer object that contains the matrix data.
`java.lang.String`	`toString()` `toString` returns a string representation of this matrix.
`Matrix3f`	`transpose()` `transpose` locally transposes this Matrix.
`Matrix3f`	`transposeLocal()` Transposes this matrix in place.
`Matrix3f`	`transposeNew()` `transposeNew` returns a transposed version of this matrix.
`void`	`write(JmeExporter e)` Serialize this matrix to the specified exporter, for example when saving to a J3O file.
`Matrix3f`	`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
```
protected float m00
```
    the element in row 0, column 0
  - m01
```
protected float m01
```
    the element in row 0, column 1
  - m02
```
protected float m02
```
    the element in row 0, column 2
  - m10
```
protected float m10
```
    the element in row 1, column 0
  - m11
```
protected float m11
```
    the element in row 1, column 1
  - m12
```
protected float m12
```
    the element in row 1, column 2
  - m20
```
protected float m20
```
    the element in row 2, column 0
  - m21
```
protected float m21
```
    the element in row 2, column 1
  - m22
```
protected float m22
```
    the element in row 2, column 2
  - ZERO
```
public static final Matrix3f ZERO
```
    an instance of the zero matrix (all elements = 0)
  - IDENTITY
```
public static final Matrix3f IDENTITY
```
    an instance of the identity matrix (diagonals = 1, other elements = 0)
- Constructor Detail
  - Matrix3f
```
public Matrix3f()
```
    Constructor instantiates a new Matrix3f object. The initial values for the matrix is that of the identity matrix.
  - Matrix3f
```
public Matrix3f(float m00,
                float m01,
                float m02,
                float m10,
                float m11,
                float m12,
                float m20,
                float m21,
                float m22)
```
    constructs a matrix with the given values.
    
    Parameters:
    
    m00 - 0x0 in the matrix.
    
    m01 - 0x1 in the matrix.
    
    m02 - 0x2 in the matrix.
    
    m10 - 1x0 in the matrix.
    
    m11 - 1x1 in the matrix.
    
    m12 - 1x2 in the matrix.
    
    m20 - 2x0 in the matrix.
    
    m21 - 2x1 in the matrix.
    
    m22 - 2x2 in the matrix.
  - Matrix3f
```
public Matrix3f(Matrix3f mat)
```
    Copy constructor that creates a new Matrix3f object that is the same as the provided matrix.
    
    Parameters:
    
    mat - the matrix to copy.
- Method Detail
  - absoluteLocal
```
public void absoluteLocal()
```
    Takes the absolute value of all matrix fields locally.
  - set
```
public Matrix3f set(Matrix3f 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.
    
    Returns:
    
    this
  - 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
  - get
```
public void get(float[] data,
                boolean rowMajor)
```
    get(float[]) returns the matrix in row-major or column-major order.
    
    Parameters:
    
    data - The array to return the data into. This array can be 9 or 16 floats in size. Only the upper 3x3 are assigned to in the case of a 16 element array.
    
    rowMajor - True for row major storage in the array (translation in elements 3, 7, 11 for a 4x4), false for column major (translation in elements 12, 13, 14 for a 4x4).
  - normalize
```
public Matrix3f normalize(Matrix3f store)
```
    Normalize this matrix and store the result in the store parameter that is returned. Note that the original matrix is not altered.
    
    Parameters:
    
    store - the matrix to store the result of the normalization. If this parameter is null a new one is created
    
    Returns:
    
    the normalized matrix
  - normalizeLocal
```
public Matrix3f normalizeLocal()
```
    Normalize this matrix
    
    Returns:
    
    this matrix once normalized.
  - getColumn
```
public Vector3f getColumn(int i)
```
    getColumn returns one of three columns specified by the parameter. This column is returned as a Vector3f object.
    
    Parameters:
    
    i - the column to retrieve. Must be between 0 and 2.
    
    Returns:
    
    the column specified by the index.
  - getColumn
```
public Vector3f getColumn(int i,
                          Vector3f store)
```
    getColumn returns one of three columns specified by the parameter. This column is returned as a Vector3f object.
    
    Parameters:
    
    i - the column to retrieve. Must be between 0 and 2.
    
    store - the vector object to store the result in. if null, a new one is created.
    
    Returns:
    
    the column specified by the index.
  - getRow
```
public Vector3f getRow(int i)
```
    getColumn returns one of three rows as specified by the parameter. This row is returned as a Vector3f object.
    
    Parameters:
    
    i - the row to retrieve. Must be between 0 and 2.
    
    Returns:
    
    the row specified by the index.
  - getRow
```
public Vector3f getRow(int i,
                       Vector3f store)
```
    getRow returns one of three rows as specified by the parameter. This row is returned as a Vector3f object.
    
    Parameters:
    
    i - the row to retrieve. Must be between 0 and 2.
    
    store - the vector object to store the result in. if null, a new one is created.
    
    Returns:
    
    the row specified by the index.
  - toFloatBuffer
```
public java.nio.FloatBuffer toFloatBuffer()
```
    toFloatBuffer returns a FloatBuffer object that contains the matrix data.
    
    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 9 more floats.
    
    columnMajor - true → column-major order, false → row-major order
    
    Returns:
    
    matrix data as a FloatBuffer. (position is advanced by 9 and any limit set is not changed).
  - fillFloatArray
```
public void fillFloatArray(float[] f,
                           boolean columnMajor)
```
    Copy all elements of this matrix to a float array.
    
    Parameters:
    
    f - the array to fill (not null, length≥9)
    
    columnMajor - true → column-major order, false → row-major order
  - setColumn
```
public Matrix3f setColumn(int i,
                          Vector3f 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.
    
    Returns:
    
    this
  - setRow
```
public Matrix3f setRow(int i,
                       Vector3f row)
```
    setRow sets a particular row of this matrix to that represented by the provided vector.
    
    Parameters:
    
    i - the row to set.
    
    row - the data to set.
    
    Returns:
    
    this
  - set
```
public Matrix3f 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).
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalArgumentException - if either index is invalid
  - set
```
public Matrix3f set(float[][] matrix)
```
    set sets the values of the matrix to those supplied by the 3x3 two-dimensional array.
    
    Parameters:
    
    matrix - the new values of the matrix.
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalArgumentException - if the matrix is not 3x3
  - fromAxes
```
public void fromAxes(Vector3f uAxis,
                     Vector3f vAxis,
                     Vector3f wAxis)
```
    Recreate Matrix using the provided axis.
    
    Parameters:
    
    uAxis - Vector3f
    
    vAxis - Vector3f
    
    wAxis - Vector3f
  - set
```
public Matrix3f 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.
    
    Returns:
    
    this
  - set
```
public Matrix3f 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.
    
    Returns:
    
    this
  - set
```
public Matrix3f set(Quaternion quaternion)
```
    set defines the values of the matrix based on a supplied Quaternion. It should be noted that all previous values will be overridden.
    
    Parameters:
    
    quaternion - the quaternion to create a rotational matrix from.
    
    Returns:
    
    this
  - loadIdentity
```
public void loadIdentity()
```
    loadIdentity sets this matrix to the identity matrix. Where all values are zero except those along the diagonal which are one.
  - isIdentity
```
public boolean isIdentity()
```
    Returns:
    
    true if this matrix is identity
  - 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).
  - mult
```
public Matrix3f mult(Matrix3f mat)
```
    mult multiplies this matrix by a given matrix. The result matrix is returned as a new object. If the given matrix is null, a null matrix is returned.
    
    Parameters:
    
    mat - the matrix to multiply this matrix by.
    
    Returns:
    
    the result matrix.
  - mult
```
public Matrix3f mult(Matrix3f mat,
                     Matrix3f product)
```
    mult multiplies this matrix by a given matrix. The result matrix is returned as a new object.
    
    Parameters:
    
    mat - the matrix to multiply this matrix by.
    
    product - the matrix to store the result in. if null, a new matrix3f is created. It is safe for mat and product to be the same object.
    
    Returns:
    
    a matrix3f object containing the result of this operation
  - mult
```
public Vector3f mult(Vector3f vec)
```
    mult multiplies this matrix by a given Vector3f object. The result vector is returned. If the given vector is null, null will be returned.
    
    Parameters:
    
    vec - the vector to multiply this matrix by.
    
    Returns:
    
    the result vector.
  - mult
```
public Vector3f mult(Vector3f vec,
                     Vector3f product)
```
    Multiplies this 3x3 matrix by the 1x3 Vector vec and stores the result in product.
    
    Parameters:
    
    vec - The Vector3f to multiply.
    
    product - The Vector3f to store the result, it is safe for this to be the same as vec.
    
    Returns:
    
    The given product vector.
  - multLocal
```
public Matrix3f multLocal(float scale)
```
    multLocal multiplies this matrix internally by a given float scale factor.
    
    Parameters:
    
    scale - the value to scale by.
    
    Returns:
    
    this Matrix3f
  - multLocal
```
public Vector3f multLocal(Vector3f vec)
```
    multLocal multiplies this matrix by a given Vector3f object. The result vector is stored inside the passed vector, then returned . If the given vector is null, null will be returned.
    
    Parameters:
    
    vec - the vector to multiply this matrix by.
    
    Returns:
    
    The passed vector after multiplication
  - multLocal
```
public Matrix3f multLocal(Matrix3f mat)
```
    mult multiplies this matrix by a given matrix. The result matrix is saved in the current matrix. If the given matrix is null, nothing happens. The current matrix is returned. This is equivalent to this*=mat
    
    Parameters:
    
    mat - the matrix to multiply this matrix by.
    
    Returns:
    
    This matrix, after the multiplication
  - transposeLocal
```
public Matrix3f transposeLocal()
```
    Transposes this matrix in place. Returns this matrix for chaining
    
    Returns:
    
    This matrix after transpose
  - invert
```
public Matrix3f invert()
```
    Inverts this matrix as a new Matrix3f.
    
    Returns:
    
    The new inverse matrix
  - invert
```
public Matrix3f invert(Matrix3f 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 Matrix3f invertLocal()
```
    Inverts this matrix locally.
    
    Returns:
    
    this
  - adjoint
```
public Matrix3f adjoint()
```
    Returns a new matrix representing the adjoint of this matrix.
    
    Returns:
    
    The adjoint matrix
  - adjoint
```
public Matrix3f adjoint(Matrix3f 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 determinant of this matrix.
    
    Returns:
    
    the determinant
  - zero
```
public Matrix3f zero()
```
    Sets all of the values in this matrix to zero.
    
    Returns:
    
    this matrix
  - transpose
```
public Matrix3f transpose()
```
    transpose locally transposes this Matrix. This is inconsistent with general value vs local semantics, but is preserved for backwards compatibility. Use transposeNew() to transpose to a new object (value).
    
    Returns:
    
    this object for chaining.
  - transposeNew
```
public Matrix3f transposeNew()
```
    transposeNew returns a transposed version of this matrix.
    
    Returns:
    
    The new Matrix3f object.
  - toString
```
public java.lang.String toString()
```
    toString returns a string representation of this matrix. For example, an identity matrix would be represented by:
```
 Matrix3f
 [
  1.0  0.0  0.0
  0.0  1.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
  - fromStartEndVectors
```
public void fromStartEndVectors(Vector3f start,
                                Vector3f end)
```
    A function for creating a rotation matrix that rotates a vector called "start" into another vector called "end".
    
    Parameters:
    
    start - normalized non-zero starting vector
    
    end - normalized non-zero ending vector See Tomas M�ller, John Hughes "Efficiently Building a Matrix to Rotate One Vector to Another" Journal of Graphics Tools, 4(4):1-4, 1999.
  - scale
```
public void scale(Vector3f scale)
```
    scale scales the operation performed by this matrix on a per-component basis.
    
    Parameters:
    
    scale - The scale applied to each of the X, Y and Z output values.
  - clone
```
public Matrix3f clone()
```
    Create a copy of this matrix.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a new instance, equivalent to this one

Class Matrix3f

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m00

m01

m02

m10

m11

m12

m20

m21

m22

ZERO

IDENTITY

Constructor Detail

Matrix3f

Matrix3f

Matrix3f

Method Detail

absoluteLocal

set

get

get

normalize

normalizeLocal

getColumn

getColumn

getRow

getRow

toFloatBuffer

fillFloatBuffer

fillFloatArray

setColumn

setRow

set

set

fromAxes

set

set

set

loadIdentity

isIdentity

fromAngleAxis

fromAngleNormalAxis

mult

mult

mult

mult

multLocal

multLocal

multLocal

transposeLocal

invert

invert

invertLocal

adjoint

adjoint

determinant

zero

transpose

transposeNew

toString

hashCode

equals

write

read

fromStartEndVectors

scale

clone