Package org.web3d.x3d.sai.EnvironmentalEffects

Interface FogCoordinate

All Superinterfaces:

X3DGeometricPropertyNode, X3DNode

All Known Implementing Classes:

FogCoordinate

public interface FogCoordinate
extends X3DGeometricPropertyNode

FogCoordinate defines a set of explicit fog depths on a per-vertex basis, overriding Fog visibilityRange.

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. X3D node tooltip: (X3D version 3.1 or later) [X3DGeometricPropertyNode] FogCoordinate defines a set of explicit fog depths on a per-vertex basis, overriding Fog visibilityRange. *


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

Method Summary

Modifier and Type	Method	Description
float[]	getDepth()	Provide array of float results within allowed range of [0,1] from inputOutput MFFloat field named depth.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
FogCoordinate	setDepth(float[] newValue)	Accessor method to assign float array to inputOutput MFFloat field named depth.
FogCoordinate	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

getDepth

float[] getDepth()

Provide array of float results within allowed range of [0,1] from inputOutput MFFloat field named depth.

Tooltip: depth contains a set of 3D coordinate (triplet) point values. *

Returns:

value of depth field

setDepth

FogCoordinate setDepth(float[] newValue)

Accessor method to assign float array to inputOutput MFFloat field named depth.

Tooltip: depth contains a set of 3D coordinate (triplet) point values. *

Parameters:

newValue - is new value for the depth field.

Returns:

FogCoordinate - 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 <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *

Specified by:

getMetadata in interface X3DGeometricPropertyNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

FogCoordinate 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 <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *

Specified by:

setMetadata in interface X3DGeometricPropertyNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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