Package org.web3d.x3d.jsail.HAnim

Class HAnimMotion

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.HAnim.HAnimMotion

All Implemented Interfaces:

X3DChildNode, X3DNode, HAnimMotion

public class HAnimMotion
extends X3DConcreteNode
implements HAnimMotion

An HAnimMotion node supports discrete frame-by-frame playback for HAnim motion data animation.

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. HAnimMotion node tooltip: [X3DChildNode] An HAnimMotion node supports discrete frame-by-frame playback for HAnim motion data animation. Design characteristics include integration with HAnim figure data and HAnimJoint nodes, animation control, and playback of raw motion data.

• Hint: HAnim Specification https://www.web3d.org/documents/specifications/19774/V2.0
• Hint: HAnim Specification, clause 6.2 Introduction to Motion objectshttps://www.web3d.org/documents/specifications/19774/V2.0/MotionDataAnimation/MotionNodes.html#IntroductionToMotionNodes
• Hint: HAnim Specification part 2, clause 6.6 Example Usage of Motion object https://www.web3d.org/documents/specifications/19774/V2.0/MotionDataAnimation/MotionNodes.html#MotionObjectExample

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANNELS_DEFAULT_VALUE	SFString field named channels has default value equal to an empty string.
static final ArrayList<Boolean>	CHANNELSENABLED_DEFAULT_VALUE	MFBool field named channelsEnabled has default value equal to an empty list.
static final String	COMPONENT	String constant COMPONENT defines X3D component for the HAnimMotion element: HAnim
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final int	ENDFRAME_DEFAULT_VALUE	SFInt32 field named endFrame has default value 0 (Java syntax) or 0 (XML syntax).
static final double	FRAMEDURATION_DEFAULT_VALUE	SFTime field named frameDuration has default value 0.1 (Java syntax) or 0.1 (XML syntax).
static final int	FRAMEINCREMENT_DEFAULT_VALUE	SFInt32 field named frameIncrement has default value 1 (Java syntax) or 1 (XML syntax).
static final int	FRAMEINDEX_DEFAULT_VALUE	SFInt32 field named frameIndex has default value 0 (Java syntax) or 0 (XML syntax).
static final String	fromField_CHANNELS	fromField ROUTE name for SFString field named channels.
static final String	fromField_CHANNELSENABLED	fromField ROUTE name for MFBool field named channelsEnabled.
static final String	fromField_CYCLETIME	fromField ROUTE name for SFTime field named cycleTime.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_ELAPSEDTIME	fromField ROUTE name for SFTime field named elapsedTime.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_ENDFRAME	fromField ROUTE name for SFInt32 field named endFrame.
static final String	fromField_FRAMECOUNT	fromField ROUTE name for SFInt32 field named frameCount.
static final String	fromField_FRAMEDURATION	fromField ROUTE name for SFTime field named frameDuration.
static final String	fromField_FRAMEINCREMENT	fromField ROUTE name for SFInt32 field named frameIncrement.
static final String	fromField_FRAMEINDEX	fromField ROUTE name for SFInt32 field named frameIndex.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_JOINTS	fromField ROUTE name for SFString field named joints.
static final String	fromField_LOA	fromField ROUTE name for SFInt32 field named loa.
static final String	fromField_LOOP	fromField ROUTE name for SFBool field named loop.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_NAME	fromField ROUTE name for SFString field named name.
static final String	fromField_STARTFRAME	fromField ROUTE name for SFInt32 field named startFrame.
static final String	fromField_VALUES	fromField ROUTE name for MFFloat field named values.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final String	JOINTS_DEFAULT_VALUE	SFString field named joints has default value equal to an empty string.
static final int	LEVEL	Integer constant LEVEL provides default X3D HAnim component level for this element: 2
static final int	LOA_DEFAULT_VALUE	SFInt32 field named loa has default value -1 (Java syntax) or -1 (XML syntax).
static final boolean	LOOP_DEFAULT_VALUE	SFBool field named loop has default value false (Java syntax) or false (XML syntax).
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: HAnimMotion.
static final String	NAME_DEFAULT_VALUE	SFString field named name has default value equal to an empty string.
static final int	STARTFRAME_DEFAULT_VALUE	SFInt32 field named startFrame has default value 0 (Java syntax) or 0 (XML syntax).
static final String	toField_CHANNELS	toField ROUTE name for SFString field named channels.
static final String	toField_CHANNELSENABLED	toField ROUTE name for MFBool field named channelsEnabled.
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_ENDFRAME	toField ROUTE name for SFInt32 field named endFrame.
static final String	toField_FRAMEDURATION	toField ROUTE name for SFTime field named frameDuration.
static final String	toField_FRAMEINCREMENT	toField ROUTE name for SFInt32 field named frameIncrement.
static final String	toField_FRAMEINDEX	toField ROUTE name for SFInt32 field named frameIndex.
static final String	toField_JOINTS	toField ROUTE name for SFString field named joints.
static final String	toField_LOA	toField ROUTE name for SFInt32 field named loa.
static final String	toField_LOOP	toField ROUTE name for SFBool field named loop.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_NAME	toField ROUTE name for SFString field named name.
static final String	toField_NEXT	toField ROUTE name for SFBool field named next.
static final String	toField_PREVIOUS	toField ROUTE name for SFBool field named previous.
static final String	toField_STARTFRAME	toField ROUTE name for SFInt32 field named startFrame.
static final String	toField_VALUES	toField ROUTE name for MFFloat field named values.
static final ArrayList<Float>	VALUES_DEFAULT_VALUE	MFFloat field named values has default value equal to an empty list.

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

