Interface NurbsSurfaceInterpolator

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

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

X3D node tooltip: [X3DChildNode] NurbsSurfaceInterpolator describes a 3D NURBS curve and outputs interpolated position and normal 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: NurbsSurfaceInterpolator, X3D Tooltips: NurbsSurfaceInterpolator, 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.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[] getNormal()
    Provide array of 3-tuple float results from outputOnly SFVec3f field named normal_changed.
    float[] getPosition()
    Provide array of 3-tuple float results from outputOnly SFVec3f field named position_changed.
    int getUDimension()
    Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named uDimension.
    double[] getUKnot()
    Provide array of double results from initializeOnly MFDouble field named uKnot.
    int getUOrder()
    Provide int value within allowed range of [2,infinity) from initializeOnly SFInt32 field named uOrder.
    int getVDimension()
    Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named vDimension.
    double[] getVKnot()
    Provide array of double results from initializeOnly MFDouble field named vKnot.
    int getVOrder()
    Provide int value within allowed range of [2,infinity) from initializeOnly SFInt32 field named vOrder.
    double[] getWeight()
    Provide array of double results from inputOutput MFDouble field named weight.
    NurbsSurfaceInterpolator setControlPoint​(X3DCoordinateNode newValue)
    Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.
    NurbsSurfaceInterpolator setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    NurbsSurfaceInterpolator setUDimension​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named uDimension.
    NurbsSurfaceInterpolator setUKnot​(double[] newValue)
    Accessor method to assign double array to initializeOnly MFDouble field named uKnot.
    NurbsSurfaceInterpolator setUOrder​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named uOrder.
    NurbsSurfaceInterpolator setVDimension​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named vDimension.
    NurbsSurfaceInterpolator setVKnot​(double[] newValue)
    Accessor method to assign double array to initializeOnly MFDouble field named vKnot.
    NurbsSurfaceInterpolator setVOrder​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named vOrder.
    NurbsSurfaceInterpolator 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

      NurbsSurfaceInterpolator 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:
      NurbsSurfaceInterpolator - 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

      NurbsSurfaceInterpolator 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:
      NurbsSurfaceInterpolator - 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
    • getNormal

      float[] getNormal()
      Provide array of 3-tuple float results from outputOnly SFVec3f field named normal_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 normal_changed field
    • getPosition

      float[] getPosition()
      Provide array of 3-tuple float results from outputOnly SFVec3f field named position_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 position_changed field
    • getUDimension

      int getUDimension()
      Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named uDimension.

      Tooltip: Number of control points in u dimension. *
      Returns:
      value of uDimension field
    • setUDimension

      NurbsSurfaceInterpolator setUDimension​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named uDimension.

      Tooltip: Number of control points in u dimension. *
      Parameters:
      newValue - is new value for the uDimension field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUKnot

      double[] getUKnot()
      Provide array of double results from initializeOnly MFDouble field named uKnot.

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

      NurbsSurfaceInterpolator setUKnot​(double[] newValue)
      Accessor method to assign double array to initializeOnly MFDouble field named uKnot.

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

      int getUOrder()
      Provide int value within allowed range of [2,infinity) from initializeOnly SFInt32 field named uOrder.

      Tooltip: Define order of surface by polynomials of degree = order-1. *
      Returns:
      value of uOrder field
    • setUOrder

      NurbsSurfaceInterpolator setUOrder​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named uOrder.

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

      int getVDimension()
      Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named vDimension.

      Tooltip: Number of control points in v dimension. *
      Returns:
      value of vDimension field
    • setVDimension

      NurbsSurfaceInterpolator setVDimension​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named vDimension.

      Tooltip: Number of control points in v dimension. *
      Parameters:
      newValue - is new value for the vDimension field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getVKnot

      double[] getVKnot()
      Provide array of double results from initializeOnly MFDouble field named vKnot.

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

      NurbsSurfaceInterpolator setVKnot​(double[] newValue)
      Accessor method to assign double array to initializeOnly MFDouble field named vKnot.

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

      int getVOrder()
      Provide int value within allowed range of [2,infinity) from initializeOnly SFInt32 field named vOrder.

      Tooltip: Define order of surface by polynomials of degree = order-1. *
      Returns:
      value of vOrder field
    • setVOrder

      NurbsSurfaceInterpolator setVOrder​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named vOrder.

      Tooltip: Define order of surface by polynomials of degree = order-1. *
      Parameters:
      newValue - is new value for the vOrder field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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

      NurbsSurfaceInterpolator 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:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).