lottie-ios 4.1.2 → 4.1.3

package/Sources/Private/Model/ShapeItems/Repeater.swift

@@ -22,8 +22,19 @@ final class Repeater: ShapeItem {
       .decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .startOpacity) ?? KeyframeGroup(LottieVector1D(100))
     endOpacity = try transformContainer
       .decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .endOpacity) ?? KeyframeGroup(LottieVector1D(100))
-    rotation = try transformContainer
-      .decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotation) ?? KeyframeGroup(LottieVector1D(0))
+    if let rotation = try transformContainer.decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotation) {
+      rotationZ = rotation
+    } else if let rotation = try transformContainer.decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotationZ) {
+      rotationZ = rotation
+    } else {
+      rotationZ = KeyframeGroup(LottieVector1D(0))
+    }
+
+    rotationX = try transformContainer
+      .decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotationX) ?? KeyframeGroup(LottieVector1D(0))
+    rotationY = try transformContainer
+      .decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotationY) ?? KeyframeGroup(LottieVector1D(0))
+
     position = try transformContainer
       .decodeIfPresent(KeyframeGroup<LottieVector3D>.self, forKey: .position) ??
       KeyframeGroup(LottieVector3D(x: Double(0), y: 0, z: 0))
@@ -58,10 +69,22 @@ final class Repeater: ShapeItem {
     } else {
       endOpacity = KeyframeGroup(LottieVector1D(100))
     }
+    if let rotationDictionary = transformDictionary[TransformKeys.rotationX.rawValue] as? [String: Any] {
+      rotationX = try KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
+    } else {
+      rotationX = KeyframeGroup(LottieVector1D(0))
+    }
+    if let rotationDictionary = transformDictionary[TransformKeys.rotationY.rawValue] as? [String: Any] {
+      rotationY = try KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
+    } else {
+      rotationY = KeyframeGroup(LottieVector1D(0))
+    }
     if let rotationDictionary = transformDictionary[TransformKeys.rotation.rawValue] as? [String: Any] {
-      rotation = try KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
+      rotationZ = try KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
+    } else if let rotationDictionary = transformDictionary[TransformKeys.rotationZ.rawValue] as? [String: Any] {
+      rotationZ = try KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
     } else {
-      rotation = KeyframeGroup(LottieVector1D(0))
+      rotationZ = KeyframeGroup(LottieVector1D(0))
     }
     if let positionDictionary = transformDictionary[TransformKeys.position.rawValue] as? [String: Any] {
       position = try KeyframeGroup<LottieVector3D>(dictionary: positionDictionary)
@@ -95,8 +118,14 @@ final class Repeater: ShapeItem {
   /// End opacity
   let endOpacity: KeyframeGroup<LottieVector1D>
 
-  /// The rotation
-  let rotation: KeyframeGroup<LottieVector1D>
+  /// The rotation on X axis
+  let rotationX: KeyframeGroup<LottieVector1D>
+
+  /// The rotation on Y axis
+  let rotationY: KeyframeGroup<LottieVector1D>
+
+  /// The rotation on Z axis
+  let rotationZ: KeyframeGroup<LottieVector1D>
 
   /// Anchor Point
   let anchorPoint: KeyframeGroup<LottieVector3D>
@@ -115,7 +144,9 @@ final class Repeater: ShapeItem {
     var transformContainer = container.nestedContainer(keyedBy: TransformKeys.self, forKey: .transform)
     try transformContainer.encode(startOpacity, forKey: .startOpacity)
     try transformContainer.encode(endOpacity, forKey: .endOpacity)
-    try transformContainer.encode(rotation, forKey: .rotation)
+    try transformContainer.encode(rotationX, forKey: .rotationX)
+    try transformContainer.encode(rotationY, forKey: .rotationY)
+    try transformContainer.encode(rotationZ, forKey: .rotationZ)
     try transformContainer.encode(position, forKey: .position)
     try transformContainer.encode(anchorPoint, forKey: .anchorPoint)
     try transformContainer.encode(scale, forKey: .scale)
@@ -131,6 +162,9 @@ final class Repeater: ShapeItem {
 
   private enum TransformKeys: String, CodingKey {
     case rotation = "r"
+    case rotationX = "rx"
+    case rotationY = "ry"
+    case rotationZ = "rz"
     case startOpacity = "so"
     case endOpacity = "eo"
     case anchorPoint = "a"

package/Sources/Private/Model/ShapeItems/ShapeTransform.swift

@@ -22,8 +22,25 @@ final class ShapeTransform: ShapeItem {
     scale = try container
       .decodeIfPresent(KeyframeGroup<LottieVector3D>.self, forKey: .scale) ??
       KeyframeGroup(LottieVector3D(x: Double(100), y: 100, z: 100))
-    rotation = try container
-      .decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotation) ?? KeyframeGroup(LottieVector1D(0))
+
+    rotationX = try container
+      .decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotationX) ?? KeyframeGroup(LottieVector1D(0))
+    rotationY = try container
+      .decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotationY) ?? KeyframeGroup(LottieVector1D(0))
+    if
+      let rotation = try container
+        .decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotation)
+    {
+      rotationZ = rotation
+    } else if
+      let rotation = try container
+        .decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotationZ)
+    {
+      rotationZ = rotation
+    } else {
+      rotationZ = KeyframeGroup(LottieVector1D(0))
+    }
+
     opacity = try container
       .decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .opacity) ?? KeyframeGroup(LottieVector1D(100))
     skew = try container.decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .skew) ?? KeyframeGroup(LottieVector1D(0))
