Xj3D 2.0 VRML/X3D Code API

vrml.eai.field
Class EventInMFRotation

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

public abstract class EventInMFRotation
extends EventIn

VRML eventIn class for MFRotation.

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 EventInMFRotation()
          Construct an instance of this class.
 
Method Summary
abstract  void set1Value(int index, float[] value)
          Set a particular rotation in the given eventIn array.
abstract  void setValue(float[][] value)
          Set the value of the array of rotations.
 
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

EventInMFRotation

protected EventInMFRotation()
Construct an instance of this class. The superclass constructor is called with a type of MFRotation.

Method Detail

setValue

public abstract void setValue(float[][] value)
Set the value of the array of rotations. Input is an array of floats values in order required to specify an SFRotation. If value[i] does not contain at least four values an ArrayIndexOutOfBoundsException will be generated. If value[i] contains more than four items only the first four values will be used and the rest ignored.

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

set1Value

public abstract void set1Value(int index,
                               float[] value)
Set a particular rotation in the given eventIn array. To the VRML world this will generate a full MFRotation event with the nominated index value changed.

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

If the index is out of the bounds of the current array of data values or the array of values does not contain at least 4 elements an ArrayIndexOutOfBoundsException will be generated.

Parameters:
index - The position to set the rotation value
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 - A value did not contain at least four values for the rotation

Xj3D 2.0 VRML/X3D Code API

Copyright © 2001 - 2006 Web3D Consortium