Package org.web3d.vrml.scripting.ecmascript.x3d

Class X3DExecutionContext

java.lang.Object

org.web3d.vrml.scripting.ecmascript.builtin.AbstractScriptableObject

org.web3d.vrml.scripting.ecmascript.x3d.X3DExecutionContext

All Implemented Interfaces:

org.mozilla.javascript.Scriptable

Direct Known Subclasses:

Scene

public class X3DExecutionContext
extends AbstractScriptableObject

X3DExecutionContext prototype object.

Version:

$Revision: 1.22 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected final ComponentInfoArray	components	The list of components in use
protected final String	encoding	The encoding type constant
protected org.j3d.util.ErrorReporter	errorReporter	Class that represents the external reporter
protected VRMLExecutionSpace	executionSpace	The execution space that this context works in
protected ExternProtoDeclarationArray	externprotos	The list of extern protos declared
protected static final org.j3d.util.HashSet<String>	functionNames	Set of the valid function names for this object
protected Map<String,VRMLNode>	importMap	map containing imports info
protected List<SFNode>	nodeWrapperList	Listing of all the valid X3DNode wrappers.
protected Map<VRMLNodeType,SFNode>	nodeWrapperMap	Mapping of the VRMLNodeType to its X3DNode wrapper
protected final ProfileInfo	profile	The list of profiles in use
protected static final org.j3d.util.HashSet<String>	propertyNames	Set of the valid property names for this object
protected ProtoDeclarationArray	protos	The array of protos declared
protected MFNode	rootNodes	Listing of root nodes
protected RouteManager	routeManager	Route manager for handling user added/removed routes
protected BasicScene	scene	The basic scene type
protected boolean	sceneChanged	Flag to indicate part of the scene infrastructure has changed
protected final String	specVersion	The version of the specification represented
protected FrameStateManager	stateManager	FrameState manager for creating nodes
protected final String	url	The world URL

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

BAD_FORMAT_MSG, dataChanged, INVALID_TYPE_MSG, JS_FUNCTION_PREFIX, readOnly, READONLY_MSG

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
X3DExecutionContext(VRMLExecutionSpace space, RouteManager rm, FrameStateManager fsm, ProfileInfo profile)	Construct an execution context descriptor for the given information.

Method Summary

Modifier and Type	Method	Description
Object	get(String name, org.mozilla.javascript.Scriptable start)	Get the value of the named function.
Object	getChangedData()	Get the list of fields that have changed.
boolean	has(String name, org.mozilla.javascript.Scriptable start)	Check for the named property presence.
Route	jsFunction_addRoute(org.mozilla.javascript.Scriptable fn, String fromField, org.mozilla.javascript.Scriptable tn, String toField)	addRoute() function defined by From table 6.6.
SFNode	jsFunction_createNode(String name)	createNode() function defined by From table 6.6.
SFNode	jsFunction_createProto(String name)	createProto() function defined by From table 6.6.
void	jsFunction_deleteRoute(org.mozilla.javascript.Scriptable r)	deleteRoute() function defined by From table 6.6
SFNode	jsFunction_getImportedNode(String defName, String asName)	getImportedNode() function defined by From table 7.8.
SFNode	jsFunction_getNamedNode(String name)	getNamedNode() function defined by From table 6.6.
void	jsFunction_removeImportedNode(String name)	getImportedNode() function defined by From table 7.8.
void	jsFunction_removeNamedNode(String name)	removeNamedNode() function defined by From table 6.6.
void	jsFunction_updateImportedNode(String name, String newName)	updateImportedNode() function defined by From table 7.8.
void	jsFunction_updateNamedNode(String name, org.mozilla.javascript.Scriptable node)	updateNamedNode() function defined by From table 6.6.
protected org.mozilla.javascript.FunctionObject	locateFunction(String methodName)	Convenience method to locate a function name for this object and create an appropriate Function instance to represent it.
void	put(String name, org.mozilla.javascript.Scriptable start, Object value)	Sets the named property with a new value.
protected void	registerFunction(String name, Object value)	Register a function object with this field type
void	setErrorReporter(org.j3d.util.ErrorReporter reporter)	Register an error reporter with the engine so that any errors generated by the script code can be reported in a nice, pretty fashion.

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

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

Methods inherited from class java.lang.Object

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

Field Details

propertyNames

protected static final org.j3d.util.HashSet<String> propertyNames

Set of the valid property names for this object

functionNames

protected static final org.j3d.util.HashSet<String> functionNames

Set of the valid function names for this object

specVersion

protected final String specVersion

The version of the specification represented

encoding

protected final String encoding

The encoding type constant

profile

protected final ProfileInfo profile

The list of profiles in use

components

protected final ComponentInfoArray components

The list of components in use

errorReporter

protected org.j3d.util.ErrorReporter errorReporter

Class that represents the external reporter

url

protected final String url

The world URL

