Package org.web3d.x3d.jsail.ParticleSystems

Class WindPhysicsModel

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.ParticleSystems.WindPhysicsModel

All Implemented Interfaces:

X3DNode, WindPhysicsModel, X3DParticlePhysicsModelNode

public class WindPhysicsModel
extends X3DConcreteNode
implements WindPhysicsModel

WindPhysicsModel applies a wind effect to the particles.

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. WindPhysicsModel node tooltip: (X3D version 3.2 or later) [X3DParticlePhysicsModelNode] WindPhysicsModel applies a wind effect to the particles. The wind includes a random variation factor to model gustiness. *


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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the WindPhysicsModel element: ParticleSystems
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final float[]	DIRECTION_DEFAULT_VALUE	SFVec3f field named direction has default value {1f,0f,0f} (Java syntax) or 1 0 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_DIRECTION	fromField ROUTE name for SFVec3f field named direction.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_GUSTINESS	fromField ROUTE name for SFFloat field named gustiness.
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_SPEED	fromField ROUTE name for SFFloat field named speed.
static final String	fromField_TURBULENCE	fromField ROUTE name for SFFloat field named turbulence.
static final float	GUSTINESS_DEFAULT_VALUE	SFFloat field named gustiness has default value 0.1f (Java syntax) or 0.1 (XML syntax).
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 ParticleSystems component level for this element: 1
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: WindPhysicsModel.
static final float	SPEED_DEFAULT_VALUE	SFFloat field named speed has default value 0.1f (Java syntax) or 0.1 (XML syntax).
static final String	toField_DIRECTION	toField ROUTE name for SFVec3f field named direction.
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_GUSTINESS	toField ROUTE name for SFFloat field named gustiness.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_SPEED	toField ROUTE name for SFFloat field named speed.
static final String	toField_TURBULENCE	toField ROUTE name for SFFloat field named turbulence.
static final float	TURBULENCE_DEFAULT_VALUE	SFFloat field named turbulence has default value 0f (Java syntax) or 0 (XML syntax).

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

Method Summary

