Interface UnitInfo

public interface UnitInfo
Abstract node interface, defined by X3D Java Scene Access Interface (SAI) Specification to support X3D Java interoperability.

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.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). UNIT statements define data conversion factors for a scene that can override default units of measure for angles in radians, length in meters, etc.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCategory()
    Get the category (angle | length | force | mass) of this UNIT statement.
    double
    getConversionFactor()
    Get the positive double-precision factor that converts new base unit to default base unit.
    String
    getName()
    Get the name of this UNIT statement.
    String
    toX3DString()
    Return a formatted string version of this component that conforms to the X3D specification for X3D file encoding.

  • Method Details

    • getName

      String getName()
      Get the name of this UNIT statement.
      Returns:
      The name of the UNIT statement

    • getCategory

      String getCategory()
      Get the category (angle | length | force | mass) of this UNIT statement.
      Returns:
      The category of the UNIT statement

    • getConversionFactor

      double getConversionFactor()
      Get the positive double-precision factor that converts new base unit to default base unit.
      Returns:
      The positive double-precision conversion factor of the UNIT statement

    • toX3DString

      String toX3DString()
      Return a formatted string version of this component that conforms to the X3D specification for X3D file encoding. The string will start with the UNIT keyword, as per specification.
      Returns:
      A correctly formatted string