NurbsPositionInterpolator (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DNode

All Known Implementing Classes:

NurbsPositionInterpolatorObject
```
public interface NurbsPositionInterpolator
extends X3DChildNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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)` Assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.
`NurbsPositionInterpolator`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`NurbsPositionInterpolator`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`NurbsPositionInterpolator`	`setKnot(double[] newValue)` Assign double array to initializeOnly MFDouble field named knot.
`NurbsPositionInterpolator`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`NurbsPositionInterpolator`	`setOrder(int newValue)` Assign int value within allowed range of [2,infinity) to inputOutput SFInt32 field named order.
`NurbsPositionInterpolator`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`NurbsPositionInterpolator`	`setWeight(double[] newValue)` Assign double array to inputOutput MFDouble field named weight.

- Method Detail
  - 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)
```
    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)
```
    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)
```
    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)
```
    Assign int value within allowed range of [2,infinity) 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.
    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)
```
    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).
  - setDEF
```
NurbsPositionInterpolator setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
NurbsPositionInterpolator setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
NurbsPositionInterpolator setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface NurbsPositionInterpolator

Method Summary

Method Detail

getControlPoint

setControlPoint

getKnot

setKnot

getMetadata

setMetadata

getOrder

setOrder

getValue

getWeight

setWeight

setDEF

setUSE

setCssClass