Modifier and Type	Method	Description
WindPhysicsModel	addComments(String newComment)	Add comment as String to contained commentsList.
WindPhysicsModel	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
WindPhysicsModel	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
WindPhysicsModel	clearIS()	Utility method to clear SFNode value of IS field.
WindPhysicsModel	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(String nameValue)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(String nameValue, String elementName)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
final String	getComponent()	Defines X3D component for the WindPhysicsModel element: ParticleSystems
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
float[]	getDirection()	Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
final String	getElementName()	Provides name of this element: WindPhysicsModel
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
float	getGustiness()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named gustiness.
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	getSpeed()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.
float	getTurbulence()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named turbulence.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasElementByNameValue(String nameValue, String elementName)	Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
final WindPhysicsModel	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
WindPhysicsModel	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final WindPhysicsModel	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
WindPhysicsModel	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final WindPhysicsModel	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
WindPhysicsModel	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
WindPhysicsModel	setDirection(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDirection(float[]).
WindPhysicsModel	setDirection(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDirection(float[]).
WindPhysicsModel	setDirection(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.
WindPhysicsModel	setDirection(float x, float y, float z)	Assign values to SFVec3f direction field, similar to setDirection(float[]).
WindPhysicsModel	setDirection(SFVec3f newValue)	Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).
WindPhysicsModel	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
WindPhysicsModel	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
WindPhysicsModel	setGustiness(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setGustiness(float).
WindPhysicsModel	setGustiness(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named gustiness.
WindPhysicsModel	setGustiness(SFFloat newValue)	Assign typed object value to SFFloat gustiness field, similar to setGustiness(float).
final WindPhysicsModel	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
WindPhysicsModel	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
WindPhysicsModel	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
WindPhysicsModel	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
WindPhysicsModel	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
WindPhysicsModel	setSpeed(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSpeed(float).
WindPhysicsModel	setSpeed(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named speed.
WindPhysicsModel	setSpeed(SFFloat newValue)	Assign typed object value to SFFloat speed field, similar to setSpeed(float).
WindPhysicsModel	setTurbulence(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setTurbulence(float).
WindPhysicsModel	setTurbulence(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named turbulence.
WindPhysicsModel	setTurbulence(SFFloat newValue)	Assign typed object value to SFFloat turbulence field, similar to setTurbulence(float).
final WindPhysicsModel	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
WindPhysicsModel	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
WindPhysicsModel	setUSE(WindPhysicsModel 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: WindPhysicsModel.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the WindPhysicsModel element: ParticleSystems

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D ParticleSystems component level for this element: 1

See Also:

• Constant Field Values

DIRECTION_DEFAULT_VALUE

public static final float[] DIRECTION_DEFAULT_VALUE

SFVec3f field named direction has default value {1f,0f,0f} (Java syntax) or 1 0 0 (XML syntax).

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

GUSTINESS_DEFAULT_VALUE

public static final float GUSTINESS_DEFAULT_VALUE

SFFloat field named gustiness has default value 0.1f (Java syntax) or 0.1 (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).

SPEED_DEFAULT_VALUE

public static final float SPEED_DEFAULT_VALUE

SFFloat field named speed has default value 0.1f (Java syntax) or 0.1 (XML syntax).

See Also:

• Constant Field Values

TURBULENCE_DEFAULT_VALUE

public static final float TURBULENCE_DEFAULT_VALUE

SFFloat field named turbulence 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 = "physics";
containerField_ALLOWED_VALUES = {"physics" }; 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_DIRECTION

public static final String fromField_DIRECTION

fromField ROUTE name for SFVec3f field named direction.

See Also:

• Constant Field Values

toField_DIRECTION

public static final String toField_DIRECTION

toField ROUTE name for SFVec3f field named direction.

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_GUSTINESS

public static final String fromField_GUSTINESS

fromField ROUTE name for SFFloat field named gustiness.

See Also:

• Constant Field Values

toField_GUSTINESS

public static final String toField_GUSTINESS

toField ROUTE name for SFFloat field named gustiness.

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_SPEED

public static final String fromField_SPEED

fromField ROUTE name for SFFloat field named speed.

See Also:

• Constant Field Values

toField_SPEED

public static final String toField_SPEED

toField ROUTE name for SFFloat field named speed.

See Also:

• Constant Field Values

fromField_TURBULENCE

public static final String fromField_TURBULENCE

fromField ROUTE name for SFFloat field named turbulence.

See Also:

• Constant Field Values

toField_TURBULENCE

public static final String toField_TURBULENCE

toField ROUTE name for SFFloat field named turbulence.

See Also:

• Constant Field Values

Constructor Details

WindPhysicsModel

public WindPhysicsModel()

Constructor for WindPhysicsModel to initialize member variables with default values.

WindPhysicsModel

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the WindPhysicsModel element: ParticleSystems

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

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

getDirection

public float[] getDirection()

Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.

Tooltip: direction in which wind is travelling in the form of a normalized, unit vector. *

Specified by:

getDirection in interface WindPhysicsModel

Returns:

value of direction field

setDirection

public WindPhysicsModel setDirection(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.

Tooltip: direction in which wind is travelling in the form of a normalized, unit vector. *

Specified by:

setDirection in interface WindPhysicsModel

Parameters:

newValue - is new value for the direction field.

Returns:

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

setDirection

public WindPhysicsModel setDirection(SFVec3f newValue)

Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).

Parameters:

newValue - is new value for the direction field.

Returns:

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

setDirection

public WindPhysicsModel setDirection(float x,
 float y,
 float z)

Assign values to SFVec3f direction field, similar to setDirection(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setDirection

public WindPhysicsModel setDirection(double x,
 double y,
 double z)

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

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setDirection

public WindPhysicsModel setDirection(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

Specified by:

getEnabled in interface X3DParticlePhysicsModelNode

Returns:

value of enabled field

setEnabled

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

Specified by:

setEnabled in interface X3DParticlePhysicsModelNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

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

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

getGustiness

public float getGustiness()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named gustiness.

Tooltip: [0,+infinity) gustiness specifies how much wind speed varies from the average speed.

• Hint: wind speed variation is calculated once per frame and applied equally to all particles.

Specified by:

getGustiness in interface WindPhysicsModel

Returns:

value of gustiness field

setGustiness

public WindPhysicsModel setGustiness(float newValue)

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

Tooltip: [0,+infinity) gustiness specifies how much wind speed varies from the average speed.

• Hint: wind speed variation is calculated once per frame and applied equally to all particles.

Specified by:

setGustiness in interface WindPhysicsModel

Parameters:

newValue - is new value for the gustiness field.

Returns:

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

setGustiness

public WindPhysicsModel setGustiness(SFFloat newValue)

Assign typed object value to SFFloat gustiness field, similar to setGustiness(float).

Parameters:

newValue - is new value for the gustiness field.

Returns:

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

setGustiness

public WindPhysicsModel setGustiness(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DParticlePhysicsModelNode

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

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DParticlePhysicsModelNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getSpeed

public float getSpeed()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.

Tooltip: [0,+infinity) Initial linear speed (default is m/s) imparted to all particles along their direction of movement. *

Specified by:

getSpeed in interface WindPhysicsModel

Returns:

value of speed field

setSpeed

public WindPhysicsModel setSpeed(float newValue)

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

Tooltip: [0,+infinity) Initial linear speed (default is m/s) imparted to all particles along their direction of movement. *

Specified by:

setSpeed in interface WindPhysicsModel

Parameters:

newValue - is new value for the speed field.

Returns:

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

setSpeed

public WindPhysicsModel setSpeed(SFFloat newValue)

Assign typed object value to SFFloat speed field, similar to setSpeed(float).

Parameters:

newValue - is new value for the speed field.

Returns:

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

setSpeed

public WindPhysicsModel setSpeed(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getTurbulence

public float getTurbulence()

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

Tooltip: [0,1] turbulence field specifies how much the wind acts directly in line with the direction, and how much variation is applied in directions other than the wind direction.

• Hint: this is determined per-particle to model how each is effected by turbulence.

Specified by:

getTurbulence in interface WindPhysicsModel

Returns:

value of turbulence field

setTurbulence

public WindPhysicsModel setTurbulence(float newValue)

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

Tooltip: [0,1] turbulence field specifies how much the wind acts directly in line with the direction, and how much variation is applied in directions other than the wind direction.

• Hint: this is determined per-particle to model how each is effected by turbulence.

Specified by:

setTurbulence in interface WindPhysicsModel

Parameters:

newValue - is new value for the turbulence field.

Returns:

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

setTurbulence

public WindPhysicsModel setTurbulence(SFFloat newValue)

Assign typed object value to SFFloat turbulence field, similar to setTurbulence(float).

Parameters:

newValue - is new value for the turbulence field.

Returns:

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

setTurbulence

public WindPhysicsModel setTurbulence(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public WindPhysicsModel addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public WindPhysicsModel addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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