Package org.web3d.x3d.sai.ParticleSystems

Interface ForcePhysicsModel

All Superinterfaces:

X3DNode, X3DParticlePhysicsModelNode

All Known Implementing Classes:

ForcePhysicsModel

public interface ForcePhysicsModel
extends X3DParticlePhysicsModelNode

ForcePhysicsModel applies a constant force value 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. ForcePhysicsModel node tooltip: (X3D version 3.2 or later) [X3DParticlePhysicsModelNode] ForcePhysicsModel applies a constant force value to the particles.

• Hint: force may act in any given direction vector at any strength.

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

Method Summary

Modifier and Type	Method	Description
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
float[]	getForce()	Provide array of 3-tuple float results from inputOutput SFVec3f field named force.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
ForcePhysicsModel	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
ForcePhysicsModel	setForce(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named force.
ForcePhysicsModel	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Method Details

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

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

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

getForce

float[] getForce()

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

Tooltip: (-infinity,+infinity) force field indicates strength and direction of the propelling force on the particles (for example, default is Earth's gravity).

• Hint: if particles have zero mass, ForcePhysicsModel node has no effect.
• Hint: force is specified in force base units (usually newtons, acceleration of one kilogram at rate of one meter per second squared).
• Hint: https://en.wikipedia.org/wiki/Newton_(unit) and https://en.wikipedia.org/wiki/Kilogram
• Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#Standardunitscoordinates

Returns:

value of force field

setForce

ForcePhysicsModel setForce(float[] newValue)

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

Tooltip: (-infinity,+infinity) force field indicates strength and direction of the propelling force on the particles (for example, default is Earth's gravity).

• Hint: if particles have zero mass, ForcePhysicsModel node has no effect.
• Hint: force is specified in force base units (usually newtons, acceleration of one kilogram at rate of one meter per second squared).
• Hint: https://en.wikipedia.org/wiki/Newton_(unit) and https://en.wikipedia.org/wiki/Kilogram
• Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#Standardunitscoordinates

Parameters:

newValue - is new value for the force field.

Returns:

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

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

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