Xj3D 2.0 VRML/X3D Code API

org.web3d.x3d.sai
Interface SFVec2d

All Superinterfaces:
X3DField

public interface SFVec2d
extends X3DField

Representation of a SFVec2d field.

Version:
1.0 30 April 1998

Method Summary
 void getValue(double[] vec)
          Write the vector value to the given eventOut
 void setValue(double[] 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 Detail

getValue

void getValue(double[] 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
Throws:
java.lang.ArrayIndexOutOfBoundsException - The provided array was too small

setValue

void setValue(double[] value)
Set the vector value in the given eventIn.

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

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

Parameters:
value - The array of vector components where
value[0] = X
value[1] = Y
Throws:
java.lang.ArrayIndexOutOfBoundsException - The value did not contain at least two values for the vector

Xj3D 2.0 VRML/X3D Code API

Copyright © 2001 - 2006 Web3D Consortium