Package org.web3d.x3d.sai

Interface UnitInfo

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


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:
SAI Java Specification: B.6.3 UnitInfo, X3D Abstract Specification: 7.2.5.5 UNIT statement, X3D Tooltips: UnitInfo, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    java.lang.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.
    java.lang.String getName()
    Get the name of this UNIT statement.
    java.lang.String toX3DString()
    Return a formatted string version of this component that conforms to the X3D specification for X3D file encoding.

  • Method Details

    • getName

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

    • getCategory

      java.lang.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

      java.lang.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