thothbot.parallax.core.shared.math

Class Matrix4

java.lang.Object

thothbot.parallax.core.shared.math.Matrix4

public class Matrix4
extends java.lang.Object

This class implements three-dimensional matrix. NxN, where N=4. This matrix actually is array which is represented the following indexes:

 0 4  8 12
 1 5  9 13
 2 6 10 14
 3 7 11 15
 

Author:

thothbot

Constructor Summary

Constructors

Constructor and Description
Matrix4() Default constructor will make identity four-dimensional matrix.
Matrix4(double n11, double n12, double n13, double n14, double n21, double n22, double n23, double n24, double n31, double n32, double n33, double n34, double n41, double n42, double n43, double n44) This constructor will create four-dimensional matrix.

Method Summary

Modifier and Type	Method and Description
Float32Array	applyToVector3Array(Float32Array array)
Float32Array	applyToVector3Array(Float32Array array, int offset, int length)
Matrix4	clone() Clone the current matrix.
Matrix4	compose(Vector3 position, Quaternion quaternion, Vector3 scale)
Matrix4	copy(Matrix4 m) Sets the value of this matrix to the values of input matrix.
Matrix4	copyPosition(Matrix4 m)
Matrix4	decompose(Vector3 position, Quaternion quaternion, Vector3 scale)
double	determinant() get the current matrix determinant.
Matrix4	extractRotation(Matrix4 m) Setting rotation values to the rotation values of the input matrix.
Float32Array	flattenToArrayOffset(Float32Array flat) Sets the value of input array to the values of the current matrix.
Float32Array	flattenToArrayOffset(Float32Array flat, int offset) Sets the value of input array to the values of the current matrix.
Float32Array	getArray() get the current Matrix which is represented by Array[16] which the following indexes: 0 4 8 12 1 5 9 13 2 6 10 14 3 7 11 15
Matrix4	getInverse(Matrix4 m) Sets the value of this matrix to the matrix inverse of the passed matrix m.
double	getMaxScaleOnAxis()
Matrix4	identity() Make make identity four-dimensional matrix.
Matrix4	lookAt(Vector3 eye, Vector3 target, Vector3 up) Modifies the current matrix by looking at target on defined eye.
Matrix4	makeFrustum(double left, double right, double bottom, double top, double near, double far) Creates a frustum matrix.
Matrix4	makeOrthographic(double left, double right, double top, double bottom, double near, double far) Making Orthographic Projection Matrix
Matrix4	makePerspective(double fov, double aspect, double near, double far) Making Perspective Projection Matrix
Matrix4	makeRotationAxis(Vector3 axis, double angle) The method will make rotation matrix on XYZ-axis using defining angle theta.
Matrix4	makeRotationFromEuler(Euler euler)
Matrix4	makeRotationFromQuaternion(Quaternion q)
Matrix4	makeRotationX(double theta) The method will make rotation matrix on X-axis using defining angle theta.
Matrix4	makeRotationY(double theta) The method will make rotation matrix on Y-axis using defining angle theta.
Matrix4	makeRotationZ(double theta) The method will make rotation matrix on Z-axis using defining angle theta.
Matrix4	makeScale(double x, double y, double z) Make a scaled matrix on the X, Y, Z coordinates.
Matrix4	makeTranslation(double x, double y, double z) This method will make translation matrix using X, Y,Z coordinates
Matrix4	multiply(double s) Sets the value of this matrix to the scalar multiplication of the scale factor with this.
Matrix4	multiply(Matrix4 m) Sets the value of this matrix to the matrix multiplication of itself and matrix m.
Matrix4	multiply(Matrix4 m1, Matrix4 m2) Sets the value of this matrix to the matrix multiplication of m1 and vector m2.
void	scale(Vector3 v) Scale the current matrix.
Matrix4	set(double n11, double n12, double n13, double n14, double n21, double n22, double n23, double n24, double n31, double n32, double n33, double n34, double n41, double n42, double n43, double n44) Setting input values n11-n44 to the current matrix.
Matrix4	setPosition(Vector3 v) Setting position values of the current matrix to the values of input vector.
java.lang.String	toString() get matrix information by printing list of matrix's elements.
Matrix4	transpose() Transpose the current matrix where its rows will be the columns or its columns are the rows of the current matrix.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Matrix4