@@ -57,14 +74,39 @@ final class ShapeTransform: ShapeItem {
     } else {
       scale = KeyframeGroup(LottieVector3D(x: Double(100), y: 100, z: 100))
     }
+
+    if
+      let rotationDictionary = dictionary[CodingKeys.rotationX.rawValue] as? [String: Any],
+      let rotation = try? KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
+    {
+      rotationX = rotation
+    } else {
+      rotationX = KeyframeGroup(LottieVector1D(0))
+    }
+
+    if
+      let rotationDictionary = dictionary[CodingKeys.rotationY.rawValue] as? [String: Any],
+      let rotation = try? KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
+    {
+      rotationY = rotation
+    } else {
+      rotationY = KeyframeGroup(LottieVector1D(0))
+    }
+
     if
       let rotationDictionary = dictionary[CodingKeys.rotation.rawValue] as? [String: Any],
       let rotation = try? KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
     {
-      self.rotation = rotation
+      rotationZ = rotation
+    } else if
+      let rotationDictionary = dictionary[CodingKeys.rotationZ.rawValue] as? [String: Any],
+      let rotation = try? KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
+    {
+      rotationZ = rotation
     } else {
-      rotation = KeyframeGroup(LottieVector1D(0))
+      rotationZ = KeyframeGroup(LottieVector1D(0))
     }
+
     if
       let opacityDictionary = dictionary[CodingKeys.opacity.rawValue] as? [String: Any],
       let opacity = try? KeyframeGroup<LottieVector1D>(dictionary: opacityDictionary)
@@ -89,6 +131,7 @@ final class ShapeTransform: ShapeItem {
     } else {
       skewAxis = KeyframeGroup(LottieVector1D(0))
     }
+
     try super.init(dictionary: dictionary)
   }
 
