Package vrml.eai.field

Class EventOutSFColor

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventOut

vrml.eai.field.EventOutSFColor

Direct Known Subclasses:

EventOutSFColorWrapper

public abstract class EventOutSFColor
extends EventOut

VRML eventOut class for SFColor.

Colour values are represented as floating point numbers between [0 - 1] as per the VRML IS specification Section 4.4.5 Standard units and coordinate system.

Version:

1.0 30 April 1998

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

Modifier	Constructor	Description
protected	EventOutSFColor()	Construct an instance of this class.

Method Summary

Modifier and Type	Method	Description
abstract float[]	getValue()	Get a the colour value in the given eventIn.
abstract void	getValue(float[] col)	Write the value of the colour to the given array.

Methods inherited from class vrml.eai.field.EventOut

addVrmlEventListener, getUserData, removeVrmlEventListener, setUserData

Methods inherited from class vrml.eai.field.BaseField

getType

Methods inherited from class java.lang.Object

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

Constructor Details

EventOutSFColor

protected EventOutSFColor()

Construct an instance of this class. Calls the superclass constructor with the field type set to SFColor.

Method Details

getValue

public abstract float[] getValue()

Get a the colour value in the given eventIn. Colour values are in the range [0-1].

Returns:

The array of colour values where
value[0] = Red component [0-1]
value[1] = Green component [0-1]
value[2] = Blue component [0-1]

getValue

public abstract void getValue(float[] col)

Write the value of the colour to the given array.

Parameters:

col - The array of colour values to be filled in where
value[0] = Red component [0-1]
value[1] = Green component [0-1]
value[2] = Blue component [0-1]

Throws:

ArrayIndexOutOfBoundsException - The provided array was too small