CameraAnimationsManager

public class CameraAnimationsManager : CameraAnimationsManagerProtocol

An object that manages a camera’s view lifecycle.

cameraAnimators
List of animators currently alive
Declaration
Swift

public var cameraAnimators: [CameraAnimator] { get }

Setting a new camera

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()


                    
                    
                    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 camera: CameraOptions,
                duration: TimeInterval? = nil,
                completion: AnimationCompletion? = nil) -> Cancelable?

Parameters

`camera`	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 camera: CameraOptions,
                 duration: TimeInterval,
                 curve: UIView.AnimationCurve = .easeOut,
                 completion: AnimationCompletion? = nil) -> Cancelable?

Parameters

`camera`	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
`completion`	completion to be called after animation

Return Value

An instance of Cancelable which can be canceled if necessary

Animator Functions


                    
                    
                    makeAnimator(duration:timingParameters:animationOwner:animations:)

Convenience to create a BasicCameraAnimator and will add it to a list of BasicCameraAnimators to track the lifecycle of that animation.

NOTE: Keep in mind the lifecycle of a BasicCameraAnimator. If a BasicCameraAnimator is destroyed, before the animation is finished, the animation will be interrupted and completion handlers will not be called.

Declaration

Swift

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

Parameters

`duration`	The duration of the animation, in seconds.
`timingParameters`	The object providing the timing information. This object must adopt the `UITimingCurveProvider` protocol.
`animationOwner`	Property that conforms to `AnimationOwner` to represent who owns that animation.

Return Value

A class that represents an animator with the provided configuration.


                    
                    
                    makeAnimator(duration:curve:animationOwner:animations:)

Convenience to create a BasicCameraAnimator and will add it to a list of BasicCameraAnimator to track the lifecycle of that animation.

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, in seconds.
`curve`	The UIKit timing curve to apply to the animation.
`animationOwner`	Property that conforms to `AnimationOwner` to represent who owns that animation.
`animations`	The block containing the animations. This block has no return value and takes no parameters. Use this block to modify any animatable view properties. When you start the animations, those properties are animated from their current values to the new values using the specified animation parameters.

Return Value

A class that represents an animator with the provided configuration.


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

Convenience to create a BasicCameraAnimator and will add it to a list of BasicCameraAnimator to track the lifecycle of that animation.

Declaration

Swift

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

Parameters

`duration`	The duration of the animation, in seconds.
`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`	Property that conforms to `AnimationOwner` to represent who owns that animation.
`animations`	The block containing the animations. This block has no return value and takes no parameters. Use this block to modify any animatable view properties. When you start the animations, those properties are animated from their current values to the new values using the specified animation parameters.

Return Value

A class that represents an animator with the provided configuration.


                    
                    
                    makeAnimator(duration:dampingRatio:animationOwner:animations:)

Convenience to create a BasicCameraAnimator and will add it to a list of BasicCameraAnimator to track the lifecycle of that animation.

Declaration

Swift

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

Parameters

`duration`	The duration of the animation, in seconds.
`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`	Property that conforms to `AnimationOwner` to represent who owns that animation.
`animations`	The block containing the animations. This block has no return value and takes no parameters. Use this block to modify any animatable view properties. When you start the animations, those properties are animated from their current values to the new values using the specified animation parameters.

Return Value

A class that represents an animator with the provided configuration.