org.joml

Class Matrix3f

java.lang.Object

org.joml.Matrix3f

All Implemented Interfaces:

Externalizable, Serializable

public class Matrix3f
extends Object
implements Externalizable

Contains the definition of a 3x3 Matrix of floats, and associated functions to transform it. The matrix is column-major to match OpenGL's interpretation, and it looks like this:

m00 m10 m20
m01 m11 m21
m02 m12 m22

Author:

Kai Burjack

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
float	m00
float	m01
float	m02
float	m10
float	m11
float	m12
float	m20
float	m21
float	m22

Constructor Summary

Constructors

Constructor and Description
Matrix3f() Create a new Matrix3f and set it to identity.
Matrix3f(float m00, float m01, float m02, float m10, float m11, float m12, float m20, float m21, float m22) Create a new 3x3 matrix using the supplied float values.
Matrix3f(Matrix3f mat) Create a new Matrix3f and make it a copy of the given matrix.

Method Summary

Modifier and Type	Method and Description
float	determinant() Return the determinant of this matrix.
ByteBuffer	get(ByteBuffer buffer) Store this matrix in column-major order into the supplied ByteBuffer at the current buffer position.
FloatBuffer	get(FloatBuffer buffer) Store this matrix in column-major order into the supplied FloatBuffer at the current buffer position.
ByteBuffer	get(int index, ByteBuffer buffer) Store this matrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.
FloatBuffer	get(int index, FloatBuffer buffer) Store this matrix in column-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.
Matrix3f	get(Matrix3f dest) Get the current values of this matrix and store them into dest.
Matrix3f	identity() Set this matrix to the identity.
Matrix3f	invert() Invert this matrix.
Matrix3f	invert(Matrix3f dest) Invert the this matrix and store the result in dest.
Matrix3f	mul(Matrix3f right) Multiply this matrix by the supplied right matrix.
Matrix3f	mul(Matrix3f right, Matrix3f dest) Multiply this matrix by the supplied right matrix and store the result in dest.
void	readExternal(ObjectInput in)
Matrix3f	rotate(float ang) Apply a rotation transformation to this matrix by rotating the given amount of radians.
Matrix3f	rotate(float ang, Matrix3f dest) Apply a rotation transformation to this matrix by rotating the given amount of radians and store the result in dest.
Matrix3f	rotateAbout(float ang, float x, float y) Apply a rotation transformation to this matrix by rotating the given amount of radians about the specified rotation center (x, y).
Matrix3f	rotateAbout(float ang, float x, float y, Matrix3f dest) Apply a rotation transformation to this matrix by rotating the given amount of radians about the specified rotation center (x, y) and store the result in dest.
Matrix3f	rotateTo(Vector2f fromDir, Vector2f toDir) Apply a rotation transformation to this matrix that rotates the given normalized fromDir direction vector to point along the normalized toDir.
Matrix3f	rotateTo(Vector2f fromDir, Vector2f toDir, Matrix3f dest) Apply a rotation transformation to this matrix that rotates the given normalized fromDir direction vector to point along the normalized toDir, and store the result in dest.
Matrix3f	rotation(float angle) Set this matrix to a rotation matrix which rotates the given radians.
Matrix3f	scale(float xy) Apply scaling to this matrix by uniformly scaling the two base axes by the given xyz factor.
Matrix3f	scale(float x, float y) Apply scaling to this matrix by scaling the unit axes by the given x and y factors.
Matrix3f	scale(float x, float y, Matrix3f dest) Apply scaling to this matrix by scaling the unit axes by the given x and y and store the result in dest.
Matrix3f	scale(float xy, Matrix3f dest) Apply scaling to this matrix by uniformly scaling the two base axes by the given xy factor and store the result in dest.
Matrix3f	scaling(float factor) Set this matrix to be a simple scale matrix, which scales the two base axes uniformly by the given factor.
Matrix3f	scaling(float x, float y) Set this matrix to be a simple scale matrix.
Matrix3f	set(ByteBuffer buffer) Set the values of this matrix by reading 9 float values from the given ByteBuffer in column-major order, starting at its current position.
Matrix3f	set(float[] m) Set the values in this matrix based on the supplied float array.
Matrix3f	set(FloatBuffer buffer) Set the values of this matrix by reading 9 float values from the given FloatBuffer in column-major order, starting at its current position.
Matrix3f	set(float m00, float m01, float m02, float m10, float m11, float m12, float m20, float m21, float m22) Set the values within this matrix to the supplied float values.
Matrix3f	set(Matrix3f m) Set the elements of this matrix to the ones in m.
Matrix3f	setTranslation(float x, float y) Set only the translation components of this matrix (m20, m21) to the given values (x, y).
Matrix3f	setTranslation(Vector2f offset) Set only the translation components of this matrix (m20, m21) to the given values (offset.x, offset.y).
Matrix3f	setView(float left, float right, float bottom, float top) Set this matrix to define a "view" transformation that maps the given (left, bottom) and (right, top) corners to (-1, -1) and (1, 1) respectively.
String	toString() Return a string representation of this matrix.
String	toString(NumberFormat formatter) Return a string representation of this matrix by formatting the matrix elements with the given NumberFormat.
Matrix3f	transform(Vector2f v) Transform the given vector by this matrix.
Vector2f	transform(Vector2f v, Vector2f dest) Transform the given vector by this matrix and store the result in dest.
Matrix3f	translate(float x, float y) Apply a translation to this matrix by translating by the given number of units in x and y.
Matrix3f	translate(float x, float y, Matrix3f dest) Apply a translation to this matrix by translating by the given number of units in x and y and store the result in dest.
Matrix3f	translate(Vector2f offset) Apply a translation to this matrix by translating by the given number of units in x and y.
Matrix3f	translate(Vector2f offset, Matrix3f dest) Apply a translation to this matrix by translating by the given number of units in x and y, and store the result in dest.
Matrix3f	translation(float x, float y) Set this matrix to be a simple translation matrix in a two-dimensional coordinate system.
Matrix3f	translation(Vector2f offset) Set this matrix to be a simple translation matrix in a two-dimensional coordinate system.
Matrix3f	transpose() Transpose this matrix.
Matrix3f	transpose(Matrix3f dest) Transpose this matrix and store the result in dest.
Matrix3f	view(float left, float right, float bottom, float top) Apply a "view" transformation to this matrix that maps the given (left, bottom) and (right, top) corners to (-1, -1) and (1, 1) respectively.
Matrix3f	view(float left, float right, float bottom, float top, Matrix3f dest) Apply a "view" transformation to this matrix that maps the given (left, bottom) and (right, top) corners to (-1, -1) and (1, 1) respectively and store the result in dest.
void	writeExternal(ObjectOutput out)
Matrix3f	zero() Set all values within this matrix to zero.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m00

