Package com.esri.arcgisruntime.navigation

Class TrackingStatus.Distance

  • Enclosing class:
    TrackingStatus
    public static class TrackingStatus.Distance
extends java.lang.Object
    Defines tracking distance.

    Tracking distance contains two types of distances - raw and display. Raw distance is always in meters (fixed units). Display distance is in getDisplayTextUnits() (LinearUnit).

    Since:
    100.6.0

    • Method Detail

      • getDisplayText

        public java.lang.String getDisplayText()
        Gets formatted and rounded distance, ready for displaying.

        Use this property to have consistent distances/units with voice guidance. Display distance is in getDisplayTextUnits() (LinearUnit). The following rules are used for rounding and formatting:

        IMPERIAL

        • 0 -> 50' => Round to increments of 10' (e.g. "10", "20", "30", "40")
        • 50' -> 0.1 mi (528') => Round to increments of 50' (e.g. "50", "100", "150", etc.)
        • 0.1 -> 1.0 mi => Round to decimal mile (e.g "0.1", "0.2", "0.3", etc.)
        • 1.0 mi -> 10 mi => Round to half mile (e.g. "1.0", "1.5", "2.0", etc.)
        • 10+ mi => Round to mile (e.g. "10", "11", "12", etc.)
        METRIC
        • 0 -> 50 m => Round to increments of 10 m (e.g. "10", "20", "30", "40")
        • 50 m -> 500 m => Round to increments of 50 m (e.g. "50", "100", "150", etc.)
        • 500 m -> 10 km => Round to half km (e.g. "1.0", "1.5", "2.0", etc.)
        • 10+ km => Round to whole km (e.g. "10", "11", "12", etc.)
        Returns:
        formatted and rounded distance, ready for displaying
        Since:
        100.6.0

      • getDisplayTextUnits

        public LinearUnit getDisplayTextUnits()
        Gets the units used in the getDisplayText() which vary base on distance from maneuver/destination.
        Returns:
        the units used in the getDisplayText() which vary base on distance from maneuver/destination
        Since:
        100.6.0

      • getDistance

        public double getDistance()
        Gets the distance in meters.

        The raw distance without rounding and formatting, in meters.

        Returns:
        the distance in meters
        Since:
        100.6.0