AvoidPolygonAreaOptions Structure Reference


                    
                    
                    avoidPolygonArea

Area of polygon shape which routes must not cross. Strictly enforced. Violations are reported as SectionNoticeCode.violatedBlockedRoad. Note: 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 avoidPolygonArea: GeoPolygon


                    
                    
                    boundingBoxExceptionAreas

Areas of rectangular shape to exclude from avoidance.

Declaration

Swift

public var boundingBoxExceptionAreas: [GeoBox]


                    
                    
                    polygonExceptionAreas

Areas of polygon shape to exclude from avoidance.

Declaration

Swift

public var polygonExceptionAreas: [GeoPolygon]


                    
                    
                    corridorExceptionAreas

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]


                    
                    
                    init(avoidPolygonArea:boundingBoxExceptionAreas:polygonExceptionAreas:corridorExceptionAreas:)

Creates a new instance.

Declaration

Swift

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