CameraAnimationsManager

public final class CameraAnimationsManager

APIs for animating the camera.

cameraAnimators
List of animators currently alive
Declaration
Swift

public var cameraAnimators: [CameraAnimator] { get }
cancelAnimations()
Interrupts all active animation. The camera remains at the last point before the cancel request was invoked, i.e., the camera is not reset or fast-forwarded to the end of the transition. Canceled animations cannot be restarted / resumed. The animator must be recreated.
Declaration
Swift

public func cancelAnimations()

High-Level Animation APIs


                    
                    
                    fly(to:duration:completion:)

Moves the viewpoint to a different location using a transition animation that evokes powered flight and an optional transition duration and timing function It seamlessly incorporates zooming and panning to help the user find his or her bearings even after traversing a great distance.

Declaration

Swift

@discardableResult
public func fly(to: CameraOptions,
                duration: TimeInterval? = nil,
                completion: AnimationCompletion? = nil) -> Cancelable?

Parameters

`to`	The camera options at the end of the animation. Any camera parameters that are nil will not be animated.
`duration`	Duration of the animation, measured in seconds. If nil, a suitable calculated duration is used.
`completion`	Completion handler called when the animation stops

Return Value

An instance of Cancelable which can be canceled if necessary


                    
                    
                    ease(to:duration:curve:completion:)

Ease the camera to a destination

Declaration

Swift

@discardableResult
public func ease(to: CameraOptions,
                 duration: TimeInterval,
                 curve: UIView.AnimationCurve = .easeOut,
                 completion: AnimationCompletion? = nil) -> Cancelable?

Parameters

`to`	the target camera after animation; if `camera.anchor` is non-nil, it is use for both the `fromValue` and the `toValue` of the underlying animation such that the value specified will not be interpolated, but will be passed as-is to each camera update during the animation. To animate `anchor` itself, use the `makeAnimator` APIs.
`duration`	duration of the animation
`curve`	the easing curve for the animation
`completion`	completion to be called after animation

Return Value

An instance of Cancelable which can be canceled if necessary

Low-Level Animation APIs


                    
                    
                    makeAnimator(duration:timingParameters:animationOwner:animations:)

Creates a BasicCameraAnimator.

Note

CameraAnimationsManager only keeps animators alive while their state is .active.

Declaration

Swift

public func makeAnimator(duration: TimeInterval,
                         timingParameters: UITimingCurveProvider,
                         animationOwner: AnimationOwner = .unspecified,
                         animations: @escaping (inout CameraTransition) -> Void) -> BasicCameraAnimator

Parameters

`duration`	The duration of the animation.
`timingParameters`	The object providing the timing information. This object must adopt the `UITimingCurveProvider` protocol.
`animationOwner`	An `AnimationOwner` that can be used to identify what component initiated an animation.
`animations`	a closure that configures the animation’s to and from values via a `CameraTransition`.

Return Value

A new BasicCameraAnimator.


                    
                    
                    makeAnimator(duration:curve:animationOwner:animations:)

Creates a BasicCameraAnimator.

Note

CameraAnimationsManager only keeps animators alive while their state is .active.

Declaration

Swift

public func makeAnimator(duration: TimeInterval,
                         curve: UIView.AnimationCurve,
                         animationOwner: AnimationOwner = .unspecified,
                         animations: @escaping (inout CameraTransition) -> Void) -> BasicCameraAnimator

Parameters

`duration`	The duration of the animation.
`curve`	One of UIKit’s predefined timing curves to apply to the animation.
`animationOwner`	An `AnimationOwner` that can be used to identify what component initiated an animation.
`animations`	a closure that configures the animation’s to and from values via a `CameraTransition`.

Return Value

A new BasicCameraAnimator.


                    
                    
                    makeAnimator(duration:controlPoint1:controlPoint2:animationOwner:animations:)

Creates a BasicCameraAnimator.

Note

CameraAnimationsManager only keeps animators alive while their state is .active.

Declaration

Swift

public func makeAnimator(duration: TimeInterval,
                         controlPoint1: CGPoint,
                         controlPoint2: CGPoint,
                         animationOwner: AnimationOwner = .unspecified,
                         animations: @escaping (inout CameraTransition) -> Void) -> BasicCameraAnimator

Parameters

`duration`	The duration of the animation.
`controlPoint1`	The first control point for the cubic Bézier timing curve.
`controlPoint2`	The second control point for the cubic Bézier timing curve.
`animationOwner`	An `AnimationOwner` that can be used to identify what component initiated an animation.
`animations`	a closure that configures the animation’s to and from values via a `CameraTransition`.

Return Value

A new BasicCameraAnimator.


                    
                    
                    makeAnimator(duration:dampingRatio:animationOwner:animations:)

Creates a BasicCameraAnimator.

Note

CameraAnimationsManager only keeps animators alive while their state is .active.

Declaration

Swift

public func makeAnimator(duration: TimeInterval,
                         dampingRatio: CGFloat,
                         animationOwner: AnimationOwner = .unspecified,
                         animations: @escaping (inout CameraTransition) -> Void) -> BasicCameraAnimator

Parameters

`duration`	The duration of the animation.
`dampingRatio`	The damping ratio to apply to the initial acceleration and oscillation. To smoothly decelerate the animation without oscillation, specify a value of 1. Specify values closer to 0 to create less damping and more oscillation.
`animationOwner`	An `AnimationOwner` that can be used to identify what component initiated an animation.
`animations`	a closure that configures the animation’s to and from values via a `CameraTransition`.

Return Value

A new BasicCameraAnimator.