com.threerings.math
Class Matrix4f

java.lang.Object
  com.threerings.math.Matrix4f

All Implemented Interfaces:

Encodable, Exportable, com.threerings.io.Streamable

public final class Matrix4f
extends Object
implements Encodable, com.threerings.io.Streamable

A 4x4 column-major matrix.

Nested Class Summary

Nested classes/interfaces inherited from interface com.threerings.io.Streamable

com.threerings.io.Streamable.Closure

Field Summary

static Matrix4f[]	EMPTY_ARRAY An empty matrix array.
static Matrix4f	IDENTITY The identity matrix.
float	m00 The values of the matrix.
float	m01
float	m02
float	m03
float	m10 The values of the matrix.
float	m11
float	m12
float	m13
float	m20 The values of the matrix.
float	m21
float	m22
float	m23
float	m30 The values of the matrix.
float	m31
float	m32
float	m33

Constructor Summary

Matrix4f()
Creates an identity matrix.

Matrix4f(float[] values)
Creates a matrix from an array of values.

Matrix4f(FloatBuffer buf)
Creates a matrix from a float buffer.

Matrix4f(float m00, float m10, float m20, float m30, float m01, float m11, float m21, float m31, float m02, float m12, float m22, float m32, float m03, float m13, float m23, float m33)
Creates a matrix from its components.

Matrix4f(Matrix4f other)
Copy constructor.

Method Summary

