Package org.web3d.vrml.scripting.external.eai

Class EAINode

java.lang.Object

vrml.eai.Node

org.web3d.vrml.scripting.external.eai.EAINode

All Implemented Interfaces:

Runnable

public class EAINode
extends Node
implements Runnable

EAINode is a simple implementation of the vrml.eai.Node class. It serves simply as a wrapper around the VRMLNodeType implementation, although that task does include producing wrappers around the various EventIn and EventOut classes.

Version:

1.0

Author:

Brad Vender

Method Summary

Modifier and Type	Method	Description
void	dispose()	Dispose of this node's resources.
boolean	equals(Object other)
EventIn	getEventIn(String eventName)	Get an eventIn for this node.
EventOut	getEventOut(String eventName)	Get an eventOut for this node.
String	getType()	Get the type of this node.
void	run()

Methods inherited from class java.lang.Object

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

Method Details

getEventIn

public EventIn getEventIn(String eventName)
                   throws InvalidEventInException,
InvalidNodeException

Description copied from class: Node

Get an eventIn for this node.

If the basic field required is an exposedField you can use either the standard name (such as translation) or you can use the set_ modifier (such as set_translation).

Specified by:

getEventIn in class Node

Parameters:

eventName - The name of the eventIn that is required

Returns:

A reference to the eventIn requested.

Throws:

InvalidEventInException - The named eventIn does not exist for this node.

InvalidNodeException - The node has had it's resources disposed of

getEventOut

public EventOut getEventOut(String eventName)
                     throws InvalidEventOutException,
InvalidNodeException

Description copied from class: Node

Get an eventOut for this node.

If the basic field required is an exposedField you can use either the standard name (such as translation) or you can use the _changed modifier (such as translation_changed).

Specified by:

getEventOut in class Node

Parameters:

eventName - The name of the eventIn that is required

Returns:

A reference to the eventIn requested.

Throws:

InvalidEventOutException - The named eventIn does not exist for this node.

InvalidNodeException - The node has had it's resources disposed of

getType

public String getType()
               throws InvalidNodeException

Description copied from class: Node

Get the type of this node. The string returned should be the name of the VRML node or the name of the proto instance this node represents.

Specified by:

getType in class Node

Returns:

The type of this node.

Throws:

InvalidNodeException - The node has had it's resources disposed of

equals

public boolean equals(Object other)

Overrides:

equals in class Object

dispose

public void dispose()
             throws InvalidNodeException

Description copied from class: Node

Dispose of this node's resources. This is used to indicate to the browser that the java side of the application does not require the resources represented by this node. The browser is now free to do what it likes with the node.

This in no way implies that the browser is to remove this node from the scene graph, only that the java applet is no longer interested in this particular node through this reference.

Once this method has been called, any further calls to methods of this instance of the class is will generate an InvalidNodeException.

Specified by:

dispose in class Node

Throws:

InvalidNodeException - The node is no longer valid and can't be disposed of again.

run

public void run()

Specified by:

run in interface Runnable