Package org.jmol.util

Class Matrix4f

java.lang.Object

org.jmol.util.Matrix4f

All Implemented Interfaces:

java.io.Serializable

public class Matrix4f
extends java.lang.Object
implements java.io.Serializable

A single precision floating point 4 by 4 matrix.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
float	m00	The first element of the first row.
float	m01	The second element of the first row.
float	m02	third element of the first row.
float	m03	The fourth element of the first row.
float	m10	The first element of the second row.
float	m11	The second element of the second row.
float	m12	The third element of the second row.
float	m13	The fourth element of the second row.
float	m20	The first element of the third row.
float	m21	The second element of the third row.
float	m22	The third element of the third row.
float	m23	The fourth element of the third row.
float	m30	The first element of the fourth row.
float	m31	The second element of the fourth row.
float	m32	The third element of the fourth row.
float	m33	The fourth element of the fourth row.

Constructor Summary

Constructors

Constructor	Description
Matrix4f()

Method Summary

Modifier and Type	Method	Description
float	determinant()	Computes the determinant of this matrix.
boolean	equals(java.lang.Object o)	Returns true if the Object o is of type Matrix4f and all of the data members of t1 are equal to the corresponding data members in this Matrix4f.
void	get(Vector3f trans)	Retrieves the translational components of this matrix.
void	getColumn(int column, float[] v)	Copies the matrix values in the specified column into the array parameter.
float	getElement(int row, int column)	Retrieves the value at the specified row and column of this matrix.
void	getRotationScale(Matrix3f m1)	Gets the upper 3x3 values of this matrix and places them into the matrix m1.
void	getRow(int row, float[] v)	Copies the matrix values in the specified row into the array parameter.
int	hashCode()	Returns a hash number based on the data values in this object.
void	invert()	Sets the value of this matrix to its inverse.
void	invertM(Matrix4f m1)	Sets the value of this matrix to the matrix inverse of the passed matrix m1.
void	mul(float scalar)	Multiplies each element of this matrix by a scalar.
void	mul(Matrix4f m1)	Sets the value of this matrix to the result of multiplying itself with matrix m1.
void	mul2(Matrix4f m1, Matrix4f m2)	Sets the value of this matrix to the result of multiplying the two argument matrices together.
static Matrix4f	newA(float[] v)	Constructs and initializes a Matrix4f from the specified 16 element array.
static Matrix4f	newM(Matrix4f m1)	Constructs a new matrix with the same values as the Matrix4f parameter.
static Matrix4f	newMV(Matrix3f m1, Vector3f t)	Constructs and initializes a Matrix4f from the rotation matrix and translation.
void	rotX(float angle)	Sets the value of this matrix to a rotation matrix about the x axis by the passed angle.
void	rotY(float angle)	Sets the value of this matrix to a rotation matrix about the y axis by the passed angle.
void	rotZ(float angle)	Sets the value of this matrix to a rotation matrix about the z axis by the passed angle.
void	setA(float[] m)	Sets the values in this Matrix4f equal to the row-major array parameter (ie, the first four elements of the array will be copied into the first row of this matrix, etc.).
void	setAA(AxisAngle4f a1)	Sets the value of this matrix to the matrix conversion of the single precision axis and angle argument.
void	setColumn(int column, float[] v)	Sets the specified column of this matrix4f to the four values provided.
void	setColumn4(int column, float x, float y, float z, float w)	Sets the specified column of this matrix4f to the four values provided.
void	setElement(int row, int column, float value)	Sets the specified element of this matrix4f to the value provided.
void	setIdentity()	Sets this Matrix4f to identity.
void	setM(Matrix4f m1)	Sets the value of this matrix to a copy of the passed matrix m1.
void	setM3(Matrix3f m1)	Sets the rotational component (upper 3x3) of this matrix to the matrix values in the single precision Matrix3f argument; the other elements of this matrix are initialized as if this were an identity matrix (ie, affine matrix with no translational component).
void	setMV(Matrix3f m1, Vector3f t)	Initializes a Matrix4f from the rotation matrix and translation.
void	setRotationScale(Matrix3f m1)	Replaces the upper 3x3 matrix values of this matrix with the values in the matrix m1.
void	setRow(int row, float[] v)	Sets the specified row of this matrix4f to the four values provided.
void	setTranslation(Vector3f trans)	Modifies the translational components of this matrix to the values of the Vector3f argument; the other values of this matrix are not modified.
void	setZero()	Sets this matrix to all zeros.
void	sub(Matrix4f m1)	Sets the value of this matrix to the matrix difference of itself and matrix m1 (this = this - m1).
java.lang.String	toString()	Returns a string that contains the values of this Matrix4f.
void	transform(Point3f point)	Transforms the point parameter with this Matrix4f and places the result back into point.
void	transform2(Point3f point, Point3f pointOut)	Transforms the point parameter with this Matrix4f and places the result into pointOut.
void	transform4(Tuple4f vec)	Transform the vector vec using this Matrix4f and place the result back into vec.
void	transformT2(Tuple4f vec, Tuple4f vecOut)	Transform the vector vec using this Matrix4f and place the result into vecOut.
void	transformV(Vector3f normal)	Transforms the normal parameter by this transform and places the value back into normal.
void	transformV2(Vector3f normal, Vector3f normalOut)	Transforms the normal parameter by this Matrix4f and places the value into normalOut.
void	transpose()	Sets the value of this matrix to its transpose.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