float	approximateUniformScale() Returns an approximation of the uniform scale for this matrix (the cube root of the signed volume of the parallelepiped spanned by the axis vectors).
void	decodeFromStream(DataInputStream in) Initializes this object with data read from the specified stream.
void	decodeFromString(String string) Initializes this object with the contents of the specified string.
void	encodeToStream(DataOutputStream out) Encodes this object to the specified stream.
String	encodeToString() Returns a string representation of this object.
boolean	epsilonEquals(Matrix4f other, float epsilon) Compares this matrix to another with the provided epsilon.
boolean	equals(Object other)
Quaternion	extractRotation() Extracts the rotation component of the matrix.
Quaternion	extractRotation(Quaternion result) Extracts the rotation component of the matrix and places it in the provided result quaternion.
Vector3f	extractScale() Extracts the scale component of the matrix.
Vector3f	extractScale(Vector3f result) Extracts the scale component of the matrix and places it in the provided result vector.
FloatBuffer	get(FloatBuffer buf) Places the contents of this matrix into the given buffer in the standard OpenGL order.
int	hashCode()
Matrix4f	invert() Inverts this matrix.
Matrix4f	invert(Matrix4f result) Inverts this matrix and places the result in the given object.
Matrix4f	invertAffine() Inverts this matrix as an affine matrix.
Matrix4f	invertAffine(Matrix4f result) Inverts this matrix as an affine matrix and places the result in the given object.
Matrix4f	invertAffineLocal() Inverts this matrix in-place as an affine matrix.
Matrix4f	invertLocal() Inverts this matrix in-place.
boolean	isAffine() Determines whether this matrix represents an affine transformation.
boolean	isMirrored() Determines whether the matrix is mirrored.
Matrix4f	lerp(Matrix4f other, float t) Linearly interpolates between this and the specified other matrix.
Matrix4f	lerp(Matrix4f other, float t, Matrix4f result) Linearly interpolates between this and the specified other matrix, placing the result in the object provided.
Matrix4f	lerpAffine(Matrix4f other, float t) Linearly interpolates between this and the specified other matrix, treating the matrices as affine.
Matrix4f	lerpAffine(Matrix4f other, float t, Matrix4f result) Linearly interpolates between this and the specified other matrix (treating the matrices as affine), placing the result in the object provided.
Matrix4f	lerpAffineLocal(Matrix4f other, float t) Linearly interpolates between this and the specified other matrix (treating the matrices as affine), placing the result in this matrix.
Matrix4f	lerpLocal(Matrix4f other, float t) Linearly interpolates between the this and the specified other matrix, placing the result in this matrix.
Matrix4f	mult(Matrix4f other) Multiplies this matrix by another.
Matrix4f	mult(Matrix4f other, Matrix4f result) Multiplies this matrix by another and stores the result in the object provided.
Matrix4f	multAffine(Matrix4f other) Multiplies this matrix by another, treating the matrices as affine.
Matrix4f	multAffine(Matrix4f other, Matrix4f result) Multiplies this matrix by another, treating the matrices as affine, and stores the result in the object provided.
Matrix4f	multAffineLocal(Matrix4f other) Multiplies this matrix in-place by another, treating the matricees as affine.
Matrix4f	multLocal(Matrix4f other) Multiplies this matrix in-place by another.
Vector3f	projectPoint(Vector3f point) Projects the supplied point using this matrix.
Vector3f	projectPoint(Vector3f point, Vector3f result) Projects the supplied point using this matrix and places the result in the object supplied.
Vector3f	projectPointLocal(Vector3f point) Projects the supplied point in-place using this matrix.
Matrix4f	set(float[] values) Copies the elements of an array.
Matrix4f	set(FloatBuffer buf) Sets the contents of this matrix from the supplied buffer.
Matrix4f	set(float m00, float m10, float m20, float m30, float m01, float m11, float m21, float m31, float m02, float m12, float m22, float m32, float m03, float m13, float m23, float m33) Sets all of the matrix's components at once.
Matrix4f	set(Matrix4f other) Copies the contents of another matrix.
Matrix4f	setToFrustum(float left, float right, float bottom, float top, float near, float far) Sets this to a perspective projection matrix.
Matrix4f	setToFrustum(float left, float right, float bottom, float top, float near, float far, Vector3f nearFarNormal) Sets this to a perspective projection matrix.
Matrix4f	setToIdentity() Sets this matrix to the identity matrix.
Matrix4f	setToOrtho(float left, float right, float bottom, float top, float near, float far) Sets this to an orthographic projection matrix.
Matrix4f	setToOrtho(float left, float right, float bottom, float top, float near, float far, Vector3f nearFarNormal) Sets this to an orthographic projection matrix.
Matrix4f	setToPerspective(float fovy, float aspect, float near, float far) Sets this to a perspective projection matrix.
Matrix4f	setToReflection(float x, float y, float z) Sets this to a reflection across a plane intersecting the origin with the supplied normal.
Matrix4f	setToReflection(float x, float y, float z, float w) Sets this to a reflection across the specified plane.
Matrix4f	setToReflection(Plane plane) Sets this to a reflection across the specified plane.
Matrix4f	setToReflection(Vector3f normal) Sets this to a reflection across a plane intersecting the origin with the supplied normal.
Matrix4f	setToReflection(Vector3f normal, float constant) Sets this to a reflection across the specified plane.
Matrix4f	setToRotation(float angle, float x, float y, float z) Sets this to a rotation matrix.
Matrix4f	setToRotation(float angle, Vector3f axis) Sets this to a rotation matrix.
Matrix4f	setToRotation(Quaternion quat) Sets this to a rotation matrix.
Matrix4f	setToRotation(Vector3f from, Vector3f to) Sets this to a rotation matrix that rotates one vector onto another.
Matrix4f	setToScale(float s) Sets this to a uniform scale matrix.
Matrix4f	setToScale(float x, float y, float z) Sets this to a scale matrix.
Matrix4f	setToScale(Vector3f scale) Sets this to a scale matrix.
Matrix4f	setToSkew(float a, float b, float c, float d, float x, float y, float z) Sets this to a skew by the specified amount relative to the given plane.
Matrix4f	setToSkew(Plane plane, Vector3f amount) Sets this to a skew by the specified amount relative to the given plane.
Matrix4f	setToSkew(Vector3f normal, float constant, Vector3f amount) Sets this to a skew by the specified amount relative to the given plane.
Matrix4f	setToTransform(Vector3f translation, Quaternion rotation) Sets this to a matrix that first rotates, then translates.
Matrix4f	setToTransform(Vector3f translation, Quaternion rotation, float scale) Sets this to a matrix that first scales, then rotates, then translates.
Matrix4f	setToTransform(Vector3f translation, Quaternion rotation, Vector3f scale) Sets this to a matrix that first scales, then rotates, then translates.
Matrix4f	setToTranslation(float x, float y, float z) Sets this to a translation matrix.
Matrix4f	setToTranslation(Vector3f translation) Sets this to a translation matrix.
Matrix4f	setTranslation(float x, float y, float z) Sets the translation component of this matrix.
Matrix4f	setTranslation(Vector3f translation) Sets the translation component of this matrix.
String	toString()
Vector3f	transformPoint(Vector3f point) Transforms a point by this matrix.
Vector3f	transformPoint(Vector3f point, Vector3f result) Transforms a point by this matrix and places the result in the object provided.
Vector3f	transformPointLocal(Vector3f point) Transforms a point in-place by this matrix.
float	transformPointZ(Vector3f point) Transforms a point by this matrix and returns the resulting z coordinate.
Vector3f	transformVector(Vector3f vector) Transforms a vector by this inner 3x3 part of this matrix.
Vector3f	transformVector(Vector3f vector, Vector3f result) Transforms a vector by the inner 3x3 part of this matrix and places the result in the object provided.
Vector3f	transformVectorLocal(Vector3f vector) Transforms a vector in-place by the inner 3x3 part of this matrix.
Matrix4f	transpose() Transposes this matrix.
Matrix4f	transpose(Matrix4f result) Transposes this matrix, storing the result in the provided object.
Matrix4f	transposeLocal() Transposes this matrix in-place.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

