Class PeriodicWave

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Sound.PeriodicWave

All Implemented Interfaces:

X3DChildNode, X3DNode, PeriodicWave, X3DSoundNode

public class PeriodicWave
extends X3DConcreteNode
implements PeriodicWave

PeriodicWave defines a periodic waveform that can be used to shape the output of an Oscillator.

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. PeriodicWave node tooltip: [X3DNode] PeriodicWave defines a periodic waveform that can be used to shape the output of an Oscillator.#10;

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#periodicwave

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the PeriodicWave element: Sound
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 String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_OPTIONSIMAG	fromField ROUTE name for MFFloat field named optionsImag.
static final String	fromField_OPTIONSREAL	fromField ROUTE name for MFFloat field named optionsReal.
static final String	fromField_TYPE	fromField ROUTE name for SFString field named type.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Sound component level for this element: 2
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: PeriodicWave.
static final ArrayList<Float>	OPTIONSIMAG_DEFAULT_VALUE	MFFloat field named optionsImag has default value equal to an empty list.
static final ArrayList<Float>	OPTIONSREAL_DEFAULT_VALUE	MFFloat field named optionsReal has default value equal to an empty list.
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_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_OPTIONSIMAG	toField ROUTE name for MFFloat field named optionsImag.
static final String	toField_OPTIONSREAL	toField ROUTE name for MFFloat field named optionsReal.
static final String	toField_TYPE	toField ROUTE name for SFString field named type.
static final String	TYPE_CUSTOM	Tooltip: X3D version of "custom" in Web Audio API.
static final String	TYPE_CUSTOM_ALIAS	SFString SFString enumeration value "CUSTOM" has alias "custom"
static final String	TYPE_DEFAULT_VALUE	SFString field named type has default value "SQUARE" (Java syntax) or SQUARE (XML syntax).
static final String	TYPE_SAWTOOTH	Tooltip: X3D version of "sawtooth" in Web Audio API.
static final String	TYPE_SAWTOOTH_ALIAS	SFString SFString enumeration value "SAWTOOTH" has alias "sawtooth"
static final String	TYPE_SINE	Tooltip: X3D version of "sine" in Web Audio API.
static final String	TYPE_SINE_ALIAS	SFString SFString enumeration value "SINE" has alias "sine"
static final String	TYPE_SQUARE	Tooltip: X3D version of "square" in Web Audio API.
static final String	TYPE_SQUARE_ALIAS	SFString SFString enumeration value "SQUARE" has alias "square"
static final String	TYPE_TRIANGLE	Tooltip: X3D version of "triangle" in Web Audio API.
static final String	TYPE_TRIANGLE_ALIAS	SFString SFString enumeration value "TRIANGLE" has alias "triangle"

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

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PeriodicWave	addComments(String newComment)	Add comment as String to contained commentsList.
PeriodicWave	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
PeriodicWave	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
PeriodicWave	addOptionsImag(float newValue)	Add singleton float value to MFFloat optionsImag field.
PeriodicWave	addOptionsImag(SFFloat newValue)	Add singleton SFFloat value to MFFloat optionsImag field.
PeriodicWave	addOptionsReal(float newValue)	Add singleton float value to MFFloat optionsReal field.
PeriodicWave	addOptionsReal(SFFloat newValue)	Add singleton SFFloat value to MFFloat optionsReal field.
PeriodicWave	clearIS()	Utility method to clear SFNode value of IS field.
PeriodicWave	clearMetadata()	Utility method to clear SFNode value of metadata field.
PeriodicWave	clearOptionsImag()	Utility method to clear MFFloat value of optionsImag field.
PeriodicWave	clearOptionsReal()	Utility method to clear MFFloat value of optionsReal 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 PeriodicWave element: Sound
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.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
String	getDescription()	Provide String value from inputOutput SFString field named description.
final String	getElementName()	Provides name of this element: PeriodicWave
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
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.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float[]	getOptionsImag()	Provide array of Float results from inputOutput MFFloat field named optionsImag.
ArrayList<Float>	getOptionsImagList()	Utility method to get ArrayList value of MFFloat optionsImag field, similar to getOptionsImag().
String	getOptionsImagString()	Utility method to get String value of MFFloat optionsImag field, similar to getOptionsImag().
float[]	getOptionsReal()	Provide array of Float results from inputOutput MFFloat field named optionsReal.
ArrayList<Float>	getOptionsRealList()	Utility method to get ArrayList value of MFFloat optionsReal field, similar to getOptionsReal().
String	getOptionsRealString()	Utility method to get String value of MFFloat optionsReal field, similar to getOptionsReal().
String	getType()	Provide String enumeration value (baseType SFString) ["SINE" | "SQUARE" | "SAWTOOTH" | "TRIANGLE" | "CUSTOM"] from inputOutput SFString field named type.
static String	getTypeAlias(String typeValue)	Get alias for this type
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.
static boolean	hasTypeAlias(String type)	Whether a alias exists for this type
final void	initialize()	Initialize all member variables to default values.
final PeriodicWave	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
PeriodicWave	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final PeriodicWave	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
PeriodicWave	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final PeriodicWave	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
PeriodicWave	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
PeriodicWave	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
PeriodicWave	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
PeriodicWave	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
PeriodicWave	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
final PeriodicWave	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
PeriodicWave	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
PeriodicWave	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
PeriodicWave	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
PeriodicWave	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
PeriodicWave	setOptionsImag(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOptionsImag(float[]).
PeriodicWave	setOptionsImag(float[] newValue)	Accessor method to assign Float array to inputOutput MFFloat field named optionsImag.
PeriodicWave	setOptionsImag(int[] newValue)	Assign floating-point array value of MFFloat optionsImag field, similar to setOptionsImag(float[]).
PeriodicWave	setOptionsImag(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat optionsImag field, similar to setOptionsImag(float[]).
PeriodicWave	setOptionsImag(MFFloat newValue)	Assign typed object value to MFFloat optionsImag field, similar to setOptionsImag(float[]).
PeriodicWave	setOptionsReal(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOptionsReal(float[]).
PeriodicWave	setOptionsReal(float[] newValue)	Accessor method to assign Float array to inputOutput MFFloat field named optionsReal.
PeriodicWave	setOptionsReal(int[] newValue)	Assign floating-point array value of MFFloat optionsReal field, similar to setOptionsReal(float[]).
PeriodicWave	setOptionsReal(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat optionsReal field, similar to setOptionsReal(float[]).
PeriodicWave	setOptionsReal(MFFloat newValue)	Assign typed object value to MFFloat optionsReal field, similar to setOptionsReal(float[]).
PeriodicWave	setType(String newValue)	Accessor method to assign String enumeration value ("SINE" | "SQUARE" | "SAWTOOTH" | "TRIANGLE" | "CUSTOM") to inputOutput SFString field named type.
PeriodicWave	setType(SFString newValue)	Assign typed object value to SFString type field, similar to setType(String).
final PeriodicWave	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
PeriodicWave	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
PeriodicWave	setUSE(PeriodicWave DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	validate()	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

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

Field Details

TYPE_SINE

public static final String TYPE_SINE

Tooltip: X3D version of "sine" in Web Audio API. SFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "SINE" (Java syntax) or SINE (XML syntax).

See Also:

• TYPE_SINE_ALIAS
• XML Schema: periodicWaveTypeChoices
• https://www.w3.org/TR/webaudio/#enumdef-oscillatortype
• Constant Field Values

TYPE_SINE_ALIAS

public static final String TYPE_SINE_ALIAS

SFString SFString enumeration value "SINE" has alias "sine"

See Also:

• TYPE_SINE
• Constant Field Values

TYPE_SQUARE

public static final String TYPE_SQUARE

Tooltip: X3D version of "square" in Web Audio API. SFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "SQUARE" (Java syntax) or SQUARE (XML syntax).

See Also:

• TYPE_SQUARE_ALIAS
• XML Schema: periodicWaveTypeChoices
• https://www.w3.org/TR/webaudio/#enumdef-oscillatortype
• Constant Field Values

TYPE_SQUARE_ALIAS

public static final String TYPE_SQUARE_ALIAS

SFString SFString enumeration value "SQUARE" has alias "square"

See Also:

• TYPE_SQUARE
• Constant Field Values

TYPE_SAWTOOTH

public static final String TYPE_SAWTOOTH

Tooltip: X3D version of "sawtooth" in Web Audio API. SFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "SAWTOOTH" (Java syntax) or SAWTOOTH (XML syntax).

See Also:

• TYPE_SAWTOOTH_ALIAS
• XML Schema: periodicWaveTypeChoices
• https://www.w3.org/TR/webaudio/#enumdef-oscillatortype
• Constant Field Values

TYPE_SAWTOOTH_ALIAS

public static final String TYPE_SAWTOOTH_ALIAS

SFString SFString enumeration value "SAWTOOTH" has alias "sawtooth"

See Also:

• TYPE_SAWTOOTH
• Constant Field Values

TYPE_TRIANGLE

public static final String TYPE_TRIANGLE

Tooltip: X3D version of "triangle" in Web Audio API. SFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "TRIANGLE" (Java syntax) or TRIANGLE (XML syntax).

See Also:

• TYPE_TRIANGLE_ALIAS
• XML Schema: periodicWaveTypeChoices
• https://www.w3.org/TR/webaudio/#enumdef-oscillatortype
• Constant Field Values

TYPE_TRIANGLE_ALIAS

public static final String TYPE_TRIANGLE_ALIAS

SFString SFString enumeration value "TRIANGLE" has alias "triangle"

See Also:

• TYPE_TRIANGLE
• Constant Field Values

TYPE_CUSTOM

public static final String TYPE_CUSTOM

Tooltip: X3D version of "custom" in Web Audio API. SFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "CUSTOM" (Java syntax) or CUSTOM (XML syntax).

See Also:

• TYPE_CUSTOM_ALIAS
• XML Schema: periodicWaveTypeChoices
• https://www.w3.org/TR/webaudio/#enumdef-oscillatortype
• Constant Field Values

TYPE_CUSTOM_ALIAS

public static final String TYPE_CUSTOM_ALIAS

SFString SFString enumeration value "CUSTOM" has alias "custom"

See Also:

• TYPE_CUSTOM
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: PeriodicWave.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the PeriodicWave element: Sound

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

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

See Also:

• Constant Field Values

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

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

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

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

OPTIONSIMAG_DEFAULT_VALUE

public static final ArrayList<Float> OPTIONSIMAG_DEFAULT_VALUE

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

OPTIONSREAL_DEFAULT_VALUE

public static final ArrayList<Float> OPTIONSREAL_DEFAULT_VALUE

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

TYPE_DEFAULT_VALUE

public static final String TYPE_DEFAULT_VALUE

SFString field named type has default value "SQUARE" (Java syntax) or SQUARE (XML syntax).

See Also:

• Constant Field Values

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "periodicWave";
containerField_ALLOWED_VALUES = {"periodicWave" }; type xs:NMTOKEN

See Also:

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

fromField_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_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_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

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_OPTIONSIMAG

public static final String fromField_OPTIONSIMAG

fromField ROUTE name for MFFloat field named optionsImag.

See Also:

• Constant Field Values

toField_OPTIONSIMAG

public static final String toField_OPTIONSIMAG

toField ROUTE name for MFFloat field named optionsImag.

See Also:

• Constant Field Values

fromField_OPTIONSREAL

public static final String fromField_OPTIONSREAL

fromField ROUTE name for MFFloat field named optionsReal.

See Also:

• Constant Field Values

toField_OPTIONSREAL

public static final String toField_OPTIONSREAL

toField ROUTE name for MFFloat field named optionsReal.

See Also:

• Constant Field Values

fromField_TYPE

public static final String fromField_TYPE

fromField ROUTE name for SFString field named type.

See Also:

• Constant Field Values

toField_TYPE

public static final String toField_TYPE

toField ROUTE name for SFString field named type.

See Also:

• Constant Field Values

Constructor Details

PeriodicWave

public PeriodicWave()

Constructor for PeriodicWave to initialize member variables with default values.

PeriodicWave

public PeriodicWave(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

getTypeAlias

public static String getTypeAlias(String typeValue)

Get alias for this type

Parameters:

typeValue - of interest

Returns:

alias value, otherwise empty string if not found

hasTypeAlias

public static boolean hasTypeAlias(String type)

Whether a alias exists for this type

Parameters:

type - of interest

Returns:

true if found

getElementName

public final String getElementName()

Provides name of this element: PeriodicWave

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the PeriodicWave element: Sound

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. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• 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 PeriodicWave

Specified by:

getDescription in interface X3DSoundNode

Returns:

value of description field

setDescription

public PeriodicWave setDescription(String newValue)

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

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• 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 PeriodicWave

Specified by:

setDescription in interface X3DSoundNode

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

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

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

getEnabled

public boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface PeriodicWave

Specified by:

getEnabled in interface X3DSoundNode

Returns:

value of enabled field

setEnabled

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

Specified by:

setEnabled in interface X3DSoundNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

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

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

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 PeriodicWave

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DSoundNode

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

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DSoundNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getOptionsImag

public float[] getOptionsImag()

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

Tooltip: imaginary coefficients for defining a waveform.

• Warning: array lengths for optionsReal and optionsImag must match.

Specified by:

getOptionsImag in interface PeriodicWave

Returns:

value of optionsImag field

getOptionsImagList

public ArrayList<Float> getOptionsImagList()

Utility method to get ArrayList value of MFFloat optionsImag field, similar to getOptionsImag().

Returns:

value of optionsImag field

getOptionsImagString

public String getOptionsImagString()

Utility method to get String value of MFFloat optionsImag field, similar to getOptionsImag().

Returns:

value of optionsImag field

setOptionsImag

public PeriodicWave setOptionsImag(float[] newValue)

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

Tooltip: imaginary coefficients for defining a waveform.

• Warning: array lengths for optionsReal and optionsImag must match.

Specified by:

setOptionsImag in interface PeriodicWave

Parameters:

newValue - is new value for the optionsImag field.

Returns:

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

setOptionsImag

public PeriodicWave setOptionsImag(MFFloat newValue)

Assign typed object value to MFFloat optionsImag field, similar to setOptionsImag(float[]).

Parameters:

newValue - is new value for the optionsImag field.

Returns:

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

setOptionsImag

public PeriodicWave setOptionsImag(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat optionsImag field, similar to setOptionsImag(float[]).

Parameters:

newValue - is new value for the optionsImag field.

Returns:

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

clearOptionsImag

public PeriodicWave clearOptionsImag()

Utility method to clear MFFloat value of optionsImag field. This method does not initialize withOPTIONSIMAG_DEFAULT_VALUE.

Returns:

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

setOptionsImag

public PeriodicWave setOptionsImag(int[] newValue)

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

Parameters:

newValue - is new value for the optionsImag field.

Returns:

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

addOptionsImag

public PeriodicWave addOptionsImag(float newValue)

Add singleton float value to MFFloat optionsImag field.

Parameters:

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

Returns:

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

addOptionsImag

public PeriodicWave addOptionsImag(SFFloat newValue)

Add singleton SFFloat value to MFFloat optionsImag field.

Parameters:

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

Returns:

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

setOptionsImag

public PeriodicWave setOptionsImag(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

getOptionsReal

public float[] getOptionsReal()

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

Tooltip: real coefficients for defining a waveform.

• Warning: array lengths for optionsReal and optionsImag must match.

Specified by:

getOptionsReal in interface PeriodicWave

Returns:

value of optionsReal field

getOptionsRealList

public ArrayList<Float> getOptionsRealList()

Utility method to get ArrayList value of MFFloat optionsReal field, similar to getOptionsReal().

Returns:

value of optionsReal field

getOptionsRealString

public String getOptionsRealString()

Utility method to get String value of MFFloat optionsReal field, similar to getOptionsReal().

Returns:

value of optionsReal field

setOptionsReal

public PeriodicWave setOptionsReal(float[] newValue)

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

Tooltip: real coefficients for defining a waveform.

• Warning: array lengths for optionsReal and optionsImag must match.

Specified by:

setOptionsReal in interface PeriodicWave

Parameters:

newValue - is new value for the optionsReal field.

Returns:

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

setOptionsReal

public PeriodicWave setOptionsReal(MFFloat newValue)

Assign typed object value to MFFloat optionsReal field, similar to setOptionsReal(float[]).

Parameters:

newValue - is new value for the optionsReal field.

Returns:

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

setOptionsReal

public PeriodicWave setOptionsReal(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat optionsReal field, similar to setOptionsReal(float[]).

Parameters:

newValue - is new value for the optionsReal field.

Returns:

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

clearOptionsReal

public PeriodicWave clearOptionsReal()

Utility method to clear MFFloat value of optionsReal field. This method does not initialize withOPTIONSREAL_DEFAULT_VALUE.

Returns:

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

setOptionsReal

public PeriodicWave setOptionsReal(int[] newValue)

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

Parameters:

newValue - is new value for the optionsReal field.

Returns:

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

addOptionsReal

public PeriodicWave addOptionsReal(float newValue)

Add singleton float value to MFFloat optionsReal field.

Parameters:

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

Returns:

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

addOptionsReal

public PeriodicWave addOptionsReal(SFFloat newValue)

Add singleton SFFloat value to MFFloat optionsReal field.

Parameters:

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

Returns:

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

setOptionsReal

public PeriodicWave setOptionsReal(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

getType

public String getType()

Provide String enumeration value (baseType SFString) ["SINE" | "SQUARE" | "SAWTOOTH" | "TRIANGLE" | "CUSTOM"] from inputOutput SFString field named type.

Tooltip: The type field specifies shape of waveform to play, which can be one of several provided values or else 'custom' to indicate that real and imaginary coefficient arrays define a custom waveform.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dictdef-periodicwaveoptions

Available enumeration values for string comparison: SINE, SQUARE, SAWTOOTH, TRIANGLE, CUSTOM.

Specified by:

getType in interface PeriodicWave

Returns:

value of type field

setType

public PeriodicWave setType(String newValue)

Accessor method to assign String enumeration value ("SINE" | "SQUARE" | "SAWTOOTH" | "TRIANGLE" | "CUSTOM") to inputOutput SFString field named type.

Warning: authors can only choose from a strict list of enumeration values (SINE, SQUARE, SAWTOOTH, TRIANGLE, CUSTOM).

Tooltip: The type field specifies shape of waveform to play, which can be one of several provided values or else 'custom' to indicate that real and imaginary coefficient arrays define a custom waveform.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dictdef-periodicwaveoptions

Specified by:

setType in interface PeriodicWave

Parameters:

newValue - is new value for the type field.

Returns:

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

setType

public PeriodicWave setType(SFString newValue)

Assign typed object value to SFString type field, similar to setType(String).

Parameters:

newValue - is new value for the type field.

Returns:

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public PeriodicWave addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public PeriodicWave addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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