Interface MFVec3d

All Superinterfaces:
MField, X3DField
All Known Implementing Classes:
MFVec3d
public interface MFVec3d extends MField
MFVec3d is an array of SFVec3d values. Individual singleton SFVec3d array values are optionally separated by commas in XML syntax. Original rationale for inclusion: GeoVRML 1.0 Recommended Practice, Section 2.3, Limitations of Single Precision. Hint: MFVec3d can be used to specify a list of georeferenced 3D coordinates.


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    append(double[] newValue)
    Places a new value at the end of the existing value array, increasing the field length accordingly.
    void
    get1Value(int index, double[] valueDestination)
    Get a single value from the existing field array.
    void
    getValue(double[] valueDestination)
    Write out the current value of this field into the external valueDestination array.
    void
    getValue(double[][] valueDestination)
    Write out the current value of this field into the external valueDestination array.
    void
    insertValue(int index, double[] newValue)
    Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
    void
    set1Value(int index, double[] newValue)
    Replace a single value at the appropriate location in the existing value array.
    void
    setValue(int size, double[] newValue)
    Assign an array subset to this field.
    void
    setValue(int size, double[][] newValue)
    Assign an array subset to this field.

    Methods inherited from interface MField

    clear, remove, size
    Modifier and Type
    Method
    Description
    void
    clear()
    Removes all values in the field array, changing the array size to zero.
    void
    remove(int index)
    Remove one element of the field array at index position, if found.
    int
    size()
    Get the size of the underlying data array.

  • Method Details

    • getValue

      void getValue(double[][] valueDestination)
      Write out the current value of this field into the external valueDestination array.
      Parameters:
      valueDestination - The array to be filled in with current field values.
      Throws:
      ArrayIndexOutOfBoundsException - The provided valueDestination array was too small.

    • getValue

      void getValue(double[] valueDestination)
      Write out the current value of this field into the external valueDestination array.
      Parameters:
      valueDestination - The array to be filled in with current field values.
      Throws:
      ArrayIndexOutOfBoundsException - The provided valueDestination array was too small.

    • get1Value

      void get1Value(int index, double[] valueDestination)

      Get a single value from the existing field array.

      If the index is outside the bounds of the current array of data values, an ArrayIndexOutOfBoundsException is thrown.

      Parameters:
      index - is position of selected value in current array
      valueDestination - The array to be filled in with the selected current field value.
      Throws:
      ArrayIndexOutOfBoundsException - index outside bounds of current array.

    • setValue

      void setValue(int size, double[] newValue)
      Assign an array subset to this field. Warning: newValue array length must correspond to tuple size for base type MFVec3d tuple size of 3.
      Parameters:
      size - indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.
      newValue - The replacement value array to (potentially) slice and then assign.

    • setValue

      void setValue(int size, double[][] newValue)
      Assign an array subset to this field. Warning: newValue array length must correspond to tuple size for base type MFVec3d tuple size of 3.
      Parameters:
      size - indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.
      newValue - The replacement value array to (potentially) slice and then assign.

    • set1Value

      void set1Value(int index, double[] newValue)
      Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change. Warning: newValue array length must correspond to tuple size for base type MFVec3d tuple size of 3.
      Parameters:
      index - is position of selected value in current array
      newValue - provides new value to apply

    • append

      void append(double[] newValue)
      Places a new value at the end of the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFVec3d tuple size of 3.
      Parameters:
      newValue - The newValue to append

    • insertValue

      void insertValue(int index, double[] newValue)
      Insert a new value prior to the index location in the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFVec3d tuple size of 3.
      Parameters:
      index - The position for the inserted value in the current array
      newValue - The newValue to insert