@@ -103,8 +146,14 @@ final class ShapeTransform: ShapeItem {
   /// Scale
   let scale: KeyframeGroup<LottieVector3D>
 
-  /// Rotation
-  let rotation: KeyframeGroup<LottieVector1D>
+  /// Rotation on X axis
+  let rotationX: KeyframeGroup<LottieVector1D>
+
+  /// Rotation on Y axis
+  let rotationY: KeyframeGroup<LottieVector1D>
+
+  /// Rotation on Z axis
+  let rotationZ: KeyframeGroup<LottieVector1D>
 
   /// opacity
   let opacity: KeyframeGroup<LottieVector1D>
@@ -130,7 +179,9 @@ final class ShapeTransform: ShapeItem {
     try container.encode(anchor, forKey: .anchor)
     try container.encode(position, forKey: .position)
     try container.encode(scale, forKey: .scale)
-    try container.encode(rotation, forKey: .rotation)
+    try container.encode(rotationX, forKey: .rotationX)
+    try container.encode(rotationY, forKey: .rotationY)
+    try container.encode(rotationZ, forKey: .rotationZ)
     try container.encode(opacity, forKey: .opacity)
     try container.encode(skew, forKey: .skew)
     try container.encode(skewAxis, forKey: .skewAxis)
@@ -143,6 +194,9 @@ final class ShapeTransform: ShapeItem {
     case position = "p"
     case scale = "s"
     case rotation = "r"
+    case rotationX = "rx"
+    case rotationY = "ry"
+    case rotationZ = "rz"
     case opacity = "o"
     case skew = "sk"
     case skewAxis = "sa"

package/Sources/Private/Model/Text/TextAnimator.swift

@@ -24,7 +24,15 @@ final class TextAnimator: Codable, DictionaryInitializable {
     scale = try animatorContainer.decodeIfPresent(KeyframeGroup<LottieVector3D>.self, forKey: .scale)
     skew = try animatorContainer.decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .skew)
     skewAxis = try animatorContainer.decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .skewAxis)
-    rotation = try animatorContainer.decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotation)
+    rotationX = try animatorContainer.decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotationX)
+    rotationY = try animatorContainer.decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotationY)
+    if let rotation = try animatorContainer.decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotation) {
+      rotationZ = rotation
+    } else if let rotation = try animatorContainer.decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .rotationZ) {
+      rotationZ = rotation
+    } else {
+      rotationZ = nil
+    }
     opacity = try animatorContainer.decodeIfPresent(KeyframeGroup<LottieVector1D>.self, forKey: .opacity)
   }
 
@@ -76,11 +84,26 @@ final class TextAnimator: Codable, DictionaryInitializable {
     } else {
       skewAxis = nil
     }
+    if let rotationDictionary = animatorDictionary[TextAnimatorKeys.rotationX.rawValue] as? [String: Any] {
+      rotationX = try? KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
+    } else {
+      rotationX = nil
+    }
+
+    if let rotationDictionary = animatorDictionary[TextAnimatorKeys.rotationY.rawValue] as? [String: Any] {
+      rotationY = try? KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
+    } else {
+      rotationY = nil
+    }
+
     if let rotationDictionary = animatorDictionary[TextAnimatorKeys.rotation.rawValue] as? [String: Any] {
-      rotation = try? KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
+      rotationZ = try? KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
+    } else if let rotationDictionary = animatorDictionary[TextAnimatorKeys.rotationZ.rawValue] as? [String: Any] {
+      rotationZ = try? KeyframeGroup<LottieVector1D>(dictionary: rotationDictionary)
     } else {
-      rotation = nil
+      rotationZ = nil
     }
