WindPhysicsModel (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DNode, X3DParticlePhysicsModelNode

All Known Implementing Classes:

WindPhysicsModelObject
```
public interface WindPhysicsModel
extends X3DParticlePhysicsModelNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D 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 interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification: TODO, X3D Abstract Specification: WindPhysicsModel, X3D Tooltips: WindPhysicsModel, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`float[]`	`getDirection()` Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
`boolean`	`getEnabled()` Provide boolean value from inputOutput SFBool field named enabled.
`float`	`getGustiness()` Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named gustiness.
`X3DMetadataObject`	`getMetadata()` Provide 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.
`WindPhysicsModel`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`WindPhysicsModel`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`WindPhysicsModel`	`setDirection(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named direction.
`WindPhysicsModel`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`WindPhysicsModel`	`setGustiness(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named gustiness.
`WindPhysicsModel`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`WindPhysicsModel`	`setSpeed(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named speed.
`WindPhysicsModel`	`setTurbulence(float newValue)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named turbulence.
`WindPhysicsModel`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getDirection
```
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. *
    
    Returns:
    
    value of direction field
  - setDirection
```
WindPhysicsModel setDirection(float[] newValue)
```
    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.
    
    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).
  - getEnabled
```
boolean getEnabled()
```
    Provide boolean value from inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation. *
    
    Specified by:
    
    getEnabled in interface X3DParticlePhysicsModelNode
    
    Returns:
    
    value of enabled field
  - setEnabled
```
WindPhysicsModel setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    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).
  - getGustiness
```
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.
    Returns:
    
    value of gustiness field
  - setGustiness
```
WindPhysicsModel setGustiness(float newValue)
```
    Assign float value within allowed range of [0,infinity) 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.
    
    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).
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface X3DParticlePhysicsModelNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
WindPhysicsModel setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DParticlePhysicsModelNode
    
    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:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getSpeed
```
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. *
    
    Returns:
    
    value of speed field
  - setSpeed
```
WindPhysicsModel setSpeed(float newValue)
```
    Assign float value within allowed range of [0,infinity) 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.
    
    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).
  - getTurbulence
```
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.
    Returns:
    
    value of turbulence field
  - setTurbulence
```
WindPhysicsModel setTurbulence(float newValue)
```
    Assign float value within allowed range of [0,1] 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.
    
    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).
  - setDEF
```
WindPhysicsModel setDEF(java.lang.String newValue)
```
    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 http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DParticlePhysicsModelNode
    
    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).
  - setUSE
```
WindPhysicsModel setUSE(java.lang.String newValue)
```
    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 interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DParticlePhysicsModelNode
    
    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).
  - setCssClass
```
WindPhysicsModel setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DParticlePhysicsModelNode
    
    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).

Interface WindPhysicsModel

Method Summary

Method Detail

getDirection

setDirection

getEnabled

setEnabled

getGustiness

setGustiness

getMetadata

setMetadata

getSpeed

setSpeed

getTurbulence

setTurbulence

setDEF

setUSE

setCssClass