rootNodes

protected MFNode rootNodes

Listing of root nodes

protos

protected ProtoDeclarationArray protos

The array of protos declared

externprotos

protected ExternProtoDeclarationArray externprotos

The list of extern protos declared

executionSpace

protected VRMLExecutionSpace executionSpace

The execution space that this context works in

scene

protected BasicScene scene

The basic scene type

routeManager

protected RouteManager routeManager

Route manager for handling user added/removed routes

stateManager

protected FrameStateManager stateManager

FrameState manager for creating nodes

nodeWrapperList

protected List<SFNode> nodeWrapperList

Listing of all the valid X3DNode wrappers.

nodeWrapperMap

protected Map<VRMLNodeType,SFNode> nodeWrapperMap

Mapping of the VRMLNodeType to its X3DNode wrapper

importMap

protected Map<String,VRMLNode> importMap

map containing imports info

sceneChanged

protected boolean sceneChanged

Flag to indicate part of the scene infrastructure has changed

Constructor Details

X3DExecutionContext

public X3DExecutionContext(VRMLExecutionSpace space,
 RouteManager rm,
 FrameStateManager fsm,
 ProfileInfo profile)

Construct an execution context descriptor for the given information.

Parameters:

space - The space to source information for this scene

rm - A route manager for users creating/removing routes

fsm -

profile - Instance of the ProfileInfo that describes this scene

Method Details

setErrorReporter

public void setErrorReporter(org.j3d.util.ErrorReporter reporter)

Register an error reporter with the engine so that any errors generated by the script code can be reported in a nice, pretty fashion. Setting a value of null will clear the currently set reporter. If one is already set, the new value replaces the old. Also changes the ErrorReporter used by the CommonBrowser instance.

Parameters:

reporter - The instance to use or null

has

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

Check for the named property presence.

Specified by:

has in interface org.mozilla.javascript.Scriptable

Overrides:

has in class AbstractScriptableObject

Parameters:

name - name of the script

start - the script corresponding to the given name

Returns:

true if it is a defined eventOut or field

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 AbstractScriptableObject

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)

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 AbstractScriptableObject

Parameters:

name - The name of the property to define

start - The object who's property is being set

value - The value being requested

jsFunction_addRoute

public Route jsFunction_addRoute(org.mozilla.javascript.Scriptable fn,
 String fromField,
 org.mozilla.javascript.Scriptable tn,
 String toField)

addRoute() function defined by From table 6.6.

Parameters:

fn -

fromField -

tn -

toField -

Returns:

jsFunction_deleteRoute

public void jsFunction_deleteRoute(org.mozilla.javascript.Scriptable r)

deleteRoute() function defined by From table 6.6

Parameters:

r -

jsFunction_createNode

public SFNode jsFunction_createNode(String name)

createNode() function defined by From table 6.6.

Parameters:

name -

Returns:

jsFunction_createProto

public SFNode jsFunction_createProto(String name)

createProto() function defined by From table 6.6.

Parameters:

name -

Returns:

jsFunction_getNamedNode

public SFNode jsFunction_getNamedNode(String name)

getNamedNode() function defined by From table 6.6.

Parameters:

name -

Returns:

jsFunction_updateNamedNode

public void jsFunction_updateNamedNode(String name,
 org.mozilla.javascript.Scriptable node)

updateNamedNode() function defined by From table 6.6.

Parameters:

name -

node -

jsFunction_removeNamedNode

public void jsFunction_removeNamedNode(String name)

removeNamedNode() function defined by From table 6.6.

Parameters:

name -

jsFunction_getImportedNode

public SFNode jsFunction_getImportedNode(String defName,
 String asName)

getImportedNode() function defined by From table 7.8.

Parameters:

defName -

asName -

Returns:

jsFunction_updateImportedNode

public void jsFunction_updateImportedNode(String name,
 String newName)

updateImportedNode() function defined by From table 7.8.

Parameters:

name -

newName -

jsFunction_removeImportedNode

public void jsFunction_removeImportedNode(String name)

getImportedNode() function defined by From table 7.8.

Parameters:

name -

getChangedData

public Object getChangedData()

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.

Returns:

A single NodeFieldData, ArrayList or null

registerFunction

protected void registerFunction(String name,
 Object value)

Register a function object with this field type

Parameters:

name - The name to associate it with

value - The object to keep this as

locateFunction

protected org.mozilla.javascript.FunctionObject locateFunction(String methodName)

Convenience method to locate a function name for this object and create an appropriate Function instance to represent it. It assumes that the name you give it is the normal name and will add a "jsFunction_" prefix to locate that from the method details. There is also the implicit assumption that you have made a check for this name being a valid function for this object before you call this method. If a function object is found for this method, it will automatically be registered and you can also have a copy of it returned to use.

Parameters:

methodName - The real method name to look for

Returns:

The function object corresponding to the munged method name