IndoorRouteOptions

public struct IndoorRouteOptions : Hashable

All the options to specify how an indoor route should be calculated.

  • Specifies the common route calculation options.

    Note: Currently, only RouteOptions.optimizationMode parameter is utilized for indoor route calculation.

    Declaration

    Swift

    public var routeOptions: RouteOptions

  • The transport mode for route calculation.

    Note: Mode of transport for the resulting indoor route will by default be VenueTransportMode.pedestrian in the current implementation. This option will affect only indoor route sections.

    Declaration

    Swift

    public var transportMode: VenueTransportMode

  • Defines the venue transport specification which contains the vehicle specifications for the transport mode chosen via IndoorRouteOptions.transportMode. Notes:

    • By default all vehicle specifications from IndoorRouteOptions.venueTransportSpecification are set to nil.
    • The transport mode is determined by IndoorRouteOptions.transportMode.

    Declaration

    Swift

    public var venueTransportSpecification: VenueTransportSpecification

  • Options to specify restrictions for indoor route calculations. By default no restrictions are applied.

    Declaration

    Swift

    public var indoorAvoidanceOptions: IndoorAvoidanceOptions

  • Specifies the via waypoints that the route should pass through between the origin and destination. Via waypoints are processed in the exact order provided.

    Notes:

    • Maximum of 5 via waypoints are allowed.
    • Via waypoints can be either stop waypoints (with stop_duration) or passthrough waypoints (with pass_through = true).
    • Via waypoints with stop_duration or pass_through = false create section in the resulting route.
    • Via waypoints with pass_through = true appear in the section’s passthrough array.
    • The order of via waypoints determines the routing path and must be preserved.

    Declaration

    Swift

    public var viaWaypoints: [IndoorWaypoint]

  • Creates an object and assign default values for route options.

    • Parameters

      • routeOptions: Specifies the common route calculation options.

      Note: Currently, only RouteOptions.optimizationMode parameter is utilized for indoor route calculation.

      • transportMode: The transport mode for route calculation.

      Note: Mode of transport for the resulting indoor route will by default be VenueTransportMode.pedestrian in the current implementation. This option will affect only indoor route sections.

      • venueTransportSpecification: Defines the venue transport specification which contains the vehicle specifications for the transport mode chosen via IndoorRouteOptions.transportMode. Notes:
      • indoorAvoidanceOptions: Options to specify restrictions for indoor route calculations. By default no restrictions are applied.
      • viaWaypoints: Specifies the via waypoints that the route should pass through between the origin and destination. Via waypoints are processed in the exact order provided.

      Notes:

      • Maximum of 5 via waypoints are allowed.
      • Via waypoints can be either stop waypoints (with stop_duration) or passthrough waypoints (with pass_through = true).
      • Via waypoints with stop_duration or pass_through = false create section in the resulting route.
      • Via waypoints with pass_through = true appear in the section’s passthrough array.
      • The order of via waypoints determines the routing path and must be preserved.

    Declaration

    Swift

    public init(routeOptions: RouteOptions = RouteOptions(), transportMode: VenueTransportMode = VenueTransportMode.pedestrian, venueTransportSpecification: VenueTransportSpecification = VenueTransportSpecification(), indoorAvoidanceOptions: IndoorAvoidanceOptions = IndoorAvoidanceOptions(), viaWaypoints: [IndoorWaypoint] = [])