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 newMatrix2fby reading its 4 float components from the givenFloatBufferat the buffer's current position.Matrix2f(Matrix2fc mat)Create a newMatrix2fand make it a copy of the given matrix.Matrix2f(Matrix3fc mat)Matrix2f(Vector2fc col0, Vector2fc col1)Create a newMatrix2fand initialize its two columns using the supplied vectors.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Matrix2fadd(Matrix2fc other)Component-wise addthisandother.Matrix2fadd(Matrix2fc other, Matrix2f dest)Component-wise addthisandotherand store the result indest.java.lang.Objectclone()floatdeterminant()Return the determinant of this matrix.booleanequals(java.lang.Object obj)booleanequals(Matrix2fc m, float delta)Compare the matrix elements ofthismatrix with the given matrix using the givendeltaand 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.floatget(int column, int row)Get the matrix element value at the given column and row.java.nio.ByteBufferget(int index, java.nio.ByteBuffer buffer)Store this matrix in column-major order into the suppliedByteBufferstarting at the specified absolute buffer position/index.java.nio.FloatBufferget(int index, java.nio.FloatBuffer buffer)Store this matrix in column-major order into the suppliedFloatBufferstarting at the specified absolute buffer position/index.java.nio.ByteBufferget(java.nio.ByteBuffer buffer)Store this matrix in column-major order into the suppliedByteBufferat the current bufferposition.java.nio.FloatBufferget(java.nio.FloatBuffer buffer)Store this matrix in column-major order into the suppliedFloatBufferat the current bufferposition.Matrix2fget(Matrix2f dest)Get the current values ofthismatrix and store them intodest.Matrix3fget(Matrix3f dest)Get the current values ofthismatrix and store them as the rotational component ofdest.Matrix3x2fget(Matrix3x2f dest)Get the current values ofthismatrix and store them as the rotational component ofdest.Vector2fgetColumn(int column, Vector2f dest)Get the column at the givencolumnindex, starting with0.floatgetRotation()Get the angle of the rotation component ofthismatrix.Vector2fgetRow(int row, Vector2f dest)Get the row at the givenrowindex, starting with0.Vector2fgetScale(Vector2f dest)Get the scaling factors ofthismatrix for the three base axes.Matrix2fcgetToAddress(long address)Store this matrix in column-major order at the given off-heap address.java.nio.ByteBuffergetTransposed(int index, java.nio.ByteBuffer buffer)Store the transpose of this matrix in column-major order into the suppliedByteBufferstarting at the specified absolute buffer position/index.java.nio.FloatBuffergetTransposed(int index, java.nio.FloatBuffer buffer)Store the transpose of this matrix in column-major order into the suppliedFloatBufferstarting at the specified absolute buffer position/index.java.nio.ByteBuffergetTransposed(java.nio.ByteBuffer buffer)Store the transpose of this matrix in column-major order into the suppliedByteBufferat the current bufferposition.java.nio.FloatBuffergetTransposed(java.nio.FloatBuffer buffer)Store the transpose of this matrix in column-major order into the suppliedFloatBufferat the current bufferposition.inthashCode()Matrix2fidentity()Set this matrix to the identity.Matrix2finvert()Invert this matrix.Matrix2finvert(Matrix2f dest)Invert thethismatrix and store the result indest.booleanisFinite()Determine whether all matrix elements are finite floating-point values, that is, they are notNaNand notinfinity.Matrix2flerp(Matrix2fc other, float t)Linearly interpolatethisandotherusing the given interpolation factortand store the result inthis.Matrix2flerp(Matrix2fc other, float t, Matrix2f dest)Linearly interpolatethisandotherusing the given interpolation factortand store the result indest.floatm00()Return the value of the matrix element at column 0 and row 0.Matrix2fm00(float m00)Set the value of the matrix element at column 0 and row 0.floatm01()Return the value of the matrix element at column 0 and row 1.Matrix2fm01(float m01)Set the value of the matrix element at column 0 and row 1.floatm10()Return the value of the matrix element at column 1 and row 0.Matrix2fm10(float m10)Set the value of the matrix element at column 1 and row 0.floatm11()Return the value of the matrix element at column 1 and row 1.Matrix2fm11(float m11)Set the value of the matrix element at column 1 and row 1.Matrix2fmul(Matrix2fc right)Multiply this matrix by the suppliedrightmatrix.Matrix2fmul(Matrix2fc right, Matrix2f dest)Multiply this matrix by the suppliedrightmatrix and store the result indest.Matrix2fmulComponentWise(Matrix2fc other)Component-wise multiplythisbyother.Matrix2fmulComponentWise(Matrix2fc other, Matrix2f dest)Component-wise multiplythisbyotherand store the result indest.Matrix2fmulLocal(Matrix2fc left)Pre-multiply this matrix by the suppliedleftmatrix and store the result inthis.Matrix2fmulLocal(Matrix2fc left, Matrix2f dest)Pre-multiply this matrix by the suppliedleftmatrix and store the result indest.Matrix2fnormal()Setthismatrix to its own normal matrix.Matrix2fnormal(Matrix2f dest)Compute a normal matrix fromthismatrix and store it intodest.Vector2fnormalizedPositiveX(Vector2f dir)Obtain the direction of+Xbefore the transformation represented bythisorthogonal matrix is applied.Vector2fnormalizedPositiveY(Vector2f dir)Obtain the direction of+Ybefore the transformation represented bythisorthogonal matrix is applied.Vector2fpositiveX(Vector2f dir)Obtain the direction of+Xbefore the transformation represented bythismatrix is applied.Vector2fpositiveY(Vector2f dir)Obtain the direction of+Ybefore the transformation represented bythismatrix is applied.voidreadExternal(java.io.ObjectInput in)Matrix2frotate(float angle)Apply rotation about the origin to this matrix by rotating the given amount of radians.Matrix2frotate(float angle, Matrix2f dest)Apply rotation to this matrix by rotating the given amount of radians and store the result indest.Matrix2frotateLocal(float angle)Pre-multiply a rotation to this matrix by rotating the given amount of radians about the origin.Matrix2frotateLocal(float angle, Matrix2f dest)Pre-multiply a rotation to this matrix by rotating the given amount of radians and store the result indest.Matrix2frotation(float angle)Set this matrix to a rotation matrix which rotates the given radians about the origin.Matrix2fscale(float xy)Apply scaling to this matrix by uniformly scaling all base axes by the givenxyfactor.Matrix2fscale(float x, float y)Apply scaling to this matrix by scaling the base axes by the given x and y factors.Matrix2fscale(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.Matrix2fscale(float xy, Matrix2f dest)Apply scaling to this matrix by uniformly scaling all base axes by the givenxyfactor and store the result indest.Matrix2fscale(Vector2fc xy)Apply scaling to this matrix by scaling the base axes by the givenxy.xandxy.yfactors, respectively.Matrix2fscale(Vector2fc xy, Matrix2f dest)Apply scaling tothismatrix by scaling the base axes by the givenxy.xandxy.yfactors, respectively and store the result indest.Matrix2fscaleLocal(float x, float y)Pre-multiply scaling to this matrix by scaling the base axes by the given x and y factors.Matrix2fscaleLocal(float x, float y, Matrix2f dest)Pre-multiply scaling tothismatrix by scaling the base axes by the given x and y factors and store the result indest.Matrix2fscaling(float factor)Set this matrix to be a simple scale matrix, which scales all axes uniformly by the given factor.Matrix2fscaling(float x, float y)Set this matrix to be a simple scale matrix.Matrix2fscaling(Vector2fc xy)Set this matrix to be a simple scale matrix which scales the base axes byxy.xandxy.yrespectively.Matrix2fset(float[] m)Set the values in this matrix based on the supplied float array.Matrix2fset(float m00, float m01, float m10, float m11)Set the values within this matrix to the supplied float values.Matrix2fset(int column, int row, float value)Set the matrix element at the given column and row to the specified value.Matrix2fset(int index, java.nio.ByteBuffer buffer)Set the values of this matrix by reading 4 float values from the givenByteBufferin column-major order, starting at the specified absolute buffer position/index.Matrix2fset(int index, java.nio.FloatBuffer buffer)Set the values of this matrix by reading 4 float values from the givenFloatBufferin column-major order, starting at the specified absolute buffer position/index.Matrix2fset(java.nio.ByteBuffer buffer)Set the values of this matrix by reading 4 float values from the givenByteBufferin column-major order, starting at its current position.Matrix2fset(java.nio.FloatBuffer buffer)Set the values of this matrix by reading 4 float values from the givenFloatBufferin column-major order, starting at its current position.Matrix2fset(Matrix2fc m)Set the elements of this matrix to the ones inm.Matrix2fset(Matrix3fc m)Set the elements of this matrix to the upper left 2x2 of the givenMatrix3fc.Matrix2fset(Matrix3x2fc m)Set the elements of this matrix to the left 2x2 submatrix ofm.Matrix2fset(Vector2fc col0, Vector2fc col1)Set the two columns of this matrix to the supplied vectors, respectively.Matrix2fsetColumn(int column, float x, float y)Set the column at the givencolumnindex, starting with0.Matrix2fsetColumn(int column, Vector2fc src)Set the column at the givencolumnindex, starting with0.Matrix2fsetFromAddress(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.Matrix2fsetRow(int row, float x, float y)Set the row at the givenrowindex, starting with0.Matrix2fsetRow(int row, Vector2fc src)Set the row at the givenrowindex, starting with0.Matrix2fsub(Matrix2fc subtrahend)Component-wise subtractsubtrahendfromthis.Matrix2fsub(Matrix2fc other, Matrix2f dest)Component-wise subtractsubtrahendfromthisand store the result indest.Matrix2fswap(Matrix2f other)Exchange the values ofthismatrix with the givenothermatrix.java.lang.StringtoString()Return a string representation of this matrix.java.lang.StringtoString(java.text.NumberFormat formatter)Return a string representation of this matrix by formatting the matrix elements with the givenNumberFormat.Vector2ftransform(float x, float y, Vector2f dest)Transform the vector(x, y)by this matrix and store the result indest.Vector2ftransform(Vector2f v)Transform the given vector by this matrix.Vector2ftransform(Vector2fc v, Vector2f dest)Transform the given vector by this matrix and store the result indest.Vector2ftransformTranspose(float x, float y, Vector2f dest)Transform the vector(x, y)by the transpose of this matrix and store the result indest.Vector2ftransformTranspose(Vector2f v)Transform the given vector by the transpose of this matrix.Vector2ftransformTranspose(Vector2fc v, Vector2f dest)Transform the given vector by the transpose of this matrix and store the result indest.Matrix2ftranspose()Transpose this matrix.Matrix2ftranspose(Matrix2f dest)Transposethismatrix and store the result indest.voidwriteExternal(java.io.ObjectOutput out)Matrix2fzero()Set all values within this matrix to zero.
-
-
-
Constructor Detail
-
Matrix2f
public Matrix2f()
-
Matrix2f
public Matrix2f(Matrix2fc mat)
Create a newMatrix2fand make it a copy of the given matrix.- Parameters:
mat- theMatrix2fcto 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 newMatrix2fby reading its 4 float components from the givenFloatBufferat 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- theFloatBufferto read the matrix values from
-
-
Method Detail
-
m00
public float m00()
Description copied from interface:Matrix2fcReturn the value of the matrix element at column 0 and row 0.
-
m01
public float m01()
Description copied from interface:Matrix2fcReturn the value of the matrix element at column 0 and row 1.
-
m10
public float m10()
Description copied from interface:Matrix2fcReturn the value of the matrix element at column 1 and row 0.
-
m11
public float m11()
Description copied from interface:Matrix2fcReturn 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- theMatrix3fcto copy the values from- Returns:
- this
-
mul
public Matrix2f mul(Matrix2fc right)
Multiply this matrix by the suppliedrightmatrix.If
Misthismatrix andRtherightmatrix, then the new matrix will beM * R. So when transforming a vectorvwith 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:Matrix2fcMultiply this matrix by the suppliedrightmatrix and store the result indest.If
Misthismatrix andRtherightmatrix, then the new matrix will beM * R. So when transforming a vectorvwith 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 suppliedleftmatrix and store the result inthis.If
Misthismatrix andLtheleftmatrix, then the new matrix will beL * M. So when transforming a vectorvwith the new matrix by usingL * M * v, the transformation ofthismatrix 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:Matrix2fcPre-multiply this matrix by the suppliedleftmatrix and store the result indest.If
Misthismatrix andLtheleftmatrix, then the new matrix will beL * M. So when transforming a vectorvwith the new matrix by usingL * M * v, the transformation ofthismatrix 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:Matrix2fcReturn the determinant of this matrix.- Specified by:
determinantin interfaceMatrix2fc- Returns:
- the determinant
-
invert
public Matrix2f invert()
Invert this matrix.- Returns:
- this
-
invert
public Matrix2f invert(Matrix2f dest)
Description copied from interface:Matrix2fcInvert thethismatrix and store the result indest.
-
transpose
public Matrix2f transpose()
Transpose this matrix.- Returns:
- this
-
transpose
public Matrix2f transpose(Matrix2f dest)
Description copied from interface:Matrix2fcTransposethismatrix and store the result indest.
-
toString
public java.lang.String toString()
Return a string representation of this matrix.This method creates a new
DecimalFormaton every invocation with the format string "0.000E0;-".- Overrides:
toStringin 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- theNumberFormatused to format the matrix values with- Returns:
- the string representation
-
get
public Matrix2f get(Matrix2f dest)
Get the current values ofthismatrix 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:
getin 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:Matrix2fcGet the current values ofthismatrix and store them as the rotational component ofdest. All other values ofdestwill be set to 0.- Specified by:
getin 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:Matrix2fcGet the current values ofthismatrix and store them as the rotational component ofdest. All other values ofdestwill be set to identity.- Specified by:
getin interfaceMatrix2fc- Parameters:
dest- the destination matrix- Returns:
- the passed in destination
- See Also:
Matrix3f.set(Matrix2fc)
-
getRotation
public float getRotation()
Description copied from interface:Matrix2fcGet the angle of the rotation component ofthismatrix.This method assumes that there is a valid rotation to be returned, i.e. that
atan2(-m10, m00) == atan2(m01, m11).- Specified by:
getRotationin interfaceMatrix2fc- Returns:
- the angle
-
get
public java.nio.FloatBuffer get(java.nio.FloatBuffer buffer)
Description copied from interface:Matrix2fcStore this matrix in column-major order into the suppliedFloatBufferat 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:
getin 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:Matrix2fcStore this matrix in column-major order into the suppliedFloatBufferstarting 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:Matrix2fcStore this matrix in column-major order into the suppliedByteBufferat 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:
getin 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:Matrix2fcStore this matrix in column-major order into the suppliedByteBufferstarting 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:Matrix2fcStore the transpose of this matrix in column-major order into the suppliedFloatBufferat 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:
getTransposedin 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:Matrix2fcStore the transpose of this matrix in column-major order into the suppliedFloatBufferstarting at the specified absolute buffer position/index.This method will not increment the position of the given FloatBuffer.
- Specified by:
getTransposedin 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:Matrix2fcStore the transpose of this matrix in column-major order into the suppliedByteBufferat 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:
getTransposedin 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:Matrix2fcStore the transpose of this matrix in column-major order into the suppliedByteBufferstarting at the specified absolute buffer position/index.This method will not increment the position of the given ByteBuffer.
- Specified by:
getTransposedin 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:Matrix2fcStore this matrix in column-major order at the given off-heap address.This method will throw an
UnsupportedOperationExceptionwhen 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:
getToAddressin 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:Matrix2fcStore 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:Matrix2fcStore 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:
getin 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 givenFloatBufferin 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 givenByteBufferin 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 givenFloatBufferin 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 givenByteBufferin 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
UnsupportedOperationExceptionwhen 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:Matrix2fcApply scaling tothismatrix by scaling the base axes by the givenxy.xandxy.yfactors, respectively and store the result indest.If
Misthismatrix andSthe scaling matrix, then the new matrix will beM * S. So when transforming a vectorvwith 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.xandxy.yfactors, respectively.If
Misthismatrix andSthe scaling matrix, then the new matrix will beM * S. So when transforming a vectorvwith 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:Matrix2fcApply scaling to this matrix by scaling the base axes by the given x and y factors and store the result indest.If
Misthismatrix andSthe scaling matrix, then the new matrix will beM * S. So when transforming a vectorvwith 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
Misthismatrix andSthe scaling matrix, then the new matrix will beM * S. So when transforming a vectorvwith 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:Matrix2fcApply scaling to this matrix by uniformly scaling all base axes by the givenxyfactor and store the result indest.If
Misthismatrix andSthe scaling matrix, then the new matrix will beM * S. So when transforming a vectorvwith the new matrix by usingM * S * v, the scaling will be applied first!- Specified by:
scalein 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 givenxyfactor.If
Misthismatrix andSthe scaling matrix, then the new matrix will beM * S. So when transforming a vectorvwith 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:Matrix2fcPre-multiply scaling tothismatrix by scaling the base axes by the given x and y factors and store the result indest.If
Misthismatrix andSthe scaling matrix, then the new matrix will beS * M. So when transforming a vectorvwith the new matrix by usingS * M * v, the scaling will be applied last!- Specified by:
scaleLocalin 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
Misthismatrix andSthe scaling matrix, then the new matrix will beS * M. So when transforming a vectorvwith 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.xandxy.yrespectively.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:Matrix2fcTransform the given vector by this matrix.
-
transform
public Vector2f transform(Vector2fc v, Vector2f dest)
Description copied from interface:Matrix2fcTransform 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:Matrix2fcTransform the vector(x, y)by this matrix and store the result indest.
-
transformTranspose
public Vector2f transformTranspose(Vector2f v)
Description copied from interface:Matrix2fcTransform the given vector by the transpose of this matrix.- Specified by:
transformTransposein interfaceMatrix2fc- Parameters:
v- the vector to transform- Returns:
- v
-
transformTranspose
public Vector2f transformTranspose(Vector2fc v, Vector2f dest)
Description copied from interface:Matrix2fcTransform the given vector by the transpose of this matrix and store the result indest.- Specified by:
transformTransposein 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:Matrix2fcTransform the vector(x, y)by the transpose of this matrix and store the result indest.- Specified by:
transformTransposein 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:
writeExternalin interfacejava.io.Externalizable- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException- Specified by:
readExternalin 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
Misthismatrix andRthe rotation matrix, then the new matrix will beM * R. So when transforming a vectorvwith 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:Matrix2fcApply 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
Misthismatrix andRthe rotation matrix, then the new matrix will beM * R. So when transforming a vectorvwith 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
Misthismatrix andRthe rotation matrix, then the new matrix will beR * M. So when transforming a vectorvwith 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:Matrix2fcPre-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
Misthismatrix andRthe rotation matrix, then the new matrix will beR * M. So when transforming a vectorvwith the new matrix by usingR * M * v, the rotation will be applied last!Reference: http://en.wikipedia.org
- Specified by:
rotateLocalin 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:Matrix2fcGet the row at the givenrowindex, starting with0.
-
setRow
public Matrix2f setRow(int row, Vector2fc src) throws java.lang.IndexOutOfBoundsException
Set the row at the givenrowindex, starting with0.- Parameters:
row- the row index in[0..1]src- the row components to set- Returns:
- this
- Throws:
java.lang.IndexOutOfBoundsException- ifrowis not in[0..1]
-
setRow
public Matrix2f setRow(int row, float x, float y) throws java.lang.IndexOutOfBoundsException
Set the row at the givenrowindex, 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- ifrowis not in[0..1]
-
getColumn
public Vector2f getColumn(int column, Vector2f dest) throws java.lang.IndexOutOfBoundsException
Description copied from interface:Matrix2fcGet the column at the givencolumnindex, starting with0.
-
setColumn
public Matrix2f setColumn(int column, Vector2fc src) throws java.lang.IndexOutOfBoundsException
Set the column at the givencolumnindex, starting with0.- Parameters:
column- the column index in[0..1]src- the column components to set- Returns:
- this
- Throws:
java.lang.IndexOutOfBoundsException- ifcolumnis not in[0..1]
-
setColumn
public Matrix2f setColumn(int column, float x, float y) throws java.lang.IndexOutOfBoundsException
Set the column at the givencolumnindex, 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- ifcolumnis not in[0..1]
-
get
public float get(int column, int row)Description copied from interface:Matrix2fcGet 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()
Setthismatrix to its own normal matrix.Please note that, if
thisis an orthogonal matrix or a matrix whose columns are orthogonal vectors, then this method need not be invoked, since in that casethisitself 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 fromthismatrix and store it intodest.Please note that, if
thisis an orthogonal matrix or a matrix whose columns are orthogonal vectors, then this method need not be invoked, since in that casethisitself is its normal matrix. In this case, useset(Matrix2fc)to set a given Matrix2f to this matrix.- Specified by:
normalin interfaceMatrix2fc- Parameters:
dest- will hold the result- Returns:
- dest
- See Also:
set(Matrix2fc)
-
getScale
public Vector2f getScale(Vector2f dest)
Description copied from interface:Matrix2fcGet the scaling factors ofthismatrix for the three base axes.
-
positiveX
public Vector2f positiveX(Vector2f dir)
Description copied from interface:Matrix2fcObtain the direction of+Xbefore the transformation represented bythismatrix is applied.This method is equivalent to the following code:
Matrix2f inv = new Matrix2f(this).invert(); inv.transform(dir.set(1, 0)).normalize();
Ifthisis already an orthogonal matrix, then consider usingMatrix2fc.normalizedPositiveX(Vector2f)instead.
-
normalizedPositiveX
public Vector2f normalizedPositiveX(Vector2f dir)
Description copied from interface:Matrix2fcObtain the direction of+Xbefore the transformation represented bythisorthogonal matrix is applied. This method only produces correct results ifthisis 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:
normalizedPositiveXin interfaceMatrix2fc- Parameters:
dir- will hold the direction of+X- Returns:
- dest
-
positiveY
public Vector2f positiveY(Vector2f dir)
Description copied from interface:Matrix2fcObtain the direction of+Ybefore the transformation represented bythismatrix is applied.This method is equivalent to the following code:
Matrix2f inv = new Matrix2f(this).invert(); inv.transform(dir.set(0, 1)).normalize();
Ifthisis already an orthogonal matrix, then consider usingMatrix2fc.normalizedPositiveY(Vector2f)instead.
-
normalizedPositiveY
public Vector2f normalizedPositiveY(Vector2f dir)
Description copied from interface:Matrix2fcObtain the direction of+Ybefore the transformation represented bythisorthogonal matrix is applied. This method only produces correct results ifthisis 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:
normalizedPositiveYin interfaceMatrix2fc- Parameters:
dir- will hold the direction of+Y- Returns:
- dest
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
equals
public boolean equals(Matrix2fc m, float delta)
Description copied from interface:Matrix2fcCompare the matrix elements ofthismatrix with the given matrix using the givendeltaand 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
ArrayListHashSetorHashMapand 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 ofthismatrix with the givenothermatrix.- Parameters:
other- the other matrix to exchange the values with- Returns:
- this
-
add
public Matrix2f add(Matrix2fc other)
Component-wise addthisandother.- Parameters:
other- the other addend- Returns:
- this
-
add
public Matrix2f add(Matrix2fc other, Matrix2f dest)
Description copied from interface:Matrix2fcComponent-wise addthisandotherand store the result indest.
-
sub
public Matrix2f sub(Matrix2fc subtrahend)
Component-wise subtractsubtrahendfromthis.- Parameters:
subtrahend- the subtrahend- Returns:
- this
-
sub
public Matrix2f sub(Matrix2fc other, Matrix2f dest)
Description copied from interface:Matrix2fcComponent-wise subtractsubtrahendfromthisand store the result indest.
-
mulComponentWise
public Matrix2f mulComponentWise(Matrix2fc other)
Component-wise multiplythisbyother.- Parameters:
other- the other matrix- Returns:
- this
-
mulComponentWise
public Matrix2f mulComponentWise(Matrix2fc other, Matrix2f dest)
Description copied from interface:Matrix2fcComponent-wise multiplythisbyotherand store the result indest.- Specified by:
mulComponentWisein interfaceMatrix2fc- Parameters:
other- the other matrixdest- will hold the result- Returns:
- dest
-
lerp
public Matrix2f lerp(Matrix2fc other, float t)
Linearly interpolatethisandotherusing the given interpolation factortand store the result inthis.If
tis0.0then the result isthis. If the interpolation factor is1.0then 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:Matrix2fcLinearly interpolatethisandotherusing the given interpolation factortand store the result indest.If
tis0.0then the result isthis. If the interpolation factor is1.0then the result isother.
-
isFinite
public boolean isFinite()
Description copied from interface:Matrix2fcDetermine whether all matrix elements are finite floating-point values, that is, they are notNaNand notinfinity.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException- Overrides:
clonein classjava.lang.Object- Throws:
java.lang.CloneNotSupportedException
-
-