IDENTITY

public static final Matrix4f IDENTITY

The identity matrix.

EMPTY_ARRAY

public static final Matrix4f[] EMPTY_ARRAY

An empty matrix array.

m00

public float m00

The values of the matrix.

m10

public float m10

The values of the matrix.

m20

public float m20

The values of the matrix.

m30

public float m30

The values of the matrix.

m01

public float m01

m11

public float m11

m21

public float m21

m31

public float m31

m02

public float m02

m12

public float m12

m22

public float m22

m32

public float m32

m03

public float m03

m13

public float m13

m23

public float m23

m33

public float m33

Constructor Detail

Matrix4f

public Matrix4f(float m00,
                float m10,
                float m20,
                float m30,
                float m01,
                float m11,
                float m21,
                float m31,
                float m02,
                float m12,
                float m22,
                float m32,
                float m03,
                float m13,
                float m23,
                float m33)

Creates a matrix from its components.

Matrix4f

public Matrix4f(float[] values)

Creates a matrix from an array of values.

Matrix4f

public Matrix4f(FloatBuffer buf)

Creates a matrix from a float buffer.

Matrix4f

public Matrix4f(Matrix4f other)

Copy constructor.

Matrix4f

public Matrix4f()

Creates an identity matrix.

Method Detail

setToIdentity

public Matrix4f setToIdentity()

Sets this matrix to the identity matrix.

Returns:

a reference to this matrix, for chaining.

setToTransform

public Matrix4f setToTransform(Vector3f translation,
                               Quaternion rotation)

Sets this to a matrix that first rotates, then translates.

Returns:

a reference to this matrix, for chaining.

setToTransform

public Matrix4f setToTransform(Vector3f translation,
                               Quaternion rotation,
                               float scale)

Sets this to a matrix that first scales, then rotates, then translates.

Returns:

a reference to this matrix, for chaining.

setToTransform

public Matrix4f setToTransform(Vector3f translation,
                               Quaternion rotation,
                               Vector3f scale)

Sets this to a matrix that first scales, then rotates, then translates.

Returns:

a reference to this matrix, for chaining.

setToTranslation

public Matrix4f setToTranslation(Vector3f translation)

Sets this to a translation matrix.

Returns:

a reference to this matrix, for chaining.

setToTranslation

public Matrix4f setToTranslation(float x,
                                 float y,
                                 float z)

Sets this to a translation matrix.

Returns:

a reference to this matrix, for chaining.

setTranslation

public Matrix4f setTranslation(Vector3f translation)

Sets the translation component of this matrix.

Returns:

a reference to this matrix, for chaining.

setTranslation

public Matrix4f setTranslation(float x,
                               float y,
                               float z)

Sets the translation component of this matrix.

Returns:

a reference to this matrix, for chaining.

setToRotation

public Matrix4f setToRotation(Vector3f from,
                              Vector3f to)

Sets this to a rotation matrix that rotates one vector onto another.

Returns:

a reference to this matrix, for chaining.

setToRotation

