IndoorRouteOptions Structure Reference


                    
                    
                    routeOptions

Specifies the common route calculation options.

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

Declaration

Swift

public var routeOptions: RouteOptions


                    
                    
                    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.

Declaration

Swift

public var transportMode: VenueTransportMode


                    
                    
                    venueTransportSpecification

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


                    
                    
                    indoorAvoidanceOptions

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

Declaration

Swift

public var indoorAvoidanceOptions: IndoorAvoidanceOptions


                    
                    
                    speedInMetersPerSecond

Specifies the speed that will be used by the service as the speed for VenueTransportMode in meters per second. It influences the duration of segments along the route. The default speed is 1 meter per second.

Declaration

Swift

@available(*, deprecated, message: "Will be removed in v4.28.0. Use `VenuePedestrianSpecification.walking_speed_in_meters_per_second` instead.")
public var speedInMetersPerSecond: Double


                    
                    
                    init(routeOptions:transportMode:venueTransportSpecification:indoorAvoidanceOptions:)

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:
  - By default all vehicle specifications from IndoorRouteOptions.venueTransportSpecification are set to nil.
  - The transport mode is determined by IndoorRouteOptions.transportMode.
- indoorAvoidanceOptions: Options to specify restrictions for indoor route calculations. By default no restrictions are applied.

Declaration

Swift

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


                    
                    
                    init(routeOptions:transportMode:venueTransportSpecification:indoorAvoidanceOptions:speedInMetersPerSecond:)

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:
  - By default all vehicle specifications from IndoorRouteOptions.venueTransportSpecification are set to nil.
  - The transport mode is determined by IndoorRouteOptions.transportMode.
- indoorAvoidanceOptions: Options to specify restrictions for indoor route calculations. By default no restrictions are applied.
- speedInMetersPerSecond: Specifies the speed that will be used by the service as the speed for VenueTransportMode in meters per second. It influences the duration of segments along the route. The default speed is 1 meter per second.

Declaration

Swift

@available(*, deprecated)
public init(routeOptions: RouteOptions = RouteOptions(), transportMode: VenueTransportMode = VenueTransportMode.pedestrian, venueTransportSpecification: VenueTransportSpecification = VenueTransportSpecification(), indoorAvoidanceOptions: IndoorAvoidanceOptions = IndoorAvoidanceOptions(), speedInMetersPerSecond: Double = -1.0)