Package org.web3d.x3d.jsail.Interpolation

Class ScalarInterpolator

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Interpolation.ScalarInterpolator

All Implemented Interfaces:

X3DChildNode, X3DNode, ScalarInterpolator, X3DInterpolatorNode

public class ScalarInterpolator
extends X3DConcreteNode
implements ScalarInterpolator

ScalarInterpolator generates piecewise-linear SFFloat 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. ScalarInterpolator node tooltip: [X3DInterpolatorNode] ScalarInterpolator generates piecewise-linear SFFloat values. Authors can ROUTE value_changed output events to other SFFloat fields.

• Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
• Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
• Hint: example scenes and authoring assets at https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation

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: ScalarInterpolator
• X3D Tooltips: ScalarInterpolator
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the ScalarInterpolator element: Interpolation
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_KEY	fromField ROUTE name for MFFloat field named key.
static final String	fromField_KEYVALUE	fromField ROUTE name for MFFloat field named keyValue.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_VALUE_CHANGED	fromField ROUTE name for SFFloat field named value_changed.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Float>	KEY_DEFAULT_VALUE	MFFloat field named key has default value equal to an empty list.
static final ArrayList<Float>	KEYVALUE_DEFAULT_VALUE	MFFloat field named keyValue has default value equal to an empty list.
static final int	LEVEL	Integer constant LEVEL provides default X3D Interpolation 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: ScalarInterpolator.
static final String	toField_KEY	toField ROUTE name for MFFloat field named key.
static final String	toField_KEYVALUE	toField ROUTE name for MFFloat field named keyValue.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_SET_FRACTION	toField ROUTE name for SFFloat field named set_fraction.

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
ScalarInterpolator()	Constructor for ScalarInterpolator to initialize member variables with default values.
ScalarInterpolator(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
ScalarInterpolator	addComments(String newComment)	Add comment as String to contained commentsList.
ScalarInterpolator	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
ScalarInterpolator	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
ScalarInterpolator	addKey(float newValue)	Add singleton float value to MFFloat key field.
ScalarInterpolator	addKey(SFFloat newValue)	Add singleton SFFloat value to MFFloat key field.
ScalarInterpolator	addKeyValue(float newValue)	Add singleton float value to MFFloat keyValue field.
ScalarInterpolator	addKeyValue(SFFloat newValue)	Add singleton SFFloat value to MFFloat keyValue field.
ScalarInterpolator	clearIS()	Utility method to clear SFNode value of IS field.
ScalarInterpolator	clearKey()	Utility method to clear MFFloat value of key field.
ScalarInterpolator	clearKeyValue()	Utility method to clear MFFloat value of keyValue field.
ScalarInterpolator	clearMetadata()	Utility method to clear SFNode value of metadata 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 ScalarInterpolator element: Interpolation
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.
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: ScalarInterpolator
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.
float[]	getKey()	Provide array of Float results from inputOutput MFFloat field named key.
ArrayList<Float>	getKeyList()	Utility method to get ArrayList value of MFFloat key field, similar to getKey().
String	getKeyString()	Utility method to get String value of MFFloat key field, similar to getKey().
float[]	getKeyValue()	Provide array of Float results from inputOutput MFFloat field named keyValue.
ArrayList<Float>	getKeyValueList()	Utility method to get ArrayList value of MFFloat keyValue field, similar to getKeyValue().
String	getKeyValueString()	Utility method to get String value of MFFloat keyValue field, similar to getKeyValue().
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
float	getValue()	Provide float value from outputOnly SFFloat field named value_changed.
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.
final ScalarInterpolator	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
ScalarInterpolator	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final ScalarInterpolator	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
ScalarInterpolator	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final ScalarInterpolator	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
ScalarInterpolator	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
final ScalarInterpolator	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
ScalarInterpolator	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
ScalarInterpolator	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
ScalarInterpolator	setKey(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setKey(float[]).
ScalarInterpolator	setKey(float[] newValue)	Accessor method to assign Float array to inputOutput MFFloat field named key.
ScalarInterpolator	setKey(int[] newValue)	Assign floating-point array value of MFFloat key field, similar to setKey(float[]).
ScalarInterpolator	setKey(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat key field, similar to setKey(float[]).
ScalarInterpolator	setKey(MFFloat newValue)	Assign typed object value to MFFloat key field, similar to setKey(float[]).
ScalarInterpolator	setKeyValue(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setKeyValue(float[]).
ScalarInterpolator	setKeyValue(float[] newValue)	Accessor method to assign Float array to inputOutput MFFloat field named keyValue.
ScalarInterpolator	setKeyValue(int[] newValue)	Assign floating-point array value of MFFloat keyValue field, similar to setKeyValue(float[]).
ScalarInterpolator	setKeyValue(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat keyValue field, similar to setKeyValue(float[]).
ScalarInterpolator	setKeyValue(MFFloat newValue)	Assign typed object value to MFFloat keyValue field, similar to setKeyValue(float[]).
ScalarInterpolator	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ScalarInterpolator	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
final ScalarInterpolator	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
ScalarInterpolator	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
ScalarInterpolator	setUSE(ScalarInterpolator DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
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: ScalarInterpolator.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the ScalarInterpolator element: Interpolation

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Interpolation component level for this element: 1

See Also:

• Constant Field Values

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

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

KEY_DEFAULT_VALUE

public static final ArrayList<Float> KEY_DEFAULT_VALUE

MFFloat field named key has default value equal to an empty list.

KEYVALUE_DEFAULT_VALUE

public static final ArrayList<Float> KEYVALUE_DEFAULT_VALUE

MFFloat field named keyValue 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).

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_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_KEY

public static final String fromField_KEY

fromField ROUTE name for MFFloat field named key.

See Also:

• Constant Field Values

toField_KEY

public static final String toField_KEY

toField ROUTE name for MFFloat field named key.

See Also:

• Constant Field Values

fromField_KEYVALUE

public static final String fromField_KEYVALUE

fromField ROUTE name for MFFloat field named keyValue.

See Also:

• Constant Field Values

toField_KEYVALUE

public static final String toField_KEYVALUE

toField ROUTE name for MFFloat field named keyValue.

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

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 SFFloat field named value_changed.

See Also:

• Constant Field Values

Constructor Details

ScalarInterpolator

public ScalarInterpolator()

Constructor for ScalarInterpolator to initialize member variables with default values.

ScalarInterpolator

public ScalarInterpolator(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: ScalarInterpolator

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the ScalarInterpolator element: Interpolation

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

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

getKey

public float[] getKey()

Provide array of Float results from inputOutput MFFloat field named key.

Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array.

• Warning: number of keys must match number of keyValues!
• Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value.
• Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.

Specified by:

getKey in interface ScalarInterpolator

Specified by:

getKey in interface X3DInterpolatorNode

Returns:

value of key field

getKeyList

public ArrayList<Float> getKeyList()

Utility method to get ArrayList value of MFFloat key field, similar to getKey().

Returns:

value of key field

getKeyString

public String getKeyString()

Utility method to get String value of MFFloat key field, similar to getKey().

Returns:

value of key field

setKey

public ScalarInterpolator setKey(float[] newValue)

Accessor method to assign Float array to inputOutput MFFloat field named key.

Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array.

• Warning: number of keys must match number of keyValues!
• Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value.
• Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.

Specified by:

setKey in interface ScalarInterpolator

Specified by:

setKey in interface X3DInterpolatorNode

Parameters:

newValue - is new value for the key field.

Returns:

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

setKey

public ScalarInterpolator setKey(MFFloat newValue)

Assign typed object value to MFFloat key field, similar to setKey(float[]).

Parameters:

newValue - is new value for the key field.

Returns:

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

setKey

public ScalarInterpolator setKey(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat key field, similar to setKey(float[]).

Parameters:

newValue - is new value for the key field.

Returns:

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

clearKey

public ScalarInterpolator clearKey()

Utility method to clear MFFloat value of key field. This method does not initialize withKEY_DEFAULT_VALUE.

Returns:

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

setKey

public ScalarInterpolator setKey(int[] newValue)

Assign floating-point array value of MFFloat key field, similar to setKey(float[]).

Parameters:

newValue - is new value for the key field.

Returns:

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

addKey

public ScalarInterpolator addKey(float newValue)

Add singleton float value to MFFloat key field.

Parameters:

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

Returns:

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

addKey

public ScalarInterpolator addKey(SFFloat newValue)

Add singleton SFFloat value to MFFloat key field.

Parameters:

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

Returns:

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

setKey

public ScalarInterpolator setKey(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setKey(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getKeyValue

public float[] getKeyValue()

Provide array of Float results from inputOutput MFFloat field named keyValue.

Tooltip: Output values for linear interpolation, each corresponding to an input-fraction value in the key array.

• Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. https://en.wikipedia.org/wiki/Step_function
• Warning: number of keys must match number of keyValues!

Specified by:

getKeyValue in interface ScalarInterpolator

Returns:

value of keyValue field

getKeyValueList

public ArrayList<Float> getKeyValueList()

Utility method to get ArrayList value of MFFloat keyValue field, similar to getKeyValue().

Returns:

value of keyValue field

getKeyValueString

public String getKeyValueString()

Utility method to get String value of MFFloat keyValue field, similar to getKeyValue().

Returns:

value of keyValue field

setKeyValue

public ScalarInterpolator setKeyValue(float[] newValue)

Accessor method to assign Float array to inputOutput MFFloat field named keyValue.

Tooltip: Output values for linear interpolation, each corresponding to an input-fraction value in the key array.

• Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. https://en.wikipedia.org/wiki/Step_function
• Warning: number of keys must match number of keyValues!

Specified by:

setKeyValue in interface ScalarInterpolator

Parameters:

newValue - is new value for the keyValue field.

Returns:

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

setKeyValue

public ScalarInterpolator setKeyValue(MFFloat newValue)

Assign typed object value to MFFloat keyValue field, similar to setKeyValue(float[]).

Parameters:

newValue - is new value for the keyValue field.

Returns:

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

setKeyValue

public ScalarInterpolator setKeyValue(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat keyValue field, similar to setKeyValue(float[]).

Parameters:

newValue - is new value for the keyValue field.

Returns:

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

clearKeyValue

public ScalarInterpolator clearKeyValue()

Utility method to clear MFFloat value of keyValue field. This method does not initialize withKEYVALUE_DEFAULT_VALUE.

Returns:

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

setKeyValue

public ScalarInterpolator setKeyValue(int[] newValue)

Assign floating-point array value of MFFloat keyValue field, similar to setKeyValue(float[]).

Parameters:

newValue - is new value for the keyValue field.

Returns:

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

addKeyValue

public ScalarInterpolator addKeyValue(float newValue)

Add singleton float value to MFFloat keyValue field.

Parameters:

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

Returns:

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

addKeyValue

public ScalarInterpolator addKeyValue(SFFloat newValue)

Add singleton SFFloat value to MFFloat keyValue field.

Parameters:

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

Returns:

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

setKeyValue

public ScalarInterpolator setKeyValue(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setKeyValue(float[]).

Parameters:

newArray - is new value for field

Returns:

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

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DInterpolatorNode

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

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DInterpolatorNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

ScalarInterpolator - 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 ScalarInterpolator clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getValue

public float getValue()

Provide float value from outputOnly SFFloat field named value_changed.

Tooltip: Linearly interpolated output value determined by current key time and corresponding keyValue pair.

• Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive superfluous events that have no effect.
• 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 ScalarInterpolator

Returns:

value of value_changed field

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public ScalarInterpolator addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

ScalarInterpolator - 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 ScalarInterpolator addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public ScalarInterpolator addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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