SFRotation (Xj3D 2.3-nps Code Library)

All Superinterfaces:: X3DField

public interface SFRotation extends X3DField

Representation of a SFRotation field.

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

Version:: 1.0 30 April 1998

Method Summary

Modifier and Type

Method

Description

void

getValue(float[] vec)

Write the rotation value to the given eventOut

void

setValue(float[] value)

Set the rotation value in the given eventIn.

Methods inherited from interface org.web3d.x3d.sai.X3DField
addX3DEventListener, getDefinition, getUserData, isReadable, isWritable, removeX3DEventListener, setUserData

Method Details
- getValue
  
  void getValue(float[] vec)
  
  Write the rotation value to the given eventOut
  
  Parameters:
  
  vec - The array of vector values to be filled in 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:
  
  ArrayIndexOutOfBoundsException - The provided array was too small
- setValue
  
  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:
  
  ArrayIndexOutOfBoundsException - The value did not contain at least 4 values for the rotation.