public Matrix4()

Default constructor will make identity four-dimensional matrix.

 1 0 0 0
 0 1 0 0
 0 0 1 0
 0 0 0 1
 

Matrix4

public Matrix4(double n11,
               double n12,
               double n13,
               double n14,
               double n21,
               double n22,
               double n23,
               double n24,
               double n31,
               double n32,
               double n33,
               double n34,
               double n41,
               double n42,
               double n43,
               double n44)

This constructor will create four-dimensional matrix. This matrix uses input values n11-n44 and represented as the following:

 n11 n12 n13 n14
 n21 n22 n23 n24
 n31 n32 n33 n34
 n41 n42 n43 n44
 

Method Detail

getArray

public Float32Array getArray()

get the current Matrix which is represented by Array[16] which the following indexes:

 0 4  8 12
 1 5  9 13
 2 6 10 14
 3 7 11 15
 

Returns:

the Array

set

public Matrix4 set(double n11,
                   double n12,
                   double n13,
                   double n14,
                   double n21,
                   double n22,
                   double n23,
                   double n24,
                   double n31,
                   double n32,
                   double n33,
                   double n34,
                   double n41,
                   double n42,
                   double n43,
                   double n44)

Setting input values n11-n44 to the current matrix. This matrix will be represented as the following:

 n11 n12 n13 n14
 n21 n22 n23 n24
 n31 n32 n33 n34
 n41 n42 n43 n44
 

Returns:

the current matrix.

identity

public Matrix4 identity()

Make make identity four-dimensional matrix.

 1 0 0 0
 0 1 0 0
 0 0 1 0
 0 0 0 1
 

copy

public Matrix4 copy(Matrix4 m)

Sets the value of this matrix to the values of input matrix.

Parameters:

m - the matrix values which we wat to copy

Returns:

the current matrix

copyPosition

public Matrix4 copyPosition(Matrix4 m)

extractRotation

public Matrix4 extractRotation(Matrix4 m)

Setting rotation values to the rotation values of the input matrix.

Parameters:

m - the input matrix

makeRotationFromEuler

public Matrix4 makeRotationFromEuler(Euler euler)

makeRotationFromQuaternion

public Matrix4 makeRotationFromQuaternion(Quaternion q)

lookAt

public Matrix4 lookAt(Vector3 eye,
                      Vector3 target,
                      Vector3 up)

Modifies the current matrix by looking at target on defined eye.

Parameters:

eye - the Eye vector

target - the Target vector

up - the Up vector

Returns:

the current matrix

multiply

public Matrix4 multiply(Matrix4 m1,
                        Matrix4 m2)

Sets the value of this matrix to the matrix multiplication of m1 and vector m2.

Parameters:

m1 - the first matrix

m2 - the second matrix

Returns:

the current matrix

multiply

public Matrix4 multiply(Matrix4 m)

Sets the value of this matrix to the matrix multiplication of itself and matrix m. (this = this * m)

Parameters:

m - the other matrix

Returns:

the current matrix

multiply

public Matrix4 multiply(double s)

Sets the value of this matrix to the scalar multiplication of the scale factor with this.

Parameters:

s - the scalar value

Returns:

the current matrix

applyToVector3Array

public Float32Array applyToVector3Array(Float32Array array)

applyToVector3Array

public Float32Array applyToVector3Array(Float32Array array,
                                        int offset,
                                        int length)

determinant

public double determinant()

get the current matrix determinant.

Returns:

the matrix determinant

transpose

public Matrix4 transpose()

Transpose the current matrix where its rows will be the columns or its columns are the rows of the current matrix.

Returns:

the current matrix

