Package org.web3d.x3d.jsail.Interpolation

Class EaseInEaseOut

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Interpolation.EaseInEaseOut

All Implemented Interfaces:

X3DChildNode, X3DNode, EaseInEaseOut

public class EaseInEaseOut
extends X3DConcreteNode
implements EaseInEaseOut

EaseInEaseOut enables gradual animation transitions by modifying TimeSensor fraction outputs.

X3D node tooltip: (X3D version 3.2 or later) [X3DNode] EaseInEaseOut enables gradual animation transitions by modifying TimeSensor fraction outputs. Output values are modified fractions. Authors can ROUTE value_changed output events to an interpolator, a sequencer, or another SFFloat attribute.

• Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisEaseInEaseOutDEF.set_fraction
• Hint: typical output connection is ROUTE thisEaseInEaseOutDEF.modifiedFraction_changed TO someDestinationNodeDEF.set_fraction.
• Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='3'/>

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the EaseInEaseOut element: Interpolation
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final float[]	EASEINEASEOUT_DEFAULT_VALUE	MFVec2f field named easeInEaseOut has default value equal to an empty list.
static final String	fromField_EASEINEASEOUT	fromField ROUTE name for MFVec2f field named easeInEaseOut.
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_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_MODIFIEDFRACTION_CHANGED	fromField ROUTE name for SFFloat field named modifiedFraction_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 int	LEVEL	Integer constant LEVEL provides default X3D Interpolation component level for this element: 4
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: EaseInEaseOut.
static final String	toField_EASEINEASEOUT	toField ROUTE name for MFVec2f field named easeInEaseOut.
static final String	toField_KEY	toField ROUTE name for MFFloat field named key.
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_ALTERNATE_VALUES, 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
EaseInEaseOut()	Constructor for EaseInEaseOut to initialize member variables with default values.
EaseInEaseOut(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
EaseInEaseOut	addComments(String newComment)	Add comment as String to contained commentsList.
EaseInEaseOut	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
EaseInEaseOut	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
EaseInEaseOut	addEaseInEaseOut(SFVec2f newValue)	Add singleton SFVec2f value to MFVec2f easeInEaseOut field.
EaseInEaseOut	addKey(float newValue)	Add singleton float value to MFFloat key field.
EaseInEaseOut	addKey(SFFloat newValue)	Add singleton SFFloat value to MFFloat key field.
EaseInEaseOut	clearIS()	Utility method to clear SFNode value of IS field.
EaseInEaseOut	clearKey()	Utility method to clear MFFloat value of key field.
EaseInEaseOut	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 EaseInEaseOut element: Interpolation
final int	getComponentLevel()	Provides default X3D component level for this element: 4
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.
float[]	getEaseInEaseOut()	Provide array of 2-tuple float results from inputOutput MFVec2f field named easeInEaseOut.
final String	getElementName()	Provides name of this element: EaseInEaseOut
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().
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getModifiedFraction()	Provide float value from outputOnly SFFloat field named modifiedFraction_changed.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
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 EaseInEaseOut	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
EaseInEaseOut	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final EaseInEaseOut	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
EaseInEaseOut	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final EaseInEaseOut	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
EaseInEaseOut	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
EaseInEaseOut	setEaseInEaseOut(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setEaseInEaseOut(float[]).
EaseInEaseOut	setEaseInEaseOut(float[] newValue)	Accessor method to assign 2-tuple float array to inputOutput MFVec2f field named easeInEaseOut.
EaseInEaseOut	setEaseInEaseOut(MFVec2f newValue)	Assign typed object value to MFVec2f easeInEaseOut field, similar to setEaseInEaseOut(float[]).
final EaseInEaseOut	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
EaseInEaseOut	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
EaseInEaseOut	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
EaseInEaseOut	setKey(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setKey(float[]).
EaseInEaseOut	setKey(float[] newValue)	Accessor method to assign Float array to inputOutput MFFloat field named key.
EaseInEaseOut	setKey(int[] newValue)	Assign floating-point array value of MFFloat key field, similar to setKey(float[]).
EaseInEaseOut	setKey(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat key field, similar to setKey(float[]).
EaseInEaseOut	setKey(MFFloat newValue)	Assign typed object value to MFFloat key field, similar to setKey(float[]).
EaseInEaseOut	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
EaseInEaseOut	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 EaseInEaseOut	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
EaseInEaseOut	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
EaseInEaseOut	setUSE(EaseInEaseOut 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

getContainerFieldAlternateValues, 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: EaseInEaseOut.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the EaseInEaseOut 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: 4

See Also:

• Constant Field Values

EASEINEASEOUT_DEFAULT_VALUE

public static final float[] EASEINEASEOUT_DEFAULT_VALUE

MFVec2f field named easeInEaseOut has default value equal to an empty list.

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.

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, default value is provided for informational purposes.

See Also:

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

fromField_EASEINEASEOUT

public static final String fromField_EASEINEASEOUT

fromField ROUTE name for MFVec2f field named easeInEaseOut.

See Also:

• Constant Field Values

toField_EASEINEASEOUT

public static final String toField_EASEINEASEOUT

toField ROUTE name for MFVec2f field named easeInEaseOut.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_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_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_MODIFIEDFRACTION_CHANGED

public static final String fromField_MODIFIEDFRACTION_CHANGED

fromField ROUTE name for SFFloat field named modifiedFraction_changed.

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

Constructor Details

EaseInEaseOut

public EaseInEaseOut()

Constructor for EaseInEaseOut to initialize member variables with default values.

EaseInEaseOut

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the EaseInEaseOut 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: 4

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

getEaseInEaseOut

public float[] getEaseInEaseOut()

Provide array of 2-tuple float results from inputOutput MFVec2f field named easeInEaseOut.

Tooltip: Array of paired values for easeOut fraction and easeIn fraction within each key interval.

• Hint: number of easeInEaseOut values must be one less than the number of keys.

Specified by:

getEaseInEaseOut in interface EaseInEaseOut

Returns:

value of easeInEaseOut field

setEaseInEaseOut

public EaseInEaseOut setEaseInEaseOut(float[] newValue)

Accessor method to assign 2-tuple float array to inputOutput MFVec2f field named easeInEaseOut.

Tooltip: Array of paired values for easeOut fraction and easeIn fraction within each key interval.

• Hint: number of easeInEaseOut values must be one less than the number of keys.

Specified by:

setEaseInEaseOut in interface EaseInEaseOut

Parameters:

newValue - is new value for the easeInEaseOut field.

Returns:

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

setEaseInEaseOut

public EaseInEaseOut setEaseInEaseOut(MFVec2f newValue)

Assign typed object value to MFVec2f easeInEaseOut field, similar to setEaseInEaseOut(float[]).

Parameters:

newValue - is new value for the easeInEaseOut field.

Returns:

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

addEaseInEaseOut

public EaseInEaseOut addEaseInEaseOut(SFVec2f newValue)

Add singleton SFVec2f value to MFVec2f easeInEaseOut field.

Parameters:

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

Returns:

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

setEaseInEaseOut

public EaseInEaseOut setEaseInEaseOut(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

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

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

Utility method to clear SFNode value of IS field.

Returns:

EaseInEaseOut - 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 easeInEaseOut array.

• Hint: number of keys must be one more than the number of easeInEaseOut values!
• 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 EaseInEaseOut

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 EaseInEaseOut 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 easeInEaseOut array.

• Hint: number of keys must be one more than the number of easeInEaseOut values!
• 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 EaseInEaseOut

Parameters:

newValue - is new value for the key field.

Returns:

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

setKey

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

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

setKey

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

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

clearKey

public EaseInEaseOut clearKey()

Utility method to clear MFFloat value of key field.

Returns:

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

setKey

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

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

addKey

public EaseInEaseOut addKey(float newValue)

Add singleton float value to MFFloat key field.

Parameters:

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

Returns:

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

addKey

public EaseInEaseOut addKey(SFFloat newValue)

Add singleton SFFloat value to MFFloat key field.

Parameters:

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

Returns:

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

setKey

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

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

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• 

Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public EaseInEaseOut clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getModifiedFraction

public float getModifiedFraction()

Provide float value from outputOnly SFFloat field named modifiedFraction_changed.

Tooltip: Interpolated output value determined by current key time, corresponding easeInEaseOut smoothing intervals, and corresponding key pair.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Specified by:

getModifiedFraction in interface EaseInEaseOut

Returns:

value of modifiedFraction_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 EaseInEaseOut 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:

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public EaseInEaseOut addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public EaseInEaseOut addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)