Package org.web3d.vrml.scripting.ecmascript.builtin

Class Matrix4

java.lang.Object

org.web3d.vrml.scripting.ecmascript.builtin.FieldScriptableObject

org.web3d.vrml.scripting.ecmascript.builtin.Matrix4

All Implemented Interfaces:

org.mozilla.javascript.Scriptable

public class Matrix4
extends FieldScriptableObject

ECMAScript Matrix4 builtin object.

The implementation of all the functionality in this class is according to the Matrix and Quaternion FAQ, which is currently located at: http://www.j3d.org/matrix_faq/

The spec is sort of a bit wishy-washy about how the flat references of array indices. Internally the matrix is stored with the translations values down the right "column" where the X3D spec has them across the bottom. Not entirely convinced that this is correct. Just makes it easy to check this code against the FAQ code, which uses them stored in the same way.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.web3d.vrml.scripting.ecmascript.builtin.FieldScriptableObject

BAD_FORMAT_MSG, dataChanged, INVALID_TYPE_MSG, readOnly, READONLY_MSG, scriptField

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
Matrix4()	Default public constructor required by Rhino for when created by an Ecmascript call.
Matrix4(double[] data)	Default public constructor required by Rhino for when created by an Ecmascript call.

Method Summary

Modifier and Type	Method	Description
Object	get(int index, org.mozilla.javascript.Scriptable start)	Look up the element in the associated matrix and return it if it exists.
Object	get(String name, org.mozilla.javascript.Scriptable start)	Get the value of the named function.
boolean	has(int index, org.mozilla.javascript.Scriptable start)	Check to see if a numeric property is valid.
void	jsConstructor(double f11, double f12, double f13, double f14, double f21, double f22, double f23, double f24, double f31, double f32, double f33, double f34, double f41, double f42, double f43, double f44)
boolean	jsFunction_equals(Object val)	Comparison of this object to another of the same type.
void	jsFunction_getTransform(org.mozilla.javascript.Scriptable tx, org.mozilla.javascript.Scriptable rot, org.mozilla.javascript.Scriptable sc)	Get the value of the transform.
Matrix4	jsFunction_inverse()	Create the inverse of the matrix and return that in a new matrix.
Matrix4	jsFunction_multLeft(org.mozilla.javascript.Scriptable m)	Multiply the passed matrix this matrix and return the value in a new matrix instance.
SFVec3f	jsFunction_multMatrixVec(org.mozilla.javascript.Scriptable vector)	Return a vector that is this multiplied by the given vector as a column.
Matrix4	jsFunction_multRight(org.mozilla.javascript.Scriptable m)	Multiply this matrix by the passed matrix and return the value in a new matrix instance.
SFVec3f	jsFunction_multVecMatrix(org.mozilla.javascript.Scriptable vector)	Return a vector that is this multiplied by the given vector as a row.
void	jsFunction_setTransform(org.mozilla.javascript.Scriptable trans, org.mozilla.javascript.Scriptable rot, org.mozilla.javascript.Scriptable scale, org.mozilla.javascript.Scriptable scaleOrient, org.mozilla.javascript.Scriptable center)	Set the transform to the new values of translation, rotation, scale etc.
String	jsFunction_toString()	Creates a string version of this node.
Matrix4	jsFunction_transpose()	Create the transpose of this matrix and return it in a new matrix.
void	put(int index, org.mozilla.javascript.Scriptable start, Object value)	Set an indexed property.
void	put(String name, org.mozilla.javascript.Scriptable start, Object value)	Sets the named property with a new value.
String	toString()	Format the internal values of this matrix as a string.

Methods inherited from class org.web3d.vrml.scripting.ecmascript.builtin.FieldScriptableObject

delete, delete, getClassName, getDefaultValue, getIds, getParentScope, getPrototype, has, hasChanged, hasInstance, locateFunction, registerFunction, setParentScope, setPrototype, setReadOnly, setScriptField

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Matrix4

public Matrix4()

Default public constructor required by Rhino for when created by an Ecmascript call.

Matrix4

public Matrix4(double[] data)

Default public constructor required by Rhino for when created by an Ecmascript call.

Parameters:

data - array of doubles for constructor, up to 16 values used

Method Details

jsConstructor

public void jsConstructor(double f11,
 double f12,
 double f13,
 double f14,
 double f21,
 double f22,
 double f23,
 double f24,
 double f31,
 double f32,
 double f33,
 double f34,
 double f41,
 double f42,
 double f43,
 double f44)

has

public boolean has(int index,
 org.mozilla.javascript.Scriptable start)

Check to see if a numeric property is valid. We only accept the first 16 as that is the dimension of the array.

Specified by:

has in interface org.mozilla.javascript.Scriptable