public float m00

m10

public float m10

m20

public float m20

m01

public float m01

m11

public float m11

m21

public float m21

m02

public float m02

m12

public float m12

m22

public float m22

Constructor Detail

Matrix3f

public Matrix3f()

Create a new Matrix3f and set it to identity.

Matrix3f

public Matrix3f(Matrix3f mat)

Create a new Matrix3f and make it a copy of the given matrix.

Parameters:

mat - the Matrix3f to copy the values from

Matrix3f

public Matrix3f(float m00,
                float m01,
                float m02,
                float m10,
                float m11,
                float m12,
                float m20,
                float m21,
                float m22)

Create a new 3x3 matrix using the supplied float values. The order of the parameter is column-major, so the first three parameters specify the three elements of the first column.

Parameters:

m00 - the value of m00

m01 - the value of m01

m02 - the value of m02

m10 - the value of m10

m11 - the value of m11

m12 - the value of m12

m20 - the value of m20

m21 - the value of m21

m22 - the value of m22

Method Detail

set

public Matrix3f set(Matrix3f m)

Set the elements of this matrix to the ones in m.

Parameters:

m - the matrix to copy the elements from

Returns:

this

mul

public Matrix3f mul(Matrix3f right)

Multiply this matrix by the supplied right matrix.

If M is this matrix and R the right matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the transformation of the right matrix will be applied first!

Parameters:

right - the right operand of the matrix multiplication

Returns:

this

mul

public Matrix3f mul(Matrix3f right,
                    Matrix3f dest)

Multiply this matrix by the supplied right matrix and store the result in dest.

If M is this matrix and R the right matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the transformation of the right matrix will be applied first!

Parameters:

right - the right operand of the matrix multiplication

dest - will hold the result

Returns:

dest

set

public Matrix3f set(float m00,
                    float m01,
                    float m02,
                    float m10,
                    float m11,
                    float m12,
                    float m20,
                    float m21,
                    float m22)

Set the values within this matrix to the supplied float values. The result looks like this:

m00, m10, m20
m01, m11, m21
m02, m12, m22

Parameters:

m00 - the new value of m00

m01 - the new value of m01

m02 - the new value of m02

m10 - the new value of m10

m11 - the new value of m11

m12 - the new value of m12

m20 - the new value of m20

m21 - the new value of m21

m22 - the new value of m22

