wobs.java.player
Class JavaWob

java.lang.Object
  com.wirefusion.player.Wob
      wobs.java.player.JavaWob

public abstract class JavaWob
extends Wob

The super class of all "Java Object" classes.

Constructor Summary

JavaWob()

Method Summary

void	destroy() Called to inform this object that it is being reclaimed and that it should destroy any resources that it has allocated.
void	init() Override this method to initialize this Wob.
void	send2DNumber(java.lang.String portName, double x, double y) Sends a 2D Number through the port named 'portName'.
void	sendBoolean(java.lang.String portName, boolean arg) Sends a Boolean through the port named 'portName'.
void	sendColor(java.lang.String portName, int color) Sends a Color through the port named 'portName'.
void	sendNumber(java.lang.String portName, double arg) Sends a Number through the port named 'portName'.
void	sendPulse(java.lang.String portName) Sends a Pulse through the port named 'portName'.
void	sendText(java.lang.String portName, java.lang.String arg) Sends a Text through the port named 'portName'.

Methods inherited from class com.wirefusion.player.Wob

addChild, addFocusListener, addInteractiveSceneChild, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, contains, disableEvents, enableEvents, filterPixels, getAwtComponent, getBounds, getChild, getChildren, getCore, getCursor, getInPort, getMemoryUsage, getName, getOutPort, getParent, getResource, getResourceById, getSize, isFocusable, isVisible, paint, prepareForSceneRender, printMemoryUsageInfo, processComponentEvent, processEvent, processFocusEvent, processInportEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, processPlayerEvent, readData, removeChild, repaint, repaint, requestFocus, send, sendBoolean, sendColor, sendNumber, sendNumber2D, sendPulse, sendText, setBounds, setCursor, setLayer, setLocation, setName, setSize, setVisible, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaWob

public JavaWob()

Method Detail

destroy

public void destroy()

Description copied from class: Wob

Called to inform this object that it is being reclaimed and that it should destroy any resources that it has allocated. A subclass of Wob should override this method if it has any operation that it wants to perform before it is destroyed. For example, a Wob with threads would use the init method to create the threads and the destroy method to kill them.

Overrides:

destroy in class Wob

init

public void init()

Override this method to initialize this Wob. The player may not be ready for sending events at this point, so do not send events to other Wobs here.

Overrides:

init in class Wob

sendPulse

public void sendPulse(java.lang.String portName)

Sends a Pulse through the port named 'portName'. The portName argument MUST be a String object and not a reference to a String object. Before the source is compiled by the Java Object, it will be parsed, and the portName argument in calls to this method will be used for automatic port creation.

Parameters:

portName - the port name

sendNumber

public void sendNumber(java.lang.String portName,
                       double arg)

Sends a Number through the port named 'portName'. The portName argument MUST be a String object and not a reference to a String object. Before the source is compiled by the Java Object, it will be parsed, and the portName argument in calls to this method will be used for automatic port creation.

Parameters:

portName - the port name

arg - the number

sendBoolean

public void sendBoolean(java.lang.String portName,
                        boolean arg)

Sends a Boolean through the port named 'portName'. The portName argument MUST be a String object and not a reference to a String object. Before the source is compiled by the Java Object, it will be parsed, and the portName argument in calls to this method will be used for automatic port creation.

Parameters:

portName - the port name

arg - the boolean value

sendText

public void sendText(java.lang.String portName,
                     java.lang.String arg)

Sends a Text through the port named 'portName'. The portName argument MUST be a String object and not a reference to a String object. Before the source is compiled by the Java Object, it will be parsed, and the portName argument in calls to this method will be used for automatic port creation.

Parameters:

portName - the port name

arg - the text

send2DNumber

public void send2DNumber(java.lang.String portName,
                         double x,
                         double y)

Sends a 2D Number through the port named 'portName'. The portName argument MUST be a String object and not a reference to a String object. Before the source is compiled by the Java Object, it will be parsed, and the portName argument in calls to this method will be used for automatic port creation.

Parameters:

portName - the port name

x - the x value

y - the y value

sendColor

public void sendColor(java.lang.String portName,
                      int color)

Sends a Color through the port named 'portName'. The portName argument MUST be a String object and not a reference to a String object. Before the source is compiled by the Java Object, it will be parsed, and the portName argument in calls to this method will be used for automatic port creation.

Parameters:

portName - the port name

color - an RGB value consisting of the red component in bits 16-23, the green component in bits 8-15, and the blue component in bits 0-7.