Overrides:

has in class FieldScriptableObject

Parameters:

index - the index of the property

start - the object where lookup began

Returns:

true if 0 < index < 16

get

public Object get(int index,
 org.mozilla.javascript.Scriptable start)

Look up the element in the associated matrix and return it if it exists. If it doesn't exist return

Specified by:

get in interface org.mozilla.javascript.Scriptable

Overrides:

get in class FieldScriptableObject

Parameters:

index - the index of the integral property

start - the object where the lookup began

Returns:

element or NOT_FOUND

get

public Object get(String name,
 org.mozilla.javascript.Scriptable start)

Get the value of the named function. If no function object is registered for this name, the method will return null.

Specified by:

get in interface org.mozilla.javascript.Scriptable

Overrides:

get in class FieldScriptableObject

Parameters:

name - The variable name

start - The object where the lookup began

Returns:

the corresponding function object or null

put

public void put(int index,
 org.mozilla.javascript.Scriptable start,
 Object value)

Set an indexed property. Only accept the first 16 values.

Specified by:

put in interface org.mozilla.javascript.Scriptable

Overrides:

put in class FieldScriptableObject

Parameters:

index - The index of the property to look up

start - The object where the lookup began

value - The value of the object to use

put

public void put(String name,
 org.mozilla.javascript.Scriptable start,
 Object value)

Sets the named property with a new value. A put usually means changing the entire property. So, if the property has changed using an operation like e = new SFColor(0, 1, 0); then a whole new object is passed to us.

Specified by:

put in interface org.mozilla.javascript.Scriptable

Overrides:

put in class FieldScriptableObject

Parameters:

name - The name of the property to define

start - The object who's property is being set

value - The value being requested

jsFunction_setTransform

public void jsFunction_setTransform(org.mozilla.javascript.Scriptable trans,
 org.mozilla.javascript.Scriptable rot,
 org.mozilla.javascript.Scriptable scale,
 org.mozilla.javascript.Scriptable scaleOrient,
 org.mozilla.javascript.Scriptable center)

Set the transform to the new values of translation, rotation, scale etc. Takes a variable list of arguments. Anything more than 5 and we ignore the extras. There may by up to 5 items in the array. Zero items means to set the array to an identity matrix. After that, the arguments are:

Parameters:

trans - translation

rot - rotation

scale - scale

scaleOrient - scaleOrientation

center - center

jsFunction_getTransform

public void jsFunction_getTransform(org.mozilla.javascript.Scriptable tx,
 org.mozilla.javascript.Scriptable rot,
 org.mozilla.javascript.Scriptable sc)

Get the value of the transform.

Parameters:

tx - The transform component

rot - The orientation component

sc - The scale component

jsFunction_inverse

public Matrix4 jsFunction_inverse()

Create the inverse of the matrix and return that in a new matrix.

Returns:

inverse Matrix4

jsFunction_transpose

public Matrix4 jsFunction_transpose()

Create the transpose of this matrix and return it in a new matrix.

Returns:

A matrix containing the transpose of this one

jsFunction_multLeft

public Matrix4 jsFunction_multLeft(org.mozilla.javascript.Scriptable m)

Multiply the passed matrix this matrix and return the value in a new matrix instance.

Parameters:

m - The left hand matrix to use

Returns:

A new matrix with the new values

jsFunction_multRight

public Matrix4 jsFunction_multRight(org.mozilla.javascript.Scriptable m)

Multiply this matrix by the passed matrix and return the value in a new matrix instance.

Parameters:

m - The left hand matrix to use

Returns:

A new matrix with the new values

jsFunction_multVecMatrix

public SFVec3f jsFunction_multVecMatrix(org.mozilla.javascript.Scriptable vector)

Return a vector that is this multiplied by the given vector as a row.

Parameters:

vector - The row vector to use for multiplication

Returns:

A new vector containing the results

jsFunction_multMatrixVec

public SFVec3f jsFunction_multMatrixVec(org.mozilla.javascript.Scriptable vector)

Return a vector that is this multiplied by the given vector as a column.

Parameters:

vector - The column vector to use for multiplication

Returns:

A new vector containing the results

jsFunction_toString

public String jsFunction_toString()

Creates a string version of this node. Just calls the standard toString() method of the object.

Returns:

A VRML string representation of the field

jsFunction_equals

public boolean jsFunction_equals(Object val)

Comparison of this object to another of the same type. Just calls the standard equals() method of the object.

Parameters:

val - The value to compare to this object

Returns:

true if the components of the object are the same

toString

public String toString()

Format the internal values of this matrix as a string. Does some nice pretty formatting.

Overrides:

toString in class Object

Returns:

A string representation of this matrix