Returns:

this

set

public Matrix3f set(float[] m)

Set the values in this matrix based on the supplied float array. The result looks like this:

0, 3, 6
1, 4, 7
2, 5, 8
This method only uses the first 9 values, all others are ignored.

Parameters:

m - the array to read the matrix values from

Returns:

this

determinant

public float determinant()

Return the determinant of this matrix.

Returns:

the determinant

invert

public Matrix3f invert()

Invert this matrix.

Returns:

this

invert

public Matrix3f invert(Matrix3f dest)

Invert the this matrix and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

transpose

public Matrix3f transpose()

Transpose this matrix.

Returns:

this

transpose

public Matrix3f transpose(Matrix3f dest)

Transpose this matrix and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

translation

public Matrix3f translation(float x,
                            float y)

Set this matrix to be a simple translation matrix in a two-dimensional coordinate system.

The resulting matrix can be multiplied against another transformation matrix to obtain an additional translation.

In order to apply a translation via to an already existing transformation matrix, use translate() instead.

Parameters:

x - the units to translate in x

y - the units to translate in y

Returns:

this

See Also:

translate(float, float)

translation

public Matrix3f translation(Vector2f offset)

Set this matrix to be a simple translation matrix in a two-dimensional coordinate system.

The resulting matrix can be multiplied against another transformation matrix to obtain an additional translation.

In order to apply a translation via to an already existing transformation matrix, use translate() instead.

Parameters:

offset - the translation

Returns:

this

See Also:

translate(Vector2f)

setTranslation

public Matrix3f setTranslation(float x,
                               float y)

Set only the translation components of this matrix (m20, m21) to the given values (x, y).

To build a translation matrix instead, use translation(float, float). To apply a translation to another matrix, use translate(float, float).

Parameters:

x - the offset to translate in x

y - the offset to translate in y

Returns:

this

See Also:

translation(float, float), translate(float, float)

setTranslation

public Matrix3f setTranslation(Vector2f offset)

Set only the translation components of this matrix (m20, m21) to the given values (offset.x, offset.y).

To build a translation matrix instead, use translation(Vector2f). To apply a translation to another matrix, use translate(Vector2f).

Parameters:

offset - the new translation to set

Returns:

this

See Also:

translation(Vector2f), translate(Vector2f)

translate

public Matrix3f translate(float x,
                          float y,
                          Matrix3f dest)

Apply a translation to this matrix by translating by the given number of units in x and y and store the result in dest.

If M is this matrix and T the translation matrix, then the new matrix will be M * T. So when transforming a vector v with the new matrix by using M * T * v, the translation will be applied first!

In order to set the matrix to a translation transformation without post-multiplying it, use translation(float, float).

Parameters:

x - the offset to translate in x

y - the offset to translate in y

dest - will hold the result

Returns:

dest

See Also:

translation(float, float)

translate

public Matrix3f translate(float x,
                          float y)

Apply a translation to this matrix by translating by the given number of units in x and y.

If M is this matrix and T the translation matrix, then the new matrix will be M * T. So when transforming a vector v with the new matrix by using M * T * v, the translation will be applied first!

In order to set the matrix to a translation transformation without post-multiplying it, use translation(float, float).

Parameters:

x - the offset to translate in x

y - the offset to translate in y

Returns:

this

See Also:

translation(float, float)

translate

public Matrix3f translate(Vector2f offset,
                          Matrix3f dest)

Apply a translation to this matrix by translating by the given number of units in x and y, and store the result in dest.

If M is this matrix and T the translation matrix, then the new matrix will be M * T. So when transforming a vector v with the new matrix by using M * T * v, the translation will be applied first!

In order to set the matrix to a translation transformation without post-multiplying it, use translation(float, float).

Parameters:

offset - the offset to translate

dest - will hold the result

Returns:

dest

See Also:

translation(Vector2f)

translate

public Matrix3f translate(Vector2f offset)

Apply a translation to this matrix by translating by the given number of units in x and y.

If M is this matrix and T the translation matrix, then the new matrix will be M * T. So when transforming a vector v with the new matrix by using M * T * v, the translation will be applied first!

In order to set the matrix to a translation transformation without post-multiplying it, use translation(float, float).

Parameters:

offset - the offset to translate

Returns:

this

See Also:

translation(Vector2f)

toString

public String toString()

Return a string representation of this matrix.

This method creates a new DecimalFormat on every invocation with the format string " 0.000E0; -".

Overrides:

toString in class Object

Returns:

the string representation

toString

public String toString(NumberFormat formatter)

Return a string representation of this matrix by formatting the matrix elements with the given NumberFormat.

