org.web3d.x3d.jsail.Interpolation

Class ScalarInterpolatorObject

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Interpolation.ScalarInterpolatorObject

All Implemented Interfaces:

X3DChildNode, X3DNode, ScalarInterpolator, X3DInterpolatorNode

public class ScalarInterpolatorObject
extends X3DConcreteNode
implements ScalarInterpolator

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

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 and Description
static java.lang.String	COMPONENT String constant COMPONENT defines X3D component for the ScalarInterpolator element: Interpolation
static java.lang.String	containerField_DEFAULT_VALUE containerField describes typical field relationship of a node to its parent.
static java.lang.String	fromField_KEY fromField ROUTE name for MFFloat field named key.
static java.lang.String	fromField_KEYVALUE fromField ROUTE name for MFFloat field named keyValue.
static java.lang.String	fromField_METADATA fromField ROUTE name for SFNode field named metadata.
static java.lang.String	fromField_VALUE_CHANGED fromField ROUTE name for SFFloat field named value_changed.
static int	LEVEL Integer constant LEVEL provides default X3D Interpolation component level for this element: 1
static java.lang.String	NAME String constant NAME provides name of this element: ScalarInterpolator.
static java.lang.String	toField_KEY toField ROUTE name for MFFloat field named key.
static java.lang.String	toField_KEYVALUE toField ROUTE name for MFFloat field named keyValue.
static java.lang.String	toField_METADATA toField ROUTE name for SFNode field named metadata.
static java.lang.String	toField_SET_FRACTION toField ROUTE name for SFFloat field named set_fraction.

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

CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

validationResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ScalarInterpolatorObject	addComments(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.
ScalarInterpolatorObject	addComments(java.lang.String newComment) Add comment as String to contained commentsList.
ScalarInterpolatorObject	addComments(java.lang.String[] newComments) Add comments as String[] array to contained commentsList.
ScalarInterpolatorObject	addKey(float newValue) Add singleton float value to MFFloat key field.
ScalarInterpolatorObject	addKey(SFFloatObject newValue) Add singleton SFFloatObject value to MFFloat key field.
ScalarInterpolatorObject	addKeyValue(float newValue) Add singleton float value to MFFloat keyValue field.
ScalarInterpolatorObject	addKeyValue(SFFloatObject newValue) Add singleton SFFloatObject value to MFFloat keyValue field.
ScalarInterpolatorObject	clearKey() Utility method to clear MFFloat value of key field.
ScalarInterpolatorObject	clearKeyValue() Utility method to clear MFFloat value of keyValue field.
ScalarInterpolatorObject	clearMetadata() Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(java.lang.String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
java.lang.String	getAccessType(java.lang.String fieldName) Indicate accessType corresponding to given fieldName.
java.lang.String	getComponent() Defines X3D component for the ScalarInterpolator element: Interpolation
int	getComponentLevel() Provides default X3D component level for this element: 1
java.lang.String	getContainerFieldDefault() containerField describes typical field relationship of a node to its parent.
java.lang.String	getElementName() Provides name of this element: ScalarInterpolator
java.lang.String	getFieldType(java.lang.String fieldName) Indicate type corresponding to given fieldName.
ISObject	getIS() Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
float[]	getKey() Provide array of Float results from inputOutput MFFloat field named key.
java.util.ArrayList<java.lang.Float>	getKeyList() Utility method to get ArrayList value of MFFloat key field, similar to getKey().
float[]	getKeyValue() Provide array of Float results from inputOutput MFFloat field named keyValue.
java.util.ArrayList<java.lang.Float>	getKeyValueList() Utility method to get ArrayList value of MFFloat keyValue field, similar to getKeyValue().
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getValue() Provide float value from outputOnly SFFloat field named value_changed.
boolean	hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasMetadata() Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(java.lang.String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
void	initialize() Initialize all member variables to default values.
ScalarInterpolatorObject	setCssClass(SFStringObject newValue) Assign typed object value to SFString cssClass field, similar to setCssClass(String).
ScalarInterpolatorObject	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
ScalarInterpolatorObject	setDEF(SFStringObject newValue) Assign typed object value to SFString DEF field, similar to setDEF(String).
ScalarInterpolatorObject	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
ScalarInterpolatorObject	setIS(ISObject newValue) Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
ScalarInterpolatorObject	setKey(java.util.ArrayList<java.lang.Float> newValue) Assign ArrayList value of MFFloat key field, similar to setKey(float[]).
ScalarInterpolatorObject	setKey(float[] newValue) Assign Float array to inputOutput MFFloat field named key.
ScalarInterpolatorObject	setKey(int[] newValue) Assign floating-point array value of MFFloat key field, similar to setKey(float[]).
ScalarInterpolatorObject	setKey(MFFloatObject newValue) Assign typed object value to MFFloat key field, similar to setKey(float[]).
ScalarInterpolatorObject	setKeyValue(java.util.ArrayList<java.lang.Float> newValue) Assign ArrayList value of MFFloat keyValue field, similar to setKeyValue(float[]).
ScalarInterpolatorObject	setKeyValue(float[] newValue) Assign Float array to inputOutput MFFloat field named keyValue.
ScalarInterpolatorObject	setKeyValue(int[] newValue) Assign floating-point array value of MFFloat keyValue field, similar to setKeyValue(float[]).
ScalarInterpolatorObject	setKeyValue(MFFloatObject newValue) Assign typed object value to MFFloat keyValue field, similar to setKeyValue(float[]).
ScalarInterpolatorObject	setMetadata(ProtoInstanceObject newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ScalarInterpolatorObject	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ScalarInterpolatorObject	setUSE(ScalarInterpolatorObject DEFnode) Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
ScalarInterpolatorObject	setUSE(SFStringObject newValue) Assign typed object value to SFString USE field, similar to setUSE(String).
ScalarInterpolatorObject	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.
java.lang.String	toStringClassicVRML(int indentLevel) Recursive method to provide ClassicVRML string serialization.
java.lang.String	toStringVRML97(int indentLevel) Recursive method to provide VRML97 string serialization.
java.lang.String	toStringX3D(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
java.lang.String	validate() Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

String constant NAME provides name of this element: ScalarInterpolator.

See Also:

Constant Field Values

COMPONENT

public static final java.lang.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

containerField_DEFAULT_VALUE

public static final java.lang.String containerField_DEFAULT_VALUE

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

See Also:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values

fromField_KEY

public static final java.lang.String fromField_KEY

fromField ROUTE name for MFFloat field named key.

See Also:

Constant Field Values

toField_KEY

public static final java.lang.String toField_KEY

toField ROUTE name for MFFloat field named key.

See Also:

Constant Field Values

fromField_KEYVALUE

public static final java.lang.String fromField_KEYVALUE

fromField ROUTE name for MFFloat field named keyValue.

See Also:

Constant Field Values

toField_KEYVALUE

public static final java.lang.String toField_KEYVALUE

toField ROUTE name for MFFloat field named keyValue.

See Also:

Constant Field Values

fromField_METADATA

public static final java.lang.String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

toField_METADATA

public static final java.lang.String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

toField_SET_FRACTION

public static final java.lang.String toField_SET_FRACTION

toField ROUTE name for SFFloat field named set_fraction.

See Also:

Constant Field Values

fromField_VALUE_CHANGED

public static final java.lang.String fromField_VALUE_CHANGED

fromField ROUTE name for SFFloat field named value_changed.

See Also:

Constant Field Values

Constructor Detail

ScalarInterpolatorObject

public ScalarInterpolatorObject()

Constructor for ScalarInterpolatorObject to initialize member variables with default values.

ScalarInterpolatorObject

public ScalarInterpolatorObject(java.lang.String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Detail

getElementName

public final java.lang.String getElementName()

Provides name of this element: ScalarInterpolator

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final java.lang.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 java.lang.String getFieldType(java.lang.String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public java.lang.String getAccessType(java.lang.String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final java.lang.String getContainerFieldDefault()

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

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

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 java.util.ArrayList<java.lang.Float> getKeyList()

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

Returns:

value of key field

setKey

public ScalarInterpolatorObject setKey(float[] newValue)

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:

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

setKey

public ScalarInterpolatorObject setKey(MFFloatObject newValue)

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

Parameters:

newValue - is new value for the key field.

Returns:

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

setKey

public ScalarInterpolatorObject setKey(java.util.ArrayList<java.lang.Float> newValue)

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

Parameters:

newValue - is new value for the key field.

Returns:

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

clearKey

public ScalarInterpolatorObject clearKey()

Utility method to clear MFFloat value of key field.

Returns:

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

setKey

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

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

addKey

public ScalarInterpolatorObject addKey(float newValue)

Add singleton float value to MFFloat key field.

Parameters:

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

Returns:

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

addKey

public ScalarInterpolatorObject addKey(SFFloatObject newValue)

Add singleton SFFloatObject value to MFFloat key field.

Parameters:

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

Returns:

ScalarInterpolatorObject - 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 java.util.ArrayList<java.lang.Float> getKeyValueList()

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

Returns:

value of keyValue field

setKeyValue

public ScalarInterpolatorObject setKeyValue(float[] newValue)

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:

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

setKeyValue

public ScalarInterpolatorObject setKeyValue(MFFloatObject newValue)

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

Parameters:

newValue - is new value for the keyValue field.

Returns:

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

setKeyValue

public ScalarInterpolatorObject setKeyValue(java.util.ArrayList<java.lang.Float> newValue)

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

Parameters:

newValue - is new value for the keyValue field.

Returns:

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

clearKeyValue

public ScalarInterpolatorObject clearKeyValue()

Utility method to clear MFFloat value of keyValue field.

Returns:

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

setKeyValue

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

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

addKeyValue

public ScalarInterpolatorObject addKeyValue(float newValue)

Add singleton float value to MFFloat keyValue field.

Parameters:

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

Returns:

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

addKeyValue

public ScalarInterpolatorObject addKeyValue(SFFloatObject newValue)

Add singleton SFFloatObject value to MFFloat keyValue field.

Parameters:

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

Returns:

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

getMetadata

public X3DMetadataObject getMetadata()

Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface ScalarInterpolator

Specified by:

getMetadata in interface X3DInterpolatorNode

Returns:

value of metadata field

See Also:

getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public ScalarInterpolatorObject setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface ScalarInterpolator

Specified by:

setMetadata in interface X3DInterpolatorNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public ScalarInterpolatorObject clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

public ScalarInterpolatorObject setMetadata(ProtoInstanceObject 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:

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

See Also:

setMetadata(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.

Specified by:

getValue in interface ScalarInterpolator

Returns:

value of value_changed field

setDEF

public final ScalarInterpolatorObject setDEF(java.lang.String newValue)

Assign String value to inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DChildNode

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in interface ScalarInterpolator

Specified by:

setDEF in interface X3DInterpolatorNode

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setDEF

public ScalarInterpolatorObject setDEF(SFStringObject newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

public final ScalarInterpolatorObject setUSE(java.lang.String newValue)

Assign String value to inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.

Specified by:

setUSE in interface X3DChildNode

Specified by:

setUSE in interface X3DNode

Specified by:

setUSE in interface ScalarInterpolator

Specified by:

setUSE in interface X3DInterpolatorNode

Specified by:

setUSE in class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setUSE

public ScalarInterpolatorObject setUSE(SFStringObject newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

public final ScalarInterpolatorObject setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS

Specified by:

setCssClass in interface X3DChildNode

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in interface ScalarInterpolator

Specified by:

setCssClass in interface X3DInterpolatorNode

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

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

See Also:

W3C Cascading Style Sheets

setCssClass

public ScalarInterpolatorObject setCssClass(SFStringObject newValue)

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

Parameters:

newValue - is new value for the class field.

Returns:

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

setIS

public ScalarInterpolatorObject setIS(ISObject newValue)

Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the description field.

Returns:

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

getIS

public ISObject getIS()

Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

getIS in class X3DConcreteNode

Returns:

current ISObject, if any.

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

setUSE

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

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

addComments

public ScalarInterpolatorObject addComments(java.lang.String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

addComments

public ScalarInterpolatorObject addComments(java.lang.String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public ScalarInterpolatorObject addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

toStringX3D

public java.lang.String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form

toStringClassicVRML

public java.lang.String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public java.lang.String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)

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

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)

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

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasElementByNameValue

public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

whether node is found

See Also:

findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasNodeByDEF

public boolean hasNodeByDEF(java.lang.String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

whether node is found

See Also:

findNodeByDEF(String)

validate

public java.lang.String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)