Package org.web3d.x3d.sai.ParticleSystems

Interface BoundedPhysicsModel

All Superinterfaces:

X3DNode, X3DParticlePhysicsModelNode

All Known Implementing Classes:

BoundedPhysicsModel

public interface BoundedPhysicsModel
extends X3DParticlePhysicsModelNode

BoundedPhysicsModel provides user-defined geometrical boundaries for particle motion.

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. BoundedPhysicsModel node tooltip: (X3D version 3.2 or later) [X3DParticlePhysicsModelNode] BoundedPhysicsModel provides user-defined geometrical boundaries for particle motion. A child geometry node specifies boundaries that constrain the location of the particles.

• Hint: when a particle touches the boundary surface, it is reflected by the geometry (either inside or outside).

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

Method Summary

Modifier and Type	Method	Description
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
X3DGeometryNode	getGeometry()	Provide org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field geometry.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
BoundedPhysicsModel	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
BoundedPhysicsModel	setGeometry(X3DGeometryNode newValue)	Accessor method to assign org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.
BoundedPhysicsModel	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

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

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

getGeometry

X3DGeometryNode getGeometry()

Provide org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field geometry.

Tooltip: [X3DGeometryNode] Single contained geometry node provides the geometry used for each particle when the parent ParticleSystem node has geometryType=GEOMETRY.

• Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
• Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>

Returns:

value of geometry field

setGeometry

BoundedPhysicsModel setGeometry(X3DGeometryNode newValue)

Accessor method to assign org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.

Tooltip: [X3DGeometryNode] Single contained geometry node provides the geometry used for each particle when the parent ParticleSystem node has geometryType=GEOMETRY.

• Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
• Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>

Parameters:

newValue - is new value for the geometry field.

Returns:

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

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

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