AvoidBoundingBoxAreaOptions

public struct AvoidBoundingBoxAreaOptions : Hashable

The options to specify rectangular shape which routes must not cross.

  • Area of rectangular shape which routes must not cross. Strictly enforced. Note: Violations are reported as [sdk.routing.SectionNoticeCode.VIOLATED_BLOCKED_ROAD]. This avoidance option is not supported for IsolineOptions. If it is defined for isoline calculation then an [sdk.routing.RoutingError.INVALID_PARAMETER] error is generated.

    Declaration

    Swift

    public var avoidBoundingBoxArea: GeoBox

  • Areas of rectangular shape to exclude from avoidance.

    Declaration

    Swift

    public var boundingBoxExceptionAreas: [GeoBox]

  • Areas of polygon shape to exclude from avoidance.

    Declaration

    Swift

    public var polygonExceptionAreas: [GeoPolygon]

  • Areas of corridor shape to exclude from avoidance. Note: Even though GeoCorridor.half_width_in_meters is an optional property in case of exception areas it is mandatory. Otherwise route calculation will fail with an [sdk.routing.RoutingError.INVALID_PARAMETER] error.

    Declaration

    Swift

    public var corridorExceptionAreas: [GeoCorridor]

  • Creates a new instance.

    Declaration

    Swift

    public init(avoidBoundingBoxArea: GeoBox, boundingBoxExceptionAreas: [GeoBox] = [], polygonExceptionAreas: [GeoPolygon] = [], corridorExceptionAreas: [GeoCorridor] = [])