Xj3D 2.0 VRML/X3D Code API

vrml.eai.field
Class EventInSFRotation

java.lang.Object
  extended by vrml.eai.field.BaseField
      extended by vrml.eai.field.EventIn
          extended by vrml.eai.field.EventInSFRotation

public abstract class EventInSFRotation
extends EventIn

VRML eventIn class for SFRotation.

Rotation values are specified according to the VRML IS Specification Section 5.8 SFRotation and MFRotation.

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
protected EventInSFRotation()
          Construct an instance of this class.
 
Method Summary
abstract  void setValue(float[] value)
          Set the rotation value in the given eventIn.
 
Methods inherited from class vrml.eai.field.EventIn
getUserData, 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 Detail

EventInSFRotation

protected EventInSFRotation()
Construct an instance of this class. Calls the superclass constructor with the field type set to SFRotation

Method Detail

setValue

public abstract void setValue(float[] value)
Set the rotation value in the given eventIn.

The value array must contain at least four elements. If the array contains more than 4 values only the first 4 values will be used and the rest ignored.

If the array of values does not contain at least 4 elements an ArrayIndexOutOfBoundsException will be generated.

Parameters:
value - The array of rotation values where
value[0] = X component [0-1]
value[1] = Y component [0-1]
value[2] = Z component [0-1]
value[3] = Angle of rotation [-PI - PI] (nominally).
Throws:
java.lang.ArrayIndexOutOfBoundsException - The value did not contain at least 4 values for the rotation.

Xj3D 2.0 VRML/X3D Code API

Copyright © 2001 - 2006 Web3D Consortium