Parameters:

formatter - the NumberFormat used to format the matrix values with

Returns:

the string representation

get

public Matrix3f get(Matrix3f dest)

Get the current values of this matrix and store them into dest.

This is the reverse method of set(Matrix3f) and allows to obtain intermediate calculation results when chaining multiple transformations.

Parameters:

dest - the destination matrix

Returns:

dest

See Also:

set(Matrix3f)

get

public FloatBuffer get(FloatBuffer buffer)

Store this matrix in column-major order into the supplied FloatBuffer at the current buffer position.

This method will not increment the position of the given FloatBuffer.

In order to specify the offset into the FloatBuffer at which the matrix is stored, use get(int, FloatBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of this matrix in column-major order at its current position

Returns:

buffer

See Also:

get(int, FloatBuffer)

get

public FloatBuffer get(int index,
                       FloatBuffer buffer)

Store this matrix in column-major order into the supplied FloatBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given FloatBuffer.

Parameters:

index - the absolute position into the FloatBuffer

buffer - will receive the values of this matrix in column-major order

Returns:

buffer

get

public ByteBuffer get(ByteBuffer buffer)

Store this matrix in column-major order into the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the matrix is stored, use get(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - will receive the values of this matrix in column-major order at its current position

Returns:

buffer

See Also:

get(int, ByteBuffer)

get

public ByteBuffer get(int index,
                      ByteBuffer buffer)

Store this matrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Parameters:

index - the absolute position into the ByteBuffer

buffer - will receive the values of this matrix in column-major order

Returns:

buffer

set

public Matrix3f set(FloatBuffer buffer)

Set the values of this matrix by reading 9 float values from the given FloatBuffer in column-major order, starting at its current position.

The FloatBuffer is expected to contain the values in column-major order.

The position of the FloatBuffer will not be changed by this method.

Parameters:

buffer - the FloatBuffer to read the matrix values from in column-major order

Returns:

this

set

public Matrix3f set(ByteBuffer buffer)

Set the values of this matrix by reading 9 float values from the given ByteBuffer in column-major order, starting at its current position.

The ByteBuffer is expected to contain the values in column-major order.

The position of the ByteBuffer will not be changed by this method.

Parameters:

buffer - the ByteBuffer to read the matrix values from in column-major order

Returns:

this

zero

public Matrix3f zero()

Set all values within this matrix to zero.

Returns:

this

identity

public Matrix3f identity()

Set this matrix to the identity.

Returns:

this

scale

public Matrix3f scale(float x,
                      float y,
                      Matrix3f dest)

Apply scaling to this matrix by scaling the unit axes by the given x and y and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v, the scaling will be applied first!

Parameters:

x - the factor of the x component

y - the factor of the y component

dest - will hold the result

Returns:

dest

scale

public Matrix3f scale(float x,
                      float y)

Apply scaling to this matrix by scaling the unit axes by the given x and y factors.

If M is this matrix and S the scaling matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v, the scaling will be applied first!

Parameters:

x - the factor of the x component

y - the factor of the y component

Returns:

this

scale

public Matrix3f scale(float xy,
                      Matrix3f dest)

Apply scaling to this matrix by uniformly scaling the two base axes by the given xy factor and store the result in dest.

If M is this matrix and S the scaling matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v, the scaling will be applied first!

Parameters:

xy - the factor for the two components

dest - will hold the result

Returns:

dest

See Also:

scale(float, float, Matrix3f)

scale

public Matrix3f scale(float xy)

Apply scaling to this matrix by uniformly scaling the two base axes by the given xyz factor.

If M is this matrix and S the scaling matrix, then the new matrix will be M * S. So when transforming a vector v with the new matrix by using M * S * v, the scaling will be applied first!

Parameters:

xy - the factor for the two components

Returns:

this

See Also:

scale(float, float)

scaling

public Matrix3f scaling(float factor)

Set this matrix to be a simple scale matrix, which scales the two base axes uniformly by the given factor.

The resulting matrix can be multiplied against another transformation matrix to obtain an additional scaling.

In order to post-multiply a scaling transformation directly to a matrix, use scale() instead.

Parameters:

factor - the scale factor in x and y

Returns:

this

See Also:

scale(float)

scaling

public Matrix3f scaling(float x,
                        float y)

Set this matrix to be a simple scale matrix.

Parameters:

x - the scale in x

y - the scale in y

Returns:

this

rotation

public Matrix3f rotation(float angle)

Set this matrix to a rotation matrix which rotates the given radians.

The resulting matrix can be multiplied against another transformation matrix to obtain an additional rotation.

In order to apply the rotation transformation to an existing transformation, use rotate() instead.

Parameters:

angle - the angle in radians

Returns:

this

See Also:

rotate(float)

transform

public Matrix3f transform(Vector2f v)

Transform the given vector by this matrix.

Parameters:

v - the vector to transform

Returns:

this

transform

public Vector2f transform(Vector2f v,
                          Vector2f dest)

Transform the given vector by this matrix and store the result in dest.

Parameters:

v - the vector to transform

dest - will hold the result

Returns:

dest

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

rotate

public Matrix3f rotate(float ang)

Apply a rotation transformation to this matrix by rotating the given amount of radians.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v , the rotation will be applied first!

Parameters:

ang - the angle in radians

Returns:

this

rotate

public Matrix3f rotate(float ang,
                       Matrix3f dest)

Apply a rotation transformation to this matrix by rotating the given amount of radians and store the result in dest.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Parameters:

ang - the angle in radians

dest - will hold the result

Returns:

dest

rotateAbout

public Matrix3f rotateAbout(float ang,
                            float x,
                            float y)

Apply a rotation transformation to this matrix by rotating the given amount of radians about the specified rotation center (x, y).

This method is equivalent to calling: translate(x, y).rotate(ang).translate(-x, -y)

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Parameters:

ang - the angle in radians

x - the x component of the rotation center

y - the y component of the rotation center

Returns:

dest

See Also:

translate(float, float), rotate(float)

rotateAbout

public Matrix3f rotateAbout(float ang,
                            float x,
                            float y,
                            Matrix3f dest)

Apply a rotation transformation to this matrix by rotating the given amount of radians about the specified rotation center (x, y) and store the result in dest.

This method is equivalent to calling: translate(x, y, dest).rotate(ang).translate(-x, -y)

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Parameters:

ang - the angle in radians

x - the x component of the rotation center

y - the y component of the rotation center

dest - will hold the result

Returns:

dest

See Also:

translate(float, float, Matrix3f), rotate(float, Matrix3f)

rotateTo

public Matrix3f rotateTo(Vector2f fromDir,
                         Vector2f toDir,
                         Matrix3f dest)

Apply a rotation transformation to this matrix that rotates the given normalized fromDir direction vector to point along the normalized toDir, and store the result in dest.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Parameters:

fromDir - the normalized direction which should be rotate to point along toDir

toDir - the normalized destination direction

dest - will hold the result

Returns:

dest

rotateTo

public Matrix3f rotateTo(Vector2f fromDir,
                         Vector2f toDir)

Apply a rotation transformation to this matrix that rotates the given normalized fromDir direction vector to point along the normalized toDir.

If M is this matrix and R the rotation matrix, then the new matrix will be M * R. So when transforming a vector v with the new matrix by using M * R * v, the rotation will be applied first!

Parameters:

fromDir - the normalized direction which should be rotate to point along toDir

toDir - the normalized destination direction

Returns:

this

view

public Matrix3f view(float left,
                     float right,
                     float bottom,
                     float top,
                     Matrix3f dest)

Apply a "view" transformation to this matrix that maps the given (left, bottom) and (right, top) corners to (-1, -1) and (1, 1) respectively and store the result in dest.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first!

Parameters:

left - the distance from the center to the left view edge

right - the distance from the center to the right view edge

bottom - the distance from the center to the bottom view edge

top - the distance from the center to the top view edge

dest - will hold the result

Returns:

dest

See Also:

setView(float, float, float, float)

view

public Matrix3f view(float left,
                     float right,
                     float bottom,
                     float top)

Apply a "view" transformation to this matrix that maps the given (left, bottom) and (right, top) corners to (-1, -1) and (1, 1) respectively.

If M is this matrix and O the orthographic projection matrix, then the new matrix will be M * O. So when transforming a vector v with the new matrix by using M * O * v, the orthographic projection transformation will be applied first!

Parameters:

left - the distance from the center to the left view edge

right - the distance from the center to the right view edge

bottom - the distance from the center to the bottom view edge

top - the distance from the center to the top view edge

Returns:

this

See Also:

setView(float, float, float, float)

setView

public Matrix3f setView(float left,
                        float right,
                        float bottom,
                        float top)

Set this matrix to define a "view" transformation that maps the given (left, bottom) and (right, top) corners to (-1, -1) and (1, 1) respectively.

Parameters:

left - the distance from the center to the left view edge

right - the distance from the center to the right view edge

bottom - the distance from the center to the bottom view edge

top - the distance from the center to the top view edge

Returns:

this

See Also:

view(float, float, float, float)