public Matrix4f setToRotation(float angle,
                              Vector3f axis)

Sets this to a rotation matrix.

Returns:

a reference to this matrix, for chaining.

setToRotation

public Matrix4f setToRotation(float angle,
                              float x,
                              float y,
                              float z)

Sets this to a rotation matrix. The formula comes from the OpenGL documentation for the glRotatef function.

Returns:

a reference to this matrix, for chaining.

setToRotation

public Matrix4f setToRotation(Quaternion quat)

Sets this to a rotation matrix. The formula comes from the Matrix and Quaternion FAQ.

Returns:

a reference to this matrix, for chaining.

setToScale

public Matrix4f setToScale(Vector3f scale)

Sets this to a scale matrix.

Returns:

a reference to this matrix, for chaining.

setToScale

public Matrix4f setToScale(float s)

Sets this to a uniform scale matrix.

Returns:

a reference to this matrix, for chaining.

setToScale

public Matrix4f setToScale(float x,
                           float y,
                           float z)

Sets this to a scale matrix.

Returns:

a reference to this matrix, for chaining.

setToReflection

public Matrix4f setToReflection(Vector3f normal)

Sets this to a reflection across a plane intersecting the origin with the supplied normal.

Returns:

a reference to this matrix, for chaining.

setToReflection

public Matrix4f setToReflection(float x,
                                float y,
                                float z)

Sets this to a reflection across a plane intersecting the origin with the supplied normal.

Returns:

a reference to this matrix, for chaining.

setToReflection

public Matrix4f setToReflection(Plane plane)

Sets this to a reflection across the specified plane.

Returns:

a reference to this matrix, for chaining.

setToReflection

public Matrix4f setToReflection(Vector3f normal,
                                float constant)

Sets this to a reflection across the specified plane.

Returns:

a reference to this matrix, for chaining.

setToReflection

public Matrix4f setToReflection(float x,
                                float y,
                                float z,
                                float w)

Sets this to a reflection across the specified plane.

Returns:

a reference to this matrix, for chaining.

setToSkew

public Matrix4f setToSkew(Plane plane,
                          Vector3f amount)

Sets this to a skew by the specified amount relative to the given plane.

Returns:

a reference to this matrix, for chaining.

setToSkew

public Matrix4f setToSkew(Vector3f normal,
                          float constant,
                          Vector3f amount)

Sets this to a skew by the specified amount relative to the given plane.

Returns:

a reference to this matrix, for chaining.

setToSkew

public Matrix4f setToSkew(float a,
                          float b,
                          float c,
                          float d,
                          float x,
                          float y,
                          float z)

Sets this to a skew by the specified amount relative to the given plane.

Returns:

a reference to this matrix, for chaining.

setToPerspective

public Matrix4f setToPerspective(float fovy,
                                 float aspect,
                                 float near,
                                 float far)

Sets this to a perspective projection matrix. The formula comes from the OpenGL documentation for the gluPerspective function.

Returns:

a reference to this matrix, for chaining.

setToFrustum

public Matrix4f setToFrustum(float left,
                             float right,
                             float bottom,
                             float top,
                             float near,
                             float far)

Sets this to a perspective projection matrix. The formula comes from the OpenGL documentation for the glFrustum function.

Returns:

a reference to this matrix, for chaining.

setToFrustum

public Matrix4f setToFrustum(float left,
                             float right,
                             float bottom,
                             float top,
                             float near,
                             float far,
                             Vector3f nearFarNormal)

Sets this to a perspective projection matrix.

Returns:

a reference to this matrix, for chaining.

setToOrtho

public Matrix4f setToOrtho(float left,
                           float right,
                           float bottom,
                           float top,
                           float near,
                           float far)

Sets this to an orthographic projection matrix. The formula comes from the OpenGL documentation for the glOrtho function.

Returns:

a reference to this matrix, for chaining.

setToOrtho

public Matrix4f setToOrtho(float left,
                           float right,
                           float bottom,
                           float top,
                           float near,
                           float far,
                           Vector3f nearFarNormal)

Sets this to an orthographic projection matrix.

Returns:

a reference to this matrix, for chaining.

transposeLocal

public Matrix4f transposeLocal()

Transposes this matrix in-place.

Returns:

