Package org.web3d.x3d.sai

Interface MFNode

All Superinterfaces:
MField, X3DField
All Known Implementing Classes:
MFNode
public interface MFNode extends MField
MFNode specifies zero or more nodes; the default value of an MFNode field is the empty list.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes.
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(X3DNode newValue)
    Places a new value at the end of the existing value array, increasing the field length accordingly.
    X3DNode
    get1Value(int index)
    Get an individual value from the existing field array.
    void
    getValue(X3DNode[] copiedNodes)
    Write the current value of the field out to the provided copiedNodes array.
    void
    insertValue(int imageIndex, X3DNode newValue)
    Insert a new value prior to the imageIndex location in the existing value array, increasing the field length accordingly.
    void
    set1Value(int imageIndex, X3DNode newValue)
    Replace a single value at the appropriate location in the existing value array.
    void
    setValue(int size, X3DNode[] newValue)
    Assign an array subset to this field.

    Methods inherited from interface org.web3d.x3d.sai.MField

    clear, remove, size

  • Method Details

    • getValue

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

    • get1Value

      X3DNode get1Value(int index)

      Get an individual 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
      Returns:
      The selected value
      Throws:
      ArrayIndexOutOfBoundsException - The index was outside of the bounds of the current array.

    • setValue

      void setValue(int size, X3DNode[] newValue)
      Assign an array subset to this field.
      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 imageIndex, X3DNode newValue)
      Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change.
      Parameters:
      imageIndex - the index of the selected image
      newValue - provides new value to apply

    • append

      void append(X3DNode newValue)
      Places a new value at the end of the existing value array, increasing the field length accordingly.
      Parameters:
      newValue - The newValue to append

    • insertValue

      void insertValue(int imageIndex, X3DNode newValue)
      Insert a new value prior to the imageIndex location in the existing value array, increasing the field length accordingly.
      Parameters:
      imageIndex - the index of the selected image
      newValue - The newValue to insert