+
     if let opacityDictionary = animatorDictionary[TextAnimatorKeys.opacity.rawValue] as? [String: Any] {
       opacity = try KeyframeGroup<LottieVector1D>(dictionary: opacityDictionary)
     } else {
@@ -107,8 +130,14 @@ final class TextAnimator: Codable, DictionaryInitializable {
   /// Skew Axis
   let skewAxis: KeyframeGroup<LottieVector1D>?
 
-  /// Rotation
-  let rotation: KeyframeGroup<LottieVector1D>?
+  /// Rotation on X axis
+  let rotationX: KeyframeGroup<LottieVector1D>?
+
+  /// Rotation on Y axis
+  let rotationY: KeyframeGroup<LottieVector1D>?
+
+  /// Rotation on Z axis
+  let rotationZ: KeyframeGroup<LottieVector1D>?
 
   /// Opacity
   let opacity: KeyframeGroup<LottieVector1D>?
@@ -159,6 +188,9 @@ final class TextAnimator: Codable, DictionaryInitializable {
     case skew = "sk"
     case skewAxis = "sa"
     case rotation = "r"
+    case rotationX = "rx"
+    case rotationY = "ry"
+    case rotationZ = "rz"
     case opacity = "o"
   }
 }

package/Sources/Private/Utility/Primitives/ColorExtension.swift

@@ -38,22 +38,18 @@ extension LottieColor: Codable {
       b1 = 0
     }
 
-    var a1: Double
-    if !container.isAtEnd {
-      a1 = try container.decode(Double.self)
-    } else {
-      a1 = 1
-    }
-    if r1 > 1, g1 > 1, b1 > 1, a1 > 1 {
+    if r1 > 1, g1 > 1, b1 > 1 {
       r1 = r1 / 255
       g1 = g1 / 255
       b1 = b1 / 255
-      a1 = a1 / 255
     }
     r = r1
     g = g1
     b = b1
-    a = a1
+
+    // The Lottie JSON schema supports alpha values in theory, as the fourth value in this array.
+    // We intentionally do not support this, though, for consistency with Lottie on other platforms.
+    a = 1
   }
 
   // MARK: Public
@@ -79,17 +75,18 @@ extension LottieColor: AnyInitializable {
     var r: Double = array.count > 0 ? array.removeFirst() : 0
     var g: Double = array.count > 0 ? array.removeFirst() : 0
     var b: Double = array.count > 0 ? array.removeFirst() : 0
-    var a: Double = array.count > 0 ? array.removeFirst() : 1
-    if r > 1, g > 1, b > 1, a > 1 {
+    if r > 1, g > 1, b > 1 {
       r /= 255
       g /= 255
       b /= 255
-      a /= 255
     }
     self.r = r
     self.g = g
     self.b = b
-    self.a = a
+
+    // The Lottie JSON schema supports alpha values in theory, as the fourth value in this array.
+    // We intentionally do not support this, though, for consistency with Lottie on other platforms.
+    a = 1
   }
 
 }

package/Sources/Private/Utility/Primitives/VectorsExtensions.swift

@@ -246,6 +246,10 @@ extension CGSize {
 
 extension CATransform3D {
 
+  enum Axis {
+    case x, y, z
+  }
+
   static func makeSkew(skew: CGFloat, skewAxis: CGFloat) -> CATransform3D {
     let mCos = cos(skewAxis.toRadians())
     let mSin = sin(skewAxis.toRadians())
@@ -311,20 +315,37 @@ extension CATransform3D {
     anchor: CGPoint,
     position: CGPoint,
     scale: CGSize,
-    rotation: CGFloat,
+    rotationX: CGFloat,
+    rotationY: CGFloat,
+    rotationZ: CGFloat,
     skew: CGFloat?,
     skewAxis: CGFloat?)
     -> CATransform3D
   {
     if let skew = skew, let skewAxis = skewAxis {
-      return CATransform3DMakeTranslation(position.x, position.y, 0).rotated(rotation).skewed(skew: -skew, skewAxis: skewAxis)
-        .scaled(scale * 0.01).translated(anchor * -1)
+      return CATransform3DMakeTranslation(position.x, position.y, 0)
+        .rotated(rotationX, axis: .x)
+        .rotated(rotationY, axis: .y)
+        .rotated(rotationZ, axis: .z)
+        .skewed(skew: -skew, skewAxis: skewAxis)
+        .scaled(scale * 0.01)
+        .translated(anchor * -1)
     }
-    return CATransform3DMakeTranslation(position.x, position.y, 0).rotated(rotation).scaled(scale * 0.01).translated(anchor * -1)
+    return CATransform3DMakeTranslation(position.x, position.y, 0)
+      .rotated(rotationX, axis: .x)
+      .rotated(rotationY, axis: .y)
+      .rotated(rotationZ, axis: .z)
+      .scaled(scale * 0.01)
+      .translated(anchor * -1)
   }
 
-  func rotated(_ degrees: CGFloat) -> CATransform3D {
-    CATransform3DRotate(self, degrees.toRadians(), 0, 0, 1)
+  func rotated(_ degrees: CGFloat, axis: Axis) -> CATransform3D {
+    CATransform3DRotate(
+      self,
+      degrees.toRadians(),
+      axis == .x ? 1 : 0,
+      axis == .y ? 1 : 0,
+      axis == .z ? 1 : 0)
   }
 
   func translated(_ translation: CGPoint) -> CATransform3D {
@@ -338,4 +359,5 @@ extension CATransform3D {
   func skewed(skew: CGFloat, skewAxis: CGFloat) -> CATransform3D {
     CATransform3DConcat(CATransform3D.makeSkew(skew: skew, skewAxis: skewAxis), self)
   }
+
 }