a reference to this matrix, for chaining.

transpose

public Matrix4f transpose()

Transposes this matrix.

Returns:

a new matrix containing the result.

transpose

public Matrix4f transpose(Matrix4f result)

Transposes this matrix, storing the result in the provided object.

Returns:

the result matrix, for chaining.

multLocal

public Matrix4f multLocal(Matrix4f other)

Multiplies this matrix in-place by another.

Returns:

a reference to this matrix, for chaining.

mult

public Matrix4f mult(Matrix4f other)

Multiplies this matrix by another.

Returns:

a new matrix containing the result.

mult

public Matrix4f mult(Matrix4f other,
                     Matrix4f result)

Multiplies this matrix by another and stores the result in the object provided.

Returns:

a reference to the result matrix, for chaining.

isAffine

public boolean isAffine()

Determines whether this matrix represents an affine transformation.

isMirrored

public boolean isMirrored()

Determines whether the matrix is mirrored.

multAffineLocal

public Matrix4f multAffineLocal(Matrix4f other)

Multiplies this matrix in-place by another, treating the matricees as affine.

Returns:

a reference to this matrix, for chaining.

multAffine

public Matrix4f multAffine(Matrix4f other)

Multiplies this matrix by another, treating the matrices as affine.

Returns:

a new matrix containing the result.

multAffine

public Matrix4f multAffine(Matrix4f other,
                           Matrix4f result)

Multiplies this matrix by another, treating the matrices as affine, and stores the result in the object provided.

Returns:

a reference to the result matrix, for chaining.

invertLocal

public Matrix4f invertLocal()

Inverts this matrix in-place.

Returns:

a reference to this matrix, for chaining.

invert

public Matrix4f invert()

Inverts this matrix.

Returns:

a new matrix containing the result.

invert

public Matrix4f invert(Matrix4f result)
                throws SingularMatrixException

Inverts this matrix and places the result in the given object. This code is based on the examples in the Matrix and Quaternion FAQ.

Returns:

a reference to the result matrix, for chaining.

Throws:

SingularMatrixException

invertAffineLocal

public Matrix4f invertAffineLocal()

Inverts this matrix in-place as an affine matrix.

Returns:

a reference to this matrix, for chaining.

invertAffine

public Matrix4f invertAffine()

Inverts this matrix as an affine matrix.

Returns:

a new matrix containing the result.

invertAffine

public Matrix4f invertAffine(Matrix4f result)
                      throws SingularMatrixException

Inverts this matrix as an affine matrix and places the result in the given object.

Returns:

a reference to the result matrix, for chaining.

Throws:

SingularMatrixException

lerpLocal

public Matrix4f lerpLocal(Matrix4f other,
                          float t)

Linearly interpolates between the this and the specified other matrix, placing the result in this matrix.

Returns:

a reference to this matrix, for chaining.

lerp

public Matrix4f lerp(Matrix4f other,
                     float t)

Linearly interpolates between this and the specified other matrix.

Returns:

a new matrix containing the result.

lerp

public Matrix4f lerp(Matrix4f other,
                     float t,
                     Matrix4f result)

Linearly interpolates between this and the specified other matrix, placing the result in the object provided.

Returns:

a reference to the result object, for chaining.

lerpAffineLocal

public Matrix4f lerpAffineLocal(Matrix4f other,
                                float t)

Linearly interpolates between this and the specified other matrix (treating the matrices as affine), placing the result in this matrix.

Returns:

a reference to this matrix, for chaining.

lerpAffine

public Matrix4f lerpAffine(Matrix4f other,
                           float t)

Linearly interpolates between this and the specified other matrix, treating the matrices as affine.

Returns:

a new matrix containing the result.

lerpAffine

public Matrix4f lerpAffine(Matrix4f other,
                           float t,
                           Matrix4f result)

Linearly interpolates between this and the specified other matrix (treating the matrices as affine), placing the result in the object provided.

Returns:

a reference to the result object, for chaining.

set

public Matrix4f set(Matrix4f other)

Copies the contents of another matrix.

Returns:

a reference to this matrix, for chaining.

set

public Matrix4f set(float[] values)

Copies the elements of an array.

Returns:

a reference to this matrix, for chaining.

set

