Package org.web3d.x3d.sai.ParticleSystems

Interface WindPhysicsModel

All Superinterfaces:

X3DNode, X3DParticlePhysicsModelNode

All Known Implementing Classes:

WindPhysicsModel

public interface WindPhysicsModel
extends X3DParticlePhysicsModelNode

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

See Also:

• SAI Java Specification
• X3D Abstract Specification: WindPhysicsModel
• X3D Tooltips: WindPhysicsModel
• X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	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 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.
WindPhysicsModel	setDirection(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.
WindPhysicsModel	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
WindPhysicsModel	setGustiness(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named gustiness.
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(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named speed.
WindPhysicsModel	setTurbulence(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named turbulence.

Method Details

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)

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

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)

Accessor method to 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)

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.

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 org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

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

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)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

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

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)

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

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)

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.

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