Class NurbsSurfaceInterpolator

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.NURBS.NurbsSurfaceInterpolator
All Implemented Interfaces:
X3DChildNode, X3DNode, NurbsSurfaceInterpolator

public class NurbsSurfaceInterpolator
extends X3DConcreteNode
implements NurbsSurfaceInterpolator
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 controlPoint field can contain a single Coordinate or CoordinateDouble node.

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
X3D Abstract Specification: NurbsSurfaceInterpolator, X3D Tooltips: NurbsSurfaceInterpolator, X3D Scene Authoring Hints
  • Field Details

    • NAME

      public static final java.lang.String NAME
      String constant NAME provides name of this element: NurbsSurfaceInterpolator.
      See Also:
      Constant Field Values
    • COMPONENT

      public static final java.lang.String COMPONENT
      String constant COMPONENT defines X3D component for the NurbsSurfaceInterpolator element: NURBS
      See Also:
      Constant Field Values
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D NURBS component level for this element: 1
      See Also:
      Constant Field Values
    • CONTROLPOINT_DEFAULT_VALUE

      public static final X3DCoordinateNode CONTROLPOINT_DEFAULT_VALUE
      SFNode field named controlPoint has default value null (Java syntax) or NULL (XML syntax).
    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    • UDIMENSION_DEFAULT_VALUE

      public static final int UDIMENSION_DEFAULT_VALUE
      SFInt32 field named uDimension has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • UKNOT_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.Double> UKNOT_DEFAULT_VALUE
      MFDouble field named uKnot has default value equal to an empty list.
    • UORDER_DEFAULT_VALUE

      public static final int UORDER_DEFAULT_VALUE
      SFInt32 field named uOrder has default value 3 (Java syntax) or 3 (XML syntax).
      See Also:
      Constant Field Values
    • VDIMENSION_DEFAULT_VALUE

      public static final int VDIMENSION_DEFAULT_VALUE
      SFInt32 field named vDimension has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • VKNOT_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.Double> VKNOT_DEFAULT_VALUE
      MFDouble field named vKnot has default value equal to an empty list.
    • VORDER_DEFAULT_VALUE

      public static final int VORDER_DEFAULT_VALUE
      SFInt32 field named vOrder has default value 3 (Java syntax) or 3 (XML syntax).
      See Also:
      Constant Field Values
    • WEIGHT_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.Double> WEIGHT_DEFAULT_VALUE
      MFDouble field named weight has default value equal to an empty list.
    • containerField_DEFAULT_VALUE

      public static final java.lang.String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
    • fromField_CONTROLPOINT

      public static final java.lang.String fromField_CONTROLPOINT
      fromField ROUTE name for SFNode field named controlPoint.
      See Also:
      Constant Field Values
    • toField_CONTROLPOINT

      public static final java.lang.String toField_CONTROLPOINT
      toField ROUTE name for SFNode field named controlPoint.
      See Also:
      Constant Field Values
    • fromField_IS

      public static final java.lang.String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
      Constant Field Values
    • fromField_METADATA

      public static final java.lang.String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values
    • toField_METADATA

      public static final java.lang.String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values
    • fromField_NORMAL_CHANGED

      public static final java.lang.String fromField_NORMAL_CHANGED
      fromField ROUTE name for SFVec3f field named normal_changed.
      See Also:
      Constant Field Values
    • fromField_POSITION_CHANGED

      public static final java.lang.String fromField_POSITION_CHANGED
      fromField ROUTE name for SFVec3f field named position_changed.
      See Also:
      Constant Field Values
    • toField_SET_FRACTION

      public static final java.lang.String toField_SET_FRACTION
      toField ROUTE name for SFVec2f field named set_fraction.
      See Also:
      Constant Field Values
    • fromField_WEIGHT

      public static final java.lang.String fromField_WEIGHT
      fromField ROUTE name for MFDouble field named weight.
      See Also:
      Constant Field Values
    • toField_WEIGHT

      public static final java.lang.String toField_WEIGHT
      toField ROUTE name for MFDouble field named weight.
      See Also:
      Constant Field Values
  • Constructor Details

    • NurbsSurfaceInterpolator

      public NurbsSurfaceInterpolator()
      Constructor for NurbsSurfaceInterpolator to initialize member variables with default values.
    • NurbsSurfaceInterpolator

      public NurbsSurfaceInterpolator​(java.lang.String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
  • Method Details

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: NurbsSurfaceInterpolator
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the NurbsSurfaceInterpolator element: NURBS
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 1
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public java.lang.String getAccessType​(java.lang.String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode
    • getControlPoint

      public X3DCoordinateNode getControlPoint()
      Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field controlPoint.
      Specified by:
      getControlPoint in interface NurbsSurfaceInterpolator
      Returns:
      value of controlPoint field
      See Also:
      Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies control points for NURBS geometry definitions. *
    • setControlPoint

      public NurbsSurfaceInterpolator setControlPoint​(X3DCoordinateNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.
      Specified by:
      setControlPoint in interface NurbsSurfaceInterpolator
      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).
      See Also:
      Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies control points for NURBS geometry definitions. *
    • clearControlPoint

      public NurbsSurfaceInterpolator clearControlPoint()
      Utility method to clear SFNode value of controlPoint field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setControlPoint

      public NurbsSurfaceInterpolator setControlPoint​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field controlPoint.
      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).
      See Also:
      setControlPoint( org.web3d.x3d.sai.Rendering.X3DCoordinateNode)
    • hasControlPoint

      public boolean hasControlPoint()
      Indicate whether an object is available for inputOutput SFNode field controlPoint.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getControlPoint(), getControlPointProtoInstance()
    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public NurbsSurfaceInterpolator setIS​(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public NurbsSurfaceInterpolator clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface NurbsSurfaceInterpolator
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public NurbsSurfaceInterpolator setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface NurbsSurfaceInterpolator
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      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:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

      public NurbsSurfaceInterpolator clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public NurbsSurfaceInterpolator setMetadata​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      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:
      setMetadata( org.web3d.x3d.sai.Core.X3DMetadataObject)
    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • getNormal

      public 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.
      Specified by:
      getNormal in interface NurbsSurfaceInterpolator
      Returns:
      value of normal_changed field
    • getPosition

      public 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.
      Specified by:
      getPosition in interface NurbsSurfaceInterpolator
      Returns:
      value of position_changed field
    • getUDimension

      public 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. *
      Specified by:
      getUDimension in interface NurbsSurfaceInterpolator
      Returns:
      value of uDimension field
    • setUDimension

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

      Tooltip: Number of control points in u dimension. *
      Specified by:
      setUDimension in interface NurbsSurfaceInterpolator
      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).
    • setUDimension

      public NurbsSurfaceInterpolator setUDimension​(SFInt32 newValue)
      Assign typed object value to SFInt32 uDimension field, similar to setUDimension(int).
      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

      public 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. *
      Specified by:
      getUKnot in interface NurbsSurfaceInterpolator
      Returns:
      value of uKnot field
    • getUKnotList

      public java.util.ArrayList<java.lang.Double> getUKnotList()
      Utility method to get ArrayList value of MFDouble uKnot field, similar to getUKnot().
      Returns:
      value of uKnot field
    • getUKnotString

      public java.lang.String getUKnotString()
      Utility method to get String value of MFDouble uKnot field, similar to getUKnot().
      Returns:
      value of uKnot field
    • setUKnot

      public 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. *
      Specified by:
      setUKnot in interface NurbsSurfaceInterpolator
      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).
    • setUKnot

      public NurbsSurfaceInterpolator setUKnot​(MFDouble newValue)
      Assign typed object value to MFDouble uKnot field, similar to setUKnot(double[]).
      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).
    • setUKnot

      public NurbsSurfaceInterpolator setUKnot​(java.util.ArrayList<java.lang.Double> newValue)
      Assign ArrayList value of MFDouble uKnot field, similar to setUKnot(double[]).
      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).
    • clearUKnot

      public NurbsSurfaceInterpolator clearUKnot()
      Utility method to clear MFDouble value of uKnot field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setUKnot

      public NurbsSurfaceInterpolator setUKnot​(int[] newValue)
      Assign floating-point array value of MFDouble uKnot field, similar to setUKnot(double[]).
      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).
    • addUKnot

      public NurbsSurfaceInterpolator addUKnot​(double newValue)
      Add singleton double value to MFDouble uKnot field.
      Parameters:
      newValue - is new value to add to the uKnot field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addUKnot

      public NurbsSurfaceInterpolator addUKnot​(SFDouble newValue)
      Add singleton SFDouble value to MFDouble uKnot field.
      Parameters:
      newValue - is new value to add to the uKnot field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUOrder

      public 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. *
      Specified by:
      getUOrder in interface NurbsSurfaceInterpolator
      Returns:
      value of uOrder field
    • setUOrder

      public 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. *
      Specified by:
      setUOrder in interface NurbsSurfaceInterpolator
      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).
    • setUOrder

      public NurbsSurfaceInterpolator setUOrder​(SFInt32 newValue)
      Assign typed object value to SFInt32 uOrder field, similar to setUOrder(int).
      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

      public 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. *
      Specified by:
      getVDimension in interface NurbsSurfaceInterpolator
      Returns:
      value of vDimension field
    • setVDimension

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

      Tooltip: Number of control points in v dimension. *
      Specified by:
      setVDimension in interface NurbsSurfaceInterpolator
      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).
    • setVDimension

      public NurbsSurfaceInterpolator setVDimension​(SFInt32 newValue)
      Assign typed object value to SFInt32 vDimension field, similar to setVDimension(int).
      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

      public 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. *
      Specified by:
      getVKnot in interface NurbsSurfaceInterpolator
      Returns:
      value of vKnot field
    • getVKnotList

      public java.util.ArrayList<java.lang.Double> getVKnotList()
      Utility method to get ArrayList value of MFDouble vKnot field, similar to getVKnot().
      Returns:
      value of vKnot field
    • getVKnotString

      public java.lang.String getVKnotString()
      Utility method to get String value of MFDouble vKnot field, similar to getVKnot().
      Returns:
      value of vKnot field
    • setVKnot

      public 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. *
      Specified by:
      setVKnot in interface NurbsSurfaceInterpolator
      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).
    • setVKnot

      public NurbsSurfaceInterpolator setVKnot​(MFDouble newValue)
      Assign typed object value to MFDouble vKnot field, similar to setVKnot(double[]).
      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).
    • setVKnot

      public NurbsSurfaceInterpolator setVKnot​(java.util.ArrayList<java.lang.Double> newValue)
      Assign ArrayList value of MFDouble vKnot field, similar to setVKnot(double[]).
      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).
    • clearVKnot

      public NurbsSurfaceInterpolator clearVKnot()
      Utility method to clear MFDouble value of vKnot field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setVKnot

      public NurbsSurfaceInterpolator setVKnot​(int[] newValue)
      Assign floating-point array value of MFDouble vKnot field, similar to setVKnot(double[]).
      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).
    • addVKnot

      public NurbsSurfaceInterpolator addVKnot​(double newValue)
      Add singleton double value to MFDouble vKnot field.
      Parameters:
      newValue - is new value to add to the vKnot field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addVKnot

      public NurbsSurfaceInterpolator addVKnot​(SFDouble newValue)
      Add singleton SFDouble value to MFDouble vKnot field.
      Parameters:
      newValue - is new value to add to the vKnot field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getVOrder

      public 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. *
      Specified by:
      getVOrder in interface NurbsSurfaceInterpolator
      Returns:
      value of vOrder field
    • setVOrder

      public 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. *
      Specified by:
      setVOrder in interface NurbsSurfaceInterpolator
      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).
    • setVOrder

      public NurbsSurfaceInterpolator setVOrder​(SFInt32 newValue)
      Assign typed object value to SFInt32 vOrder field, similar to setVOrder(int).
      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

      public 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!.
      Specified by:
      getWeight in interface NurbsSurfaceInterpolator
      Returns:
      value of weight field
    • getWeightList

      public java.util.ArrayList<java.lang.Double> getWeightList()
      Utility method to get ArrayList value of MFDouble weight field, similar to getWeight().
      Returns:
      value of weight field
    • getWeightString

      public java.lang.String getWeightString()
      Utility method to get String value of MFDouble weight field, similar to getWeight().
      Returns:
      value of weight field
    • setWeight

      public 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!.
      Specified by:
      setWeight in interface NurbsSurfaceInterpolator
      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).
    • setWeight

      public NurbsSurfaceInterpolator setWeight​(MFDouble newValue)
      Assign typed object value to MFDouble weight field, similar to setWeight(double[]).
      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).
    • setWeight

      public NurbsSurfaceInterpolator setWeight​(java.util.ArrayList<java.lang.Double> newValue)
      Assign ArrayList value of MFDouble weight field, similar to setWeight(double[]).
      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).
    • clearWeight

      public NurbsSurfaceInterpolator clearWeight()
      Utility method to clear MFDouble value of weight field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setWeight

      public NurbsSurfaceInterpolator setWeight​(int[] newValue)
      Assign floating-point array value of MFDouble weight field, similar to setWeight(double[]).
      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).
    • addWeight

      public NurbsSurfaceInterpolator addWeight​(double newValue)
      Add singleton double value to MFDouble weight field.
      Parameters:
      newValue - is new value to add to the weight field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addWeight

      public NurbsSurfaceInterpolator addWeight​(SFDouble newValue)
      Add singleton SFDouble value to MFDouble weight field.
      Parameters:
      newValue - is new value to add to the weight field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final NurbsSurfaceInterpolator setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public NurbsSurfaceInterpolator setDEF​(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

      public java.lang.String getUSE()
      Provide String value from 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.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final NurbsSurfaceInterpolator setUSE​(java.lang.String newValue)
      Accessor method to 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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public NurbsSurfaceInterpolator setUSE​(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssClass

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final NurbsSurfaceInterpolator setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public NurbsSurfaceInterpolator setCssClass​(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that 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.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public NurbsSurfaceInterpolator addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public NurbsSurfaceInterpolator addComments​(java.lang.String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public NurbsSurfaceInterpolator addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      NurbsSurfaceInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public java.lang.String toStringClassicVRML​(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3D.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public java.lang.String toStringVRML97​(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
      findNodeByDEF(String)
    • validate

      public java.lang.String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)