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

Class EventOutMFVec3fWrapper

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventOut

vrml.eai.field.EventOutMField

vrml.eai.field.EventOutMFVec3f

org.web3d.vrml.scripting.external.neteai.EventOutMFVec3fWrapper

public class EventOutMFVec3fWrapper
extends EventOutMFVec3f

Client side implementation of EventOutMFVec3fWrapper 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
EventOutMFVec3fWrapper(int fieldID, FieldAndNodeRequestProcessor requestProcessor)
EventOutMFVec3fWrapper(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
float[]	get1Value(int index)	Get a particular vector value in the given eventOut array.
void	get1Value(int index, float[] vec)	Get the value of a particular vector value in the event out array.
int	getFieldID()	The underlying field ID
int	getType()	The type of the underlying field.
Object	getUserData()	Get the user data that is associated with this eventOut
float[][]	getValue()	Get the value of the array of 2D vectors.
void	getValue(float[] vec)	Get the values of the event out flattened into a single 1D array.
void	getValue(float[][] vec)	Write the value of the event out to the given array.
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.
int	size()	Get the size of the underlying data array.
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

EventOutMFVec3fWrapper

public EventOutMFVec3fWrapper(int fieldID,
 FieldAndNodeRequestProcessor requestProcessor)

Parameters:

fieldID - The network field ID

requestProcessor - Handler for field services

EventOutMFVec3fWrapper

public EventOutMFVec3fWrapper(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()

The underlying field ID

See Also:

• EventWrapper.getFieldID()

getValue

public float[][] getValue()

Description copied from class: EventOutMFVec3f

Get the value of the array of 2D vectors. Output is an array of floats

Specified by:

getValue in class EventOutMFVec3f

Returns:

* @see vrml.eai.field.EventOutMFVec3f#getValue()

getValue

public void getValue(float[][] vec)

Description copied from class: EventOutMFVec3f

Write the value of the event out to the given array.

Specified by:

getValue in class EventOutMFVec3f

Parameters:

vec - The array to be filled in where
vec[i][0] = X
vec[i][1] = Y
vec[i][2] = Z

See Also:

• EventOutMFVec3f.getValue(float[][])

getValue

public void getValue(float[] vec)

Description copied from class: EventOutMFVec3f

Get the values of the event out flattened into a single 1D array. The array must be at least 3 times the size of the array.

Specified by:

getValue in class EventOutMFVec3f

Parameters:

vec - The array to be filled in where the vec[i + 0] = X
vec[i + 1] = Y
vec[i + 2] = Z

See Also:

• EventOutMFVec3f.getValue(float[])

get1Value

public float[] get1Value(int index)

Description copied from class: EventOutMFVec3f

Get a particular vector value in the given eventOut array.

If the index is out of the bounds of the current array of data values an ArrayIndexOutOfBoundsException will be generated.

Specified by:

get1Value in class EventOutMFVec3f

Parameters:

index - The position to get the vector value from

Returns:

* @see vrml.eai.field.EventOutMFVec3f#get1Value(int)

get1Value

public void get1Value(int index,
 float[] vec)

Description copied from class: EventOutMFVec3f

Get the value of a particular vector value in the event out array.

Specified by:

get1Value in class EventOutMFVec3f

Parameters:

index - The position to get the vector value from.

vec - The array to place the value in where. vec[0] = X
vec[1] = Y
vec[2] = Z

See Also:

• EventOutMFVec3f.get1Value(int, float[])

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()

size

public int size()

Description copied from class: EventOutMField

Get the size of the underlying data array.

Specified by:

size in class EventOutMField

Returns:

* @see vrml.eai.field.EventOutMField#size()

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:

* @see vrml.eai.field.EventOut#getUserData()

loadFieldValue

public void loadFieldValue(DataInputStream input)
                    throws IOException

Throws:

IOException - * @see org.web3d.vrml.scripting.external.neteai.EventWrapper#loadFieldValue(java.io.DataInputStream)

writeFieldValue

public void writeFieldValue(DataOutputStream output)
                     throws IOException

Throws:

IOException - * @see org.web3d.vrml.scripting.external.neteai.EventWrapper#writeFieldValue(java.io.DataOutputStream)

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