Class AcousticProperties

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Shape.AcousticProperties

All Implemented Interfaces:

X3DNode, AcousticProperties, X3DAppearanceChildNode

public class AcousticProperties
extends X3DConcreteNode
implements AcousticProperties

AcousticProperties specifies the interaction of sound waves with characteristics of geometric objects in the scene.

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. AcousticProperties node tooltip: [X3DAppearanceChildNode] AcousticProperties specifies the interaction of sound waves with characteristics of geometric objects in the scene. Acoustic coefficient values are expected to fully account for physical and structural characteristics of associated geometry such as width, height, thickness, shape, softness and/or hardness, and density variations.

• Hint: AcousticProperties must have a parent Appearance node, and only affects geometry within the same Shape.
• Hint: proxy geometry for acoustic response can be far simpler than geometry needed for visual rendering.
• Hint: X3D Architecture Figure 16.2 Sound Propagation Phenomena https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/sound.html#f-SoundPropagationPhenomena

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

Field Summary

Fields

Modifier and Type	Field	Description
static final float	ABSORPTION_DEFAULT_VALUE	SFFloat field named absorption has default value 0f (Java syntax) or 0 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the AcousticProperties element: Shape
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 float	DIFFUSE_DEFAULT_VALUE	SFFloat field named diffuse has default value 0f (Java syntax) or 0 (XML syntax).
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final String	fromField_ABSORPTION	fromField ROUTE name for SFFloat field named absorption.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_DIFFUSE	fromField ROUTE name for SFFloat field named diffuse.
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_REFRACTION	fromField ROUTE name for SFFloat field named refraction.
static final String	fromField_SPECULAR	fromField ROUTE name for SFFloat field named specular.
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 Shape component level for this element: 5
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: AcousticProperties.
static final float	REFRACTION_DEFAULT_VALUE	SFFloat field named refraction has default value 0f (Java syntax) or 0 (XML syntax).
static final float	SPECULAR_DEFAULT_VALUE	SFFloat field named specular has default value 0f (Java syntax) or 0 (XML syntax).
static final String	toField_ABSORPTION	toField ROUTE name for SFFloat field named absorption.
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_DIFFUSE	toField ROUTE name for SFFloat field named diffuse.
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_REFRACTION	toField ROUTE name for SFFloat field named refraction.
static final String	toField_SPECULAR	toField ROUTE name for SFFloat field named specular.

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

Method Summary

