Class SplineScalarInterpolator
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Interpolation.SplineScalarInterpolator
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,SplineScalarInterpolator
,X3DInterpolatorNode
SplineScalarInterpolator performs non-linear interpolation among paired lists of float values and velocities to produce an SFFloat value_changed output event.
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
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.
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.
SplineScalarInterpolator node tooltip: (X3D version 3.2 or later) [X3DInterpolatorNode] SplineScalarInterpolator performs non-linear interpolation among paired lists of float values and velocities to produce an SFFloat value_changed output event.
- 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.
- Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='4'/>
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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
SFBool field named closed has default value false (Java syntax) or false (XML syntax).static final String
String constant COMPONENT defines X3D component for the SplineScalarInterpolator element: Interpolationstatic final String
containerField describes typical field relationship of a node to its parent.static final String
fromField ROUTE name for SFBool field named closed.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for MFFloat field named key.static final String
fromField ROUTE name for MFFloat field named keyValue.static final String
fromField ROUTE name for MFFloat field named keyVelocity.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for SFBool field named normalizeVelocity.static final String
fromField ROUTE name for SFFloat field named value_changed.static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).MFFloat field named key has default value equal to an empty list.MFFloat field named keyValue has default value equal to an empty list.MFFloat field named keyVelocity has default value equal to an empty list.static final int
Integer constant LEVEL provides default X3D Interpolation component level for this element: 4static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: SplineScalarInterpolator.static final boolean
SFBool field named normalizeVelocity has default value false (Java syntax) or false (XML syntax).static final String
toField ROUTE name for SFBool field named closed.static final String
toField ROUTE name for MFFloat field named key.static final String
toField ROUTE name for MFFloat field named keyValue.static final String
toField ROUTE name for MFFloat field named keyVelocity.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for SFBool field named normalizeVelocity.static final String
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
ConstructorDescriptionConstructor for SplineScalarInterpolator to initialize member variables with default values.SplineScalarInterpolator
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.addKey
(float newValue) Add singleton float value to MFFloat key field.Add singleton SFFloat value to MFFloat key field.addKeyValue
(float newValue) Add singleton float value to MFFloat keyValue field.addKeyValue
(SFFloat newValue) Add singleton SFFloat value to MFFloat keyValue field.addKeyVelocity
(float newValue) Add singleton float value to MFFloat keyVelocity field.addKeyVelocity
(SFFloat newValue) Add singleton SFFloat value to MFFloat keyVelocity field.clearIS()
Utility method to clear SFNode value of IS field.clearKey()
Utility method to clear MFFloat value of key field.Utility method to clear MFFloat value of keyValue field.Utility method to clear MFFloat value of keyVelocity field.Utility method to clear SFNode value of metadata field.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.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.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.boolean
Provide boolean value from inputOutput SFBool field named closed.final String
Defines X3D component for the SplineScalarInterpolator element: Interpolationfinal int
Provides default X3D component level for this element: 4final String
containerField describes typical field relationship of a node to its parent.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.final String
Provides name of this element: SplineScalarInterpolatorgetFieldType
(String fieldName) Indicate type corresponding to given fieldName.Provide String value from inputOutput SFString field named id.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.Utility method to get ArrayList value of MFFloat key field, similar togetKey()
.Utility method to get String value of MFFloat key field, similar togetKey()
.float[]
Provide array of Float results from inputOutput MFFloat field named keyValue.Utility method to get ArrayList value of MFFloat keyValue field, similar togetKeyValue()
.Utility method to get String value of MFFloat keyValue field, similar togetKeyValue()
.float[]
Provide array of Float results from inputOutput MFFloat field named keyVelocity.Utility method to get ArrayList value of MFFloat keyVelocity field, similar togetKeyVelocity()
.Utility method to get String value of MFFloat keyVelocity field, similar togetKeyVelocity()
.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.boolean
Provide boolean value from inputOutput SFBool field named normalizeVelocity.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
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 all member variables to default values.setClosed
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named closed.Assign typed object value to SFBool closed field, similar tosetClosed(boolean)
.final SplineScalarInterpolator
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final SplineScalarInterpolator
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final SplineScalarInterpolator
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.final SplineScalarInterpolator
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setKey
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetKey(float[])
.setKey
(float[] newValue) Accessor method to assign Float array to inputOutput MFFloat field named key.setKey
(int[] newValue) Assign floating-point array value of MFFloat key field, similar tosetKey(float[])
.Assign ArrayList value of MFFloat key field, similar tosetKey(float[])
.Assign typed object value to MFFloat key field, similar tosetKey(float[])
.setKeyValue
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetKeyValue(float[])
.setKeyValue
(float[] newValue) Accessor method to assign Float array to inputOutput MFFloat field named keyValue.setKeyValue
(int[] newValue) Assign floating-point array value of MFFloat keyValue field, similar tosetKeyValue(float[])
.setKeyValue
(ArrayList<Float> newValue) Assign ArrayList value of MFFloat keyValue field, similar tosetKeyValue(float[])
.setKeyValue
(MFFloat newValue) Assign typed object value to MFFloat keyValue field, similar tosetKeyValue(float[])
.setKeyVelocity
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetKeyVelocity(float[])
.setKeyVelocity
(float[] newValue) Accessor method to assign Float array to inputOutput MFFloat field named keyVelocity.setKeyVelocity
(int[] newValue) Assign floating-point array value of MFFloat keyVelocity field, similar tosetKeyVelocity(float[])
.setKeyVelocity
(ArrayList<Float> newValue) Assign ArrayList value of MFFloat keyVelocity field, similar tosetKeyVelocity(float[])
.setKeyVelocity
(MFFloat newValue) Assign typed object value to MFFloat keyVelocity field, similar tosetKeyVelocity(float[])
.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setNormalizeVelocity
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named normalizeVelocity.setNormalizeVelocity
(SFBool newValue) Assign typed object value to SFBool normalizeVelocity field, similar tosetNormalizeVelocity(boolean)
.final SplineScalarInterpolator
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(SplineScalarInterpolator DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.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
-
Field Details
-
NAME
String constant NAME provides name of this element: SplineScalarInterpolator.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the SplineScalarInterpolator element: Interpolation- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Interpolation component level for this element: 4- See Also:
-
CLOSED_DEFAULT_VALUE
public static final boolean CLOSED_DEFAULT_VALUESFBool field named closed has default value false (Java syntax) or false (XML syntax).- See Also:
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
KEY_DEFAULT_VALUE
-
KEYVALUE_DEFAULT_VALUE
-
KEYVELOCITY_DEFAULT_VALUE
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
NORMALIZEVELOCITY_DEFAULT_VALUE
public static final boolean NORMALIZEVELOCITY_DEFAULT_VALUESFBool field named normalizeVelocity has default value false (Java syntax) or false (XML syntax).- See Also:
-
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:
-
fromField_CLOSED
fromField ROUTE name for SFBool field named closed.- See Also:
-
toField_CLOSED
toField ROUTE name for SFBool field named closed.- See Also:
-
fromField_IS
-
fromField_KEY
fromField ROUTE name for MFFloat field named key.- See Also:
-
toField_KEY
-
fromField_KEYVALUE
fromField ROUTE name for MFFloat field named keyValue.- See Also:
-
toField_KEYVALUE
toField ROUTE name for MFFloat field named keyValue.- See Also:
-
fromField_KEYVELOCITY
fromField ROUTE name for MFFloat field named keyVelocity.- See Also:
-
toField_KEYVELOCITY
toField ROUTE name for MFFloat field named keyVelocity.- See Also:
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_NORMALIZEVELOCITY
fromField ROUTE name for SFBool field named normalizeVelocity.- See Also:
-
toField_NORMALIZEVELOCITY
toField ROUTE name for SFBool field named normalizeVelocity.- See Also:
-
toField_SET_FRACTION
toField ROUTE name for SFFloat field named set_fraction.- See Also:
-
fromField_VALUE_CHANGED
fromField ROUTE name for SFFloat field named value_changed.- See Also:
-
-
Constructor Details
-
SplineScalarInterpolator
public SplineScalarInterpolator()Constructor for SplineScalarInterpolator to initialize member variables with default values. -
SplineScalarInterpolator
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
Provides name of this element: SplineScalarInterpolator- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the SplineScalarInterpolator element: Interpolation- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 4- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- 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:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- 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:
-
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 classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getClosed
public boolean getClosed()Provide boolean value from inputOutput SFBool field named closed.
Tooltip: Whether or not the curve is closed (i.e. matching end values), with continuous velocity vectors as the interpolator transitions from the last key to the first key.- Warning: if velocity vectors at first and last keys are specified, the closed field is ignored.
- Warning: if keyValues at first and last key are not identical, the closed field is ignored.
- Specified by:
getClosed
in interfaceSplineScalarInterpolator
- Returns:
- value of closed field
-
setClosed
Accessor method to assign boolean value to inputOutput SFBool field named closed.
Tooltip: Whether or not the curve is closed (i.e. matching end values), with continuous velocity vectors as the interpolator transitions from the last key to the first key.- Warning: if velocity vectors at first and last keys are specified, the closed field is ignored.
- Warning: if keyValues at first and last key are not identical, the closed field is ignored.
- Specified by:
setClosed
in interfaceSplineScalarInterpolator
- Parameters:
newValue
- is new value for the closed field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setClosed
Assign typed object value to SFBool closed field, similar tosetClosed(boolean)
.- Parameters:
newValue
- is new value for the closed field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
SplineScalarInterpolator
- 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:
-
getKey
public float[] getKey()Provide array of Float results from inputOutput MFFloat field named key.
Tooltip: Definition parameters for nonlinear-interpolation function time intervals, listed in non-decreasing order and corresponding to keyValue, keyVelocity array values.- 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 interfaceSplineScalarInterpolator
- Specified by:
getKey
in interfaceX3DInterpolatorNode
- Returns:
- value of key field
-
getKeyList
-
getKeyString
-
setKey
Accessor method to assign Float array to inputOutput MFFloat field named key.
Tooltip: Definition parameters for nonlinear-interpolation function time intervals, listed in non-decreasing order and corresponding to keyValue, keyVelocity array values.- 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 interfaceSplineScalarInterpolator
- Specified by:
setKey
in interfaceX3DInterpolatorNode
- Parameters:
newValue
- is new value for the key field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKey
Assign typed object value to MFFloat key field, similar tosetKey(float[])
.- Parameters:
newValue
- is new value for the key field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKey
Assign ArrayList value of MFFloat key field, similar tosetKey(float[])
.- Parameters:
newValue
- is new value for the key field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearKey
Utility method to clear MFFloat value of key field. This method does not initialize withKEY_DEFAULT_VALUE.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setKey
Assign floating-point array value of MFFloat key field, similar tosetKey(float[])
.- Parameters:
newValue
- is new value for the key field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKey
Add singleton float value to MFFloat key field.- Parameters:
newValue
- is new value to add to the key field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKey
Add singleton SFFloat value to MFFloat key field.- Parameters:
newValue
- is new value to add to the key field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKey
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetKey(float[])
.- Parameters:
newArray
- is new value for field- Returns:
SplineScalarInterpolator
- 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 nonlinear interpolation, each corresponding to an input-fraction value in the key array.- Warning: number of keys must match number of keyValues!.
- Specified by:
getKeyValue
in interfaceSplineScalarInterpolator
- Returns:
- value of keyValue field
-
getKeyValueList
Utility method to get ArrayList value of MFFloat keyValue field, similar togetKeyValue()
.- Returns:
- value of keyValue field
-
getKeyValueString
Utility method to get String value of MFFloat keyValue field, similar togetKeyValue()
.- Returns:
- value of keyValue field
-
setKeyValue
Accessor method to assign Float array to inputOutput MFFloat field named keyValue.
Tooltip: Output values for nonlinear interpolation, each corresponding to an input-fraction value in the key array.- Warning: number of keys must match number of keyValues!.
- Specified by:
setKeyValue
in interfaceSplineScalarInterpolator
- Parameters:
newValue
- is new value for the keyValue field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKeyValue
Assign typed object value to MFFloat keyValue field, similar tosetKeyValue(float[])
.- Parameters:
newValue
- is new value for the keyValue field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKeyValue
Assign ArrayList value of MFFloat keyValue field, similar tosetKeyValue(float[])
.- Parameters:
newValue
- is new value for the keyValue field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearKeyValue
Utility method to clear MFFloat value of keyValue field. This method does not initialize withKEYVALUE_DEFAULT_VALUE.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setKeyValue
Assign floating-point array value of MFFloat keyValue field, similar tosetKeyValue(float[])
.- Parameters:
newValue
- is new value for the keyValue field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKeyValue
Add singleton float value to MFFloat keyValue field.- Parameters:
newValue
- is new value to add to the keyValue field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKeyValue
Add singleton SFFloat value to MFFloat keyValue field.- Parameters:
newValue
- is new value to add to the keyValue field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKeyValue
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetKeyValue(float[])
.- Parameters:
newArray
- is new value for field- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getKeyVelocity
public float[] getKeyVelocity()Provide array of Float results from inputOutput MFFloat field named keyVelocity.
Tooltip: Output values for nonlinear interpolation, each corresponding to an input-fraction value in the key array.- Warning: number of keys must match number of keyVelocity values!.
- Specified by:
getKeyVelocity
in interfaceSplineScalarInterpolator
- Returns:
- value of keyVelocity field
-
getKeyVelocityList
Utility method to get ArrayList value of MFFloat keyVelocity field, similar togetKeyVelocity()
.- Returns:
- value of keyVelocity field
-
getKeyVelocityString
Utility method to get String value of MFFloat keyVelocity field, similar togetKeyVelocity()
.- Returns:
- value of keyVelocity field
-
setKeyVelocity
Accessor method to assign Float array to inputOutput MFFloat field named keyVelocity.
Tooltip: Output values for nonlinear interpolation, each corresponding to an input-fraction value in the key array.- Warning: number of keys must match number of keyVelocity values!.
- Specified by:
setKeyVelocity
in interfaceSplineScalarInterpolator
- Parameters:
newValue
- is new value for the keyVelocity field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKeyVelocity
Assign typed object value to MFFloat keyVelocity field, similar tosetKeyVelocity(float[])
.- Parameters:
newValue
- is new value for the keyVelocity field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKeyVelocity
Assign ArrayList value of MFFloat keyVelocity field, similar tosetKeyVelocity(float[])
.- Parameters:
newValue
- is new value for the keyVelocity field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearKeyVelocity
Utility method to clear MFFloat value of keyVelocity field. This method does not initialize withKEYVELOCITY_DEFAULT_VALUE.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setKeyVelocity
Assign floating-point array value of MFFloat keyVelocity field, similar tosetKeyVelocity(float[])
.- Parameters:
newValue
- is new value for the keyVelocity field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKeyVelocity
Add singleton float value to MFFloat keyVelocity field.- Parameters:
newValue
- is new value to add to the keyVelocity field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKeyVelocity
Add singleton SFFloat value to MFFloat keyVelocity field.- Parameters:
newValue
- is new value to add to the keyVelocity field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKeyVelocity
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetKeyVelocity(float[])
.- Parameters:
newArray
- is new value for field- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceSplineScalarInterpolator
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DInterpolatorNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
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 interfaceSplineScalarInterpolator
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DInterpolatorNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getNormalizeVelocity
public boolean getNormalizeVelocity()Provide boolean value from inputOutput SFBool field named normalizeVelocity.
Tooltip: normalizeVelocity field specifies whether the velocity vectors are normalized to produce smooth speed transitions, or transformed into tangency vectors.- Hint: X3D 19.2.3 Non-linear interpolation https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/interpolators.html#NonlinearInterpolation
- Specified by:
getNormalizeVelocity
in interfaceSplineScalarInterpolator
- Returns:
- value of normalizeVelocity field
-
setNormalizeVelocity
Accessor method to assign boolean value to inputOutput SFBool field named normalizeVelocity.
Tooltip: normalizeVelocity field specifies whether the velocity vectors are normalized to produce smooth speed transitions, or transformed into tangency vectors.- Hint: X3D 19.2.3 Non-linear interpolation https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/interpolators.html#NonlinearInterpolation
- Specified by:
setNormalizeVelocity
in interfaceSplineScalarInterpolator
- Parameters:
newValue
- is new value for the normalizeVelocity field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setNormalizeVelocity
Assign typed object value to SFBool normalizeVelocity field, similar tosetNormalizeVelocity(boolean)
.- Parameters:
newValue
- is new value for the normalizeVelocity field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getValue
public float getValue()Provide float value from outputOnly SFFloat field named value_changed.
Tooltip: Nonlinearly interpolated output value computed by using current time fraction along with corresponding key, keyValue and keyVelocity values.- 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 interfaceSplineScalarInterpolator
- Returns:
- value of value_changed field
-
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 classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
-
setDEF
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
SplineScalarInterpolator
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
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 classX3DConcreteElement
- 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:
-
findElementByNameValue
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 classX3DConcreteElement
- 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:
-
hasElementByNameValue
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:
-
findNodeByDEF
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 classX3DConcreteElement
- 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:
-
hasNodeByDEF
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:
-
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 classX3DConcreteElement
- Returns:
- validation results (if any)
-