Class NurbsPositionInterpolator

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.NURBS.NurbsPositionInterpolator

All Implemented Interfaces:

X3DChildNode, X3DNode, NurbsPositionInterpolator

public class NurbsPositionInterpolator
extends X3DConcreteNode
implements NurbsPositionInterpolator

NurbsPositionInterpolator describes a 3D NURBS curve and outputs interpolated position values.

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. NurbsPositionInterpolator node tooltip: [X3DChildNode] NurbsPositionInterpolator describes a 3D NURBS curve and outputs interpolated position 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: NurbsPositionInterpolator
• X3D Tooltips: NurbsPositionInterpolator
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the NurbsPositionInterpolator element: NURBS
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final X3DNode	CONTROLPOINT_DEFAULT_VALUE	SFNode field named controlPoint has default value null (Java syntax) or NULL (XML syntax).
static final String	fromField_CONTROLPOINT	fromField ROUTE name for SFNode field named controlPoint.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_KNOT	fromField ROUTE name for MFDouble field named knot.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_ORDER	fromField ROUTE name for SFInt32 field named order.
static final String	fromField_VALUE_CHANGED	fromField ROUTE name for SFVec3f field named value_changed.
static final String	fromField_WEIGHT	fromField ROUTE name for MFDouble field named weight.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Double>	KNOT_DEFAULT_VALUE	MFDouble field named knot has default value equal to an empty list.
static final int	LEVEL	Integer constant LEVEL provides default X3D NURBS component level for this element: 1
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: NurbsPositionInterpolator.
static final int	ORDER_DEFAULT_VALUE	SFInt32 field named order has default value 3 (Java syntax) or 3 (XML syntax).
static final String	toField_CONTROLPOINT	toField ROUTE name for SFNode field named controlPoint.
static final String	toField_KNOT	toField ROUTE name for MFDouble field named knot.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_ORDER	toField ROUTE name for SFInt32 field named order.
static final String	toField_SET_FRACTION	toField ROUTE name for SFFloat field named set_fraction.
static final String	toField_WEIGHT	toField ROUTE name for MFDouble field named weight.
static final ArrayList<Double>	WEIGHT_DEFAULT_VALUE	MFDouble field named weight has default value equal to an empty list.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
NurbsPositionInterpolator()	Constructor for NurbsPositionInterpolator to initialize member variables with default values.
NurbsPositionInterpolator(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
NurbsPositionInterpolator	addComments(String newComment)	Add comment as String to contained commentsList.
NurbsPositionInterpolator	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
NurbsPositionInterpolator	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
NurbsPositionInterpolator	addKnot(double newValue)	Add singleton double value to MFDouble knot field.
NurbsPositionInterpolator	addKnot(SFDouble newValue)	Add singleton SFDouble value to MFDouble knot field.
NurbsPositionInterpolator	addWeight(double newValue)	Add singleton double value to MFDouble weight field.
NurbsPositionInterpolator	addWeight(SFDouble newValue)	Add singleton SFDouble value to MFDouble weight field.
NurbsPositionInterpolator	clearControlPoint()	Utility method to clear SFNode value of controlPoint field.
NurbsPositionInterpolator	clearIS()	Utility method to clear SFNode value of IS field.
NurbsPositionInterpolator	clearKnot()	Utility method to clear MFDouble value of knot field.
NurbsPositionInterpolator	clearMetadata()	Utility method to clear SFNode value of metadata field.
NurbsPositionInterpolator	clearWeight()	Utility method to clear MFDouble value of weight field.
X3DConcreteElement	findElementByNameValue(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.
X3DConcreteElement	findElementByNameValue(String nameValue, 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.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
final String	getComponent()	Defines X3D component for the NurbsPositionInterpolator element: NURBS
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
X3DNode	getControlPoint()	Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to Coordinate|CoordinateDouble, from inputOutput SFNode field controlPoint.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: NurbsPositionInterpolator
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
double[]	getKnot()	Provide array of Double results from inputOutput MFDouble field named knot.
ArrayList<Double>	getKnotList()	Utility method to get ArrayList value of MFDouble knot field, similar to getKnot().
String	getKnotString()	Utility method to get String value of MFDouble knot field, similar to getKnot().
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.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.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
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.
ArrayList<Double>	getWeightList()	Utility method to get ArrayList value of MFDouble weight field, similar to getWeight().
String	getWeightString()	Utility method to get String value of MFDouble weight field, similar to getWeight().
boolean	hasControlPoint()	Indicate whether an object is available for inputOutput SFNode field controlPoint.
boolean	hasElementByNameValue(String nameValue, 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.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
NurbsPositionInterpolator	setControlPoint(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field controlPoint.
NurbsPositionInterpolator	setControlPoint(X3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.
final NurbsPositionInterpolator	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
NurbsPositionInterpolator	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final NurbsPositionInterpolator	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
NurbsPositionInterpolator	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final NurbsPositionInterpolator	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
NurbsPositionInterpolator	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
final NurbsPositionInterpolator	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
NurbsPositionInterpolator	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
NurbsPositionInterpolator	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
NurbsPositionInterpolator	setKnot(double[] newValue)	Accessor method to assign Double array to inputOutput MFDouble field named knot.
NurbsPositionInterpolator	setKnot(int[] newValue)	Assign floating-point array value of MFDouble knot field, similar to setKnot(double[]).
NurbsPositionInterpolator	setKnot(ArrayList<Double> newValue)	Assign ArrayList value of MFDouble knot field, similar to setKnot(double[]).
NurbsPositionInterpolator	setKnot(MFDouble newValue)	Assign typed object value to MFDouble knot field, similar to setKnot(double[]).
NurbsPositionInterpolator	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
NurbsPositionInterpolator	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.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	setOrder(SFInt32 newValue)	Assign typed object value to SFInt32 order field, similar to setOrder(int).
final NurbsPositionInterpolator	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
NurbsPositionInterpolator	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
NurbsPositionInterpolator	setUSE(NurbsPositionInterpolator DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
NurbsPositionInterpolator	setWeight(double[] newValue)	Accessor method to assign Double array to inputOutput MFDouble field named weight.
NurbsPositionInterpolator	setWeight(int[] newValue)	Assign floating-point array value of MFDouble weight field, similar to setWeight(double[]).
NurbsPositionInterpolator	setWeight(ArrayList<Double> newValue)	Assign ArrayList value of MFDouble weight field, similar to setWeight(double[]).
NurbsPositionInterpolator	setWeight(MFDouble newValue)	Assign typed object value to MFDouble weight field, similar to setWeight(double[]).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: NurbsPositionInterpolator.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the NurbsPositionInterpolator 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 X3DNode 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).

KNOT_DEFAULT_VALUE

public static final ArrayList<Double> KNOT_DEFAULT_VALUE

MFDouble field named knot has default value equal to an empty list.

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

ORDER_DEFAULT_VALUE

public static final int ORDER_DEFAULT_VALUE

SFInt32 field named order has default value 3 (Java syntax) or 3 (XML syntax).

See Also:

• Constant Field Values

WEIGHT_DEFAULT_VALUE

public static final ArrayList<Double> WEIGHT_DEFAULT_VALUE

MFDouble field named weight has default value equal to an empty list.

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_CONTROLPOINT

public static final String fromField_CONTROLPOINT

fromField ROUTE name for SFNode field named controlPoint.

See Also:

• Constant Field Values

toField_CONTROLPOINT

public static final String toField_CONTROLPOINT

toField ROUTE name for SFNode field named controlPoint.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_KNOT

public static final String fromField_KNOT

fromField ROUTE name for MFDouble field named knot.

See Also:

• Constant Field Values

toField_KNOT

public static final String toField_KNOT

toField ROUTE name for MFDouble field named knot.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_ORDER

public static final String fromField_ORDER

fromField ROUTE name for SFInt32 field named order.

See Also:

• Constant Field Values

toField_ORDER

public static final String toField_ORDER

toField ROUTE name for SFInt32 field named order.

See Also:

• Constant Field Values

toField_SET_FRACTION

public static final String toField_SET_FRACTION

toField ROUTE name for SFFloat field named set_fraction.

See Also:

• Constant Field Values

fromField_VALUE_CHANGED

public static final String fromField_VALUE_CHANGED

fromField ROUTE name for SFVec3f field named value_changed.

See Also:

• Constant Field Values

fromField_WEIGHT

public static final String fromField_WEIGHT

fromField ROUTE name for MFDouble field named weight.

See Also:

• Constant Field Values

toField_WEIGHT

public static final String toField_WEIGHT

toField ROUTE name for MFDouble field named weight.

See Also:

• Constant Field Values

Constructor Details

NurbsPositionInterpolator

public NurbsPositionInterpolator()

Constructor for NurbsPositionInterpolator to initialize member variables with default values.

NurbsPositionInterpolator

public NurbsPositionInterpolator(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 String getElementName()

Provides name of this element: NurbsPositionInterpolator

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the NurbsPositionInterpolator 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 String getFieldType(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 String getAccessType(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 String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for 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 X3DNode getControlPoint()

Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to Coordinate|CoordinateDouble, from inputOutput SFNode field controlPoint.

Specified by:

getControlPoint in interface NurbsPositionInterpolator

Returns:

value of controlPoint field

See Also:

• 
  
  Tooltip: [Coordinate|CoordinateDouble|GeoCoordinate] Single contained Coordinate or CoordinateDouble node that can specify control points for NURBS geometry definitions. *
  

setControlPoint

public NurbsPositionInterpolator setControlPoint(X3DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.

Specified by:

setControlPoint in interface NurbsPositionInterpolator

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).

See Also:

• 
  
  Tooltip: [Coordinate|CoordinateDouble|GeoCoordinate] Single contained Coordinate or CoordinateDouble node that can specify control points for NURBS geometry definitions. *
  

clearControlPoint

public NurbsPositionInterpolator clearControlPoint()

Utility method to clear SFNode value of controlPoint field.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setControlPoint

public NurbsPositionInterpolator 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:

NurbsPositionInterpolator - 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.Core.X3DNode)

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

NurbsPositionInterpolator - 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 NurbsPositionInterpolator clearIS()

Utility method to clear SFNode value of IS field.

Returns:

NurbsPositionInterpolator - 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()

getKnot

public double[] getKnot()

Provide array of Double results from inputOutput MFDouble field named knot.

Tooltip: knot vector, where size = number of control points + order of curve. *

Specified by:

getKnot in interface NurbsPositionInterpolator

Returns:

value of knot field

getKnotList

public ArrayList<Double> getKnotList()

Utility method to get ArrayList value of MFDouble knot field, similar to getKnot().

Returns:

value of knot field

getKnotString

public String getKnotString()

Utility method to get String value of MFDouble knot field, similar to getKnot().

Returns:

value of knot field

setKnot

public NurbsPositionInterpolator setKnot(double[] newValue)

Accessor method to assign Double array to inputOutput MFDouble field named knot.

Tooltip: knot vector, where size = number of control points + order of curve. *

Specified by:

setKnot in interface NurbsPositionInterpolator

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).

setKnot

public NurbsPositionInterpolator setKnot(MFDouble newValue)

Assign typed object value to MFDouble knot field, similar to setKnot(double[]).

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).

setKnot

public NurbsPositionInterpolator setKnot(ArrayList<Double> newValue)

Assign ArrayList value of MFDouble knot field, similar to setKnot(double[]).

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).

clearKnot

public NurbsPositionInterpolator clearKnot()

Utility method to clear MFDouble value of knot field. This method does not initialize withKNOT_DEFAULT_VALUE.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setKnot

public NurbsPositionInterpolator setKnot(int[] newValue)

Assign floating-point array value of MFDouble knot field, similar to setKnot(double[]).

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).

addKnot

public NurbsPositionInterpolator addKnot(double newValue)

Add singleton double value to MFDouble knot field.

Parameters:

newValue - is new value to add to the knot field.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addKnot

public NurbsPositionInterpolator addKnot(SFDouble newValue)

Add singleton SFDouble value to MFDouble knot field.

Parameters:

newValue - is new value to add to the knot field.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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 NurbsPositionInterpolator

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/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public NurbsPositionInterpolator 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 NurbsPositionInterpolator

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:

NurbsPositionInterpolator - 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/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public NurbsPositionInterpolator clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public NurbsPositionInterpolator 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:

NurbsPositionInterpolator - 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

getOrder

public 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. *

Specified by:

getOrder in interface NurbsPositionInterpolator

Returns:

value of order field

setOrder

public 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. *

Specified by:

setOrder in interface NurbsPositionInterpolator

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).

setOrder

public NurbsPositionInterpolator setOrder(SFInt32 newValue)

Assign typed object value to SFInt32 order field, similar to setOrder(int).

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

public 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.

Specified by:

getValue in interface NurbsPositionInterpolator

Returns:

value of value_changed field

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 NurbsPositionInterpolator

Returns:

value of weight field

getWeightList

public ArrayList<Double> getWeightList()

Utility method to get ArrayList value of MFDouble weight field, similar to getWeight().

Returns:

value of weight field

getWeightString

public String getWeightString()

Utility method to get String value of MFDouble weight field, similar to getWeight().

Returns:

value of weight field

setWeight

public 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!.

Specified by:

setWeight in interface NurbsPositionInterpolator

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).

setWeight

public NurbsPositionInterpolator 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:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setWeight

public NurbsPositionInterpolator setWeight(ArrayList<Double> newValue)

Assign ArrayList value of MFDouble weight field, similar to setWeight(double[]).

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).

clearWeight

public NurbsPositionInterpolator clearWeight()

Utility method to clear MFDouble value of weight field. This method does not initialize withWEIGHT_DEFAULT_VALUE.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setWeight

public NurbsPositionInterpolator 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:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addWeight

public NurbsPositionInterpolator addWeight(double newValue)

Add singleton double value to MFDouble weight field.

Parameters:

newValue - is new value to add to the weight field.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addWeight

public NurbsPositionInterpolator addWeight(SFDouble newValue)

Add singleton SFDouble value to MFDouble weight field.

Parameters:

newValue - is new value to add to the weight field.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDEF

public 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.

• 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final NurbsPositionInterpolator setDEF(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.

• 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

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:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public NurbsPositionInterpolator 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:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public 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 NurbsPositionInterpolator setUSE(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:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public NurbsPositionInterpolator 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:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final NurbsPositionInterpolator setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

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).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public NurbsPositionInterpolator 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:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final NurbsPositionInterpolator setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public NurbsPositionInterpolator setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final NurbsPositionInterpolator setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public NurbsPositionInterpolator setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public NurbsPositionInterpolator setUSE(NurbsPositionInterpolator DEFnode)

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:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public NurbsPositionInterpolator addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public NurbsPositionInterpolator addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public NurbsPositionInterpolator addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

NurbsPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public 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 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 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(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(String nameValue,
 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(String nameValue,
 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(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(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 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. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)