flattenToArrayOffset

public Float32Array flattenToArrayOffset(Float32Array flat)

Sets the value of input array to the values of the current matrix. The indexes in the array will be the following:

 0 4  8 12
 1 5  9 13
 2 6 10 14
 3 7 11 15
 

Parameters:

flat - the array for storing matrix values

Returns:

the modified input vector

flattenToArrayOffset

public Float32Array flattenToArrayOffset(Float32Array flat,
                                         int offset)

Sets the value of input array to the values of the current matrix. The indexes in the array will be the following:

 0 4  8 12
 1 5  9 13
 2 6 10 14
 3 7 11 15
 

Parameters:

flat - the array for storing matrix values

offset - the offset value

Returns:

the modified input vector

setPosition

public Matrix4 setPosition(Vector3 v)

Setting position values of the current matrix to the values of input vector.

Parameters:

v - the input vector

Returns:

the current matrix

getInverse

public Matrix4 getInverse(Matrix4 m)

Sets the value of this matrix to the matrix inverse of the passed matrix m. Based on http://www.euclideanspace.com

Parameters:

m - the matrix to be inverted

scale

public void scale(Vector3 v)

Scale the current matrix.

Parameters:

v - the vector to scale the current matrix

getMaxScaleOnAxis

public double getMaxScaleOnAxis()

makeTranslation

public Matrix4 makeTranslation(double x,
                               double y,
                               double z)

This method will make translation matrix using X, Y,Z coordinates

Parameters:

x - the X coordinate

y - the Y coordinate

z - the Z coordinate

Returns:

the current matrix

makeRotationX

public Matrix4 makeRotationX(double theta)

The method will make rotation matrix on X-axis using defining angle theta.

Parameters:

theta - the angle to make rotation matrix

Returns:

the current matrix

makeRotationY

public Matrix4 makeRotationY(double theta)

The method will make rotation matrix on Y-axis using defining angle theta.

Parameters:

theta - the angle to make rotation matrix

Returns:

the current matrix

makeRotationZ

public Matrix4 makeRotationZ(double theta)

The method will make rotation matrix on Z-axis using defining angle theta.

Parameters:

theta - the angle to make rotation matrix

Returns:

the current matrix

makeRotationAxis

public Matrix4 makeRotationAxis(Vector3 axis,
                                double angle)

The method will make rotation matrix on XYZ-axis using defining angle theta.

Parameters:

axis - the axis on which rotate the matrix

angle - the angle to make rotation matrix

Returns:

the current matrix

makeScale

public Matrix4 makeScale(double x,
                         double y,
                         double z)

Make a scaled matrix on the X, Y, Z coordinates.

Parameters:

x - the X-coordinate

y - the Y-coordinate

z - the Z-coordinate

Returns:

the current matrix

compose

public Matrix4 compose(Vector3 position,
                       Quaternion quaternion,
                       Vector3 scale)

decompose

public Matrix4 decompose(Vector3 position,
                         Quaternion quaternion,
                         Vector3 scale)

makeFrustum

public Matrix4 makeFrustum(double left,
                           double right,
                           double bottom,
                           double top,
                           double near,
                           double far)

Creates a frustum matrix.

makePerspective

public Matrix4 makePerspective(double fov,
                               double aspect,
                               double near,
                               double far)

Making Perspective Projection Matrix

Parameters:

fov - the field Of View

aspect - the aspect ration

near - the near value

far - the far value

Returns:

the current Projection Matrix

makeOrthographic

public Matrix4 makeOrthographic(double left,
                                double right,
                                double top,
                                double bottom,
                                double near,
                                double far)

Making Orthographic Projection Matrix

Returns:

the current Projection Matrix

clone

public Matrix4 clone()

Clone the current matrix. matrix.clone() != matrix

Overrides:

clone in class java.lang.Object

Returns:

the new instance of matrix

toString

public java.lang.String toString()

get matrix information by printing list of matrix's elements.

Overrides:

toString in class java.lang.Object