org.joml

Interface Matrix3x2dc

All Known Implementing Classes:

Matrix3x2d, Matrix3x2dStack

public interface Matrix3x2dc

Interface to a read-only view of a 3x2 matrix of double-precision floats.

Author:

Kai Burjack

Method Summary

Modifier and Type	Method and Description
double	determinant() Return the determinant of this matrix.
boolean	equals(Matrix3x2dc m, double delta) Compare the matrix elements of this matrix with the given matrix using the given delta and return whether all of them are equal within a maximum difference of delta.
ByteBuffer	get(ByteBuffer buffer) Store this matrix in column-major order into the supplied ByteBuffer at the current buffer position.
double[]	get(double[] arr) Store this matrix into the supplied double array in column-major order.
double[]	get(double[] arr, int offset) Store this matrix into the supplied double array in column-major order at the given offset.
DoubleBuffer	get(DoubleBuffer buffer) Store this matrix in column-major order into the supplied DoubleBuffer 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.
DoubleBuffer	get(int index, DoubleBuffer buffer) Store this matrix in column-major order into the supplied DoubleBuffer starting at the specified absolute buffer position/index.
Matrix3x2d	get(Matrix3x2d dest) Get the current values of this matrix and store them into dest.
ByteBuffer	get3x3(ByteBuffer buffer) Store this matrix as an equivalent 3x3 matrix in column-major order into the supplied ByteBuffer at the current buffer position.
double[]	get3x3(double[] arr) Store this matrix as an equivalent 3x3 matrix into the supplied double array in column-major order.
double[]	get3x3(double[] arr, int offset) Store this matrix as an equivalent 3x3 matrix into the supplied double array in column-major order at the given offset.
DoubleBuffer	get3x3(DoubleBuffer buffer) Store this matrix as an equivalent 3x3 matrix in column-major order into the supplied DoubleBuffer at the current buffer position.
ByteBuffer	get3x3(int index, ByteBuffer buffer) Store this matrix as an equivalent 3x3 matrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.
DoubleBuffer	get3x3(int index, DoubleBuffer buffer) Store this matrix as an equivalent 3x3 matrix in column-major order into the supplied DoubleBuffer starting at the specified absolute buffer position/index.
ByteBuffer	get4x4(ByteBuffer buffer) Store this matrix as an equivalent 4x4 matrix in column-major order into the supplied ByteBuffer at the current buffer position.
double[]	get4x4(double[] arr) Store this matrix as an equivalent 4x4 matrix into the supplied double array in column-major order.
double[]	get4x4(double[] arr, int offset) Store this matrix as an equivalent 4x4 matrix into the supplied double array in column-major order at the given offset.
DoubleBuffer	get4x4(DoubleBuffer buffer) Store this matrix as an equivalent 4x4 matrix in column-major order into the supplied DoubleBuffer at the current buffer position.
ByteBuffer	get4x4(int index, ByteBuffer buffer) Store this matrix as an equivalent 4x4 matrix in column-major order into the supplied ByteBuffer starting at the specified absolute buffer position/index.
DoubleBuffer	get4x4(int index, DoubleBuffer buffer) Store this matrix as an equivalent 4x4 matrix in column-major order into the supplied DoubleBuffer starting at the specified absolute buffer position/index.
Matrix3x2d	invert(Matrix3x2d dest) Invert the this matrix by assuming a third row in this matrix of (0, 0, 1) and store the result in dest.
double	m00() Return the value of the matrix element at column 0 and row 0.
double	m01() Return the value of the matrix element at column 0 and row 1.
double	m10() Return the value of the matrix element at column 1 and row 0.
double	m11() Return the value of the matrix element at column 1 and row 1.
double	m20() Return the value of the matrix element at column 2 and row 0.
double	m21() Return the value of the matrix element at column 2 and row 1.
Matrix3x2d	mul(Matrix3x2dc right, Matrix3x2d dest) Multiply this matrix by the supplied right matrix by assuming a third row in both matrices of (0, 0, 1) and store the result in dest.
Matrix3x2d	mulLocal(Matrix3x2dc left, Matrix3x2d dest) Pre-multiply this matrix by the supplied left matrix and store the result in dest.
Vector2d	normalizedPositiveX(Vector2d dir) Obtain the direction of +X before the transformation represented by this orthogonal matrix is applied.
Vector2d	normalizedPositiveY(Vector2d dir) Obtain the direction of +Y before the transformation represented by this orthogonal matrix is applied.
Vector2d	origin(Vector2d origin) Obtain the position that gets transformed to the origin by this matrix.
Vector2d	positiveX(Vector2d dir) Obtain the direction of +X before the transformation represented by this matrix is applied.
Vector2d	positiveY(Vector2d dir) Obtain the direction of +Y before the transformation represented by this matrix is applied.
Matrix3x2d	rotate(double ang, Matrix3x2d dest) Apply a rotation transformation to this matrix by rotating the given amount of radians and store the result in dest.
Matrix3x2d	rotateAbout(double ang, double x, double y, Matrix3x2d 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.
Matrix3x2d	rotateLocal(double ang, Matrix3x2d dest) Pre-multiply a rotation to this matrix by rotating the given amount of radians and store the result in dest.
Matrix3x2d	rotateTo(Vector2dc fromDir, Vector2dc toDir, Matrix3x2d 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.
Matrix3x2d	scale(double x, double y, Matrix3x2d dest) Apply scaling to this matrix by scaling the unit axes by the given x and y and store the result in dest.
Matrix3x2d	scale(double xy, Matrix3x2d dest) Apply scaling to this matrix by uniformly scaling the two base axes by the given xy factor and store the result in dest.
Matrix3x2d	scale(Vector2dc xy, Matrix3x2d dest) Apply scaling to this matrix by scaling the base axes by the given xy factors and store the result in dest.
Matrix3x2d	scale(Vector2fc xy, Matrix3x2d dest) Apply scaling to this matrix by scaling the base axes by the given xy factors and store the result in dest.
Matrix3x2d	scaleAround(double sx, double sy, double ox, double oy, Matrix3x2d dest) Apply scaling to this matrix by scaling the base axes by the given sx and sy factors while using (ox, oy) as the scaling origin, and store the result in dest.
Matrix3x2d	scaleAround(double factor, double ox, double oy, Matrix3x2d dest) Apply scaling to this matrix by scaling the base axes by the given factor while using (ox, oy) as the scaling origin, and store the result in dest.
Matrix3x2d	scaleAroundLocal(double sx, double sy, double ox, double oy, Matrix3x2d dest) Pre-multiply scaling to this matrix by scaling the base axes by the given sx and sy factors while using the given (ox, oy) as the scaling origin, and store the result in dest.
Matrix3x2d	scaleAroundLocal(double factor, double ox, double oy, Matrix3x2d dest) Pre-multiply scaling to this matrix by scaling the base axes by the given factor while using (ox, oy) as the scaling origin, and store the result in dest.
Matrix3x2d	scaleLocal(double x, double y, Matrix3x2d dest) Pre-multiply scaling to this matrix by scaling the base axes by the given x and y factors and store the result in dest.
Matrix3x2d	scaleLocal(double xy, Matrix3x2d dest) Pre-multiply scaling to this matrix by scaling the two base axes by the given xy factor, and store the result in dest.
boolean	testAar(double minX, double minY, double maxX, double maxY) Test whether the given axis-aligned rectangle is partly or completely within or outside of the frustum defined by this matrix.
boolean	testCircle(double x, double y, double r) Test whether the given circle is partly or completely within or outside of the frustum defined by this matrix.
boolean	testPoint(double x, double y) Test whether the given point (x, y) is within the frustum defined by this matrix.
Vector3d	transform(double x, double y, double z, Vector3d dest) Transform/multiply the given vector (x, y, z) by this matrix and store the result in dest.
Vector3d	transform(Vector3d v) Transform/multiply the given vector by this matrix by assuming a third row in this matrix of (0, 0, 1) and store the result in that vector.
Vector3d	transform(Vector3dc v, Vector3d dest) Transform/multiply the given vector by this matrix and store the result in dest.
Vector2d	transformDirection(double x, double y, Vector2d dest) Transform/multiply the given 2D-vector (x, y), as if it was a 3D-vector with z=0, by this matrix and store the result in dest.
Vector2d	transformDirection(Vector2d v) Transform/multiply the given 2D-vector, as if it was a 3D-vector with z=0, by this matrix and store the result in that vector.
Vector2d	transformDirection(Vector2dc v, Vector2d dest) Transform/multiply the given 2D-vector, as if it was a 3D-vector with z=0, by this matrix and store the result in dest.
Vector2d	transformPosition(double x, double y, Vector2d dest) Transform/multiply the given 2D-vector (x, y), as if it was a 3D-vector with z=1, by this matrix and store the result in dest.
Vector2d	transformPosition(Vector2d v) Transform/multiply the given 2D-vector, as if it was a 3D-vector with z=1, by this matrix and store the result in that vector.
Vector2d	transformPosition(Vector2dc v, Vector2d dest) Transform/multiply the given 2D-vector, as if it was a 3D-vector with z=1, by this matrix and store the result in dest.
Matrix3x2d	translate(double x, double y, Matrix3x2d 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.
Matrix3x2d	translate(Vector2dc offset, Matrix3x2d 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.
Matrix3x2d	translateLocal(double x, double y, Matrix3x2d dest) Pre-multiply a translation to this matrix by translating by the given number of units in x and y and store the result in dest.
Matrix3x2d	translateLocal(Vector2dc offset, Matrix3x2d dest) Pre-multiply a translation to this matrix by translating by the given number of units in x and y and store the result in dest.
Vector2d	unproject(double winX, double winY, int[] viewport, Vector2d dest) Unproject the given window coordinates (winX, winY) by this matrix using the specified viewport.
Vector2d	unprojectInv(double winX, double winY, int[] viewport, Vector2d dest) Unproject the given window coordinates (winX, winY) by this matrix using the specified viewport.
Matrix3x2d	view(double left, double right, double bottom, double top, Matrix3x2d 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.
double[]	viewArea(double[] area) Obtain the extents of the view transformation of this matrix and store it in area.

Method Detail

m00

double m00()

Return the value of the matrix element at column 0 and row 0.

Returns:

the value of the matrix element

m01

double m01()

Return the value of the matrix element at column 0 and row 1.

Returns:

the value of the matrix element

m10

double m10()

Return the value of the matrix element at column 1 and row 0.

Returns:

the value of the matrix element

m11

double m11()

Return the value of the matrix element at column 1 and row 1.

Returns:

the value of the matrix element

m20

double m20()

Return the value of the matrix element at column 2 and row 0.

Returns:

the value of the matrix element

m21

double m21()

Return the value of the matrix element at column 2 and row 1.

Returns:

the value of the matrix element

mul

Matrix3x2d mul(Matrix3x2dc right,
               Matrix3x2d dest)

Multiply this matrix by the supplied right matrix by assuming a third row in both matrices of (0, 0, 1) 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

mulLocal

Matrix3x2d mulLocal(Matrix3x2dc left,
                    Matrix3x2d dest)

Pre-multiply this matrix by the supplied left matrix and store the result in dest.

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

Parameters:

left - the left operand of the matrix multiplication

dest - the destination matrix, which will hold the result

Returns:

dest

determinant

double determinant()

Return the determinant of this matrix.

Returns:

the determinant

invert

Matrix3x2d invert(Matrix3x2d dest)

Invert the this matrix by assuming a third row in this matrix of (0, 0, 1) and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

translate

Matrix3x2d translate(double x,
                     double y,
                     Matrix3x2d 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!

Parameters:

x - the offset to translate in x

y - the offset to translate in y

dest - will hold the result

Returns:

dest

translate

Matrix3x2d translate(Vector2dc offset,
                     Matrix3x2d 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!

Parameters:

offset - the offset to translate

dest - will hold the result

Returns:

dest

translateLocal

Matrix3x2d translateLocal(Vector2dc offset,
                          Matrix3x2d dest)

Pre-multiply 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 T * M. So when transforming a vector v with the new matrix by using T * M * v, the translation will be applied last!

Parameters:

offset - the number of units in x and y by which to translate

dest - will hold the result

Returns:

dest

translateLocal

Matrix3x2d translateLocal(double x,
                          double y,
                          Matrix3x2d dest)

Pre-multiply 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 T * M. So when transforming a vector v with the new matrix by using T * M * v, the translation will be applied last!

Parameters:

x - the offset to translate in x

y - the offset to translate in y

dest - will hold the result

Returns:

dest

get

Matrix3x2d get(Matrix3x2d dest)

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

Parameters:

dest - the destination matrix

Returns:

dest

get

DoubleBuffer get(DoubleBuffer buffer)

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

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

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

Parameters:

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

Returns:

the passed in buffer

See Also:

get(int, DoubleBuffer)

get

DoubleBuffer get(int index,
                 DoubleBuffer buffer)

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

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

Parameters:

index - the absolute position into the DoubleBuffer

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

Returns:

the passed in buffer

get

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:

the passed in buffer

See Also:

get(int, ByteBuffer)

get

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:

the passed in buffer

get3x3

DoubleBuffer get3x3(DoubleBuffer buffer)

Store this matrix as an equivalent 3x3 matrix in column-major order into the supplied DoubleBuffer at the current buffer position.

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

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

Parameters:

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

Returns:

the passed in buffer

See Also:

get3x3(int, DoubleBuffer)

get3x3

DoubleBuffer get3x3(int index,
                    DoubleBuffer buffer)

Store this matrix as an equivalent 3x3 matrix in column-major order into the supplied DoubleBuffer starting at the specified absolute buffer position/index.

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

Parameters:

index - the absolute position into the DoubleBuffer

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

Returns:

the passed in buffer

get3x3

ByteBuffer get3x3(ByteBuffer buffer)

Store this matrix as an equivalent 3x3 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 get3x3(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:

the passed in buffer

See Also:

get3x3(int, ByteBuffer)

get3x3

ByteBuffer get3x3(int index,
                  ByteBuffer buffer)

Store this matrix as an equivalent 3x3 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:

the passed in buffer

get4x4

DoubleBuffer get4x4(DoubleBuffer buffer)

Store this matrix as an equivalent 4x4 matrix in column-major order into the supplied DoubleBuffer at the current buffer position.

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

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

Parameters:

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

Returns:

the passed in buffer

See Also:

get4x4(int, DoubleBuffer)

get4x4

DoubleBuffer get4x4(int index,
                    DoubleBuffer buffer)

Store this matrix as an equivalent 4x4 matrix in column-major order into the supplied DoubleBuffer starting at the specified absolute buffer position/index.

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

Parameters:

index - the absolute position into the DoubleBuffer

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

Returns:

the passed in buffer

get4x4

ByteBuffer get4x4(ByteBuffer buffer)

Store this matrix as an equivalent 4x4 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 get4x4(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:

the passed in buffer

See Also:

get4x4(int, ByteBuffer)

get4x4

ByteBuffer get4x4(int index,
                  ByteBuffer buffer)

Store this matrix as an equivalent 4x4 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:

the passed in buffer

get

double[] get(double[] arr,
             int offset)

Store this matrix into the supplied double array in column-major order at the given offset.

Parameters:

arr - the array to write the matrix values into

offset - the offset into the array

Returns:

the passed in array

get

double[] get(double[] arr)

Store this matrix into the supplied double array in column-major order.

In order to specify an explicit offset into the array, use the method get(double[], int).

Parameters:

arr - the array to write the matrix values into

Returns:

the passed in array

See Also:

get(double[], int)

get3x3

double[] get3x3(double[] arr,
                int offset)

Store this matrix as an equivalent 3x3 matrix into the supplied double array in column-major order at the given offset.

Parameters:

arr - the array to write the matrix values into

offset - the offset into the array

Returns:

the passed in array

get3x3

double[] get3x3(double[] arr)

Store this matrix as an equivalent 3x3 matrix into the supplied double array in column-major order.

In order to specify an explicit offset into the array, use the method get3x3(double[], int).

Parameters:

arr - the array to write the matrix values into

Returns:

the passed in array

See Also:

get3x3(double[], int)

get4x4

double[] get4x4(double[] arr,
                int offset)

Store this matrix as an equivalent 4x4 matrix into the supplied double array in column-major order at the given offset.

Parameters:

arr - the array to write the matrix values into

offset - the offset into the array

Returns:

the passed in array

get4x4

double[] get4x4(double[] arr)

Store this matrix as an equivalent 4x4 matrix into the supplied double array in column-major order.

In order to specify an explicit offset into the array, use the method get4x4(double[], int).

Parameters:

arr - the array to write the matrix values into

Returns:

the passed in array

See Also:

get4x4(double[], int)

scale

Matrix3x2d scale(double x,
                 double y,
                 Matrix3x2d 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

Matrix3x2d scale(Vector2dc xy,
                 Matrix3x2d dest)

Apply scaling to this matrix by scaling the base axes by the given xy factors 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 factors of the x and y component, respectively

dest - will hold the result

Returns:

dest

scale

Matrix3x2d scale(Vector2fc xy,
                 Matrix3x2d dest)

Apply scaling to this matrix by scaling the base axes by the given xy factors 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 factors of the x and y component, respectively

dest - will hold the result

Returns:

dest

scaleLocal

Matrix3x2d scaleLocal(double xy,
                      Matrix3x2d dest)

Pre-multiply scaling to this matrix by 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 S * M. So when transforming a vector v with the new matrix by using S * M * v , the scaling will be applied last!

Parameters:

xy - the factor to scale all two base axes by

dest - will hold the result

Returns:

dest

scaleLocal

Matrix3x2d scaleLocal(double x,
                      double y,
                      Matrix3x2d dest)

Pre-multiply scaling to this matrix by scaling the base axes by the given x and y factors and store the result in dest.

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

Parameters:

x - the factor of the x component

y - the factor of the y component

dest - will hold the result

Returns:

dest

scaleAroundLocal

Matrix3x2d scaleAroundLocal(double sx,
                            double sy,
                            double ox,
                            double oy,
                            Matrix3x2d dest)

Pre-multiply scaling to this matrix by scaling the base axes by the given sx and sy factors while using the given (ox, oy) as the scaling origin, and store the result in dest.

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

This method is equivalent to calling: new Matrix3x2d().translate(ox, oy).scale(sx, sy).translate(-ox, -oy).mul(this, dest)

Parameters:

sx - the scaling factor of the x component

sy - the scaling factor of the y component

ox - the x coordinate of the scaling origin

oy - the y coordinate of the scaling origin

dest - will hold the result

Returns:

dest

scaleAroundLocal

Matrix3x2d scaleAroundLocal(double factor,
                            double ox,
                            double oy,
                            Matrix3x2d dest)

Pre-multiply scaling to this matrix by scaling the base axes by the given factor while using (ox, oy) as the scaling origin, and store the result in dest.

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

This method is equivalent to calling: new Matrix3x2d().translate(ox, oy).scale(factor).translate(-ox, -oy).mul(this, dest)

Parameters:

factor - the scaling factor for all three axes

ox - the x coordinate of the scaling origin

oy - the y coordinate of the scaling origin

dest - will hold the result

Returns:

this

scale

Matrix3x2d scale(double xy,
                 Matrix3x2d 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(double, double, Matrix3x2d)

scaleAround

Matrix3x2d scaleAround(double sx,
                       double sy,
                       double ox,
                       double oy,
                       Matrix3x2d dest)

Apply scaling to this matrix by scaling the base axes by the given sx and sy factors while using (ox, oy) as the scaling origin, 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!

This method is equivalent to calling: translate(ox, oy, dest).scale(sx, sy).translate(-ox, -oy)

Parameters:

sx - the scaling factor of the x component

sy - the scaling factor of the y component

ox - the x coordinate of the scaling origin

oy - the y coordinate of the scaling origin

dest - will hold the result

Returns:

dest

scaleAround

Matrix3x2d scaleAround(double factor,
                       double ox,
                       double oy,
                       Matrix3x2d dest)

Apply scaling to this matrix by scaling the base axes by the given factor while using (ox, oy) as the scaling origin, 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!

This method is equivalent to calling: translate(ox, oy, dest).scale(factor).translate(-ox, -oy)

Parameters:

factor - the scaling factor for all three axes

ox - the x coordinate of the scaling origin

oy - the y coordinate of the scaling origin

dest - will hold the result

Returns:

this

transform

Vector3d transform(Vector3d v)

Transform/multiply the given vector by this matrix by assuming a third row in this matrix of (0, 0, 1) and store the result in that vector.

Parameters:

v - the vector to transform and to hold the final result

Returns:

v

See Also:

Vector3d.mul(Matrix3x2dc)

transform

Vector3d transform(Vector3dc v,
                   Vector3d dest)

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

Parameters:

v - the vector to transform

dest - will contain the result

Returns:

dest

See Also:

Vector3d.mul(Matrix3x2dc, Vector3d)

transform

Vector3d transform(double x,
                   double y,
                   double z,
                   Vector3d dest)

Transform/multiply the given vector (x, y, z) by this matrix and store the result in dest.

Parameters:

x - the x component of the vector to transform

y - the y component of the vector to transform

z - the z component of the vector to transform

dest - will contain the result

Returns:

dest

transformPosition

Vector2d transformPosition(Vector2d v)

Transform/multiply the given 2D-vector, as if it was a 3D-vector with z=1, by this matrix and store the result in that vector.

The given 2D-vector is treated as a 3D-vector with its z-component being 1.0, so it will represent a position/location in 2D-space rather than a direction.

In order to store the result in another vector, use transformPosition(Vector2dc, Vector2d).

Parameters:

v - the vector to transform and to hold the final result

Returns:

v

See Also:

transformPosition(Vector2dc, Vector2d), transform(Vector3d)

transformPosition

Vector2d transformPosition(Vector2dc v,
                           Vector2d dest)

Transform/multiply the given 2D-vector, as if it was a 3D-vector with z=1, by this matrix and store the result in dest.

The given 2D-vector is treated as a 3D-vector with its z-component being 1.0, so it will represent a position/location in 2D-space rather than a direction.

In order to store the result in the same vector, use transformPosition(Vector2d).

Parameters:

v - the vector to transform

dest - will hold the result

Returns:

dest

See Also:

transformPosition(Vector2d), transform(Vector3dc, Vector3d)

transformPosition

Vector2d transformPosition(double x,
                           double y,
                           Vector2d dest)

Transform/multiply the given 2D-vector (x, y), as if it was a 3D-vector with z=1, by this matrix and store the result in dest.

The given 2D-vector is treated as a 3D-vector with its z-component being 1.0, so it will represent a position/location in 2D-space rather than a direction.

In order to store the result in the same vector, use transformPosition(Vector2d).

Parameters:

x - the x component of the vector to transform

y - the y component of the vector to transform

dest - will hold the result

Returns:

dest

See Also:

transformPosition(Vector2d), transform(Vector3dc, Vector3d)

transformDirection

Vector2d transformDirection(Vector2d v)

Transform/multiply the given 2D-vector, as if it was a 3D-vector with z=0, by this matrix and store the result in that vector.

The given 2D-vector is treated as a 3D-vector with its z-component being 0.0, so it will represent a direction in 2D-space rather than a position. This method will therefore not take the translation part of the matrix into account.

In order to store the result in another vector, use transformDirection(Vector2dc, Vector2d).

Parameters:

v - the vector to transform and to hold the final result

Returns:

v

See Also:

transformDirection(Vector2dc, Vector2d)

transformDirection

Vector2d transformDirection(Vector2dc v,
                            Vector2d dest)

Transform/multiply the given 2D-vector, as if it was a 3D-vector with z=0, by this matrix and store the result in dest.

The given 2D-vector is treated as a 3D-vector with its z-component being 0.0, so it will represent a direction in 2D-space rather than a position. This method will therefore not take the translation part of the matrix into account.

In order to store the result in the same vector, use transformDirection(Vector2d).

Parameters:

v - the vector to transform and to hold the final result

dest - will hold the result

Returns:

dest

See Also:

transformDirection(Vector2d)

transformDirection

Vector2d transformDirection(double x,
                            double y,
                            Vector2d dest)

Transform/multiply the given 2D-vector (x, y), as if it was a 3D-vector with z=0, by this matrix and store the result in dest.

The given 2D-vector is treated as a 3D-vector with its z-component being 0.0, so it will represent a direction in 2D-space rather than a position. This method will therefore not take the translation part of the matrix into account.

In order to store the result in the same vector, use transformDirection(Vector2d).

Parameters:

x - the x component of the vector to transform

y - the y component of the vector to transform

dest - will hold the result

Returns:

dest

See Also:

transformDirection(Vector2d)

rotate

Matrix3x2d rotate(double ang,
                  Matrix3x2d 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

rotateLocal

Matrix3x2d rotateLocal(double ang,
                       Matrix3x2d dest)

Pre-multiply a rotation 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 R * M. So when transforming a vector v with the new matrix by using R * M * v, the rotation will be applied last!

Reference: http://en.wikipedia.org

Parameters:

ang - the angle in radians

dest - will hold the result

Returns:

dest

rotateAbout

Matrix3x2d rotateAbout(double ang,
                       double x,
                       double y,
                       Matrix3x2d 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(double, double, Matrix3x2d), rotate(double, Matrix3x2d)

rotateTo

Matrix3x2d rotateTo(Vector2dc fromDir,
                    Vector2dc toDir,
                    Matrix3x2d 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

view

Matrix3x2d view(double left,
                double right,
                double bottom,
                double top,
                Matrix3x2d 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

origin

Vector2d origin(Vector2d origin)

Obtain the position that gets transformed to the origin by this matrix. This can be used to get the position of the "camera" from a given view transformation matrix.

This method is equivalent to the following code:

 Matrix3x2d inv = new Matrix3x2d(this).invertAffine();
 inv.transform(origin.set(0, 0));
 

Parameters:

origin - will hold the position transformed to the origin

Returns:

origin

viewArea

double[] viewArea(double[] area)

Obtain the extents of the view transformation of this matrix and store it in area. This can be used to determine which region of the screen (i.e. the NDC space) is covered by the view.

Parameters:

area - will hold the view area as [minX, minY, maxX, maxY]

Returns:

area

positiveX

Vector2d positiveX(Vector2d dir)

Obtain the direction of +X before the transformation represented by this matrix is applied.

This method uses the rotation component of the left 2x2 submatrix to obtain the direction that is transformed to +X by this matrix.

This method is equivalent to the following code:

 Matrix3x2d inv = new Matrix3x2d(this).invert();
 inv.transformDirection(dir.set(1, 0)).normalize();
 

If this is already an orthogonal matrix, then consider using normalizedPositiveX(Vector2d) instead.

Reference: http://www.euclideanspace.com

Parameters:

dir - will hold the direction of +X

Returns:

dir

normalizedPositiveX

Vector2d normalizedPositiveX(Vector2d dir)

Obtain the direction of +X before the transformation represented by this orthogonal matrix is applied. This method only produces correct results if this is an orthogonal matrix.

This method uses the rotation component of the left 2x2 submatrix to obtain the direction that is transformed to +X by this matrix.

This method is equivalent to the following code:

 Matrix3x2d inv = new Matrix3x2d(this).transpose();
 inv.transformDirection(dir.set(1, 0));
 

Reference: http://www.euclideanspace.com

Parameters:

dir - will hold the direction of +X

Returns:

dir

positiveY

Vector2d positiveY(Vector2d dir)

Obtain the direction of +Y before the transformation represented by this matrix is applied.

This method uses the rotation component of the left 2x2 submatrix to obtain the direction that is transformed to +Y by this matrix.

This method is equivalent to the following code:

 Matrix3x2d inv = new Matrix3x2d(this).invert();
 inv.transformDirection(dir.set(0, 1)).normalize();
 

If this is already an orthogonal matrix, then consider using normalizedPositiveY(Vector2d) instead.

Reference: http://www.euclideanspace.com

Parameters:

dir - will hold the direction of +Y

Returns:

dir

normalizedPositiveY

Vector2d normalizedPositiveY(Vector2d dir)

Obtain the direction of +Y before the transformation represented by this orthogonal matrix is applied. This method only produces correct results if this is an orthogonal matrix.

This method uses the rotation component of the left 2x2 submatrix to obtain the direction that is transformed to +Y by this matrix.

This method is equivalent to the following code:

 Matrix3x2d inv = new Matrix3x2d(this).transpose();
 inv.transformDirection(dir.set(0, 1));
 

Reference: http://www.euclideanspace.com

Parameters:

dir - will hold the direction of +Y

Returns:

dir

unproject

Vector2d unproject(double winX,
                   double winY,
                   int[] viewport,
                   Vector2d dest)

Unproject the given window coordinates (winX, winY) by this matrix using the specified viewport.

This method first converts the given window coordinates to normalized device coordinates in the range [-1..1] and then transforms those NDC coordinates by the inverse of this matrix.

As a necessary computation step for unprojecting, this method computes the inverse of this matrix. In order to avoid computing the matrix inverse with every invocation, the inverse of this matrix can be built once outside using invert(Matrix3x2d) and then the method unprojectInv() can be invoked on it.

Parameters:

winX - the x-coordinate in window coordinates (pixels)

winY - the y-coordinate in window coordinates (pixels)

viewport - the viewport described by [x, y, width, height]

dest - will hold the unprojected position

Returns:

dest

See Also:

unprojectInv(double, double, int[], Vector2d), invert(Matrix3x2d)

unprojectInv

Vector2d unprojectInv(double winX,
                      double winY,
                      int[] viewport,
                      Vector2d dest)

Unproject the given window coordinates (winX, winY) by this matrix using the specified viewport.

This method differs from unproject() in that it assumes that this is already the inverse matrix of the original projection matrix. It exists to avoid recomputing the matrix inverse with every invocation.

Parameters:

winX - the x-coordinate in window coordinates (pixels)

winY - the y-coordinate in window coordinates (pixels)

viewport - the viewport described by [x, y, width, height]

dest - will hold the unprojected position

Returns:

dest

See Also:

unproject(double, double, int[], Vector2d)

testPoint

boolean testPoint(double x,
                  double y)

Test whether the given point (x, y) is within the frustum defined by this matrix.

This method assumes this matrix to be a transformation from any arbitrary coordinate system/space M into standard OpenGL clip space and tests whether the given point with the coordinates (x, y, z) given in space M is within the clip space.

Reference: Fast Extraction of Viewing Frustum Planes from the World-View-Projection Matrix

Parameters:

x - the x-coordinate of the point

y - the y-coordinate of the point

Returns:

true if the given point is inside the frustum; false otherwise

testCircle

boolean testCircle(double x,
                   double y,
                   double r)

Test whether the given circle is partly or completely within or outside of the frustum defined by this matrix.

This method assumes this matrix to be a transformation from any arbitrary coordinate system/space M into standard OpenGL clip space and tests whether the given sphere with the coordinates (x, y, z) given in space M is within the clip space.

Reference: Fast Extraction of Viewing Frustum Planes from the World-View-Projection Matrix

Parameters:

x - the x-coordinate of the circle's center

y - the y-coordinate of the circle's center

r - the circle's radius

Returns:

true if the given circle is partly or completely inside the frustum; false otherwise

testAar

boolean testAar(double minX,
                double minY,
                double maxX,
                double maxY)

Test whether the given axis-aligned rectangle is partly or completely within or outside of the frustum defined by this matrix. The rectangle is specified via its min and max corner coordinates.

This method assumes this matrix to be a transformation from any arbitrary coordinate system/space M into standard OpenGL clip space and tests whether the given axis-aligned rectangle with its minimum corner coordinates (minX, minY, minZ) and maximum corner coordinates (maxX, maxY, maxZ) given in space M is within the clip space.

Reference: Efficient View Frustum Culling
Reference: Fast Extraction of Viewing Frustum Planes from the World-View-Projection Matrix

Parameters:

minX - the x-coordinate of the minimum corner

minY - the y-coordinate of the minimum corner

maxX - the x-coordinate of the maximum corner

maxY - the y-coordinate of the maximum corner

Returns:

true if the axis-aligned box is completely or partly inside of the frustum; false otherwise

equals

boolean equals(Matrix3x2dc m,
               double delta)

Compare the matrix elements of this matrix with the given matrix using the given delta and return whether all of them are equal within a maximum difference of delta.

Please note that this method is not used by any data structure such as ArrayList HashSet or HashMap and their operations, such as ArrayList.contains(Object) or HashSet.remove(Object), since those data structures only use the Object.equals(Object) and Object.hashCode() methods.

Parameters:

m - the other matrix

delta - the allowed maximum difference

Returns:

true whether all of the matrix elements are equal; false otherwise