Package org.web3d.x3d.jsail.Sound
Class PeriodicWave
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Sound.PeriodicWave
- All Implemented Interfaces:
X3DNode
,PeriodicWave
public class PeriodicWave extends X3DConcreteNode implements PeriodicWave
PeriodicWave defines a periodic waveform that can be used to shape the output of an Oscillator.
X3D node tooltip: (X3D version 4.0 draft) [X3DNode] PeriodicWave defines a periodic waveform that can be used to shape the output of an Oscillator.#10;
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.
X3D node tooltip: (X3D version 4.0 draft) [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.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the PeriodicWave element: Soundstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static java.lang.String
DESCRIPTION_DEFAULT_VALUE
SFString field named description has default value equal to an empty string.static java.lang.String
fromField_DESCRIPTION
fromField ROUTE name for SFString field named description.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_OPTIONSIMAG
fromField ROUTE name for MFFloat field named optionsImag.static java.lang.String
fromField_OPTIONSREAL
fromField ROUTE name for MFFloat field named optionsReal.static java.lang.String
fromField_TYPE
fromField ROUTE name for SFString field named type.static IS
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Sound component level for this element: 2static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: PeriodicWave.static java.util.ArrayList<java.lang.Float>
OPTIONSIMAG_DEFAULT_VALUE
MFFloat field named optionsImag has default value equal to an empty list.static java.util.ArrayList<java.lang.Float>
OPTIONSREAL_DEFAULT_VALUE
MFFloat field named optionsReal has default value equal to an empty list.static java.lang.String
toField_DESCRIPTION
toField ROUTE name for SFString field named description.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_OPTIONSIMAG
toField ROUTE name for MFFloat field named optionsImag.static java.lang.String
toField_OPTIONSREAL
toField ROUTE name for MFFloat field named optionsReal.static java.lang.String
toField_TYPE
toField ROUTE name for SFString field named type.static java.lang.String
TYPE_DEFAULT_VALUE
SFString field named type has default value "square" (Java syntax) or square (XML syntax).static java.lang.String
TYPE_SAWTOOTH
SFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "sawtooth" (Java syntax) or sawtooth (XML syntax).static java.lang.String
TYPE_SINE
SFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "sine" (Java syntax) or sine (XML syntax).static java.lang.String
TYPE_SQUARE
SFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "square" (Java syntax) or square (XML syntax).static java.lang.String
TYPE_TRIANGLE
SFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "triangle" (Java syntax) or triangle (XML syntax).Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description PeriodicWave()
Constructor for PeriodicWave to initialize member variables with default values.PeriodicWave(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description PeriodicWave
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.PeriodicWave
addComments(java.lang.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(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.java.lang.String
getComponent()
Defines X3D component for the PeriodicWave element: Soundint
getComponentLevel()
Provides default X3D component level for this element: 2java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getDescription()
Provide String value from inputOutput SFString field named description.java.lang.String
getElementName()
Provides name of this element: PeriodicWavejava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.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.java.util.ArrayList<java.lang.Float>
getOptionsImagList()
Utility method to get ArrayList value of MFFloat optionsImag field, similar togetOptionsImag()
.java.lang.String
getOptionsImagString()
Utility method to get String value of MFFloat optionsImag field, similar togetOptionsImag()
.float[]
getOptionsReal()
Provide array of Float results from inputOutput MFFloat field named optionsReal.java.util.ArrayList<java.lang.Float>
getOptionsRealList()
Utility method to get ArrayList value of MFFloat optionsReal field, similar togetOptionsReal()
.java.lang.String
getOptionsRealString()
Utility method to get String value of MFFloat optionsReal field, similar togetOptionsReal()
.java.lang.String
getType()
Provide String enumeration value (baseType SFString) ["sine" | "square" | "sawtooth" | "triangle"] from inputOutput SFString field named type.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.boolean
hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
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(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.void
initialize()
Initialize all member variables to default values.PeriodicWave
setCssClass(java.lang.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 tosetCssClass(String)
.PeriodicWave
setDEF(java.lang.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 tosetDEF(String)
.PeriodicWave
setDescription(java.lang.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 tosetDescription(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 tosetOptionsImag(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 tosetOptionsImag(float[])
.PeriodicWave
setOptionsImag(java.util.ArrayList<java.lang.Float> newValue)
Assign ArrayList value of MFFloat optionsImag field, similar tosetOptionsImag(float[])
.PeriodicWave
setOptionsImag(MFFloat newValue)
Assign typed object value to MFFloat optionsImag field, similar tosetOptionsImag(float[])
.PeriodicWave
setOptionsReal(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetOptionsReal(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 tosetOptionsReal(float[])
.PeriodicWave
setOptionsReal(java.util.ArrayList<java.lang.Float> newValue)
Assign ArrayList value of MFFloat optionsReal field, similar tosetOptionsReal(float[])
.PeriodicWave
setOptionsReal(MFFloat newValue)
Assign typed object value to MFFloat optionsReal field, similar tosetOptionsReal(float[])
.PeriodicWave
setType(java.lang.String newValue)
Accessor method to assign String enumeration value ("sine" | "square" | "sawtooth" | "triangle") to inputOutput SFString field named type.PeriodicWave
setType(SFString newValue)
Assign typed object value to SFString type field, similar tosetType(String)
.PeriodicWave
setUSE(java.lang.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 tosetUSE(String)
.PeriodicWave
setUSE(PeriodicWave DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.String
validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, 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, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
TYPE_SINE
public static final java.lang.String TYPE_SINESFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "sine" (Java syntax) or sine (XML syntax). -
TYPE_SQUARE
public static final java.lang.String TYPE_SQUARESFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "square" (Java syntax) or square (XML syntax). -
TYPE_SAWTOOTH
public static final java.lang.String TYPE_SAWTOOTHSFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "sawtooth" (Java syntax) or sawtooth (XML syntax). -
TYPE_TRIANGLE
public static final java.lang.String TYPE_TRIANGLESFString field named type with X3DUOM simpleType periodicWaveTypeChoices and with X3DUOM baseType SFString can equal this value "triangle" (Java syntax) or triangle (XML syntax). -
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: PeriodicWave.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the PeriodicWave element: Sound- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Sound component level for this element: 2- See Also:
- Constant Field Values
-
DESCRIPTION_DEFAULT_VALUE
public static final java.lang.String DESCRIPTION_DEFAULT_VALUESFString field named description has default value equal to an empty string.- See Also:
- Constant Field Values
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
OPTIONSIMAG_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Float> OPTIONSIMAG_DEFAULT_VALUEMFFloat field named optionsImag has default value equal to an empty list. -
OPTIONSREAL_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Float> OPTIONSREAL_DEFAULT_VALUEMFFloat field named optionsReal has default value equal to an empty list. -
TYPE_DEFAULT_VALUE
public static final java.lang.String TYPE_DEFAULT_VALUESFString field named type has default value "square" (Java syntax) or square (XML syntax).- See Also:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField 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. -
fromField_DESCRIPTION
public static final java.lang.String fromField_DESCRIPTIONfromField ROUTE name for SFString field named description.- See Also:
- Constant Field Values
-
toField_DESCRIPTION
public static final java.lang.String toField_DESCRIPTIONtoField ROUTE name for SFString field named description.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_OPTIONSIMAG
public static final java.lang.String fromField_OPTIONSIMAGfromField ROUTE name for MFFloat field named optionsImag.- See Also:
- Constant Field Values
-
toField_OPTIONSIMAG
public static final java.lang.String toField_OPTIONSIMAGtoField ROUTE name for MFFloat field named optionsImag.- See Also:
- Constant Field Values
-
fromField_OPTIONSREAL
public static final java.lang.String fromField_OPTIONSREALfromField ROUTE name for MFFloat field named optionsReal.- See Also:
- Constant Field Values
-
toField_OPTIONSREAL
public static final java.lang.String toField_OPTIONSREALtoField ROUTE name for MFFloat field named optionsReal.- See Also:
- Constant Field Values
-
fromField_TYPE
public static final java.lang.String fromField_TYPEfromField ROUTE name for SFString field named type.- See Also:
- Constant Field Values
-
toField_TYPE
public static final java.lang.String toField_TYPEtoField 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(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: PeriodicWave- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the PeriodicWave element: Sound- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- 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 classX3DConcreteNode
-
getDescription
public java.lang.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 interfacePeriodicWave
- Returns:
- value of description field
-
setDescription
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 interfacePeriodicWave
- 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
Assign typed object value to SFString description field, similar tosetDescription(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).
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
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
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
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfacePeriodicWave
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfacePeriodicWave
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- 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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
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
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
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 interfacePeriodicWave
- Returns:
- value of optionsImag field
-
getOptionsImagList
public java.util.ArrayList<java.lang.Float> getOptionsImagList()Utility method to get ArrayList value of MFFloat optionsImag field, similar togetOptionsImag()
.- Returns:
- value of optionsImag field
-
getOptionsImagString
public java.lang.String getOptionsImagString()Utility method to get String value of MFFloat optionsImag field, similar togetOptionsImag()
.- Returns:
- value of optionsImag field
-
setOptionsImag
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 interfacePeriodicWave
- 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
Assign typed object value to MFFloat optionsImag field, similar tosetOptionsImag(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
Assign ArrayList value of MFFloat optionsImag field, similar tosetOptionsImag(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
Utility method to clear MFFloat value of optionsImag field.- Returns:
PeriodicWave
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setOptionsImag
Assign floating-point array value of MFFloat optionsImag field, similar tosetOptionsImag(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
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
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
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetOptionsImag(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 interfacePeriodicWave
- Returns:
- value of optionsReal field
-
getOptionsRealList
public java.util.ArrayList<java.lang.Float> getOptionsRealList()Utility method to get ArrayList value of MFFloat optionsReal field, similar togetOptionsReal()
.- Returns:
- value of optionsReal field
-
getOptionsRealString
public java.lang.String getOptionsRealString()Utility method to get String value of MFFloat optionsReal field, similar togetOptionsReal()
.- Returns:
- value of optionsReal field
-
setOptionsReal
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 interfacePeriodicWave
- 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
Assign typed object value to MFFloat optionsReal field, similar tosetOptionsReal(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
Assign ArrayList value of MFFloat optionsReal field, similar tosetOptionsReal(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
Utility method to clear MFFloat value of optionsReal field.- Returns:
PeriodicWave
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setOptionsReal
Assign floating-point array value of MFFloat optionsReal field, similar tosetOptionsReal(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
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
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
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetOptionsReal(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 java.lang.String getType()Provide String enumeration value (baseType SFString) ["sine" | "square" | "sawtooth" | "triangle"] 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
.- Specified by:
getType
in interfacePeriodicWave
- Returns:
- value of type field
-
setType
Accessor method to assign String enumeration value ("sine" | "square" | "sawtooth" | "triangle") to inputOutput SFString field named type.
Warning: authors can only choose from a strict list of enumeration values (SINE
,SQUARE
,SAWTOOTH
,TRIANGLE
).
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 interfacePeriodicWave
- 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
Assign typed object value to SFString type field, similar tosetType(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 java.lang.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 classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
PeriodicWave
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
PeriodicWave
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
PeriodicWave
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
PeriodicWave
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- 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:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(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).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Parameters:
DEFnode
- must have a DEF value defined- Returns:
PeriodicWave
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
PeriodicWave
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
PeriodicWave
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
PeriodicWave
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.String toStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- 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 java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
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 java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
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
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
findElementByNameValue(String, String)
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
findNodeByDEF(String)
-
validate
public java.lang.String validate()Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-