CameraUpdate

public struct CameraUpdate : Equatable

Camera update type.

Lifecycle

  • Creates an instance of CameraUpdate.

    Declaration

    Swift

    public init(
    position: CLLocationCoordinate2D? = nil,
    zoom: Double? = nil,
    tilt: Double? = nil,
    rotation: Double? = nil,
    positionMarkerVerticalOffset: Double? = nil,
    scale: Double? = nil,
    fieldOfView: Double? = nil
)

    Parameters

    position

    Position of the camera in CLLocationCoordinate2D.
    zoom

    Displays the map from a closer position. Allowed zoom level range: [0, 22].
    tilt

    Camera tilt. A value of 0 indicates the camera is looking straight down. 90 means it is looking straight ahead towards the horizon.
    rotation

    Camera heading, measured starting at due north and continuing clockwise around the compass. Thus, north is 0 degrees, east is 90 degrees, south is 180 degrees, and so on. Allowed range: [0, 360].
    positionMarkerVerticalOffset

    Sets the camera position marker vertical offset from the centre of the screen. The offset controls the placement of the position marker in the space between the center of the safe area and its bottom. Offset of 0.0 means the position marker should remain in the center of the safe area. Offset of 1.0 means the position marker should be aligned with the bottom of the safe area. The value may be ignored when the camera’s scale is such that offsetting the map causes the world to rotate oddly. Valid range for the offset is [0.0, 1.0].
    moveBy

    Adds an update that adjusts current camera position specified by move vector moveBy
    scale

    Ratio of a distance on the screen to the actual distance in the world. Cannot be less than 1.0.
    fieldOfView

    Camera field of view in degrees. Allowed range [1.0, 150.0].

  • Creates an instance with some optional parameters.

    Declaration

    Swift

    public init(
    zoomBy: Double? = nil,
    zoomIn: Bool = false,
    zoomOut: Bool = false,
    tiltBy: Double? = nil,
    rotateBy: Double? = nil,
    moveBy: CGPoint? = nil,
    fieldOfViewChangeBy: Double? = nil
)

    Parameters

    zoomBy

    Adds an update that adjusts the scale by the specified value, i.e. a scale of 1:100 with a zoomBy of 2 becomes 1:200, a scale of 1:200 with a zoomBy of 0.25 becomes 1:50. If the resulting scale would be less than 1 after the update is applied, the scale is set to 1.
    zoomIn

    If true, adds an update that reduces the scale by one step.
    zoomOut

    If true, adds an update that increases the scale by one step.
    tiltBy

    Adds an update that adjusts the tilt by the specified angle. The tilt is measured from the nadir, i.e. value of 0 indicates the camera looking straight down, and 90 - straight ahead towards the horizon. The value may be clamped to a maximum value determined based on the camera’s scale, in order to assure map readability.
    rotateBy

    Adds an update that adjusts the heading by the specified angle in degree. Heading is measured starting at due north and continues clockwise around the compass. Thus, north is 0 degrees, east is 90 degrees, south is 180 degrees, and so on.
    moveBy

    Adds an update that adjusts current camera position specified by move vector moveBy
    fieldOfViewChangeBy

    Adds an update that adjusts the field of view by the specified angle.

  • Creates an instance with FitToCoordinatesOptions.

    Declaration

    Swift

    public init(fitToCoordinatesOptions: FitToCoordinatesOptions)

    Parameters

    fitToCoordinatesOptions

    FitToCoordinatesOptions instance.

  • Returns a CameraUpdate instance that transforms the camera to ensure that all coordinates are visible and padded.

    Declaration

    Swift

    public init(fitToCoordinates coordinates: [CLLocationCoordinate2D], padding: UInt = 0)

    Parameters

    coordinates

    List of coordinates to be taken into account when setting the camera position.
    padding

    Padding between the coordinates and camera borders.

    Return Value

    A CameraUpdate instance that transforms the camera to ensure that all coordinates are visible and padded.

Public

  • Position of the camera in CLLocationCoordinate2D.

    Declaration

    Swift

    @EquatableWrapper
public var position: CLLocationCoordinate2D? { get set }

  • Displays the map from a closer position. Allowed zoom level range: [0, 22].

    Declaration

    Swift

    public var zoom: Double?

  • A value of 0 indicates the camera is looking straight down. 90 means it is looking straight ahead towards the horizon.

    Declaration

    Swift

    public var tilt: Double?

  • Camera heading, measured starting at due north and continuing clockwise around the compass. Allowed range: [0, 360].

    Declaration

    Swift

    public var rotation: Double?

  • Sets the camera position marker vertical offset from the centre of the screen.

    Declaration

    Swift

    public var positionMarkerVerticalOffset: Double?

  • A camera field of view

    Declaration

    Swift

    public var fieldOfView: Double?