public Matrix4f set(FloatBuffer buf)

Sets the contents of this matrix from the supplied buffer.

Returns:

a reference to this matrix, for chaining.

set

public Matrix4f set(float m00,
                    float m10,
                    float m20,
                    float m30,
                    float m01,
                    float m11,
                    float m21,
                    float m31,
                    float m02,
                    float m12,
                    float m22,
                    float m32,
                    float m03,
                    float m13,
                    float m23,
                    float m33)

Sets all of the matrix's components at once.

Returns:

a reference to this matrix, for chaining.

get

public FloatBuffer get(FloatBuffer buf)

Places the contents of this matrix into the given buffer in the standard OpenGL order.

Returns:

a reference to the buffer, for chaining.

projectPointLocal

public Vector3f projectPointLocal(Vector3f point)

Projects the supplied point in-place using this matrix.

Returns:

a reference to the point, for chaining.

projectPoint

public Vector3f projectPoint(Vector3f point)

Projects the supplied point using this matrix.

Returns:

a new vector containing the result.

projectPoint

public Vector3f projectPoint(Vector3f point,
                             Vector3f result)

Projects the supplied point using this matrix and places the result in the object supplied.

Returns:

a reference to the result vector, for chaining.

transformPointLocal

public Vector3f transformPointLocal(Vector3f point)

Transforms a point in-place by this matrix.

Returns:

a reference to the point, for chaining.

transformPoint

public Vector3f transformPoint(Vector3f point)

Transforms a point by this matrix.

Returns:

a new vector containing the result.

transformPoint

public Vector3f transformPoint(Vector3f point,
                               Vector3f result)

Transforms a point by this matrix and places the result in the object provided.

Returns:

a reference to the result, for chaining.

transformPointZ

public float transformPointZ(Vector3f point)

Transforms a point by this matrix and returns the resulting z coordinate.

transformVectorLocal

public Vector3f transformVectorLocal(Vector3f vector)

Transforms a vector in-place by the inner 3x3 part of this matrix.

Returns:

a reference to the vector, for chaining.

transformVector

public Vector3f transformVector(Vector3f vector)

Transforms a vector by this inner 3x3 part of this matrix.

Returns:

a new vector containing the result.

transformVector

public Vector3f transformVector(Vector3f vector,
                                Vector3f result)

Transforms a vector by the inner 3x3 part of this matrix and places the result in the object provided.

Returns:

a reference to the result, for chaining.

extractRotation

public Quaternion extractRotation()

Extracts the rotation component of the matrix.

Returns:

a new quaternion containing the result.

extractRotation

public Quaternion extractRotation(Quaternion result)

Extracts the rotation component of the matrix and places it in the provided result quaternion. This uses the iterative polar decomposition algorithm described by Ken Shoemake.

Returns:

a reference to the result quaternion, for chaining.

extractScale

public Vector3f extractScale()

Extracts the scale component of the matrix.

Returns:

a new vector containing the result.

extractScale

public Vector3f extractScale(Vector3f result)

Extracts the scale component of the matrix and places it in the provided result vector.

Returns:

a reference to the result vector, for chaining.

approximateUniformScale

public float approximateUniformScale()

Returns an approximation of the uniform scale for this matrix (the cube root of the signed volume of the parallelepiped spanned by the axis vectors).

epsilonEquals

public boolean epsilonEquals(Matrix4f other,
                             float epsilon)

Compares this matrix to another with the provided epsilon.

encodeToString

public String encodeToString()

Description copied from interface: Encodable

Returns a string representation of this object.

Specified by:

encodeToString in interface Encodable

decodeFromString

public void decodeFromString(String string)
                      throws Exception

Description copied from interface: Encodable

Initializes this object with the contents of the specified string.

Specified by:

decodeFromString in interface Encodable

Throws:

Exception

encodeToStream

public void encodeToStream(DataOutputStream out)
                    throws IOException

Description copied from interface: Encodable

Encodes this object to the specified stream.

Specified by:

encodeToStream in interface Encodable

Throws:

IOException

decodeFromStream

public void decodeFromStream(DataInputStream in)
                      throws IOException

Description copied from interface: Encodable

Initializes this object with data read from the specified stream.

Specified by:

decodeFromStream in interface Encodable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object