m00

public float m00

The first element of the first row.

m01

public float m01

The second element of the first row.

m02

public float m02

third element of the first row.

m03

public float m03

The fourth element of the first row.

m10

public float m10

The first element of the second row.

m11

public float m11

The second element of the second row.

m12

public float m12

The third element of the second row.

m13

public float m13

The fourth element of the second row.

m20

public float m20

The first element of the third row.

m21

public float m21

The second element of the third row.

m22

public float m22

The third element of the third row.

m23

public float m23

The fourth element of the third row.

m30

public float m30

The first element of the fourth row.

m31

public float m31

The second element of the fourth row.

m32

public float m32

The third element of the fourth row.

m33

public float m33

The fourth element of the fourth row.

Constructor Detail

Matrix4f

public Matrix4f()

Method Detail

newA

public static Matrix4f newA(float[] v)

Constructs and initializes a Matrix4f from the specified 16 element array. this.m00 =v[0], this.m01=v[1], etc.

Parameters:

v - the array of length 16 containing in order

Returns:

m

newM

public static Matrix4f newM(Matrix4f m1)

Constructs a new matrix with the same values as the Matrix4f parameter.

Parameters:

m1 - the source matrix

Returns:

m

newMV

public static Matrix4f newMV(Matrix3f m1,
                             Vector3f t)

Constructs and initializes a Matrix4f from the rotation matrix and translation.

Parameters:

m1 - The rotation matrix representing the rotational components

t - The translational components of the matrix

Returns:

m

setMV

public void setMV(Matrix3f m1,
                  Vector3f t)

Initializes a Matrix4f from the rotation matrix and translation.

Parameters:

m1 - The rotation matrix representing the rotational components

t - The translational components of the matrix

setAA

public final void setAA(AxisAngle4f a1)

Sets the value of this matrix to the matrix conversion of the single precision axis and angle argument.

Parameters:

a1 - the axis and angle to be converted

setM

public final void setM(Matrix4f m1)

Sets the value of this matrix to a copy of the passed matrix m1.

Parameters:

m1 - the matrix to be copied

toString

public java.lang.String toString()

Returns a string that contains the values of this Matrix4f.

Overrides:

toString in class java.lang.Object

Returns:

the String representation

setIdentity

public final void setIdentity()

Sets this Matrix4f to identity.

setElement

public final void setElement(int row,
                             int column,
                             float value)

Sets the specified element of this matrix4f to the value provided.

Parameters:

row - the row number to be modified (zero indexed)

column - the column number to be modified (zero indexed)

value - the new value

getElement

public final float getElement(int row,
                              int column)

Retrieves the value at the specified row and column of this matrix.

Parameters:

row - the row number to be retrieved (zero indexed)

column - the column number to be retrieved (zero indexed)

Returns:

the value at the indexed element

get

public final void get(Vector3f trans)

Retrieves the translational components of this matrix.

Parameters:

trans - the vector that will receive the translational component

getRotationScale

public final void getRotationScale(Matrix3f m1)

Gets the upper 3x3 values of this matrix and places them into the matrix m1.

Parameters:

m1 - The matrix that will hold the values

setRotationScale

public final void setRotationScale(Matrix3f m1)

Replaces the upper 3x3 matrix values of this matrix with the values in the matrix m1.

Parameters:

m1 - The matrix that will be the new upper 3x3

setRow

public final void setRow(int row,
                         float[] v)

Sets the specified row of this matrix4f to the four values provided.

Parameters:

row - the row number to be modified (zero indexed)

v - the replacement row

getRow

public final void getRow(int row,
                         float[] v)

Copies the matrix values in the specified row into the array parameter.

Parameters:

row - the matrix row

v - The array into which the matrix row values will be copied

setColumn4

public final void setColumn4(int column,
                             float x,
                             float y,
                             float z,
                             float w)

Sets the specified column of this matrix4f to the four values provided.

Parameters:

column - the column number to be modified (zero indexed)

x - the first row element

y - the second row element

z - the third row element

w - the fourth row element

setColumn