Method Summary

Modifier and Type	Method	Description
HAnimMotion	addChannelsEnabled(boolean newValue)	Add singleton boolean value to MFBool channelsEnabled field.
HAnimMotion	addChannelsEnabled(SFBool newValue)	Add singleton SFBool value to MFBool channelsEnabled field.
HAnimMotion	addComments(String newComment)	Add comment as String to contained commentsList.
HAnimMotion	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
HAnimMotion	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
HAnimMotion	addValues(float newValue)	Add singleton float value to MFFloat values field.
HAnimMotion	addValues(SFFloat newValue)	Add singleton SFFloat value to MFFloat values field.
HAnimMotion	clearChannelsEnabled()	Utility method to clear MFBool value of channelsEnabled field.
HAnimMotion	clearIS()	Utility method to clear SFNode value of IS field.
HAnimMotion	clearMetadata()	Utility method to clear SFNode value of metadata field.
HAnimMotion	clearValues()	Utility method to clear MFFloat value of values 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.
HAnimHumanoid	getAncestorHAnimHumanoid()	Return reference to ancestor HAnimHumanoid
String	getChannels()	Provide String value from inputOutput SFString field named channels.
boolean[]	getChannelsEnabled()	Provide array of Boolean results from inputOutput MFBool field named channelsEnabled.
ArrayList<Boolean>	getChannelsEnabledList()	Utility method to get ArrayList value of MFBool channelsEnabled field, similar to getChannelsEnabled().
String	getChannelsEnabledString()	Utility method to get String value of MFBool channelsEnabled field, similar to getChannelsEnabled().
final String	getComponent()	Defines X3D component for the HAnimMotion element: HAnim
final int	getComponentLevel()	Provides default X3D component level for this element: 2
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.
double	getCycleTime()	Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named cycleTime.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
String	getDescription()	Provide String value from inputOutput SFString field named description.
double	getElapsedTime()	Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.
final String	getElementName()	Provides name of this element: HAnimMotion
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
int	getEndFrame()	Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named endFrame.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
int	getFrameCount()	Provide int value within allowed range of [0,infinity) from outputOnly SFInt32 field named frameCount.
double	getFrameDuration()	Provide double value in seconds within allowed range of (0,infinity) from inputOutput SFTime field named frameDuration.
int	getFrameIncrement()	Provide int value from inputOutput SFInt32 field named frameIncrement.
int	getFrameIndex()	Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named frameIndex.
String	getHAnimVersion()	Return version of ancestor HAnimHumanoid (if found) or this HAnimMotion node
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.
String	getJoints()	Provide String value from inputOutput SFString field named joints.
int	getLoa()	Provide int value within allowed range of [-1,4] from inputOutput SFInt32 field named loa.
boolean	getLoop()	Provide boolean value from inputOutput SFBool field named loop.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
String	getName()	Provide String value from inputOutput SFString field named name.
int	getStartFrame()	Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named startFrame.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
float[]	getValues()	Provide array of Float results from inputOutput MFFloat field named values.
ArrayList<Float>	getValuesList()	Utility method to get ArrayList value of MFFloat values field, similar to getValues().
String	getValuesString()	Utility method to get String value of MFFloat values field, similar to getValues().
boolean	hasAncestorHAnimHumanoid()	Return whether ancestor HAnimHumanoid is available
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.
HAnimMotion	setChannels(String newValue)	Accessor method to assign String value to inputOutput SFString field named channels.
HAnimMotion	setChannels(SFString newValue)	Assign typed object value to SFString channels field, similar to setChannels(String).
HAnimMotion	setChannelsEnabled(boolean[] newValue)	Accessor method to assign Boolean array to inputOutput MFBool field named channelsEnabled.
HAnimMotion	setChannelsEnabled(ArrayList<Boolean> newValue)	Assign ArrayList value of MFBool channelsEnabled field, similar to setChannelsEnabled(boolean[]).
HAnimMotion	setChannelsEnabled(MFBool newValue)	Assign typed object value to MFBool channelsEnabled field, similar to setChannelsEnabled(boolean[]).
final HAnimMotion	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
HAnimMotion	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final HAnimMotion	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
HAnimMotion	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final HAnimMotion	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
HAnimMotion	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
HAnimMotion	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
HAnimMotion	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
HAnimMotion	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
HAnimMotion	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
HAnimMotion	setEndFrame(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named endFrame.
HAnimMotion	setEndFrame(SFInt32 newValue)	Assign typed object value to SFInt32 endFrame field, similar to setEndFrame(int).
HAnimMotion	setFrameDuration(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named frameDuration.
HAnimMotion	setFrameDuration(SFTime newValue)	Assign typed object value to SFTime frameDuration field, similar to setFrameDuration(double).
HAnimMotion	setFrameIncrement(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named frameIncrement.
HAnimMotion	setFrameIncrement(SFInt32 newValue)	Assign typed object value to SFInt32 frameIncrement field, similar to setFrameIncrement(int).
HAnimMotion	setFrameIndex(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named frameIndex.
HAnimMotion	setFrameIndex(SFInt32 newValue)	Assign typed object value to SFInt32 frameIndex field, similar to setFrameIndex(int).
final HAnimMotion	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
HAnimMotion	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
HAnimMotion	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
HAnimMotion	setJoints(String newValue)	Accessor method to assign String value to inputOutput SFString field named joints.
HAnimMotion	setJoints(SFString newValue)	Assign typed object value to SFString joints field, similar to setJoints(String).
HAnimMotion	setLoa(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named loa.
HAnimMotion	setLoa(SFInt32 newValue)	Assign typed object value to SFInt32 loa field, similar to setLoa(int).
HAnimMotion	setLoop(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named loop.
HAnimMotion	setLoop(SFBool newValue)	Assign typed object value to SFBool loop field, similar to setLoop(boolean).
HAnimMotion	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
HAnimMotion	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 HAnimMotion	setName(String newValue)	Accessor method to assign String value to inputOutput SFString field named name.
HAnimMotion	setName(SFString newValue)	Assign typed object value to SFString name field, similar to setName(String).
HAnimMotion	setNext(boolean newValue)	Accessor method to assign boolean value to inputOnly SFBool field named next.
HAnimMotion	setNext(SFBool newValue)	Assign typed object value to SFBool next field, similar to setNext(boolean).
HAnimMotion	setPrevious(boolean newValue)	Accessor method to assign boolean value to inputOnly SFBool field named previous.
HAnimMotion	setPrevious(SFBool newValue)	Assign typed object value to SFBool previous field, similar to setPrevious(boolean).
HAnimMotion	setStartFrame(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named startFrame.
HAnimMotion	setStartFrame(SFInt32 newValue)	Assign typed object value to SFInt32 startFrame field, similar to setStartFrame(int).
final HAnimMotion	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
HAnimMotion	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
HAnimMotion	setUSE(HAnimMotion DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
HAnimMotion	setValues(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setValues(float[]).
HAnimMotion	setValues(float[] newValue)	Accessor method to assign Float array to inputOutput MFFloat field named values.
HAnimMotion	setValues(int[] newValue)	Assign floating-point array value of MFFloat values field, similar to setValues(float[]).
HAnimMotion	setValues(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat values field, similar to setValues(float[]).
HAnimMotion	setValues(MFFloat newValue)	Assign typed object value to MFFloat values field, similar to setValues(float[]).
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, 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: HAnimMotion.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the HAnimMotion element: HAnim

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D HAnim component level for this element: 2

See Also:

• Constant Field Values

CHANNELS_DEFAULT_VALUE

public static final String CHANNELS_DEFAULT_VALUE

SFString field named channels has default value equal to an empty string.

See Also:

• Constant Field Values

CHANNELSENABLED_DEFAULT_VALUE

public static final ArrayList<Boolean> CHANNELSENABLED_DEFAULT_VALUE

MFBool field named channelsEnabled has default value equal to an empty list.

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

See Also:

• Constant Field Values

ENABLED_DEFAULT_VALUE

public static final boolean ENABLED_DEFAULT_VALUE

SFBool field named enabled has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

ENDFRAME_DEFAULT_VALUE

public static final int ENDFRAME_DEFAULT_VALUE

SFInt32 field named endFrame has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

FRAMEDURATION_DEFAULT_VALUE

public static final double FRAMEDURATION_DEFAULT_VALUE

SFTime field named frameDuration has default value 0.1 (Java syntax) or 0.1 (XML syntax).

See Also:

• Constant Field Values

FRAMEINCREMENT_DEFAULT_VALUE

public static final int FRAMEINCREMENT_DEFAULT_VALUE

SFInt32 field named frameIncrement has default value 1 (Java syntax) or 1 (XML syntax).

See Also:

• Constant Field Values

FRAMEINDEX_DEFAULT_VALUE

public static final int FRAMEINDEX_DEFAULT_VALUE

SFInt32 field named frameIndex has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

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

JOINTS_DEFAULT_VALUE

public static final String JOINTS_DEFAULT_VALUE

SFString field named joints has default value equal to an empty string.

See Also:

• Constant Field Values

LOA_DEFAULT_VALUE

public static final int LOA_DEFAULT_VALUE

SFInt32 field named loa has default value -1 (Java syntax) or -1 (XML syntax).

See Also:

• Constant Field Values

LOOP_DEFAULT_VALUE

public static final boolean LOOP_DEFAULT_VALUE

SFBool field named loop has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

NAME_DEFAULT_VALUE

public static final String NAME_DEFAULT_VALUE

SFString field named name has default value equal to an empty string.

See Also:

• Constant Field Values

STARTFRAME_DEFAULT_VALUE

public static final int STARTFRAME_DEFAULT_VALUE

SFInt32 field named startFrame has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

VALUES_DEFAULT_VALUE

public static final ArrayList<Float> VALUES_DEFAULT_VALUE

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

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

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

See Also:

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

fromField_CHANNELS

public static final String fromField_CHANNELS

fromField ROUTE name for SFString field named channels.

See Also:

• Constant Field Values

toField_CHANNELS

public static final String toField_CHANNELS

toField ROUTE name for SFString field named channels.

See Also:

• Constant Field Values

fromField_CHANNELSENABLED

public static final String fromField_CHANNELSENABLED

fromField ROUTE name for MFBool field named channelsEnabled.

See Also:

• Constant Field Values

toField_CHANNELSENABLED

public static final String toField_CHANNELSENABLED

toField ROUTE name for MFBool field named channelsEnabled.

See Also:

• Constant Field Values

fromField_CYCLETIME

public static final String fromField_CYCLETIME

fromField ROUTE name for SFTime field named cycleTime.

See Also:

• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

fromField_ELAPSEDTIME

public static final String fromField_ELAPSEDTIME

fromField ROUTE name for SFTime field named elapsedTime.

See Also:

• Constant Field Values

fromField_ENABLED

public static final String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

toField_ENABLED

public static final String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

fromField_ENDFRAME

public static final String fromField_ENDFRAME

fromField ROUTE name for SFInt32 field named endFrame.

See Also:

• Constant Field Values

toField_ENDFRAME

public static final String toField_ENDFRAME

toField ROUTE name for SFInt32 field named endFrame.

See Also:

• Constant Field Values

fromField_FRAMECOUNT

public static final String fromField_FRAMECOUNT

fromField ROUTE name for SFInt32 field named frameCount.

See Also:

• Constant Field Values

fromField_FRAMEDURATION

public static final String fromField_FRAMEDURATION

fromField ROUTE name for SFTime field named frameDuration.

See Also:

• Constant Field Values

toField_FRAMEDURATION

public static final String toField_FRAMEDURATION

toField ROUTE name for SFTime field named frameDuration.

See Also:

• Constant Field Values

fromField_FRAMEINCREMENT

public static final String fromField_FRAMEINCREMENT

fromField ROUTE name for SFInt32 field named frameIncrement.

See Also:

• Constant Field Values

toField_FRAMEINCREMENT

public static final String toField_FRAMEINCREMENT

toField ROUTE name for SFInt32 field named frameIncrement.

See Also:

• Constant Field Values

fromField_FRAMEINDEX

public static final String fromField_FRAMEINDEX

fromField ROUTE name for SFInt32 field named frameIndex.

See Also:

• Constant Field Values

toField_FRAMEINDEX

public static final String toField_FRAMEINDEX

toField ROUTE name for SFInt32 field named frameIndex.

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_JOINTS

public static final String fromField_JOINTS

fromField ROUTE name for SFString field named joints.

See Also:

• Constant Field Values

toField_JOINTS

public static final String toField_JOINTS

toField ROUTE name for SFString field named joints.

See Also:

• Constant Field Values

fromField_LOA

public static final String fromField_LOA

fromField ROUTE name for SFInt32 field named loa.

See Also:

• Constant Field Values

toField_LOA

public static final String toField_LOA

toField ROUTE name for SFInt32 field named loa.

See Also:

• Constant Field Values

fromField_LOOP

public static final String fromField_LOOP

fromField ROUTE name for SFBool field named loop.

See Also:

• Constant Field Values

toField_LOOP

public static final String toField_LOOP

toField ROUTE name for SFBool field named loop.

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_NAME

public static final String fromField_NAME

fromField ROUTE name for SFString field named name.

See Also:

• Constant Field Values

toField_NAME

public static final String toField_NAME

toField ROUTE name for SFString field named name.

See Also:

• Constant Field Values

toField_NEXT

public static final String toField_NEXT

toField ROUTE name for SFBool field named next.

See Also:

• Constant Field Values

toField_PREVIOUS

public static final String toField_PREVIOUS

toField ROUTE name for SFBool field named previous.

See Also:

• Constant Field Values

fromField_STARTFRAME

public static final String fromField_STARTFRAME

fromField ROUTE name for SFInt32 field named startFrame.

See Also:

• Constant Field Values

toField_STARTFRAME

public static final String toField_STARTFRAME

toField ROUTE name for SFInt32 field named startFrame.

See Also:

• Constant Field Values

fromField_VALUES

public static final String fromField_VALUES

fromField ROUTE name for MFFloat field named values.

See Also:

• Constant Field Values

toField_VALUES

public static final String toField_VALUES

toField ROUTE name for MFFloat field named values.

See Also:

• Constant Field Values

Constructor Details

HAnimMotion

public HAnimMotion()

Constructor for HAnimMotion to initialize member variables with default values.

HAnimMotion

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the HAnimMotion element: HAnim

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

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

getChannels

public String getChannels()

Provide String value from inputOutput SFString field named channels.

Tooltip: list of number of channels for transformation, followed by transformation type of each channel of data. Each value is space or comma separated.

• Hint: channels are enabled by default, unless otherwise indicated by channelsEnabled field.

Specified by:

getChannels in interface HAnimMotion

Returns:

value of channels field

setChannels

public HAnimMotion setChannels(String newValue)

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

Tooltip: list of number of channels for transformation, followed by transformation type of each channel of data. Each value is space or comma separated.

• Hint: channels are enabled by default, unless otherwise indicated by channelsEnabled field.

Specified by:

setChannels in interface HAnimMotion

Parameters:

newValue - is new value for the channels field.

Returns:

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

setChannels

public HAnimMotion setChannels(SFString newValue)

Assign typed object value to SFString channels field, similar to setChannels(String).

Parameters:

newValue - is new value for the channels field.

Returns:

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

getChannelsEnabled

public boolean[] getChannelsEnabled()

Provide array of Boolean results from inputOutput MFBool field named channelsEnabled.

Tooltip: boolean values for each channel indicating whether enabled. *

Specified by:

getChannelsEnabled in interface HAnimMotion

Returns:

value of channelsEnabled field

getChannelsEnabledList

public ArrayList<Boolean> getChannelsEnabledList()

Utility method to get ArrayList value of MFBool channelsEnabled field, similar to getChannelsEnabled().

Returns:

value of channelsEnabled field

getChannelsEnabledString

public String getChannelsEnabledString()

Utility method to get String value of MFBool channelsEnabled field, similar to getChannelsEnabled().

Returns:

value of channelsEnabled field

setChannelsEnabled

public HAnimMotion setChannelsEnabled(boolean[] newValue)

Accessor method to assign Boolean array to inputOutput MFBool field named channelsEnabled.

Tooltip: boolean values for each channel indicating whether enabled. *

Specified by:

setChannelsEnabled in interface HAnimMotion

Parameters:

newValue - is new value for the channelsEnabled field.

Returns:

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

setChannelsEnabled

public HAnimMotion setChannelsEnabled(MFBool newValue)

Assign typed object value to MFBool channelsEnabled field, similar to setChannelsEnabled(boolean[]).

Parameters:

newValue - is new value for the channelsEnabled field.

Returns:

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

setChannelsEnabled

public HAnimMotion setChannelsEnabled(ArrayList<Boolean> newValue)

Assign ArrayList value of MFBool channelsEnabled field, similar to setChannelsEnabled(boolean[]).

Parameters:

newValue - is new value for the channelsEnabled field.

Returns:

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

clearChannelsEnabled

public HAnimMotion clearChannelsEnabled()

Utility method to clear MFBool value of channelsEnabled field.

Returns:

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

addChannelsEnabled

public HAnimMotion addChannelsEnabled(boolean newValue)

Add singleton boolean value to MFBool channelsEnabled field.

Parameters:

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

Returns:

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

addChannelsEnabled

public HAnimMotion addChannelsEnabled(SFBool newValue)

Add singleton SFBool value to MFBool channelsEnabled field.

Parameters:

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

Returns:

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

getCycleTime

public double getCycleTime()

Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named cycleTime.

Tooltip: cycleTime sends a time event at initial starting time and at beginning of each new cycle.

• Hint: this event is useful for synchronization with other time-based animation objects.
• 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:

getCycleTime in interface HAnimMotion

Returns:

value of cycleTime field

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of this node.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getDescription in interface HAnimMotion

Returns:

value of description field

setDescription

public HAnimMotion setDescription(String newValue)

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

Tooltip: Author-provided prose that describes intended purpose of this node.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setDescription in interface HAnimMotion

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

public HAnimMotion setDescription(SFString newValue)

Assign typed object value to SFString description field, similar to setDescription(String).

Parameters:

newValue - is new value for the description field.

Returns:

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

getElapsedTime

public double getElapsedTime()

Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.

Tooltip: [0,+infinity) elapsedTime is computed elapsed time since the Motion object was activated and running, counting all traversed frames (as if frameIndex equaled 1) and multiplied by frameDuration, cumulative in seconds.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
• Hint: elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time.

Specified by:

getElapsedTime in interface HAnimMotion

Returns:

value of elapsedTime field

getEnabled

public boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface HAnimMotion

Returns:

value of enabled field

setEnabled

public HAnimMotion setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

setEnabled in interface HAnimMotion

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

public HAnimMotion setEnabled(SFBool newValue)

Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getEndFrame

public int getEndFrame()

Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named endFrame.

Tooltip: [0,+infinity) endFrame indicates final index of animated frame. Note that endFrame can precede, equal or follow endFrame. The default endFrame value is reset to (frameCount - 1) whenever frameCount is changed.

• Hint: endFrame starts at 0 and is no greater than (frameCount - 1).

Specified by:

getEndFrame in interface HAnimMotion

Returns:

value of endFrame field

setEndFrame

public HAnimMotion setEndFrame(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named endFrame.

Tooltip: [0,+infinity) endFrame indicates final index of animated frame. Note that endFrame can precede, equal or follow endFrame. The default endFrame value is reset to (frameCount - 1) whenever frameCount is changed.

• Hint: endFrame starts at 0 and is no greater than (frameCount - 1).

Specified by:

setEndFrame in interface HAnimMotion

Parameters:

newValue - is new value for the endFrame field.

Returns:

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

setEndFrame

public HAnimMotion setEndFrame(SFInt32 newValue)

Assign typed object value to SFInt32 endFrame field, similar to setEndFrame(int).

Parameters:

newValue - is new value for the endFrame field.

Returns:

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

getFrameCount

public int getFrameCount()

Provide int value within allowed range of [0,infinity) from outputOnly SFInt32 field named frameCount.

Tooltip: [0,+infinity) frameCount is computed at run time and indicates the total number of frames present in the animation, equaling the number of sets of channel data rows present in the values array. *

Specified by:

getFrameCount in interface HAnimMotion

Returns:

value of frameCount field

getFrameDuration

public double getFrameDuration()

Provide double value in seconds within allowed range of (0,infinity) from inputOutput SFTime field named frameDuration.

Tooltip: (0,+infinity) frameDuration specifies the duration of each frame in seconds. *

Specified by:

getFrameDuration in interface HAnimMotion

Returns:

value of frameDuration field

setFrameDuration

public HAnimMotion setFrameDuration(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named frameDuration.

Tooltip: (0,+infinity) frameDuration specifies the duration of each frame in seconds. *

Specified by:

setFrameDuration in interface HAnimMotion

Parameters:

newValue - is new value for the frameDuration field.

Returns:

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

setFrameDuration

public HAnimMotion setFrameDuration(SFTime newValue)

Assign typed object value to SFTime frameDuration field, similar to setFrameDuration(double).

Parameters:

newValue - is new value for the frameDuration field.

Returns:

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

getFrameIncrement

public int getFrameIncrement()

Provide int value from inputOutput SFInt32 field named frameIncrement.

Tooltip: [-infinity,+infinity) frameIncrement field controls whether playback direction is forwards or backwards, and also whether frames are skipped (for example, subsampled replay). For a single animation step, the next frameIndex value equals (frameIndex + frameIncrement) modulo frameCount.

• Hint: note that setting frameIncrement to 0 prevents automatic advancement of frameIndex and pauses animation of HAnimMotion node.

Specified by:

getFrameIncrement in interface HAnimMotion

Returns:

value of frameIncrement field

setFrameIncrement

public HAnimMotion setFrameIncrement(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named frameIncrement.

Tooltip: [-infinity,+infinity) frameIncrement field controls whether playback direction is forwards or backwards, and also whether frames are skipped (for example, subsampled replay). For a single animation step, the next frameIndex value equals (frameIndex + frameIncrement) modulo frameCount.

• Hint: note that setting frameIncrement to 0 prevents automatic advancement of frameIndex and pauses animation of HAnimMotion node.

Specified by:

setFrameIncrement in interface HAnimMotion

Parameters:

newValue - is new value for the frameIncrement field.

Returns:

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

setFrameIncrement

public HAnimMotion setFrameIncrement(SFInt32 newValue)

Assign typed object value to SFInt32 frameIncrement field, similar to setFrameIncrement(int).

Parameters:

newValue - is new value for the frameIncrement field.

Returns:

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

getFrameIndex

public int getFrameIndex()

Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named frameIndex.

Tooltip: [0,+infinity) frameIndex indicates index of current frame. Note that frameIndex can be modified whether the Motion node is enabled or not, and becomes effective when the next animation cycle occurs. Thus the frameIndex value indicates the frame currently (or next) being processed.

• Hint: frameIndex starts at 0 and is no greater than (frameCount - 1). Values less than 0 are reset as 0. Values greater or equal to frameCount are stored as (frameCount - 1). Thus the value of frameIndex shall be greater than or equal to zero, and less than frameCount.

Specified by:

getFrameIndex in interface HAnimMotion

Returns:

value of frameIndex field

setFrameIndex

public HAnimMotion setFrameIndex(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named frameIndex.

Tooltip: [0,+infinity) frameIndex indicates index of current frame. Note that frameIndex can be modified whether the Motion node is enabled or not, and becomes effective when the next animation cycle occurs. Thus the frameIndex value indicates the frame currently (or next) being processed.

• Hint: frameIndex starts at 0 and is no greater than (frameCount - 1). Values less than 0 are reset as 0. Values greater or equal to frameCount are stored as (frameCount - 1). Thus the value of frameIndex shall be greater than or equal to zero, and less than frameCount.

Specified by:

setFrameIndex in interface HAnimMotion

Parameters:

newValue - is new value for the frameIndex field.

Returns:

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

setFrameIndex

public HAnimMotion setFrameIndex(SFInt32 newValue)

Assign typed object value to SFInt32 frameIndex field, similar to setFrameIndex(int).

Parameters:

newValue - is new value for the frameIndex field.

Returns:

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

getJoints

public String getJoints()

Provide String value from inputOutput SFString field named joints.

Tooltip: joints field lists names of joints that raw motion data is to be applied to. The number and order of the names in the joints field shall match the number and order of the channels field information, and the number and order of the sets of values in the values field for each frame of the animation.

• Hint: values are space or comma separated.
• Hint: The joint name IGNORED shall be used for channel of motion data that is not used for any joint.

Specified by:

getJoints in interface HAnimMotion

Returns:

value of joints field

setJoints

public HAnimMotion setJoints(String newValue)

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

Tooltip: joints field lists names of joints that raw motion data is to be applied to. The number and order of the names in the joints field shall match the number and order of the channels field information, and the number and order of the sets of values in the values field for each frame of the animation.

• Hint: values are space or comma separated.
• Hint: The joint name IGNORED shall be used for channel of motion data that is not used for any joint.

Specified by:

setJoints in interface HAnimMotion

Parameters:

newValue - is new value for the joints field.

Returns:

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

setJoints

public HAnimMotion setJoints(SFString newValue)

Assign typed object value to SFString joints field, similar to setJoints(String).

Parameters:

newValue - is new value for the joints field.

Returns:

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

getLoa

public int getLoa()

Provide int value within allowed range of [-1,4] from inputOutput SFInt32 field named loa.

Tooltip: [-1,4] Level Of Articulation 0..4 indicates complexity and detail of joints for given humanoid skeletal hierarchy.

• Hint: loa value of -1 indicates that no LOA conformance is provided.
• Hint: Humanoid Animation (HAnim) Specification, Part 1 Architecture, 4.8.4 Levels of articulation, https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#LevelsOfArticulation

Specified by:

getLoa in interface HAnimMotion

Returns:

value of loa field

setLoa

public HAnimMotion setLoa(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named loa.

Tooltip: [-1,4] Level Of Articulation 0..4 indicates complexity and detail of joints for given humanoid skeletal hierarchy.

• Hint: loa value of -1 indicates that no LOA conformance is provided.
• Hint: Humanoid Animation (HAnim) Specification, Part 1 Architecture, 4.8.4 Levels of articulation, https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#LevelsOfArticulation

Specified by:

setLoa in interface HAnimMotion

Parameters:

newValue - is new value for the loa field.

Returns:

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

setLoa

public HAnimMotion setLoa(SFInt32 newValue)

Assign typed object value to SFInt32 loa field, similar to setLoa(int).

Parameters:

newValue - is new value for the loa field.

Returns:

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

getLoop

public boolean getLoop()

Provide boolean value from inputOutput SFBool field named loop.

Tooltip: Repeat indefinitely when loop=true, repeat only once when loop=false. *

Specified by:

getLoop in interface HAnimMotion

Returns:

value of loop field

setLoop

public HAnimMotion setLoop(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named loop.

Tooltip: Repeat indefinitely when loop=true, repeat only once when loop=false. *

Specified by:

setLoop in interface HAnimMotion

Parameters:

newValue - is new value for the loop field.

Returns:

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

setLoop

public HAnimMotion setLoop(SFBool newValue)

Assign typed object value to SFBool loop field, similar to setLoop(boolean).

Parameters:

newValue - is new value for the loop field.

Returns:

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

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

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

setMetadata

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

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:

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

See Also:

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

clearMetadata

public HAnimMotion clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getName

public String getName()

Provide String value from inputOutput SFString field named name.

Tooltip: Unique name attribute must be defined so that HAnimMotion node can be identified at run time for animation purposes. *

Specified by:

getName in interface HAnimMotion

Overrides:

getName in class X3DConcreteNode

Returns:

value of name field

setName

public final HAnimMotion setName(String newValue)

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

Tooltip: Unique name attribute must be defined so that HAnimMotion node can be identified at run time for animation purposes. *


@see X3D Scene Authoring Hints: Naming Conventions

Specified by:

setName in interface HAnimMotion

Parameters:

newValue - is new value for the name field.

Returns:

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

setName

public HAnimMotion setName(SFString newValue)

Assign typed object value to SFString name field, similar to setName(String).

Parameters:

newValue - is new value for the name field.

Returns:

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

setNext

public HAnimMotion setNext(boolean newValue)

Accessor method to assign boolean value to inputOnly SFBool field named next.

Tooltip: Send next output value in values array, using/updating various frame values as appropriate.

• Hint: this input event will "wrap around" boundary of frame array, i.e. continue from endFrame next to startFrame if necessary.
• Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.

Specified by:

setNext in interface HAnimMotion

Parameters:

newValue - is new value for the next field.

Returns:

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

setNext

public HAnimMotion setNext(SFBool newValue)

Assign typed object value to SFBool next field, similar to setNext(boolean).

Parameters:

newValue - is new value for the next field.

Returns:

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

setPrevious

public HAnimMotion setPrevious(boolean newValue)

Accessor method to assign boolean value to inputOnly SFBool field named previous.

Tooltip: Send previous output value in values array, using/updating various frame values as appropriate.

• Hint: this input event will "wrap around" boundary of frame array, i.e. continue from startFrame next to endFrame if necessary.
• Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.

Specified by:

setPrevious in interface HAnimMotion

Parameters:

newValue - is new value for the previous field.

Returns:

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

setPrevious

public HAnimMotion setPrevious(SFBool newValue)

Assign typed object value to SFBool previous field, similar to setPrevious(boolean).

Parameters:

newValue - is new value for the previous field.

Returns:

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

getStartFrame

public int getStartFrame()

Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named startFrame.

Tooltip: [0,+infinity) startFrame indicates initial index of animated frame. Note that startFrame can precede, equal or follow endFrame.

• Hint: startFrame starts at 0 and is no greater than (frameCount - 1).

Specified by:

getStartFrame in interface HAnimMotion

Returns:

value of startFrame field

setStartFrame

public HAnimMotion setStartFrame(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named startFrame.

Tooltip: [0,+infinity) startFrame indicates initial index of animated frame. Note that startFrame can precede, equal or follow endFrame.

• Hint: startFrame starts at 0 and is no greater than (frameCount - 1).

Specified by:

setStartFrame in interface HAnimMotion

Parameters:

newValue - is new value for the startFrame field.

Returns:

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

setStartFrame

public HAnimMotion setStartFrame(SFInt32 newValue)

Assign typed object value to SFInt32 startFrame field, similar to setStartFrame(int).

Parameters:

newValue - is new value for the startFrame field.

Returns:

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

getValues

public float[] getValues()

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

Tooltip: values field contains all transformation values, ordered first by frame, then by joint, and then by transformation Sets of floats in the values array matching the order listed in joints and channels fields. *

Specified by:

getValues in interface HAnimMotion

Returns:

value of values field

getValuesList

public ArrayList<Float> getValuesList()

Utility method to get ArrayList value of MFFloat values field, similar to getValues().

Returns:

value of values field

getValuesString

public String getValuesString()

Utility method to get String value of MFFloat values field, similar to getValues().

Returns:

value of values field

setValues

public HAnimMotion setValues(float[] newValue)

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

Tooltip: values field contains all transformation values, ordered first by frame, then by joint, and then by transformation Sets of floats in the values array matching the order listed in joints and channels fields. *

Specified by:

setValues in interface HAnimMotion

Parameters:

newValue - is new value for the values field.

Returns:

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

setValues

public HAnimMotion setValues(MFFloat newValue)

Assign typed object value to MFFloat values field, similar to setValues(float[]).

Parameters:

newValue - is new value for the values field.

Returns:

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

setValues

public HAnimMotion setValues(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat values field, similar to setValues(float[]).

Parameters:

newValue - is new value for the values field.

Returns:

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

clearValues

public HAnimMotion clearValues()

Utility method to clear MFFloat value of values field.

Returns:

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

setValues

public HAnimMotion setValues(int[] newValue)

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

Parameters:

newValue - is new value for the values field.

Returns:

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

addValues

public HAnimMotion addValues(float newValue)

Add singleton float value to MFFloat values field.

Parameters:

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

Returns:

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

addValues

public HAnimMotion addValues(SFFloat newValue)

Add singleton SFFloat value to MFFloat values field.

Parameters:

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

Returns:

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

setValues

public HAnimMotion setValues(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

getDEF

public String getDEF()

Provide String value from inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final HAnimMotion 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:

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

getAncestorHAnimHumanoid

public HAnimHumanoid getAncestorHAnimHumanoid()

Return reference to ancestor HAnimHumanoid

Returns:

HAnimHumanoid if found, otherwise null

hasAncestorHAnimHumanoid

public boolean hasAncestorHAnimHumanoid()

Return whether ancestor HAnimHumanoid is available

Returns:

true if ancestor HAnimHumanoid found

getHAnimVersion

public String getHAnimVersion()

Return version of ancestor HAnimHumanoid (if found) or this HAnimMotion node

Returns:

ancestor version if found, otherwise 2.0

See Also:

• HAnimHumanoid.VERSION_2_0

setUSE

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

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

addComments

public HAnimMotion addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public HAnimMotion addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

toStringX3D

public String toStringX3D(int indentLevel)

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

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

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

toStringVRML97

public String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

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

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue)

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

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

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

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 String elementName)

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

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

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

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

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 String elementName)

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

Parameters:

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

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

Returns:

whether node is found

See Also:

• findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(String DEFvalue)

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

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same DEF, this method does not handle that case.

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

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

Returns:

object reference to found node, null otherwise

See Also:

• findElementByNameValue(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(String DEFvalue)

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

Parameters:

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

Returns:

whether node is found

See Also:

• findNodeByDEF(String)

validate

public String validate()

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

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)