Class Matrix2f
- java.lang.Object
-
- org.joml.Matrix2f
-
- All Implemented Interfaces:
java.io.Externalizable
,java.io.Serializable
,java.lang.Cloneable
,Matrix2fc
public class Matrix2f extends java.lang.Object implements java.io.Externalizable, java.lang.Cloneable, Matrix2fc
Contains the definition of a 2x2 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
m01 m11- Author:
- Joseph Burton
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Matrix2f()
Matrix2f(float m00, float m01, float m10, float m11)
Create a new 2x2 matrix using the supplied float values.Matrix2f(java.nio.FloatBuffer buffer)
Create a newMatrix2f
by reading its 4 float components from the givenFloatBuffer
at the buffer's current position.Matrix2f(Matrix2fc mat)
Create a newMatrix2f
and make it a copy of the given matrix.Matrix2f(Matrix3fc mat)
Matrix2f(Vector2fc col0, Vector2fc col1)
Create a newMatrix2f
and initialize its two columns using the supplied vectors.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Matrix2f
add(Matrix2fc other)
Component-wise addthis
andother
.Matrix2f
add(Matrix2fc other, Matrix2f dest)
Component-wise addthis
andother
and store the result indest
.java.lang.Object
clone()
float
determinant()
Return the determinant of this matrix.boolean
equals(java.lang.Object obj)
boolean
equals(Matrix2fc m, float delta)
Compare the matrix elements ofthis
matrix with the given matrix using the givendelta
and return whether all of them are equal within a maximum difference ofdelta
.float[]
get(float[] arr)
Store this matrix into the supplied float array in column-major order.float[]
get(float[] arr, int offset)
Store this matrix into the supplied float array in column-major order at the given offset.float
get(int column, int row)
Get the matrix element value at the given column and row.java.nio.ByteBuffer
get(int index, java.nio.ByteBuffer buffer)
Store this matrix in column-major order into the suppliedByteBuffer
starting at the specified absolute buffer position/index.java.nio.FloatBuffer
get(int index, java.nio.FloatBuffer buffer)
Store this matrix in column-major order into the suppliedFloatBuffer
starting at the specified absolute buffer position/index.java.nio.ByteBuffer
get(java.nio.ByteBuffer buffer)
Store this matrix in column-major order into the suppliedByteBuffer
at the current bufferposition
.java.nio.FloatBuffer
get(java.nio.FloatBuffer buffer)
Store this matrix in column-major order into the suppliedFloatBuffer
at the current bufferposition
.Matrix2f
get(Matrix2f dest)
Get the current values ofthis
matrix and store them intodest
.Matrix3f
get(Matrix3f dest)
Get the current values ofthis
matrix and store them as the rotational component ofdest
.Matrix3x2f
get(Matrix3x2f dest)
Get the current values ofthis
matrix and store them as the rotational component ofdest
.Vector2f
getColumn(int column, Vector2f dest)
Get the column at the givencolumn
index, starting with0
.float
getRotation()
Get the angle of the rotation component ofthis
matrix.Vector2f
getRow(int row, Vector2f dest)
Get the row at the givenrow
index, starting with0
.Vector2f
getScale(Vector2f dest)
Get the scaling factors ofthis
matrix for the three base axes.Matrix2fc
getToAddress(long address)
Store this matrix in column-major order at the given off-heap address.java.nio.ByteBuffer
getTransposed(int index, java.nio.ByteBuffer buffer)
Store the transpose of this matrix in column-major order into the suppliedByteBuffer
starting at the specified absolute buffer position/index.java.nio.FloatBuffer
getTransposed(int index, java.nio.FloatBuffer buffer)
Store the transpose of this matrix in column-major order into the suppliedFloatBuffer
starting at the specified absolute buffer position/index.java.nio.ByteBuffer
getTransposed(java.nio.ByteBuffer buffer)
Store the transpose of this matrix in column-major order into the suppliedByteBuffer
at the current bufferposition
.java.nio.FloatBuffer
getTransposed(java.nio.FloatBuffer buffer)
Store the transpose of this matrix in column-major order into the suppliedFloatBuffer
at the current bufferposition
.int
hashCode()
Matrix2f
identity()
Set this matrix to the identity.Matrix2f
invert()
Invert this matrix.Matrix2f
invert(Matrix2f dest)
Invert thethis
matrix and store the result indest
.boolean
isFinite()
Determine whether all matrix elements are finite floating-point values, that is, they are notNaN
and notinfinity
.Matrix2f
lerp(Matrix2fc other, float t)
Linearly interpolatethis
andother
using the given interpolation factort
and store the result inthis
.Matrix2f
lerp(Matrix2fc other, float t, Matrix2f dest)
Linearly interpolatethis
andother
using the given interpolation factort
and store the result indest
.float
m00()
Return the value of the matrix element at column 0 and row 0.Matrix2f
m00(float m00)
Set the value of the matrix element at column 0 and row 0.float
m01()
Return the value of the matrix element at column 0 and row 1.Matrix2f
m01(float m01)
Set the value of the matrix element at column 0 and row 1.float
m10()
Return the value of the matrix element at column 1 and row 0.Matrix2f
m10(float m10)
Set the value of the matrix element at column 1 and row 0.float
m11()
Return the value of the matrix element at column 1 and row 1.Matrix2f
m11(float m11)
Set the value of the matrix element at column 1 and row 1.Matrix2f
mul(Matrix2fc right)
Multiply this matrix by the suppliedright
matrix.Matrix2f
mul(Matrix2fc right, Matrix2f dest)
Multiply this matrix by the suppliedright
matrix and store the result indest
.Matrix2f
mulComponentWise(Matrix2fc other)
Component-wise multiplythis
byother
.Matrix2f
mulComponentWise(Matrix2fc other, Matrix2f dest)
Component-wise multiplythis
byother
and store the result indest
.Matrix2f
mulLocal(Matrix2fc left)
Pre-multiply this matrix by the suppliedleft
matrix and store the result inthis
.Matrix2f
mulLocal(Matrix2fc left, Matrix2f dest)
Pre-multiply this matrix by the suppliedleft
matrix and store the result indest
.Matrix2f
normal()
Setthis
matrix to its own normal matrix.Matrix2f
normal(Matrix2f dest)
Compute a normal matrix fromthis
matrix and store it intodest
.Vector2f
normalizedPositiveX(Vector2f dir)
Obtain the direction of+X
before the transformation represented bythis
orthogonal matrix is applied.Vector2f
normalizedPositiveY(Vector2f dir)
Obtain the direction of+Y
before the transformation represented bythis
orthogonal matrix is applied.Vector2f
positiveX(Vector2f dir)
Obtain the direction of+X
before the transformation represented bythis
matrix is applied.Vector2f
positiveY(Vector2f dir)
Obtain the direction of+Y
before the transformation represented bythis
matrix is applied.void
readExternal(java.io.ObjectInput in)
Matrix2f
rotate(float angle)
Apply rotation about the origin to this matrix by rotating the given amount of radians.Matrix2f
rotate(float angle, Matrix2f dest)
Apply rotation to this matrix by rotating the given amount of radians and store the result indest
.Matrix2f
rotateLocal(float angle)
Pre-multiply a rotation to this matrix by rotating the given amount of radians about the origin.Matrix2f
rotateLocal(float angle, Matrix2f dest)
Pre-multiply a rotation to this matrix by rotating the given amount of radians and store the result indest
.Matrix2f
rotation(float angle)
Set this matrix to a rotation matrix which rotates the given radians about the origin.Matrix2f
scale(float xy)
Apply scaling to this matrix by uniformly scaling all base axes by the givenxy
factor.Matrix2f
scale(float x, float y)
Apply scaling to this matrix by scaling the base axes by the given x and y factors.Matrix2f
scale(float x, float y, Matrix2f dest)
Apply scaling to this matrix by scaling the base axes by the given x and y factors and store the result indest
.Matrix2f
scale(float xy, Matrix2f dest)
Apply scaling to this matrix by uniformly scaling all base axes by the givenxy
factor and store the result indest
.Matrix2f
scale(Vector2fc xy)
Apply scaling to this matrix by scaling the base axes by the givenxy.x
andxy.y
factors, respectively.Matrix2f
scale(Vector2fc xy, Matrix2f dest)
Apply scaling tothis
matrix by scaling the base axes by the givenxy.x
andxy.y
factors, respectively and store the result indest
.Matrix2f
scaleLocal(float x, float y)
Pre-multiply scaling to this matrix by scaling the base axes by the given x and y factors.Matrix2f
scaleLocal(float x, float y, Matrix2f dest)
Pre-multiply scaling tothis
matrix by scaling the base axes by the given x and y factors and store the result indest
.Matrix2f
scaling(float factor)
Set this matrix to be a simple scale matrix, which scales all axes uniformly by the given factor.Matrix2f
scaling(float x, float y)
Set this matrix to be a simple scale matrix.Matrix2f
scaling(Vector2fc xy)
Set this matrix to be a simple scale matrix which scales the base axes byxy.x
andxy.y
respectively.Matrix2f
set(float[] m)
Set the values in this matrix based on the supplied float array.Matrix2f
set(float m00, float m01, float m10, float m11)
Set the values within this matrix to the supplied float values.Matrix2f
set(int column, int row, float value)
Set the matrix element at the given column and row to the specified value.Matrix2f
set(int index, java.nio.ByteBuffer buffer)
Set the values of this matrix by reading 4 float values from the givenByteBuffer
in column-major order, starting at the specified absolute buffer position/index.Matrix2f
set(int index, java.nio.FloatBuffer buffer)
Set the values of this matrix by reading 4 float values from the givenFloatBuffer
in column-major order, starting at the specified absolute buffer position/index.Matrix2f
set(java.nio.ByteBuffer buffer)
Set the values of this matrix by reading 4 float values from the givenByteBuffer
in column-major order, starting at its current position.Matrix2f
set(java.nio.FloatBuffer buffer)
Set the values of this matrix by reading 4 float values from the givenFloatBuffer
in column-major order, starting at its current position.Matrix2f
set(Matrix2fc m)
Set the elements of this matrix to the ones inm
.Matrix2f
set(Matrix3fc m)
Set the elements of this matrix to the upper left 2x2 of the givenMatrix3fc
.Matrix2f
set(Matrix3x2fc m)
Set the elements of this matrix to the left 2x2 submatrix ofm
.Matrix2f
set(Vector2fc col0, Vector2fc col1)
Set the two columns of this matrix to the supplied vectors, respectively.Matrix2f
setColumn(int column, float x, float y)
Set the column at the givencolumn
index, starting with0
.Matrix2f
setColumn(int column, Vector2fc src)
Set the column at the givencolumn
index, starting with0
.Matrix2f
setFromAddress(long address)
Set the values of this matrix by reading 4 float values from off-heap memory in column-major order, starting at the given address.Matrix2f
setRow(int row, float x, float y)
Set the row at the givenrow
index, starting with0
.Matrix2f
setRow(int row, Vector2fc src)
Set the row at the givenrow
index, starting with0
.Matrix2f
sub(Matrix2fc subtrahend)
Component-wise subtractsubtrahend
fromthis
.Matrix2f
sub(Matrix2fc other, Matrix2f dest)
Component-wise subtractsubtrahend
fromthis
and store the result indest
.Matrix2f
swap(Matrix2f other)
Exchange the values ofthis
matrix with the givenother
matrix.java.lang.String
toString()
Return a string representation of this matrix.java.lang.String
toString(java.text.NumberFormat formatter)
Return a string representation of this matrix by formatting the matrix elements with the givenNumberFormat
.Vector2f
transform(float x, float y, Vector2f dest)
Transform the vector(x, y)
by this matrix and store the result indest
.Vector2f
transform(Vector2f v)
Transform the given vector by this matrix.Vector2f
transform(Vector2fc v, Vector2f dest)
Transform the given vector by this matrix and store the result indest
.Vector2f
transformTranspose(float x, float y, Vector2f dest)
Transform the vector(x, y)
by the transpose of this matrix and store the result indest
.Vector2f
transformTranspose(Vector2f v)
Transform the given vector by the transpose of this matrix.Vector2f
transformTranspose(Vector2fc v, Vector2f dest)
Transform the given vector by the transpose of this matrix and store the result indest
.Matrix2f
transpose()
Transpose this matrix.Matrix2f
transpose(Matrix2f dest)
Transposethis
matrix and store the result indest
.void
writeExternal(java.io.ObjectOutput out)
Matrix2f
zero()
Set all values within this matrix to zero.
-
-
-
Constructor Detail
-
Matrix2f
public Matrix2f()
-
Matrix2f
public Matrix2f(Matrix2fc mat)
Create a newMatrix2f
and make it a copy of the given matrix.- Parameters:
mat
- theMatrix2fc
to copy the values from
-
Matrix2f
public Matrix2f(float m00, float m01, float m10, float m11)
Create a new 2x2 matrix using the supplied float values. The order of the parameter is column-major, so the first two parameters specify the two elements of the first column.- Parameters:
m00
- the value of m00m01
- the value of m01m10
- the value of m10m11
- the value of m11
-
Matrix2f
public Matrix2f(java.nio.FloatBuffer buffer)
Create a newMatrix2f
by reading its 4 float components from the givenFloatBuffer
at the buffer's current position.That FloatBuffer is expected to hold the values in column-major order.
The buffer's position will not be changed by this method.
- Parameters:
buffer
- theFloatBuffer
to read the matrix values from
-
-
Method Detail
-
m00
public float m00()
Description copied from interface:Matrix2fc
Return the value of the matrix element at column 0 and row 0.
-
m01
public float m01()
Description copied from interface:Matrix2fc
Return the value of the matrix element at column 0 and row 1.
-
m10
public float m10()
Description copied from interface:Matrix2fc
Return the value of the matrix element at column 1 and row 0.
-
m11
public float m11()
Description copied from interface:Matrix2fc
Return the value of the matrix element at column 1 and row 1.
-
m00
public Matrix2f m00(float m00)
Set the value of the matrix element at column 0 and row 0.- Parameters:
m00
- the new value- Returns:
- this
-
m01
public Matrix2f m01(float m01)
Set the value of the matrix element at column 0 and row 1.- Parameters:
m01
- the new value- Returns:
- this
-
m10
public Matrix2f m10(float m10)
Set the value of the matrix element at column 1 and row 0.- Parameters:
m10
- the new value- Returns:
- this
-
m11
public Matrix2f m11(float m11)
Set the value of the matrix element at column 1 and row 1.- Parameters:
m11
- the new value- Returns:
- this
-
set
public Matrix2f set(Matrix2fc m)
Set the elements of this matrix to the ones inm
.- Parameters:
m
- the matrix to copy the elements from- Returns:
- this
-
set
public Matrix2f set(Matrix3x2fc m)
Set the elements of this matrix to the left 2x2 submatrix ofm
.- Parameters:
m
- the matrix to copy the elements from- Returns:
- this
-
set
public Matrix2f set(Matrix3fc m)
Set the elements of this matrix to the upper left 2x2 of the givenMatrix3fc
.- Parameters:
m
- theMatrix3fc
to copy the values from- Returns:
- this
-
mul
public Matrix2f mul(Matrix2fc right)
Multiply this matrix by the suppliedright
matrix.If
M
isthis
matrix andR
theright
matrix, then the new matrix will beM * R
. So when transforming a vectorv
with the new matrix by usingM * 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 Matrix2f mul(Matrix2fc right, Matrix2f dest)
Description copied from interface:Matrix2fc
Multiply this matrix by the suppliedright
matrix and store the result indest
.If
M
isthis
matrix andR
theright
matrix, then the new matrix will beM * R
. So when transforming a vectorv
with the new matrix by usingM * R * v
, the transformation of the right matrix will be applied first!
-
mulLocal
public Matrix2f mulLocal(Matrix2fc left)
Pre-multiply this matrix by the suppliedleft
matrix and store the result inthis
.If
M
isthis
matrix andL
theleft
matrix, then the new matrix will beL * M
. So when transforming a vectorv
with the new matrix by usingL * M * v
, the transformation ofthis
matrix will be applied first!- Parameters:
left
- the left operand of the matrix multiplication- Returns:
- this
-
mulLocal
public Matrix2f mulLocal(Matrix2fc left, Matrix2f dest)
Description copied from interface:Matrix2fc
Pre-multiply this matrix by the suppliedleft
matrix and store the result indest
.If
M
isthis
matrix andL
theleft
matrix, then the new matrix will beL * M
. So when transforming a vectorv
with the new matrix by usingL * M * v
, the transformation ofthis
matrix will be applied first!
-
set
public Matrix2f set(float m00, float m01, float m10, float m11)
Set the values within this matrix to the supplied float values. The result looks like this:m00, m10
m01, m11- Parameters:
m00
- the new value of m00m01
- the new value of m01m10
- the new value of m10m11
- the new value of m11- Returns:
- this
-
set
public Matrix2f set(float[] m)
Set the values in this matrix based on the supplied float array. The result looks like this:0, 2
1, 3
This method only uses the first 4 values, all others are ignored.- Parameters:
m
- the array to read the matrix values from- Returns:
- this
-
set
public Matrix2f set(Vector2fc col0, Vector2fc col1)
Set the two columns of this matrix to the supplied vectors, respectively.- Parameters:
col0
- the first columncol1
- the second column- Returns:
- this
-
determinant
public float determinant()
Description copied from interface:Matrix2fc
Return the determinant of this matrix.- Specified by:
determinant
in interfaceMatrix2fc
- Returns:
- the determinant
-
invert
public Matrix2f invert()
Invert this matrix.- Returns:
- this
-
invert
public Matrix2f invert(Matrix2f dest)
Description copied from interface:Matrix2fc
Invert thethis
matrix and store the result indest
.
-
transpose
public Matrix2f transpose()
Transpose this matrix.- Returns:
- this
-
transpose
public Matrix2f transpose(Matrix2f dest)
Description copied from interface:Matrix2fc
Transposethis
matrix and store the result indest
.
-
toString
public java.lang.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 classjava.lang.Object
- Returns:
- the string representation
-
toString
public java.lang.String toString(java.text.NumberFormat formatter)
Return a string representation of this matrix by formatting the matrix elements with the givenNumberFormat
.- Parameters:
formatter
- theNumberFormat
used to format the matrix values with- Returns:
- the string representation
-
get
public Matrix2f get(Matrix2f dest)
Get the current values ofthis
matrix and store them intodest
.This is the reverse method of
set(Matrix2fc)
and allows to obtain intermediate calculation results when chaining multiple transformations.- Specified by:
get
in interfaceMatrix2fc
- Parameters:
dest
- the destination matrix- Returns:
- the passed in destination
- See Also:
set(Matrix2fc)
-
get
public Matrix3x2f get(Matrix3x2f dest)
Description copied from interface:Matrix2fc
Get the current values ofthis
matrix and store them as the rotational component ofdest
. All other values ofdest
will be set to 0.- Specified by:
get
in interfaceMatrix2fc
- Parameters:
dest
- the destination matrix- Returns:
- the passed in destination
- See Also:
Matrix3x2f.set(Matrix2fc)
-
get
public Matrix3f get(Matrix3f dest)
Description copied from interface:Matrix2fc
Get the current values ofthis
matrix and store them as the rotational component ofdest
. All other values ofdest
will be set to identity.- Specified by:
get
in interfaceMatrix2fc
- Parameters:
dest
- the destination matrix- Returns:
- the passed in destination
- See Also:
Matrix3f.set(Matrix2fc)
-
getRotation
public float getRotation()
Description copied from interface:Matrix2fc
Get the angle of the rotation component ofthis
matrix.This method assumes that there is a valid rotation to be returned, i.e. that
atan2(-m10, m00) == atan2(m01, m11)
.- Specified by:
getRotation
in interfaceMatrix2fc
- Returns:
- the angle
-
get
public java.nio.FloatBuffer get(java.nio.FloatBuffer buffer)
Description copied from interface:Matrix2fc
Store this matrix in column-major order into the suppliedFloatBuffer
at the current bufferposition
.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
Matrix2fc.get(int, FloatBuffer)
, taking the absolute position as parameter.- Specified by:
get
in interfaceMatrix2fc
- Parameters:
buffer
- will receive the values of this matrix in column-major order at its current position- Returns:
- the passed in buffer
- See Also:
Matrix2fc.get(int, FloatBuffer)
-
get
public java.nio.FloatBuffer get(int index, java.nio.FloatBuffer buffer)
Description copied from interface:Matrix2fc
Store this matrix in column-major order into the suppliedFloatBuffer
starting at the specified absolute buffer position/index.This method will not increment the position of the given FloatBuffer.
-
get
public java.nio.ByteBuffer get(java.nio.ByteBuffer buffer)
Description copied from interface:Matrix2fc
Store this matrix in column-major order into the suppliedByteBuffer
at the current bufferposition
.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
Matrix2fc.get(int, ByteBuffer)
, taking the absolute position as parameter.- Specified by:
get
in interfaceMatrix2fc
- Parameters:
buffer
- will receive the values of this matrix in column-major order at its current position- Returns:
- the passed in buffer
- See Also:
Matrix2fc.get(int, ByteBuffer)
-
get
public java.nio.ByteBuffer get(int index, java.nio.ByteBuffer buffer)
Description copied from interface:Matrix2fc
Store this matrix in column-major order into the suppliedByteBuffer
starting at the specified absolute buffer position/index.This method will not increment the position of the given ByteBuffer.
-
getTransposed
public java.nio.FloatBuffer getTransposed(java.nio.FloatBuffer buffer)
Description copied from interface:Matrix2fc
Store the transpose of this matrix in column-major order into the suppliedFloatBuffer
at the current bufferposition
.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
Matrix2fc.getTransposed(int, FloatBuffer)
, taking the absolute position as parameter.- Specified by:
getTransposed
in interfaceMatrix2fc
- Parameters:
buffer
- will receive the values of this matrix in column-major order at its current position- Returns:
- the passed in buffer
- See Also:
Matrix2fc.getTransposed(int, FloatBuffer)
-
getTransposed
public java.nio.FloatBuffer getTransposed(int index, java.nio.FloatBuffer buffer)
Description copied from interface:Matrix2fc
Store the transpose of this matrix in column-major order into the suppliedFloatBuffer
starting at the specified absolute buffer position/index.This method will not increment the position of the given FloatBuffer.
- Specified by:
getTransposed
in interfaceMatrix2fc
- Parameters:
index
- the absolute position into the FloatBufferbuffer
- will receive the values of this matrix in column-major order- Returns:
- the passed in buffer
-
getTransposed
public java.nio.ByteBuffer getTransposed(java.nio.ByteBuffer buffer)
Description copied from interface:Matrix2fc
Store the transpose of this matrix in column-major order into the suppliedByteBuffer
at the current bufferposition
.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
Matrix2fc.getTransposed(int, ByteBuffer)
, taking the absolute position as parameter.- Specified by:
getTransposed
in interfaceMatrix2fc
- Parameters:
buffer
- will receive the values of this matrix in column-major order at its current position- Returns:
- the passed in buffer
- See Also:
Matrix2fc.getTransposed(int, ByteBuffer)
-
getTransposed
public java.nio.ByteBuffer getTransposed(int index, java.nio.ByteBuffer buffer)
Description copied from interface:Matrix2fc
Store the transpose of this matrix in column-major order into the suppliedByteBuffer
starting at the specified absolute buffer position/index.This method will not increment the position of the given ByteBuffer.
- Specified by:
getTransposed
in interfaceMatrix2fc
- Parameters:
index
- the absolute position into the ByteBufferbuffer
- will receive the values of this matrix in column-major order- Returns:
- the passed in buffer
-
getToAddress
public Matrix2fc getToAddress(long address)
Description copied from interface:Matrix2fc
Store this matrix in column-major order at the given off-heap address.This method will throw an
UnsupportedOperationException
when JOML is used with `-Djoml.nounsafe`.This method is unsafe as it can result in a crash of the JVM process when the specified address range does not belong to this process.
- Specified by:
getToAddress
in interfaceMatrix2fc
- Parameters:
address
- the off-heap address where to store this matrix- Returns:
- this
-
get
public float[] get(float[] arr, int offset)
Description copied from interface:Matrix2fc
Store this matrix into the supplied float array in column-major order at the given offset.
-
get
public float[] get(float[] arr)
Description copied from interface:Matrix2fc
Store this matrix into the supplied float array in column-major order.In order to specify an explicit offset into the array, use the method
Matrix2fc.get(float[], int)
.- Specified by:
get
in interfaceMatrix2fc
- Parameters:
arr
- the array to write the matrix values into- Returns:
- the passed in array
- See Also:
Matrix2fc.get(float[], int)
-
set
public Matrix2f set(java.nio.FloatBuffer buffer)
Set the values of this matrix by reading 4 float values from the givenFloatBuffer
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 Matrix2f set(java.nio.ByteBuffer buffer)
Set the values of this matrix by reading 4 float values from the givenByteBuffer
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
-
set
public Matrix2f set(int index, java.nio.FloatBuffer buffer)
Set the values of this matrix by reading 4 float values from the givenFloatBuffer
in column-major order, starting at the specified absolute buffer position/index.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:
index
- the absolute position into the FloatBufferbuffer
- the FloatBuffer to read the matrix values from in column-major order- Returns:
- this
-
set
public Matrix2f set(int index, java.nio.ByteBuffer buffer)
Set the values of this matrix by reading 4 float values from the givenByteBuffer
in column-major order, starting at the specified absolute buffer position/index.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:
index
- the absolute position into the ByteBufferbuffer
- the ByteBuffer to read the matrix values from in column-major order- Returns:
- this
-
setFromAddress
public Matrix2f setFromAddress(long address)
Set the values of this matrix by reading 4 float values from off-heap memory in column-major order, starting at the given address.This method will throw an
UnsupportedOperationException
when JOML is used with `-Djoml.nounsafe`.This method is unsafe as it can result in a crash of the JVM process when the specified address range does not belong to this process.
- Parameters:
address
- the off-heap memory address to read the matrix values from in column-major order- Returns:
- this
-
zero
public Matrix2f zero()
Set all values within this matrix to zero.- Returns:
- this
-
identity
public Matrix2f identity()
Set this matrix to the identity.- Returns:
- this
-
scale
public Matrix2f scale(Vector2fc xy, Matrix2f dest)
Description copied from interface:Matrix2fc
Apply scaling tothis
matrix by scaling the base axes by the givenxy.x
andxy.y
factors, respectively and store the result indest
.If
M
isthis
matrix andS
the scaling matrix, then the new matrix will beM * S
. So when transforming a vectorv
with the new matrix by usingM * S * v
, the scaling will be applied first!
-
scale
public Matrix2f scale(Vector2fc xy)
Apply scaling to this matrix by scaling the base axes by the givenxy.x
andxy.y
factors, respectively.If
M
isthis
matrix andS
the scaling matrix, then the new matrix will beM * S
. So when transforming a vectorv
with the new matrix by usingM * S * v
, the scaling will be applied first!- Parameters:
xy
- the factors of the x and y component, respectively- Returns:
- this
-
scale
public Matrix2f scale(float x, float y, Matrix2f dest)
Description copied from interface:Matrix2fc
Apply scaling to this matrix by scaling the base axes by the given x and y factors and store the result indest
.If
M
isthis
matrix andS
the scaling matrix, then the new matrix will beM * S
. So when transforming a vectorv
with the new matrix by usingM * S * v
, the scaling will be applied first!
-
scale
public Matrix2f scale(float x, float y)
Apply scaling to this matrix by scaling the base axes by the given x and y factors.If
M
isthis
matrix andS
the scaling matrix, then the new matrix will beM * S
. So when transforming a vectorv
with the new matrix by usingM * S * v
, the scaling will be applied first!- Parameters:
x
- the factor of the x componenty
- the factor of the y component- Returns:
- this
-
scale
public Matrix2f scale(float xy, Matrix2f dest)
Description copied from interface:Matrix2fc
Apply scaling to this matrix by uniformly scaling all base axes by the givenxy
factor and store the result indest
.If
M
isthis
matrix andS
the scaling matrix, then the new matrix will beM * S
. So when transforming a vectorv
with the new matrix by usingM * S * v
, the scaling will be applied first!- Specified by:
scale
in interfaceMatrix2fc
- Parameters:
xy
- the factor for all componentsdest
- will hold the result- Returns:
- dest
- See Also:
Matrix2fc.scale(float, float, Matrix2f)
-
scale
public Matrix2f scale(float xy)
Apply scaling to this matrix by uniformly scaling all base axes by the givenxy
factor.If
M
isthis
matrix andS
the scaling matrix, then the new matrix will beM * S
. So when transforming a vectorv
with the new matrix by usingM * S * v
, the scaling will be applied first!- Parameters:
xy
- the factor for all components- Returns:
- this
- See Also:
scale(float, float)
-
scaleLocal
public Matrix2f scaleLocal(float x, float y, Matrix2f dest)
Description copied from interface:Matrix2fc
Pre-multiply scaling tothis
matrix by scaling the base axes by the given x and y factors and store the result indest
.If
M
isthis
matrix andS
the scaling matrix, then the new matrix will beS * M
. So when transforming a vectorv
with the new matrix by usingS * M * v
, the scaling will be applied last!- Specified by:
scaleLocal
in interfaceMatrix2fc
- Parameters:
x
- the factor of the x componenty
- the factor of the y componentdest
- will hold the result- Returns:
- dest
-
scaleLocal
public Matrix2f scaleLocal(float x, float y)
Pre-multiply scaling to this matrix by scaling the base axes by the given x and y factors.If
M
isthis
matrix andS
the scaling matrix, then the new matrix will beS * M
. So when transforming a vectorv
with the new matrix by usingS * M * v
, the scaling will be applied last!- Parameters:
x
- the factor of the x componenty
- the factor of the y component- Returns:
- this
-
scaling
public Matrix2f scaling(float factor)
Set this matrix to be a simple scale matrix, which scales all 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 Matrix2f scaling(float x, float y)
Set this matrix to be a simple scale matrix.- Parameters:
x
- the scale in xy
- the scale in y- Returns:
- this
-
scaling
public Matrix2f scaling(Vector2fc xy)
Set this matrix to be a simple scale matrix which scales the base axes byxy.x
andxy.y
respectively.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:
xy
- the scale in x and y respectively- Returns:
- this
- See Also:
scale(Vector2fc)
-
rotation
public Matrix2f rotation(float angle)
Set this matrix to a rotation matrix which rotates the given radians about the origin.The produced rotation will rotate a vector counter-clockwise around the origin.
The resulting matrix can be multiplied against another transformation matrix to obtain an additional rotation.
In order to post-multiply a rotation transformation directly to a matrix, use
rotate()
instead.- Parameters:
angle
- the angle in radians- Returns:
- this
- See Also:
rotate(float)
-
transform
public Vector2f transform(Vector2f v)
Description copied from interface:Matrix2fc
Transform the given vector by this matrix.
-
transform
public Vector2f transform(Vector2fc v, Vector2f dest)
Description copied from interface:Matrix2fc
Transform the given vector by this matrix and store the result indest
.
-
transform
public Vector2f transform(float x, float y, Vector2f dest)
Description copied from interface:Matrix2fc
Transform the vector(x, y)
by this matrix and store the result indest
.
-
transformTranspose
public Vector2f transformTranspose(Vector2f v)
Description copied from interface:Matrix2fc
Transform the given vector by the transpose of this matrix.- Specified by:
transformTranspose
in interfaceMatrix2fc
- Parameters:
v
- the vector to transform- Returns:
- v
-
transformTranspose
public Vector2f transformTranspose(Vector2fc v, Vector2f dest)
Description copied from interface:Matrix2fc
Transform the given vector by the transpose of this matrix and store the result indest
.- Specified by:
transformTranspose
in interfaceMatrix2fc
- Parameters:
v
- the vector to transformdest
- will hold the result- Returns:
- dest
-
transformTranspose
public Vector2f transformTranspose(float x, float y, Vector2f dest)
Description copied from interface:Matrix2fc
Transform the vector(x, y)
by the transpose of this matrix and store the result indest
.- Specified by:
transformTranspose
in interfaceMatrix2fc
- Parameters:
x
- the x coordinate of the vector to transformy
- the y coordinate of the vector to transformdest
- will hold the result- Returns:
- dest
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
- Specified by:
writeExternal
in interfacejava.io.Externalizable
- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException
- Specified by:
readExternal
in interfacejava.io.Externalizable
- Throws:
java.io.IOException
-
rotate
public Matrix2f rotate(float angle)
Apply rotation about the origin to this matrix by rotating the given amount of radians.The produced rotation will rotate a vector counter-clockwise around the origin.
If
M
isthis
matrix andR
the rotation matrix, then the new matrix will beM * R
. So when transforming a vectorv
with the new matrix by usingM * R * v
, the rotation will be applied first!Reference: http://en.wikipedia.org
- Parameters:
angle
- the angle in radians- Returns:
- this
-
rotate
public Matrix2f rotate(float angle, Matrix2f dest)
Description copied from interface:Matrix2fc
Apply rotation to this matrix by rotating the given amount of radians and store the result indest
.The produced rotation will rotate a vector counter-clockwise around the origin.
If
M
isthis
matrix andR
the rotation matrix, then the new matrix will beM * R
. So when transforming a vectorv
with the new matrix by usingM * R * v
, the rotation will be applied first!Reference: http://en.wikipedia.org
-
rotateLocal
public Matrix2f rotateLocal(float angle)
Pre-multiply a rotation to this matrix by rotating the given amount of radians about the origin.The produced rotation will rotate a vector counter-clockwise around the origin.
If
M
isthis
matrix andR
the rotation matrix, then the new matrix will beR * M
. So when transforming a vectorv
with the new matrix by usingR * M * v
, the rotation will be applied last!In order to set the matrix to a rotation matrix without pre-multiplying the rotation transformation, use
rotation()
.Reference: http://en.wikipedia.org
- Parameters:
angle
- the angle in radians to rotate about the X axis- Returns:
- this
- See Also:
rotation(float)
-
rotateLocal
public Matrix2f rotateLocal(float angle, Matrix2f dest)
Description copied from interface:Matrix2fc
Pre-multiply a rotation to this matrix by rotating the given amount of radians and store the result indest
.The produced rotation will rotate a vector counter-clockwise around the origin.
If
M
isthis
matrix andR
the rotation matrix, then the new matrix will beR * M
. So when transforming a vectorv
with the new matrix by usingR * M * v
, the rotation will be applied last!Reference: http://en.wikipedia.org
- Specified by:
rotateLocal
in interfaceMatrix2fc
- Parameters:
angle
- the angle in radiansdest
- will hold the result- Returns:
- dest
-
getRow
public Vector2f getRow(int row, Vector2f dest) throws java.lang.IndexOutOfBoundsException
Description copied from interface:Matrix2fc
Get the row at the givenrow
index, starting with0
.
-
setRow
public Matrix2f setRow(int row, Vector2fc src) throws java.lang.IndexOutOfBoundsException
Set the row at the givenrow
index, starting with0
.- Parameters:
row
- the row index in[0..1]
src
- the row components to set- Returns:
- this
- Throws:
java.lang.IndexOutOfBoundsException
- ifrow
is not in[0..1]
-
setRow
public Matrix2f setRow(int row, float x, float y) throws java.lang.IndexOutOfBoundsException
Set the row at the givenrow
index, starting with0
.- Parameters:
row
- the row index in[0..1]
x
- the first element in the rowy
- the second element in the row- Returns:
- this
- Throws:
java.lang.IndexOutOfBoundsException
- ifrow
is not in[0..1]
-
getColumn
public Vector2f getColumn(int column, Vector2f dest) throws java.lang.IndexOutOfBoundsException
Description copied from interface:Matrix2fc
Get the column at the givencolumn
index, starting with0
.
-
setColumn
public Matrix2f setColumn(int column, Vector2fc src) throws java.lang.IndexOutOfBoundsException
Set the column at the givencolumn
index, starting with0
.- Parameters:
column
- the column index in[0..1]
src
- the column components to set- Returns:
- this
- Throws:
java.lang.IndexOutOfBoundsException
- ifcolumn
is not in[0..1]
-
setColumn
public Matrix2f setColumn(int column, float x, float y) throws java.lang.IndexOutOfBoundsException
Set the column at the givencolumn
index, starting with0
.- Parameters:
column
- the column index in[0..1]
x
- the first element in the columny
- the second element in the column- Returns:
- this
- Throws:
java.lang.IndexOutOfBoundsException
- ifcolumn
is not in[0..1]
-
get
public float get(int column, int row)
Description copied from interface:Matrix2fc
Get the matrix element value at the given column and row.
-
set
public Matrix2f set(int column, int row, float value)
Set the matrix element at the given column and row to the specified value.- Parameters:
column
- the colum index in[0..1]
row
- the row index in[0..1]
value
- the value- Returns:
- this
-
normal
public Matrix2f normal()
Setthis
matrix to its own normal matrix.Please note that, if
this
is an orthogonal matrix or a matrix whose columns are orthogonal vectors, then this method need not be invoked, since in that casethis
itself is its normal matrix. In this case, useset(Matrix2fc)
to set a given Matrix2f to this matrix.- Returns:
- this
- See Also:
set(Matrix2fc)
-
normal
public Matrix2f normal(Matrix2f dest)
Compute a normal matrix fromthis
matrix and store it intodest
.Please note that, if
this
is an orthogonal matrix or a matrix whose columns are orthogonal vectors, then this method need not be invoked, since in that casethis
itself is its normal matrix. In this case, useset(Matrix2fc)
to set a given Matrix2f to this matrix.- Specified by:
normal
in interfaceMatrix2fc
- Parameters:
dest
- will hold the result- Returns:
- dest
- See Also:
set(Matrix2fc)
-
getScale
public Vector2f getScale(Vector2f dest)
Description copied from interface:Matrix2fc
Get the scaling factors ofthis
matrix for the three base axes.
-
positiveX
public Vector2f positiveX(Vector2f dir)
Description copied from interface:Matrix2fc
Obtain the direction of+X
before the transformation represented bythis
matrix is applied.This method is equivalent to the following code:
Matrix2f inv = new Matrix2f(this).invert(); inv.transform(dir.set(1, 0)).normalize();
Ifthis
is already an orthogonal matrix, then consider usingMatrix2fc.normalizedPositiveX(Vector2f)
instead.
-
normalizedPositiveX
public Vector2f normalizedPositiveX(Vector2f dir)
Description copied from interface:Matrix2fc
Obtain the direction of+X
before the transformation represented bythis
orthogonal matrix is applied. This method only produces correct results ifthis
is an orthogonal matrix.This method is equivalent to the following code:
Matrix2f inv = new Matrix2f(this).transpose(); inv.transform(dir.set(1, 0));
- Specified by:
normalizedPositiveX
in interfaceMatrix2fc
- Parameters:
dir
- will hold the direction of+X
- Returns:
- dest
-
positiveY
public Vector2f positiveY(Vector2f dir)
Description copied from interface:Matrix2fc
Obtain the direction of+Y
before the transformation represented bythis
matrix is applied.This method is equivalent to the following code:
Matrix2f inv = new Matrix2f(this).invert(); inv.transform(dir.set(0, 1)).normalize();
Ifthis
is already an orthogonal matrix, then consider usingMatrix2fc.normalizedPositiveY(Vector2f)
instead.
-
normalizedPositiveY
public Vector2f normalizedPositiveY(Vector2f dir)
Description copied from interface:Matrix2fc
Obtain the direction of+Y
before the transformation represented bythis
orthogonal matrix is applied. This method only produces correct results ifthis
is an orthogonal matrix.This method is equivalent to the following code:
Matrix2f inv = new Matrix2f(this).transpose(); inv.transform(dir.set(0, 1));
- Specified by:
normalizedPositiveY
in interfaceMatrix2fc
- Parameters:
dir
- will hold the direction of+Y
- Returns:
- dest
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
equals
public boolean equals(Matrix2fc m, float delta)
Description copied from interface:Matrix2fc
Compare the matrix elements ofthis
matrix with the given matrix using the givendelta
and return whether all of them are equal within a maximum difference ofdelta
.Please note that this method is not used by any data structure such as
ArrayList
HashSet
orHashMap
and their operations, such asArrayList.contains(Object)
orHashSet.remove(Object)
, since those data structures only use theObject.equals(Object)
andObject.hashCode()
methods.
-
swap
public Matrix2f swap(Matrix2f other)
Exchange the values ofthis
matrix with the givenother
matrix.- Parameters:
other
- the other matrix to exchange the values with- Returns:
- this
-
add
public Matrix2f add(Matrix2fc other)
Component-wise addthis
andother
.- Parameters:
other
- the other addend- Returns:
- this
-
add
public Matrix2f add(Matrix2fc other, Matrix2f dest)
Description copied from interface:Matrix2fc
Component-wise addthis
andother
and store the result indest
.
-
sub
public Matrix2f sub(Matrix2fc subtrahend)
Component-wise subtractsubtrahend
fromthis
.- Parameters:
subtrahend
- the subtrahend- Returns:
- this
-
sub
public Matrix2f sub(Matrix2fc other, Matrix2f dest)
Description copied from interface:Matrix2fc
Component-wise subtractsubtrahend
fromthis
and store the result indest
.
-
mulComponentWise
public Matrix2f mulComponentWise(Matrix2fc other)
Component-wise multiplythis
byother
.- Parameters:
other
- the other matrix- Returns:
- this
-
mulComponentWise
public Matrix2f mulComponentWise(Matrix2fc other, Matrix2f dest)
Description copied from interface:Matrix2fc
Component-wise multiplythis
byother
and store the result indest
.- Specified by:
mulComponentWise
in interfaceMatrix2fc
- Parameters:
other
- the other matrixdest
- will hold the result- Returns:
- dest
-
lerp
public Matrix2f lerp(Matrix2fc other, float t)
Linearly interpolatethis
andother
using the given interpolation factort
and store the result inthis
.If
t
is0.0
then the result isthis
. If the interpolation factor is1.0
then the result isother
.- Parameters:
other
- the other matrixt
- the interpolation factor between 0.0 and 1.0- Returns:
- this
-
lerp
public Matrix2f lerp(Matrix2fc other, float t, Matrix2f dest)
Description copied from interface:Matrix2fc
Linearly interpolatethis
andother
using the given interpolation factort
and store the result indest
.If
t
is0.0
then the result isthis
. If the interpolation factor is1.0
then the result isother
.
-
isFinite
public boolean isFinite()
Description copied from interface:Matrix2fc
Determine whether all matrix elements are finite floating-point values, that is, they are notNaN
and notinfinity
.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
- Overrides:
clone
in classjava.lang.Object
- Throws:
java.lang.CloneNotSupportedException
-
-