Package org.jmol.util

Class Matrix3f

java.lang.Object

org.jmol.util.Matrix3f

All Implemented Interfaces:

java.io.Serializable

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

A single precision floating point 3 by 3 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	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	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.

Constructor Summary

Constructors

Constructor	Description
Matrix3f()	Constructs and initializes a Matrix3f to all zeros.

Method Summary

Modifier and Type	Method	Description
void	add(Matrix3f m1)	Sets the value of this matrix to sum of itself and matrix m1.
float	determinant()	Computes the determinant of this matrix.
boolean	equals(java.lang.Object o)	Returns true if the Object o is of type Matrix3f and all of the data members of t1 are equal to the corresponding data members in this Matrix3f.
void	getColumn(int column, float[] v)	Copies the matrix values in the specified column into the array parameter.
void	getColumnV(int column, Vector3f v)	Copies the matrix values in the specified column into the vector parameter.
float	getElement(int row, int column)	Retrieves the value at the specified row and column of this matrix.
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(Matrix3f m1)	Sets the value of this matrix to the matrix inverse of the passed matrix m1.
void	mul(Matrix3f m1)	Sets the value of this matrix to the result of multiplying itself with matrix m1.
void	mul2(Matrix3f m1, Matrix3f m2)	Sets the value of this matrix to the result of multiplying the two argument matrices together.
void	mulf(float scalar)	Multiplies each element of this matrix by a scalar.
static Matrix3f	newA(float[] v)	Constructs and initializes a Matrix3f from the specified 9 element array.
static Matrix3f	newM(Matrix3f m1)	Constructs a new matrix with the same values as the Matrix3f parameter.
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 Matrix3f 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 x, float y, float z)	Sets the specified column of this matrix3d to the three values provided.
void	setColumnA(int column, float[] v)	Sets the specified column of this matrix3d to the four values provided.
void	setColumnV(int column, Vector3f v)	Sets the specified column of this matrix3d to the vector provided.
void	setElement(int row, int column, float value)	Sets the specified element of this matrix3d to the value provided.
void	setIdentity()	Sets this Matrix3f to identity.
void	setM(Matrix3f m1)	Sets the value of this matrix to the double value of the Matrix3f argument.
void	setRow(int row, float x, float y, float z)	Sets the specified row of this matrix3d to the three values provided.
void	setRowA(int row, float[] v)	Sets the specified row of this matrix3d to the four values provided.
void	setRowV(int row, Vector3f v)	Sets the specified row of this matrix3d to the Vector provided.
void	setScale(float scale)	Sets the value of this matrix to a scale matrix with the passed scale amount.
void	setZero()	Sets this matrix to all zeros.
void	sub(Matrix3f 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 Matrix3f.
void	transform(Tuple3f t)
void	transform2(Tuple3f t, Tuple3f result)	Transform the vector vec using this Matrix3f and place the result into vecOut.
void	transpose()	Sets the value of this matrix to its transpose.
void	transposeM(Matrix3f m1)	Sets the value of this matrix to the transpose of the argument matrix

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.

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.

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.

Constructor Detail

Matrix3f

public Matrix3f()

Constructs and initializes a Matrix3f to all zeros.

Method Detail

newA

public static Matrix3f newA(float[] v)

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

Parameters:

v - the array of length 9 containing in order

Returns:

m

newM

public static Matrix3f newM(Matrix3f m1)

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

Parameters:

m1 - The source matrix.

Returns:

m

toString

public java.lang.String toString()

Returns a string that contains the values of this Matrix3f.

Overrides:

toString in class java.lang.Object

Returns:

the String representation

setIdentity

public final void setIdentity()

Sets this Matrix3f to identity.

setElement

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

Sets the specified element of this matrix3d 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

setRow

public final void setRow(int row,
                         float x,
                         float y,
                         float z)

Sets the specified row of this matrix3d to the three values provided.

Parameters:

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

x - the first column element

y - the second column element

z - the third column element

setRowV

public final void setRowV(int row,
                          Vector3f v)

Sets the specified row of this matrix3d to the Vector 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

setRowA

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

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

Parameters:

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

v - the replacement row

setColumn

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

Sets the specified column of this matrix3d to the three 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

setColumnV

public final void setColumnV(int column,
                             Vector3f v)

Sets the specified column of this matrix3d to the vector provided.

Parameters:

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

v - the replacement column

setColumnA

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

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

Parameters:

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

v - the replacement column

getColumnV

public final void getColumnV(int column,
                             Vector3f v)

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

Parameters:

column - the matrix column

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

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 row values will be copied

add

public final void add(Matrix3f m1)

Sets the value of this matrix to sum of itself and matrix m1.

Parameters:

m1 - the other matrix

sub

public final void sub(Matrix3f 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.

transposeM

public final void transposeM(Matrix3f m1)

Sets the value of this matrix to the transpose of the argument matrix

Parameters:

m1 - the matrix to be transposed

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(Matrix3f m1)

Sets the value of this matrix to the double value of the Matrix3f argument.

Parameters:

m1 - the matrix3f

setA

public final void setA(float[] m)

Sets the values in this Matrix3f 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 -

invertM

public final void invertM(Matrix3f 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

setScale

public final void setScale(float scale)

Sets the value of this matrix to a scale matrix with the passed scale amount.

Parameters:

scale - the scale factor for the matrix

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

mulf

public final void mulf(float scalar)

Multiplies each element of this matrix by a scalar.

Parameters:

scalar - The scalar multiplier.

mul

public final void mul(Matrix3f 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(Matrix3f m1,
                       Matrix3f 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 Matrix3f and all of the data members of t1 are equal to the corresponding data members in this Matrix3f.

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 Matrix3f objects with identical data values (ie, returns true for equals(Matrix3f) ) 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

setZero

public final void setZero()

Sets this matrix to all zeros.

transform

public final void transform(Tuple3f t)

transform2

public final void transform2(Tuple3f t,
                             Tuple3f result)

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

Parameters:

t - the single precision vector to be transformed

result - the vector into which the transformed values are placed