Interface NurbsPositionInterpolator

All Superinterfaces:
X3DChildNode, X3DNode
All Known Implementing Classes:
NurbsPositionInterpolatorObject

public interface NurbsPositionInterpolator
extends X3DChildNode
NurbsPositionInterpolator describes a 3D NURBS curve and outputs interpolated position values.

X3D node tooltip: [X3DChildNode] NurbsPositionInterpolator describes a 3D NURBS curve and outputs interpolated position values.
  • Hint: the SFNode controlPoints field can contain a single Coordinate or CoordinateDouble node.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: NurbsPositionInterpolator, X3D Tooltips: NurbsPositionInterpolator, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type Method Description
    X3DCoordinateNode getControlPoint()
    Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field controlPoint.
    double[] getKnot()
    Provide array of double results from initializeOnly MFDouble field named knot.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    int getOrder()
    Provide int value within allowed range of [2,infinity) from inputOutput SFInt32 field named order.
    float[] getValue()
    Provide array of 3-tuple float results from outputOnly SFVec3f field named value_changed.
    double[] getWeight()
    Provide array of double results from inputOutput MFDouble field named weight.
    NurbsPositionInterpolator setControlPoint​(X3DCoordinateNode newValue)
    Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.
    NurbsPositionInterpolator setKnot​(double[] newValue)
    Accessor method to assign double array to initializeOnly MFDouble field named knot.
    NurbsPositionInterpolator setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    NurbsPositionInterpolator setOrder​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named order.
    NurbsPositionInterpolator setWeight​(double[] newValue)
    Accessor method to assign double array to inputOutput MFDouble field named weight.
  • Method Details

    • getControlPoint

      X3DCoordinateNode getControlPoint()
      Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field controlPoint.

      Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies control points for NURBS geometry definitions. *
      Returns:
      value of controlPoint field
    • setControlPoint

      NurbsPositionInterpolator setControlPoint​(X3DCoordinateNode newValue)
      Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.

      Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies control points for NURBS geometry definitions. *
      Parameters:
      newValue - is new value for the controlPoint field.
      Returns:
      NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getKnot

      double[] getKnot()
      Provide array of double results from initializeOnly MFDouble field named knot.

      Tooltip: knot vector, where size = number of control points + order of curve. *
      Returns:
      value of knot field
    • setKnot

      NurbsPositionInterpolator setKnot​(double[] newValue)
      Accessor method to assign double array to initializeOnly MFDouble field named knot.

      Tooltip: knot vector, where size = number of control points + order of curve. *
      Parameters:
      newValue - is new value for the knot field.
      Returns:
      NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      NurbsPositionInterpolator setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • getOrder

      int getOrder()
      Provide int value within allowed range of [2,infinity) from inputOutput SFInt32 field named order.

      Tooltip: define order of surface by polynomials of degree = order-1. *
      Returns:
      value of order field
    • setOrder

      NurbsPositionInterpolator setOrder​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named order.

      Tooltip: define order of surface by polynomials of degree = order-1. *
      Parameters:
      newValue - is new value for the order field.
      Returns:
      NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getValue

      float[] getValue()
      Provide array of 3-tuple float results from outputOnly SFVec3f field named value_changed.

      Tooltip: Computationaly interpolated output value determined by current key time and corresponding keyValue pair.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Returns:
      value of value_changed field
    • getWeight

      double[] getWeight()
      Provide array of double results from inputOutput MFDouble field named weight.

      Tooltip: Output values for linear interpolation, each corresponding to knots.
      • Hint: number of weights must match number of knots!.
      Returns:
      value of weight field
    • setWeight

      NurbsPositionInterpolator setWeight​(double[] newValue)
      Accessor method to assign double array to inputOutput MFDouble field named weight.

      Tooltip: Output values for linear interpolation, each corresponding to knots.
      • Hint: number of weights must match number of knots!.
      Parameters:
      newValue - is new value for the weight field.
      Returns:
      NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).