RealisticViewWarning

public struct RealisticViewWarning : Hashable

A realistic view notification. This notification is given for complex junctions and it includes a visual representation of that junction, in order to help the user to better navigate it. When RealisticViewWarning.distanceType is DistanceType.ahead, the RealisticViewWarning.realisticViewVectorImage object will be provided with the junction view and the signpost representations. For RealisticViewWarning.distanceType with value DistanceType.passed, the RealisticViewWarning.realisticViewVectorImage object will be null. Use RealisticViewWarningListener to get notifications about the realistic views of the upcoming junctions.

Realistic view notifications require an online connection in order to function properly, or that the junction or signpost map layer data is cached, installed or preloaded as part of a Region. This can be enabled via feature configurations.

  • Distance to the junction, for which the realistic view is given, expressed in meters.

    Declaration

    Swift

    public var distanceToRealisticViewInMeters: Double

  • The realistic view object for which the warning is given. Image resources are stored as vector graphics. Within RealisticViewWarning, only one type of image, either raster or vector, will be provided. If this property is not nil, then RealisticViewWarning.realisticViewRasterImage will be nil.

    Note: The realistic views for most of the countries are stored as vector images.

    Declaration

    Swift

    public var realisticViewVectorImage: RealisticViewVectorImage?

  • The realistic view object for which the warning is given. Image resources are stored as raster graphics. Within RealisticViewWarning, only one type of image, either raster or vector, will be provided. If this property is not nil, then RealisticViewWarning.realisticViewVectorImage will be nil. Note: Certain countries support only raster images as realistic views. Currently, this is the case only for Japan, but in the future, more countries might support this type of realistic views.

    Declaration

    Swift

    public var realisticViewRasterImage: RealisticViewRasterImage?

  • The distance type for the warning, e.g. a warning for a new realistic view ahead or a warning for passing a realistic view. Since the realistic view warning is given relative to a single position on the route, DistanceType.reached will never be given for this warning.

    Declaration

    Swift

    public var distanceType: DistanceType

  • Creates a new instance.

    • Parameters

      • distanceToRealisticViewInMeters: Distance to the junction, for which the realistic view is given, expressed in meters.
      • realisticViewVectorImage: The realistic view object for which the warning is given. Image resources are stored as vector graphics. Within RealisticViewWarning, only one type of image, either raster or vector, will be provided. If this property is not nil, then RealisticViewWarning.realisticViewRasterImage will be nil.

      Note: The realistic views for most of the countries are stored as vector images.

      • realisticViewRasterImage: The realistic view object for which the warning is given. Image resources are stored as raster graphics. Within RealisticViewWarning, only one type of image, either raster or vector, will be provided. If this property is not nil, then RealisticViewWarning.realisticViewVectorImage will be nil. Note: Certain countries support only raster images as realistic views. Currently, this is the case only for Japan, but in the future, more countries might support this type of realistic views.
      • distanceType: The distance type for the warning, e.g. a warning for a new realistic view ahead or a warning for passing a realistic view. Since the realistic view warning is given relative to a single position on the route, DistanceType.reached will never be given for this warning.

    Declaration

    Swift

    public init(distanceToRealisticViewInMeters: Double, realisticViewVectorImage: RealisticViewVectorImage? = nil, realisticViewRasterImage: RealisticViewRasterImage? = nil, distanceType: DistanceType)