Interface FogCoordinate

All Superinterfaces:
X3DGeometricPropertyNode, X3DNode
All Known Implementing Classes:
FogCoordinateObject

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

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: TODO, 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 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 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 X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      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 X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      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