ViewportAnimation

 
@_documentation(visibility: public)
@_spi(Experimental)
public struct ViewportAnimation

Specifies the animation for the map Viewport.

  • Viewport transition factory closure.

    Declaration

    Swift

    @_documentation(visibility: public)
public typealias ViewportTransitionFactory = (MapView) -> ViewportTransition

  • A closure that creates a viewport transition using the MapView.

    Declaration

    Swift

    @_documentation(visibility: public)
public var makeViewportTransition: ViewportTransitionFactory

  • A default viewport animation.

    The default animation tries to provide best-looking animation for every viewport transition.

    Note

    It’s recommended to use the default animation with followPuck(zoom:bearing:pitch:) viewport, because it supports moving animation target (user location puck).

    Declaration

    Swift

    @_documentation(visibility: public)
public static var `default`: ViewportAnimation { get }

  • A default animation with the specified maximum duration.

    The default animation tries to provide best-looking animation for every viewport transition.

    Note

    It’s recommended to use the default animation with followPuck(zoom:bearing:pitch:) viewport, because it supports moving animation target (user location puck).

    Declaration

    Swift

    @_documentation(visibility: public)
public static func `default`(maxDuration: TimeInterval) -> ViewportAnimation

    Parameters

    maxDuration

    The maximum duration of the animation, measured in seconds.

    Return Value

    A default viewport animation.

  • fly

    A fly animation.

    The fly animation usually follows the zoom-out, flight, zoom-in pattern in animation. The duration of the animation will be calculated automatically.

    Declaration

    Swift

    @_documentation(visibility: public)
public static var fly: ViewportAnimation { get }

  • A fly animation with a specified duration.

    The fly animation usually follows the zoom-out, flight, zoom-in pattern in animation.

    Declaration

    Swift

    @_documentation(visibility: public)
public static func fly(duration: TimeInterval) -> ViewportAnimation

    Parameters

    duration

    Duration of the animation, measured in seconds.

    Return Value

    A fly animation.

  • An animation that starts quickly and then slows towards the end.

    Declaration

    Swift

    @_documentation(visibility: public)
public static func easeOut(duration: TimeInterval) -> ViewportAnimation

    Parameters

    duration

    Duration of the animation, measured in seconds.

    Return Value

    An ease-out animation.

  • An animation that starts slowly and then speeds up towards the end.

    Declaration

    Swift

    @_documentation(visibility: public)
public static func easeIn(duration: TimeInterval) -> ViewportAnimation

    Parameters

    duration

    Duration of the animation, measured in seconds.

    Return Value

    An ease-in animation.

  • An animation that combines behavior of ease-in and ease-out animations

    Declaration

    Swift

    @_documentation(visibility: public)
public static func easeInOut(duration: TimeInterval) -> ViewportAnimation

    Parameters

    duration

    Duration of the animation, measured in seconds.

    Return Value

    An ease-in-out animation.

  • An animation that moves at a constant speed.

    Declaration

    Swift

    @_documentation(visibility: public)
public static func linear(duration: TimeInterval) -> ViewportAnimation

    Parameters

    duration

    Duration of the animation, measured in seconds.

    Return Value

    A linear animation.