j3d-vrml97-0.1.0

vrml.node
Class Script

java.lang.Object
  extended by vrml.BaseNode
      extended by vrml.node.Script

public class Script
extends BaseNode

This is the base class for VRML scripts.


Field Summary
 
Fields inherited from class vrml.BaseNode
implBaseNode
 
Constructor Summary
Script()
          Constructor for the Script object
Script(Script init)
          This is the internal constructor, called only when the Script is being initialized by the Loader.
 
Method Summary
 Object clone()
          Description of the Method
 void eventsProcessed()
          Called after every invocation of processEvents()
 Browser getBrowser()
          Gets the browser attribute of the Script object
protected  Field getEventIn(String eventInName)
          Returns the EventIn specified in the VRML which invokes the script
protected  Field getEventOut(String eventOutName)
          Returns the EventOut specified in the VRML which invokes the script
protected  Field getField(String fieldName)
          Returns the Field specified in the VRML which invokes the script
 String getType()
          Gets the type attribute of the Script object
 void initialize()
          Called before any event is generated
 void processEvent(Event event)
          Called when there is an Event to be processed
 void processEvents(int count, Event[] events)
          Called when there are Events to be processed
 void registerOwner(Script s)
          This is an internal method, used to link the Script to its implementaton
 void shutdown()
          Called when the Script node is deleted
 
Methods inherited from class vrml.BaseNode
browserImpl, getImpl, getImplNode
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Script

public Script()
Constructor for the Script object


Script

public Script(Script init)
This is the internal constructor, called only when the Script is being initialized by the Loader.

Parameters:
init - Description of the Parameter
Method Detail

clone

public Object clone()
Description of the Method

Overrides:
clone in class Object
Returns:
Description of the Return Value

getType

public String getType()
Gets the type attribute of the Script object

Specified by:
getType in class BaseNode
Returns:
The type value

getBrowser

public Browser getBrowser()
Gets the browser attribute of the Script object

Specified by:
getBrowser in class BaseNode
Returns:
The browser value

registerOwner

public void registerOwner(Script s)
This is an internal method, used to link the Script to its implementaton

Parameters:
s - Description of the Parameter

getField

protected final Field getField(String fieldName)
                        throws InvalidFieldException
Returns the Field specified in the VRML which invokes the script

Parameters:
fieldName - Description of the Parameter
Returns:
The field value
Throws:
InvalidFieldException - Description of the Exception

getEventOut

protected final Field getEventOut(String eventOutName)
                           throws InvalidEventOutException
Returns the EventOut specified in the VRML which invokes the script

Parameters:
eventOutName - Description of the Parameter
Returns:
The eventOut value
Throws:
InvalidEventOutException - Description of the Exception

getEventIn

protected final Field getEventIn(String eventInName)
                          throws InvalidEventInException
Returns the EventIn specified in the VRML which invokes the script

Parameters:
eventInName - Description of the Parameter
Returns:
The eventIn value
Throws:
InvalidEventInException - Description of the Exception

initialize

public void initialize()
Called before any event is generated


processEvents

public void processEvents(int count,
                          Event[] events)
Called when there are Events to be processed

Parameters:
count - Description of the Parameter
events - Description of the Parameter

processEvent

public void processEvent(Event event)
Called when there is an Event to be processed

Parameters:
event - Description of the Parameter

eventsProcessed

public void eventsProcessed()
Called after every invocation of processEvents()


shutdown

public void shutdown()
Called when the Script node is deleted


j3d-vrml97-0.1.0

Todo: put BSD License reference here..