Package 

Class RegionForRoutesInfo

  • All Implemented Interfaces:
    
public final class RegionForRoutesInfo

    Data model representing region for routes info.

    Instances are typically immutable after construction. Use builders or factory methods where provided.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description
      RegionForRoutesInfo(List<String> routes, Rect rect, Boolean gridAligned, Boolean showFullRouteOverview, Boolean includeCVP, Boolean nearestLegMode, List<Annotation> annotations)
      RegionForRoutesInfo(List<String> routes, Rect rect, Boolean gridAligned, Boolean showFullRouteOverview, Boolean includeCVP, Boolean nearestLegMode)
      RegionForRoutesInfo(List<String> routes, Rect rect, Boolean gridAligned, Boolean showFullRouteOverview, Boolean includeCVP)
      RegionForRoutesInfo(List<String> routes, Rect rect, Boolean gridAligned, Boolean showFullRouteOverview)
      RegionForRoutesInfo(List<String> routes, Rect rect, Boolean gridAligned)
      RegionForRoutesInfo(List<String> routes, Rect rect)

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final List<String> getRoutes() list of id that need include
      final Rect getRect() The rect is specified by parameters of x (Rect param left), y (Rect param top), width (Rect param width) and height (Rect param height).
      final Boolean getGridAligned() If false, the end position rotation and declination of the camera will be based on the current mode.
      final Boolean getShowFullRouteOverview() if the value true shows region including already eaten parts else only shows region for the remaining route
      final Boolean getIncludeCVP() Whether to include the cvp annotation in the region which will be shown or not.
      final Boolean getNearestLegMode() If nearestLegMode is true, the route overview will display only the part of the route to the first waypoint
      final List<Annotation> getAnnotations() annotations that needed to be shown on the region

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RegionForRoutesInfo

        RegionForRoutesInfo(List<String> routes, Rect rect, Boolean gridAligned, Boolean showFullRouteOverview, Boolean includeCVP, Boolean nearestLegMode, List<Annotation> annotations)

      • RegionForRoutesInfo

        RegionForRoutesInfo(List<String> routes, Rect rect, Boolean gridAligned, Boolean showFullRouteOverview, Boolean includeCVP, Boolean nearestLegMode)

      • RegionForRoutesInfo

        RegionForRoutesInfo(List<String> routes, Rect rect, Boolean gridAligned, Boolean showFullRouteOverview, Boolean includeCVP)

      • RegionForRoutesInfo

        RegionForRoutesInfo(List<String> routes, Rect rect, Boolean gridAligned, Boolean showFullRouteOverview)

      • RegionForRoutesInfo

        RegionForRoutesInfo(List<String> routes, Rect rect, Boolean gridAligned)

      • RegionForRoutesInfo

        RegionForRoutesInfo(List<String> routes, Rect rect)

    • Method Detail

      • getRoutes

         final List<String> getRoutes()

        list of id that need include

      • getRect

         final Rect getRect()

        The rect is specified by parameters of x (Rect param left), y (Rect param top), width (Rect param width) and height (Rect param height).

      • getGridAligned

         final Boolean getGridAligned()

        If false, the end position rotation and declination of the camera will be based on the current mode. Grid aligned can be thought of as a shortcut, the shortcut to set rendering mode to 2d north up before show region.

      • getShowFullRouteOverview

         final Boolean getShowFullRouteOverview()

        if the value true shows region including already eaten parts else only shows region for the remaining route

      • getIncludeCVP

         final Boolean getIncludeCVP()

        Whether to include the cvp annotation in the region which will be shown or not.

        Note: if includeCVP is false, the region may still coincidentally include the cvp, but the engine will not actively try to make sure the cvp is within the region shown.

      • getNearestLegMode

         final Boolean getNearestLegMode()

        If nearestLegMode is true, the route overview will display only the part of the route to the first waypoint