Package org.web3d.vrml.scripting.external.neteai

Class EventOutSFBoolWrapper

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventOut

vrml.eai.field.EventOutSFBool

org.web3d.vrml.scripting.external.neteai.EventOutSFBoolWrapper

public class EventOutSFBoolWrapper
extends EventOutSFBool

Client side implementation of EventOutSFBoolWrapper field. EventOut fields which are used by the vrmlEventChanged broadcast system report only their stored value. EventOut fields produced by Node.getEventOut report only the 'live' value of the field.

Field Summary

Fields inherited from class vrml.eai.field.BaseField

fieldType, MFColor, MFFloat, MFInt32, MFNode, MFRotation, MFString, MFTime, MFVec2f, MFVec3f, SFBool, SFColor, SFFloat, SFImage, SFInt32, SFNode, SFRotation, SFString, SFTime, SFVec2f, SFVec3f, UNSET_FIELD

Constructor Summary

Constructors

Constructor	Description
EventOutSFBoolWrapper(int fieldID, FieldAndNodeRequestProcessor requestProcessor)
EventOutSFBoolWrapper(int fieldID, FieldAndNodeRequestProcessor requestProcessor, DataInputStream source)

Method Summary

Modifier and Type	Method	Description
void	addVrmlEventListener(VrmlEventListener l)	Add a listener for changes in this eventOut.
boolean	equals(Object other)	Two fields are equal if they point to the same actual node and field
int	getFieldID()
int	getType()	The type of the underlying field.
Object	getUserData()	Get the user data that is associated with this eventOut
boolean	getValue()	Get the value in the given eventOut.
int	hashCode()	In order to make the event queueing system easier, and since an equals method is required by the specification, compute the hashcode based on the field number and underlying node hashcode.
void	loadFieldValue(DataInputStream input)
void	removeVrmlEventListener(VrmlEventListener l)	Remove a listener for changes in this eventOut.
void	setUserData(Object data)	Associate user data with this event.
void	writeFieldValue(DataOutputStream output)

Methods inherited from class vrml.eai.field.BaseField

getType

Methods inherited from class java.lang.Object

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

Constructor Details

EventOutSFBoolWrapper

public EventOutSFBoolWrapper(int fieldID,
 FieldAndNodeRequestProcessor requestProcessor)

Parameters:

fieldID - The network field ID

requestProcessor - Handler for field services

EventOutSFBoolWrapper

public EventOutSFBoolWrapper(int fieldID,
 FieldAndNodeRequestProcessor requestProcessor,
 DataInputStream source)
                      throws IOException

Parameters:

fieldID - The network field ID

requestProcessor - Handler for field services

source - The stream to read field values from

Throws:

IOException

Method Details

equals

public boolean equals(Object other)

Two fields are equal if they point to the same actual node and field

Overrides:

equals in class Object

Parameters:

other - The object to compare against

getFieldID

public int getFieldID()

getValue

public boolean getValue()

Description copied from class: EventOutSFBool

Get the value in the given eventOut.

Specified by:

getValue in class EventOutSFBool

Returns:

The boolean value of the eventOut

hashCode

public int hashCode()

In order to make the event queueing system easier, and since an equals method is required by the specification, compute the hashcode based on the field number and underlying node hashcode.

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

addVrmlEventListener

public void addVrmlEventListener(VrmlEventListener l)

Description copied from class: EventOut

Add a listener for changes in this eventOut.

Specified by:

addVrmlEventListener in class EventOut

Parameters:

l - The listener to add

See Also:

• EventOut.addVrmlEventListener(vrml.eai.event.VrmlEventListener)

removeVrmlEventListener

public void removeVrmlEventListener(VrmlEventListener l)

Description copied from class: EventOut

Remove a listener for changes in this eventOut.

Specified by:

removeVrmlEventListener in class EventOut

Parameters:

l - The listener to remove

See Also:

• EventOut.removeVrmlEventListener(vrml.eai.event.VrmlEventListener)

setUserData

public void setUserData(Object data)

Description copied from class: EventOut

Associate user data with this event. Whenever an event is generated on this eventOut. this data will be available with the Event through its getData method.

Specified by:

setUserData in class EventOut

Parameters:

data - The data to associate with this eventOut instance

See Also:

• EventOut.setUserData(java.lang.Object)

getUserData

public Object getUserData()

Description copied from class: EventOut

Get the user data that is associated with this eventOut

Specified by:

getUserData in class EventOut

Returns:

The user data, if any, associated with this eventOut

loadFieldValue

public void loadFieldValue(DataInputStream input)
                    throws IOException

Throws:

IOException

writeFieldValue

public void writeFieldValue(DataOutputStream output)
                     throws IOException

Throws:

IOException

getType

int getType()

The type of the underlying field. Method name chosen to coincide with vrml.eai.field.BaseField.

Returns:

the type of the underlying field