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

Class SFVec3f

java.lang.Object

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

org.web3d.vrml.scripting.ecmascript.builtin.SFVec3f

All Implemented Interfaces:

org.mozilla.javascript.Scriptable

public class SFVec3f
extends FieldScriptableObject

SFVec3f field object.

Version:

$Revision: 1.17 $

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
SFVec3f()	Default public constructor required by Rhino for when created by an Ecmascript call.
SFVec3f(double[] vec)	Alternate constructor that takes a double array rather than a float array.
SFVec3f(float[] vec)	Construct a field based on the given array of data (sourced from a node).

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object val)	Compares two objects for equality base on the components being the same.
Object	get(int index, org.mozilla.javascript.Scriptable start)
Object	get(String name, org.mozilla.javascript.Scriptable start)	Get the value of the named function.
void	getRawData(double[] value)	Fetch the raw data held by this instance and copy it into the provided array.
void	getRawData(float[] value)	Fetch the raw data held by this instance and copy it into the provided array as float values.
boolean	has(int index, org.mozilla.javascript.Scriptable start)
boolean	has(String name, org.mozilla.javascript.Scriptable start)
void	jsConstructor(double x, double y, double z)	Constructor for all three values that rhino calls.
SFVec3f	jsFunction_add(org.mozilla.javascript.Scriptable newVector)	Add this vector to the given vector and return the value as a new vector.
SFVec3f	jsFunction_cross(org.mozilla.javascript.Scriptable newVector)	Calculate the cross product of this vector and the given vector
SFVec3f	jsFunction_divide(double n)	Divide this vector by the given scalar value and return the result in a new vector
double	jsFunction_dot(org.mozilla.javascript.Scriptable newVector)	Calculate the dot product of this vector and the passed vector.
boolean	jsFunction_equals(Object val)	Comparison of this object to another of the same type.
double	jsFunction_length()	Calculate the length of the vector.
SFVec3f	jsFunction_multiply(double n)	Multiply this vector by the scalar amount and return the result in a new vector.
SFVec3f	jsFunction_negate()	Generate a vector with the negated version of each of the components.
SFVec3f	jsFunction_normalize()	Generate the normalised version of this vector and return it.
SFVec3f	jsFunction_subtract(org.mozilla.javascript.Scriptable newVector)	Subtract the given vector from this vector and return the results in a new object.
String	jsFunction_toString()	Creates a string version of this node.
void	put(int index, org.mozilla.javascript.Scriptable start, Object value)	Sets a property based on the index.
void	put(String name, org.mozilla.javascript.Scriptable start, Object value)	Sets the named property with a new value.
void	setRawData(double[] values)	Convenience method to reset the values used by this instance.
void	setRawData(double x, double y, double z)	Convenience method to reset the values used by this instance.
void	setRawData(float[] values)	Convenience method to reset the values used by this instance.
String	toString()	Format the internal values of this field as a string.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

SFVec3f

public SFVec3f()

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

SFVec3f

public SFVec3f(float[] vec)

Construct a field based on the given array of data (sourced from a node).

Parameters:

vec - the given array of data

SFVec3f

public SFVec3f(double[] vec)

Alternate constructor that takes a double array rather than a float array. Used primarily by the VrmlMatrix code.

Parameters:

vec - the given array of data

Method Details

jsConstructor

public void jsConstructor(double x,
 double y,
 double z)

Constructor for all three values that rhino calls.

Parameters:

x - The X component of the vector

y - The Y component of the vector

z - The Z component of the vector

has

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

Specified by:

has in interface org.mozilla.javascript.Scriptable

Overrides:

has in class FieldScriptableObject

has

public boolean has(String name,
 org.mozilla.javascript.Scriptable start)

Specified by:

has in interface org.mozilla.javascript.Scriptable

Overrides:

has in class FieldScriptableObject

get

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

Specified by:

get in interface org.mozilla.javascript.Scriptable

Overrides:

get in class FieldScriptableObject

get

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

Description copied from class: FieldScriptableObject

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)

Sets a property based on the index.

Specified by:

put in interface org.mozilla.javascript.Scriptable

Overrides:

put in class FieldScriptableObject

Parameters:

index - The index of the property to set

start - The object who's property is being set

value - The value being requested

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_add

public SFVec3f jsFunction_add(org.mozilla.javascript.Scriptable newVector)

Add this vector to the given vector and return the value as a new vector.

Parameters:

newVector - The vector to add to this vector

Returns:

The addition of the two objects

jsFunction_cross

public SFVec3f jsFunction_cross(org.mozilla.javascript.Scriptable newVector)

Calculate the cross product of this vector and the given vector

Parameters:

newVector - The vector to do the cross product with

Returns:

The product

jsFunction_divide

public SFVec3f jsFunction_divide(double n)

Divide this vector by the given scalar value and return the result in a new vector

Parameters:

n - The scalar to divide the objects by

Returns:

The addition of the two objects

jsFunction_dot

public double jsFunction_dot(org.mozilla.javascript.Scriptable newVector)

Calculate the dot product of this vector and the passed vector.

Parameters:

newVector - The vector to make the calculation with

Returns:

The value of the dot product

jsFunction_length

public double jsFunction_length()

Calculate the length of the vector.

Returns:

The length of the vector

jsFunction_multiply

public SFVec3f jsFunction_multiply(double n)

Multiply this vector by the scalar amount and return the result in a new vector.

Parameters:

n - The scalar to divide the objects by

Returns:

The addition of the two objects

jsFunction_negate

public SFVec3f jsFunction_negate()

Generate a vector with the negated version of each of the components.

Returns:

A negated version of this vector

jsFunction_normalize

public SFVec3f jsFunction_normalize()

Generate the normalised version of this vector and return it.

Returns:

The normalised form of this vector

jsFunction_subtract

public SFVec3f jsFunction_subtract(org.mozilla.javascript.Scriptable newVector)

Subtract the given vector from this vector and return the results in a new object.

Parameters:

newVector - The vector to subtract from this one

Returns:

The difference between the two

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 field as a string. Does some nice pretty formatting.

Overrides:

toString in class Object

Returns:

A string representation of this field

equals

public boolean equals(Object val)

Compares two objects for equality base on the components being the same.

Overrides:

equals in class Object

Parameters:

val - The value to compare to this object

Returns:

true if the components of the object are the same

getRawData

public void getRawData(float[] value)

Fetch the raw data held by this instance and copy it into the provided array as float values.

Parameters:

value - The array to copy the data into

getRawData

public void getRawData(double[] value)

Fetch the raw data held by this instance and copy it into the provided array.

Parameters:

value - The array to copy the data into

setRawData

public void setRawData(float[] values)

Convenience method to reset the values used by this instance. Typically used by the VrmlMatrix class, but others may use this too. It does not set the data changed flag when called.

Parameters:

values - The new values to use

setRawData

public void setRawData(double[] values)

Convenience method to reset the values used by this instance. Typically used by the VrmlMatrix class, but others may use this too. It does not set the data changed flag when called.

Parameters:

values - The new values to use

setRawData

public void setRawData(double x,
 double y,
 double z)

Convenience method to reset the values used by this instance. Typically used by the VrmlMatrix class, but others may use this too. It does not set the data changed flag when called.

Parameters:

x - The new x value to use

y - The new y value to use

z - The new z value to use