lottie-ios 3.4.3 → 3.5.0

package/Sources/Public/Primitives/{Color.swift → LottieColor.swift}

@@ -1,5 +1,5 @@
 //
-//  Color.swift
+//  LottieColor.swift
 //  lottie-swift
 //
 //  Created by Brandon Withrow on 2/4/19.
@@ -28,7 +28,15 @@ public enum ColorFormatDenominator: Hashable {
 
 // MARK: - Color
 
-public struct Color: Hashable {
+@available(*, deprecated, renamed: "LottieColor", message: """
+  `Lottie.Color` has been renamed to `LottieColor`, to prevent conflicts with \
+  the `SwiftUI.Color` type. This notice will be removed in Lottie 4.0.
+  """)
+public typealias Color = LottieColor
+
+// MARK: - LottieColor
+
+public struct LottieColor: Hashable {
 
   public var r: Double
   public var g: Double

package/Sources/Public/Primitives/Vectors.swift

@@ -9,7 +9,15 @@ import Foundation
 
 // MARK: - Vector1D
 
-public struct Vector1D: Hashable {
+@available(*, deprecated, renamed: "LottieVector1D", message: """
+  `Lottie.Vector1D` has been renamed to `LottieVector1D` for consistency with \
+  the new `LottieVector3D` type. This notice will be removed in Lottie 4.0.
+  """)
+public typealias Vector1D = LottieVector1D
+
+// MARK: - LottieVector1D
+
+public struct LottieVector1D: Hashable {
 
   public init(_ value: Double) {
     self.value = value
@@ -21,9 +29,17 @@ public struct Vector1D: Hashable {
 
 // MARK: - Vector3D
 
+@available(*, deprecated, renamed: "LottieVector3D", message: """
+  `Lottie.Vector3D` has been renamed to `LottieVector3D`, to prevent conflicts with \
+  the Apple SDK `Spatial.Vector3D` type. This notice will be removed in Lottie 4.0.
+  """)
+public typealias Vector3D = LottieVector3D
+
+// MARK: - LottieVector3D
+
 /// A three dimensional vector.
 /// These vectors are encoded and decoded from [Double]
-public struct Vector3D: Hashable {
+public struct LottieVector3D: Hashable {
 
   public let x: Double
   public let y: Double

package/Sources/Public/TextProvider/AnimationTextProvider.swift

@@ -9,7 +9,7 @@ import Foundation
 
 // MARK: - AnimationTextProvider
 
-/// Text provider is a protocol that is used to supply text to `AnimationView`.
+/// Text provider is a protocol that is used to supply text to `LottieAnimationView`.
 public protocol AnimationTextProvider: AnyObject {
   func textFor(keypathName: String, sourceText: String) -> String
 }

package/Sources/Public/iOS/AnimatedButton.swift

@@ -14,7 +14,7 @@ open class AnimatedButton: AnimatedControl {
   // MARK: Lifecycle
 
   public override init(
-    animation: Animation,
+    animation: LottieAnimation,
     configuration: LottieConfiguration = .shared)
   {
     super.init(animation: animation, configuration: configuration)
@@ -31,29 +31,9 @@ open class AnimatedButton: AnimatedControl {
     isAccessibilityElement = true
   }
 
-  // MARK: Public
-
-  public override var accessibilityTraits: UIAccessibilityTraits {
-    set { super.accessibilityTraits = newValue }
-    get { super.accessibilityTraits.union(.button) }
-  }
-
-  /// Sets the play range for the given UIControlEvent.
-  public func setPlayRange(fromProgress: AnimationProgressTime, toProgress: AnimationProgressTime, event: UIControl.Event) {
-    rangesForEvents[event.rawValue] = (from: fromProgress, to: toProgress)
-  }
+  // MARK: Open
 
-  /// Sets the play range for the given UIControlEvent.
-  public func setPlayRange(fromMarker fromName: String, toMarker toName: String, event: UIControl.Event) {
-    if
-      let start = animationView.progressTime(forMarker: fromName),
-      let end = animationView.progressTime(forMarker: toName)
-    {
-      rangesForEvents[event.rawValue] = (from: start, to: end)
-    }
-  }
-
-  public override func beginTracking(_ touch: UITouch, with event: UIEvent?) -> Bool {
+  open override func beginTracking(_ touch: UITouch, with event: UIEvent?) -> Bool {
     let _ = super.beginTracking(touch, with: event)
     let touchEvent = UIControl.Event.touchDown
     if let playrange = rangesForEvents[touchEvent.rawValue] {
@@ -62,7 +42,7 @@ open class AnimatedButton: AnimatedControl {
     return true
   }
 
-  public override func endTracking(_ touch: UITouch?, with event: UIEvent?) {
+  open override func endTracking(_ touch: UITouch?, with event: UIEvent?) {
     super.endTracking(touch, with: event)
     let touchEvent: UIControl.Event
     if let touch = touch, bounds.contains(touch.location(in: self)) {
@@ -76,6 +56,28 @@ open class AnimatedButton: AnimatedControl {
     }
   }
 
+  // MARK: Public
+
+  public override var accessibilityTraits: UIAccessibilityTraits {
+    set { super.accessibilityTraits = newValue }
+    get { super.accessibilityTraits.union(.button) }
+  }
+
+  /// Sets the play range for the given UIControlEvent.
+  public func setPlayRange(fromProgress: AnimationProgressTime, toProgress: AnimationProgressTime, event: UIControl.Event) {
+    rangesForEvents[event.rawValue] = (from: fromProgress, to: toProgress)
+  }
+
+  /// Sets the play range for the given UIControlEvent.
+  public func setPlayRange(fromMarker fromName: String, toMarker toName: String, event: UIControl.Event) {
+    if
+      let start = animationView.progressTime(forMarker: fromName),
+      let end = animationView.progressTime(forMarker: toName)
+    {
+      rangesForEvents[event.rawValue] = (from: start, to: end)
+    }
+  }
+
   // MARK: Private
 
   private var rangesForEvents: [UInt : (from: CGFloat, to: CGFloat)] =

package/Sources/Public/iOS/AnimatedControl.swift

@@ -31,10 +31,10 @@ open class AnimatedControl: UIControl {
   // MARK: Initializers
 
   public init(
-    animation: Animation,
+    animation: LottieAnimation,
     configuration: LottieConfiguration = .shared)
   {
-    animationView = AnimationView(
+    animationView = LottieAnimationView(
       animation: animation,
       configuration: configuration)
 
@@ -43,13 +43,13 @@ open class AnimatedControl: UIControl {
   }
 
   public init() {
-    animationView = AnimationView()
+    animationView = LottieAnimationView()
     super.init(frame: .zero)
     commonInit()
   }
 
   required public init?(coder aDecoder: NSCoder) {
-    animationView = AnimationView()
+    animationView = LottieAnimationView()
     super.init(coder: aDecoder)
     commonInit()
   }
@@ -105,10 +105,10 @@ open class AnimatedControl: UIControl {
   // MARK: Public
 
   /// The animation view in which the animation is rendered.
-  public let animationView: AnimationView
+  public let animationView: LottieAnimationView
 
   /// The animation backing the animated control.
-  public var animation: Animation? {
+  public var animation: LottieAnimation? {
     didSet {
       animationView.animation = animation
       animationView.bounds = animation?.bounds ?? .zero

package/Sources/Public/iOS/AnimatedSwitch.swift

@@ -18,7 +18,7 @@ open class AnimatedSwitch: AnimatedControl {
   // MARK: Lifecycle
 
   public override init(
-    animation: Animation,
+    animation: LottieAnimation,
     configuration: LottieConfiguration = .shared)
   {
     /// Generate a haptic generator if available.
@@ -67,6 +67,18 @@ open class AnimatedSwitch: AnimatedControl {
     isAccessibilityElement = true
   }
 
+  // MARK: Open
+
+  open override func animationDidSet() {
+    updateOnState(isOn: _isOn, animated: animateUpdateWhenChangingAnimation, shouldFireHaptics: false)
+  }
+
+  open override func endTracking(_ touch: UITouch?, with event: UIEvent?) {
+    super.endTracking(touch, with: event)
+    updateOnState(isOn: !_isOn, animated: true, shouldFireHaptics: true)
+    sendActions(for: .valueChanged)
+  }
+
   // MARK: Public
 
   /// Defines what happens when the user taps the switch while an
@@ -79,6 +91,9 @@ open class AnimatedSwitch: AnimatedControl {
   /// The cancel behavior for the switch. See CancelBehavior for options
   public var cancelBehavior: CancelBehavior = .reverse
 
+  /// If `false` the switch will not play the animation when changing between animations.
+  public var animateUpdateWhenChangingAnimation = true
+
   public override var accessibilityTraits: UIAccessibilityTraits {
     set { super.accessibilityTraits = newValue }
     get { super.accessibilityTraits.union(.button) }
@@ -119,16 +134,6 @@ open class AnimatedSwitch: AnimatedControl {
     updateOnState(isOn: _isOn, animated: false, shouldFireHaptics: false)
   }
 
-  public override func endTracking(_ touch: UITouch?, with event: UIEvent?) {
-    super.endTracking(touch, with: event)
-    updateOnState(isOn: !_isOn, animated: true, shouldFireHaptics: true)
-    sendActions(for: .valueChanged)
-  }
-
-  public override func animationDidSet() {
-    updateOnState(isOn: _isOn, animated: true, shouldFireHaptics: false)
-  }
-
   // MARK: Internal
 
   // MARK: Animation State

package/Sources/Public/iOS/Compatibility/CompatibleAnimationView.swift

@@ -25,8 +25,8 @@ public final class CompatibleAnimation: NSObject {
 
   // MARK: Internal
 
-  internal var animation: Animation? {
-    Animation.named(name, bundle: bundle)
+  internal var animation: LottieAnimation? {
+    LottieAnimation.named(name, bundle: bundle)
   }
 
   @objc
@@ -40,7 +40,7 @@ public final class CompatibleAnimation: NSObject {
   private let bundle: Bundle
 }
 
-/// An Objective-C compatible wrapper around Lottie's AnimationView.
+/// An Objective-C compatible wrapper around Lottie's LottieAnimationView.
 @objc
 public final class CompatibleAnimationView: UIView {
 
@@ -48,7 +48,7 @@ public final class CompatibleAnimationView: UIView {
 
   @objc
   public init(compatibleAnimation: CompatibleAnimation) {
-    animationView = AnimationView(animation: compatibleAnimation.animation)
+    animationView = LottieAnimationView(animation: compatibleAnimation.animation)
     self.compatibleAnimation = compatibleAnimation
     super.init(frame: .zero)
     commonInit()
@@ -56,7 +56,7 @@ public final class CompatibleAnimationView: UIView {
 
   @objc
   public override init(frame: CGRect) {
-    animationView = AnimationView()
+    animationView = LottieAnimationView()
     super.init(frame: frame)
     commonInit()
   }
@@ -186,6 +186,16 @@ public final class CompatibleAnimationView: UIView {
       completion: completion)
   }
 
+  @objc
+  public func play(
+    marker: String,
+    completion: ((Bool) -> Void)? = nil)
+  {
+    animationView.play(
+      marker: marker,
+      completion: completion)
+  }
+
   @objc
   public func stop() {
     animationView.stop()
@@ -242,14 +252,14 @@ public final class CompatibleAnimationView: UIView {
       color.getRed(&red, green: &green, blue: &blue, alpha: &alpha)
     }
 
-    let valueProvider = ColorValueProvider(Color(r: Double(red), g: Double(green), b: Double(blue), a: Double(alpha)))
+    let valueProvider = ColorValueProvider(LottieColor(r: Double(red), g: Double(green), b: Double(blue), a: Double(alpha)))
     animationView.setValueProvider(valueProvider, keypath: keypath.animationKeypath)
   }
 
   @objc
   public func getColorValue(for keypath: CompatibleAnimationKeypath, atFrame: CGFloat) -> UIColor? {
     let value = animationView.getValue(for: keypath.animationKeypath, atFrame: atFrame)
-    guard let colorValue = value as? Color else {
+    guard let colorValue = value as? LottieColor else {
       return nil;
     }
 
@@ -302,9 +312,14 @@ public final class CompatibleAnimationView: UIView {
     animationView.frameTime(forMarker: named) ?? 0
   }
 
+  @objc
+  public func durationFrameTime(forMarker named: String) -> CGFloat {
+    animationView.durationFrameTime(forMarker: named) ?? 0
+  }
+
   // MARK: Private
 
-  private let animationView: AnimationView
+  private let animationView: LottieAnimationView
 
   private func commonInit() {
     translatesAutoresizingMaskIntoConstraints = false

package/Sources/Public/iOS/{AnimationViewBase.swift → LottieAnimationViewBase.swift}

@@ -1,5 +1,5 @@
 //
-//  AnimationViewBase.swift
+//  LottieAnimationViewBase.swift
 //  lottie-swift-iOS
 //
 //  Created by Brandon Withrow on 2/6/19.
@@ -8,10 +8,10 @@
 #if os(iOS) || os(tvOS) || os(watchOS) || targetEnvironment(macCatalyst)
 import UIKit
 
-/// The base view for `AnimationView` on iOS, tvOS, watchOS, and macCatalyst.
+/// The base view for `LottieAnimationView` on iOS, tvOS, watchOS, and macCatalyst.
 ///
-/// Enables the `AnimationView` implementation to be shared across platforms.
-public class AnimationViewBase: UIView {
+/// Enables the `LottieAnimationView` implementation to be shared across platforms.
+public class LottieAnimationViewBase: UIView {
 
   // MARK: Public
 

package/Sources/Public/iOS/UIColorExtension.swift

@@ -11,10 +11,10 @@ import UIKit
 
 extension UIColor {
 
-  public var lottieColorValue: Color {
+  public var lottieColorValue: LottieColor {
     var r: CGFloat = 0, g: CGFloat = 0, b: CGFloat = 0, a: CGFloat = 0
     getRed(&r, green: &g, blue: &b, alpha: &a)
-    return Color(r: Double(r), g: Double(g), b: Double(b), a: Double(a))
+    return LottieColor(r: Double(r), g: Double(g), b: Double(b), a: Double(a))
   }
 
 }

package/Sources/Public/macOS/{AnimationViewBase.macOS.swift → LottieAnimationViewBase.macOS.swift}

@@ -1,5 +1,5 @@
 //
-//  AnimationViewBase.swift
+//  LottieAnimationViewBase.swift
 //  lottie-swift-iOS
 //
 //  Created by Brandon Withrow on 2/6/19.
@@ -24,10 +24,10 @@ public enum LottieContentMode: Int {
   case bottomRight
 }
 
-/// The base view for `AnimationView` on macOs.
+/// The base view for `LottieAnimationView` on macOs.
 ///
-/// Enables the `AnimationView` implementation to be shared across platforms.
-public class AnimationViewBase: NSView {
+/// Enables the `LottieAnimationView` implementation to be shared across platforms.
+public class LottieAnimationViewBase: NSView {
 
   // MARK: Public
 

package/Tests/AnimationKeypathTests.swift

@@ -29,7 +29,7 @@ final class AnimationKeypathTests: XCTestCase {
   }
 
   func testLayerForKeypath() {
-    let animationView = AnimationView(
+    let animationView = LottieAnimationView(
       animation: Samples.animation(named: "Boat_Loader"),
       configuration: LottieConfiguration(renderingEngine: .mainThread))
 

package/Tests/Artifacts/LottieTests.xcresult/Data/data.0~4VqMqsI5lOfxRppnud6-VDWcNsU8J7VgFCJfW2dXPwOcAkvU-I8Um5yp9n0Zv6nr3VmcxYggaVMDFfR0U_vjKw==

@@ -0,0 +1 @@
+[]

package/Tests/Artifacts/LottieTests.xcresult/Data/data.0~Bys36bGK_YkCjRNoPMkq3R0OcyPNrVNka1Gz45ilbXJTqp9xAJexx6qKBh86_fm7OgBCO0WS2gJBy77DUUnOOA==

@@ -0,0 +1 @@
+[{"name":"testmanagerd.log","type":1}]

package/Tests/Artifacts/LottieTests.xcresult/Data/data.0~YyEdK1WNFTPo-R3Og2OWduKSikuFYneXurEZbyNLZeDmJLJkd7Ew8jNxy4mvgZw4f4Sikp4swEjJgVzXqhev5g==

@@ -0,0 +1 @@
+[{"name":"LottieTests-D2EA3CFB-B5FF-47F6-B3AB-804D6728A9BA","type":2},{"name":"scheduling.log","type":1}]

package/Tests/Artifacts/LottieTests.xcresult/Info.plist

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>dateCreated</key>
+	<date>2022-10-11T00:03:18Z</date>
+	<key>externalLocations</key>
+	<array/>
+	<key>rootId</key>
+	<dict>
+		<key>hash</key>
+		<string>0~22UHuHHSTYh5NFeueXXSDdev_8VAbw8H8yl2ICssaC0vaCLj2G2CGZCjUMEyki9c-k-CecFJRyspvzJLiQTjUw==</string>
+	</dict>
+	<key>storage</key>
+	<dict>
+		<key>backend</key>
+		<string>fileBacked2</string>
+		<key>compression</key>
+		<string>standard</string>
+	</dict>
+	<key>version</key>
+	<dict>
+		<key>major</key>
+		<integer>3</integer>
+		<key>minor</key>
+		<integer>39</integer>
+	</dict>
+</dict>
+</plist>

package/Tests/ParsingTests.swift

@@ -18,8 +18,8 @@ final class ParsingTests: XCTestCase {
     for url in Samples.sampleAnimationURLs {
       do {
         let data = try Data(contentsOf: url)
-        let codableAnimation = try Animation.from(data: data, strategy: .codable)
-        let dictAnimation = try Animation.from(data: data, strategy: .dictionaryBased)
+        let codableAnimation = try LottieAnimation.from(data: data, strategy: .codable)
+        let dictAnimation = try LottieAnimation.from(data: data, strategy: .dictionaryBased)
 
         XCTAssertNoDiff(codableAnimation, dictAnimation)
       } catch {

package/Tests/PerformanceTests.swift

@@ -85,12 +85,12 @@ final class PerformanceTests: XCTestCase {
 
   // MARK: Private
 
-  private let simpleAnimation = Animation.named(
+  private let simpleAnimation = LottieAnimation.named(
     "loading_dots_1",
     bundle: .module,
     subdirectory: "Samples/LottieFiles")!
 
-  private let complexAnimation = Animation.named(
+  private let complexAnimation = LottieAnimation.named(
     "LottieLogo2",
     bundle: .module,
     subdirectory: "Samples")!
@@ -100,7 +100,7 @@ final class PerformanceTests: XCTestCase {
   private func compareEngineSetupPerformance(
     of engineA: RenderingEngineOption,
     with engineB: RenderingEngineOption,
-    for animation: Animation,
+    for animation: LottieAnimation,
     iterations: Int)
     -> Double
   {
@@ -125,7 +125,7 @@ final class PerformanceTests: XCTestCase {
     return ratio
   }
 
-  private func setUpAndTearDownAnimationView(with animation: Animation, configuration: LottieConfiguration) {
+  private func setUpAndTearDownAnimationView(with animation: LottieAnimation, configuration: LottieConfiguration) {
     // Each animation setup needs to be wrapped in its own `CATransaction`
     // in order for the layers to be deallocated immediately. Otherwise
     // the layers aren't deallocated until the end of the test run,
@@ -142,7 +142,7 @@ final class PerformanceTests: XCTestCase {
 
   /// Compares performance of scrubbing the given animation with both the Main Thread and Core Animation engine,
   /// and returns the ratio of how much slower the Core Animation is than the Main Thread engine
-  private func compareEngineScrubbingPerformance(for animation: Animation, iterations: Int) -> Double {
+  private func compareEngineScrubbingPerformance(for animation: LottieAnimation, iterations: Int) -> Double {
     let mainThreadAnimationView = setupAnimationView(with: animation, configuration: .init(renderingEngine: .mainThread))
     let mainThreadEnginePerformance = measurePerformance {
       for i in 0..<iterations {
@@ -177,7 +177,7 @@ final class PerformanceTests: XCTestCase {
   private func compareDeserializationPerformance(data: Data, iterations: Int) throws -> Double {
     let codablePerformance = try measurePerformance {
       for _ in 0..<iterations {
-        _ = try Animation.from(data: data, strategy: .codable)
+        _ = try LottieAnimation.from(data: data, strategy: .codable)
       }
     }
 
@@ -185,7 +185,7 @@ final class PerformanceTests: XCTestCase {
 
     let dictPerformance = try measurePerformance {
       for _ in 0..<iterations {
-        _ = try Animation.from(data: data, strategy: .dictionaryBased)
+        _ = try LottieAnimation.from(data: data, strategy: .dictionaryBased)
       }
     }
 
@@ -196,8 +196,8 @@ final class PerformanceTests: XCTestCase {
   }
 
   @discardableResult
-  private func setupAnimationView(with animation: Animation, configuration: LottieConfiguration) -> AnimationView {
-    let animationView = AnimationView(animation: animation, configuration: configuration)
+  private func setupAnimationView(with animation: LottieAnimation, configuration: LottieConfiguration) -> LottieAnimationView {
+    let animationView = LottieAnimationView(animation: animation, configuration: configuration)
     animationView.frame.size = CGSize(width: animation.width, height: animation.height)
     animationView.layoutIfNeeded()
     return animationView

package/Tests/SnapshotConfiguration.swift

@@ -59,9 +59,9 @@ extension SnapshotConfiguration {
       AnimationKeypath(keypath: "Checkmark Outlines 2.Group 1.Stroke 1.Color"): ColorValueProvider(.black),
       AnimationKeypath(keypath: "X Outlines.Group 1.Stroke 1.Color"): ColorValueProvider(.black),
       AnimationKeypath(keypath: "Switch Outline Outlines.Fill 1.Color"): ColorValueProvider([
-        Keyframe(value: Color.black, time: 0),
+        Keyframe(value: LottieColor.black, time: 0),
         Keyframe(value: Color(r: 0.76, g: 0.76, b: 0.76, a: 1), time: 75),
-        Keyframe(value: Color.black, time: 150),
+        Keyframe(value: LottieColor.black, time: 150),
       ]),
     ]),
 
@@ -163,9 +163,9 @@ extension SnapshotConfiguration {
   }
 }
 
-// MARK: - Color helpers
+// MARK: - LottieColor helpers
 
-extension Color {
+extension LottieColor {
   static let black = Color(r: 0, g: 0, b: 0, a: 1)
   static let red = Color(r: 1, g: 0, b: 0, a: 1)
 }