SFVec3f (Xj3D 2.3-nps Code Library)

All Superinterfaces:: X3DField

public interface SFVec3f extends X3DField

Representation of a SFVec3f field.

Version:: 1.0 30 April 1998

Method Summary

Modifier and Type

Method

Description

void

getValue(float[] vec)

Write the vector value to the given eventOut

void

setValue(float[] value)

Set the vector 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 vector value to the given eventOut
  
  Parameters:
  
  vec - The array of vector values to be filled in where
  vec[0] = X
  vec[1] = Y
  vec[2] = Z
  
  Throws:
  
  ArrayIndexOutOfBoundsException - The provided array was too small
- setValue
  
  void setValue(float[] value)
  
  Set the vector value in the given eventIn.
  The value array must contain at least three elements. If the array contains more than 3 values only the first 3 values will be used and the rest ignored.
  If the array of values does not contain at least 3 elements an ArrayIndexOutOfBoundsException will be generated.
  
  Parameters:
  
  value - The array of vector components where
  value[0] = X
  value[1] = Y
  value[2] = Z
  
  Throws:
  
  ArrayIndexOutOfBoundsException - The value did not contain at least three values for the vector