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

Class SFNode

java.lang.Object

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

org.web3d.vrml.scripting.ecmascript.builtin.NodeFieldObject

org.web3d.vrml.scripting.ecmascript.builtin.SFNode

All Implemented Interfaces:

org.mozilla.javascript.Scriptable, NodeImplSource

public class SFNode
extends NodeFieldObject
implements NodeImplSource

SFNode field object wrapper for ECMAScript.

The node implementation works by dynamically querying the underlying node for fields. Once it finds a field, it will cache the details internally. We do this because scripts generally tend to operate on only a few fields of a given node, but when they do, they access that field very regularly.

Version:

$Revision: 1.26 $

Author:

Justin Couch

Field Summary

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

parentFieldIndex, parentNode

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
SFNode()	Default public constructor required by Rhino for when created by an Ecmascript call.
SFNode(VRMLNodeType n)	Construct the class based on a real node.
SFNode(VRMLNodeType parent, int fieldIndex, VRMLNodeType n)	Construct the class based on a real 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(String name, org.mozilla.javascript.Scriptable start)	Get the value of the named function.
Object	getChangedFields()	Get the list of fields that have changed.
VRMLNodeType	getImplNode()	Get the underlying node that this object represents.
boolean	has(String name, org.mozilla.javascript.Scriptable start)
boolean	hasChanged()	Query this field object to see if it has changed since the last time this method was called.
void	jsConstructor(String vrmlSyntax)
boolean	jsFunction_equals(Object val)	Comparison of this object to another of the same type.
FieldDefinitionArray	jsFunction_getFieldDefinitions()	Get the objects field declarations.
String	jsFunction_getNodeName()	Get the objects node name
String	jsFunction_toString()	Creates a string version of this node.
void	put(String name, org.mozilla.javascript.Scriptable start, Object value)	Sets the named property with a new value.
void	realize()	If the node contains a node instance, check and call its setupFinished if needed.
String	toString()	Format the internal values of this field as a string.

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

setParentField

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

SFNode

public SFNode()

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

SFNode

public SFNode(VRMLNodeType n)

Construct the class based on a real node.

Parameters:

n - The node that this wraps

SFNode

public SFNode(VRMLNodeType parent,
 int fieldIndex,
 VRMLNodeType n)

Construct the class based on a real node.

Parameters:

parent - The parent node of this field

fieldIndex - The index of the field that this field wraps

n - The node that this wraps

Method Details

jsConstructor

public void jsConstructor(String vrmlSyntax)

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(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(String name,
 org.mozilla.javascript.Scriptable start,
 Object value)

Description copied from class: FieldScriptableObject

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 SFVec3f(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_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

jsFunction_getNodeName

public String jsFunction_getNodeName()

Get the objects node name

Returns:

The node name

jsFunction_getFieldDefinitions

public FieldDefinitionArray jsFunction_getFieldDefinitions()

Get the objects field declarations.

Returns:

The field declarations

getChangedFields

public Object getChangedFields()

Get the list of fields that have changed. The return value may be either a single NodeFieldData instance or an ArrayList of field data instances if more than one has changed. When called, this is recursive so that all fields and nodes referenced by this node field will be included. If no fields have changed, this will return null. However, that should never happen as the user should always check FieldScriptableObject.hasChanged() which would return false before calling this method.

Specified by:

getChangedFields in class NodeFieldObject

Returns:

A single NodeFieldData, ArrayList or null

realize

public void realize()

If the node contains a node instance, check and call its setupFinished if needed.

Specified by:

realize in class NodeFieldObject

hasChanged

public boolean hasChanged()

Query this field object to see if it has changed since the last time this method was called. In a single-threaded environment, calling this method twice should return true and then false (assuming that data had changed since the previous calls).

Overrides:

hasChanged in class FieldScriptableObject

Returns:

true if the data has changed.

getImplNode

public VRMLNodeType getImplNode()

Get the underlying node that this object represents.

Specified by:

getImplNode in interface NodeImplSource

Returns:

The node reference

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