public final void setColumn(int column,
                            float[] v)

Sets the specified column of this matrix4f to the four values provided.

Parameters:

column - the column number to be modified (zero indexed)

v - the replacement column

getColumn

public final void getColumn(int column,
                            float[] v)

Copies the matrix values in the specified column into the array parameter.

Parameters:

column - the matrix column

v - The array into which the matrix column values will be copied

sub

public final void sub(Matrix4f m1)

Sets the value of this matrix to the matrix difference of itself and matrix m1 (this = this - m1).

Parameters:

m1 - the other matrix

transpose

public final void transpose()

Sets the value of this matrix to its transpose.

invertM

public final void invertM(Matrix4f m1)

Sets the value of this matrix to the matrix inverse of the passed matrix m1.

Parameters:

m1 - the matrix to be inverted

invert

public final void invert()

Sets the value of this matrix to its inverse.

determinant

public final float determinant()

Computes the determinant of this matrix.

Returns:

the determinant of the matrix

setM3

public final void setM3(Matrix3f m1)

Sets the rotational component (upper 3x3) of this matrix to the matrix values in the single precision Matrix3f argument; the other elements of this matrix are initialized as if this were an identity matrix (ie, affine matrix with no translational component).

Parameters:

m1 - the 3x3 matrix

setA

public final void setA(float[] m)

Sets the values in this Matrix4f equal to the row-major array parameter (ie, the first four elements of the array will be copied into the first row of this matrix, etc.).

Parameters:

m -

setTranslation

public void setTranslation(Vector3f trans)

Modifies the translational components of this matrix to the values of the Vector3f argument; the other values of this matrix are not modified.

Parameters:

trans - the translational component

rotX

public final void rotX(float angle)

Sets the value of this matrix to a rotation matrix about the x axis by the passed angle.

Parameters:

angle - the angle to rotate about the X axis in radians

rotY

public final void rotY(float angle)

Sets the value of this matrix to a rotation matrix about the y axis by the passed angle.

Parameters:

angle - the angle to rotate about the Y axis in radians

rotZ

public final void rotZ(float angle)

Sets the value of this matrix to a rotation matrix about the z axis by the passed angle.

Parameters:

angle - the angle to rotate about the Z axis in radians

mul

public final void mul(float scalar)

Multiplies each element of this matrix by a scalar.

Parameters:

scalar - The scalar multiplier.

mul

public final void mul(Matrix4f m1)

Sets the value of this matrix to the result of multiplying itself with matrix m1.

Parameters:

m1 - the other matrix

mul2

public final void mul2(Matrix4f m1,
                       Matrix4f m2)

Sets the value of this matrix to the result of multiplying the two argument matrices together.

Parameters:

m1 - the first matrix

m2 - the second matrix

equals

public boolean equals(java.lang.Object o)

Returns true if the Object o is of type Matrix4f and all of the data members of t1 are equal to the corresponding data members in this Matrix4f.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object with which the comparison is made.

hashCode

public int hashCode()

Returns a hash number based on the data values in this object. Two different Matrix4f objects with identical data values (ie, returns true for equals(Matrix4f) ) will return the same hash number. Two objects with different data members may return the same hash value, although this is not likely.

Overrides:

hashCode in class java.lang.Object

Returns:

the integer hash value

transformT2

public final void transformT2(Tuple4f vec,
                              Tuple4f vecOut)

Transform the vector vec using this Matrix4f and place the result into vecOut.

Parameters:

vec - the single precision vector to be transformed

vecOut - the vector into which the transformed values are placed

transform4

public final void transform4(Tuple4f vec)

Transform the vector vec using this Matrix4f and place the result back into vec.

Parameters:

vec - the single precision vector to be transformed

transform2

public final void transform2(Point3f point,
                             Point3f pointOut)

Transforms the point parameter with this Matrix4f and places the result into pointOut. The fourth element of the point input paramter is assumed to be one.

Parameters:

point - the input point to be transformed.

pointOut - the transformed point

transform

public final void transform(Point3f point)

Transforms the point parameter with this Matrix4f and places the result back into point. The fourth element of the point input paramter is assumed to be one.

Parameters:

point - the input point to be transformed.

transformV2

public final void transformV2(Vector3f normal,
                              Vector3f normalOut)

Transforms the normal parameter by this Matrix4f and places the value into normalOut. The fourth element of the normal is assumed to be zero.

Parameters:

normal - the input normal to be transformed.

normalOut - the transformed normal

transformV

public final void transformV(Vector3f normal)

Transforms the normal parameter by this transform and places the value back into normal. The fourth element of the normal is assumed to be zero.

Parameters:

normal - the input normal to be transformed.

setZero

public final void setZero()

Sets this matrix to all zeros.