Modifier and Type	Method	Description
AcousticProperties	addComments(String newComment)	Add comment as String to contained commentsList.
AcousticProperties	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
AcousticProperties	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
AcousticProperties	clearIS()	Utility method to clear SFNode value of IS field.
AcousticProperties	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(String nameValue)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(String nameValue, String elementName)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
float	getAbsorption()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named absorption.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
final String	getComponent()	Defines X3D component for the AcousticProperties element: Shape
final int	getComponentLevel()	Provides default X3D component level for this element: 5
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.
float	getDiffuse()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named diffuse.
final String	getElementName()	Provides name of this element: AcousticProperties
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	getRefraction()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named refraction.
float	getSpecular()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named specular.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasElementByNameValue(String nameValue, String elementName)	Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
AcousticProperties	setAbsorption(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAbsorption(float).
AcousticProperties	setAbsorption(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named absorption.
AcousticProperties	setAbsorption(SFFloat newValue)	Assign typed object value to SFFloat absorption field, similar to setAbsorption(float).
final AcousticProperties	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
AcousticProperties	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final AcousticProperties	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
AcousticProperties	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final AcousticProperties	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
AcousticProperties	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
AcousticProperties	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
AcousticProperties	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
AcousticProperties	setDiffuse(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setDiffuse(float).
AcousticProperties	setDiffuse(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named diffuse.
AcousticProperties	setDiffuse(SFFloat newValue)	Assign typed object value to SFFloat diffuse field, similar to setDiffuse(float).
AcousticProperties	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
AcousticProperties	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
final AcousticProperties	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
AcousticProperties	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
AcousticProperties	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
AcousticProperties	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
AcousticProperties	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
AcousticProperties	setRefraction(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setRefraction(float).
AcousticProperties	setRefraction(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named refraction.
AcousticProperties	setRefraction(SFFloat newValue)	Assign typed object value to SFFloat refraction field, similar to setRefraction(float).
AcousticProperties	setSpecular(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSpecular(float).
AcousticProperties	setSpecular(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named specular.
AcousticProperties	setSpecular(SFFloat newValue)	Assign typed object value to SFFloat specular field, similar to setSpecular(float).
final AcousticProperties	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
AcousticProperties	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
AcousticProperties	setUSE(AcousticProperties 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

NAME

public static final String NAME

String constant NAME provides name of this element: AcousticProperties.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the AcousticProperties element: Shape

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Shape component level for this element: 5

See Also:

• Constant Field Values

ABSORPTION_DEFAULT_VALUE

public static final float ABSORPTION_DEFAULT_VALUE

SFFloat field named absorption has default value 0f (Java syntax) or 0 (XML syntax).

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

DIFFUSE_DEFAULT_VALUE

public static final float DIFFUSE_DEFAULT_VALUE

SFFloat field named diffuse has default value 0f (Java syntax) or 0 (XML syntax).

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

REFRACTION_DEFAULT_VALUE

public static final float REFRACTION_DEFAULT_VALUE

SFFloat field named refraction has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

SPECULAR_DEFAULT_VALUE

public static final float SPECULAR_DEFAULT_VALUE

SFFloat field named specular has default value 0f (Java syntax) or 0 (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 = "acousticProperties";
containerField_ALLOWED_VALUES = {"acousticProperties" }; 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_ABSORPTION

public static final String fromField_ABSORPTION

fromField ROUTE name for SFFloat field named absorption.

See Also:

• Constant Field Values

toField_ABSORPTION

public static final String toField_ABSORPTION

toField ROUTE name for SFFloat field named absorption.

See Also:

• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

fromField_DIFFUSE

public static final String fromField_DIFFUSE

fromField ROUTE name for SFFloat field named diffuse.

See Also:

• Constant Field Values

toField_DIFFUSE

public static final String toField_DIFFUSE

toField ROUTE name for SFFloat field named diffuse.

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_REFRACTION

public static final String fromField_REFRACTION

fromField ROUTE name for SFFloat field named refraction.

See Also:

• Constant Field Values

toField_REFRACTION

public static final String toField_REFRACTION

toField ROUTE name for SFFloat field named refraction.

See Also:

• Constant Field Values

fromField_SPECULAR

public static final String fromField_SPECULAR

fromField ROUTE name for SFFloat field named specular.

See Also:

• Constant Field Values

toField_SPECULAR

public static final String toField_SPECULAR

toField ROUTE name for SFFloat field named specular.

See Also:

• Constant Field Values

Constructor Details

AcousticProperties

public AcousticProperties()

Constructor for AcousticProperties to initialize member variables with default values.

AcousticProperties

public AcousticProperties(String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Details

getElementName

public final String getElementName()

Provides name of this element: AcousticProperties

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the AcousticProperties element: Shape

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

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

getAbsorption

public float getAbsorption()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named absorption.

Tooltip: [0,1] specifies the sound absorption coefficient of a surface, meaning the ratio of sound intensity not reflected by a surface. *

Specified by:

getAbsorption in interface AcousticProperties

Returns:

value of absorption field

setAbsorption

public AcousticProperties setAbsorption(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named absorption.

Tooltip: [0,1] specifies the sound absorption coefficient of a surface, meaning the ratio of sound intensity not reflected by a surface. *

Specified by:

setAbsorption in interface AcousticProperties

Parameters:

newValue - is new value for the absorption field.

Returns:

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

setAbsorption

public AcousticProperties setAbsorption(SFFloat newValue)

Assign typed object value to SFFloat absorption field, similar to setAbsorption(float).

Parameters:

newValue - is new value for the absorption field.

Returns:

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

setAbsorption

public AcousticProperties setAbsorption(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAbsorption(float).

Parameters:

newValue - is new value for field

Returns:

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

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 AcousticProperties

Returns:

value of description field

setDescription

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

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

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

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

getDiffuse

public float getDiffuse()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named diffuse.

Tooltip: [0,1] diffuse coefficient of sound reflection indicates how much of the incident sound energy is reflected back in multiple directions. *

Specified by:

getDiffuse in interface AcousticProperties

Returns:

value of diffuse field

setDiffuse

public AcousticProperties setDiffuse(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named diffuse.

Tooltip: [0,1] diffuse coefficient of sound reflection indicates how much of the incident sound energy is reflected back in multiple directions. *

Specified by:

setDiffuse in interface AcousticProperties

Parameters:

newValue - is new value for the diffuse field.

Returns:

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

setDiffuse

public AcousticProperties setDiffuse(SFFloat newValue)

Assign typed object value to SFFloat diffuse field, similar to setDiffuse(float).

Parameters:

newValue - is new value for the diffuse field.

Returns:

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

setDiffuse

public AcousticProperties setDiffuse(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setDiffuse(float).

Parameters:

newValue - is new value for field

Returns:

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

Returns:

value of enabled field

setEnabled

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

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

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

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

Specified by:

getMetadata in interface X3DAppearanceChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

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

setMetadata

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

Specified by:

setMetadata in interface X3DAppearanceChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getRefraction

public float getRefraction()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named refraction.

Tooltip: [0,1] sound refraction coefficient of a medium, which determines change in propagation direction of sound wave when obliquely crossing boundary between two mediums where its speed is different.

• Hint: relationships described by Snell's Law https://en.wikipedia.org/wiki/Snell%27s_law

Specified by:

getRefraction in interface AcousticProperties

Returns:

value of refraction field

setRefraction

public AcousticProperties setRefraction(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named refraction.

Tooltip: [0,1] sound refraction coefficient of a medium, which determines change in propagation direction of sound wave when obliquely crossing boundary between two mediums where its speed is different.

• Hint: relationships described by Snell's Law https://en.wikipedia.org/wiki/Snell%27s_law

Specified by:

setRefraction in interface AcousticProperties

Parameters:

newValue - is new value for the refraction field.

Returns:

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

setRefraction

public AcousticProperties setRefraction(SFFloat newValue)

Assign typed object value to SFFloat refraction field, similar to setRefraction(float).

Parameters:

newValue - is new value for the refraction field.

Returns:

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

setRefraction

public AcousticProperties setRefraction(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setRefraction(float).

Parameters:

newValue - is new value for field

Returns:

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

getSpecular

public float getSpecular()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named specular.

Tooltip: [0,1] specular coefficient of sound reflection striking a plane surface, directly reflected back into space, where angle of reflection equals angle of incidence. *

Specified by:

getSpecular in interface AcousticProperties

Returns:

value of specular field

setSpecular

public AcousticProperties setSpecular(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named specular.

Tooltip: [0,1] specular coefficient of sound reflection striking a plane surface, directly reflected back into space, where angle of reflection equals angle of incidence. *

Specified by:

setSpecular in interface AcousticProperties

Parameters:

newValue - is new value for the specular field.

Returns:

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

setSpecular

public AcousticProperties setSpecular(SFFloat newValue)

Assign typed object value to SFFloat specular field, similar to setSpecular(float).

Parameters:

newValue - is new value for the specular field.

Returns:

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

setSpecular

public AcousticProperties setSpecular(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSpecular(float).

Parameters:

newValue - is new value for field

Returns:

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public AcousticProperties addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public AcousticProperties addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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