lottie-ios 3.2.0 → 3.4.0

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/PathNodes/EllipseNode.swift

@@ -0,0 +1,139 @@
+//
+//  EllipseNode.swift
+//  lottie-swift
+//
+//  Created by Brandon Withrow on 1/17/19.
+//
+
+import Foundation
+import QuartzCore
+
+// MARK: - EllipseNodeProperties
+
+final class EllipseNodeProperties: NodePropertyMap, KeypathSearchable {
+
+  // MARK: Lifecycle
+
+  init(ellipse: Ellipse) {
+    keypathName = ellipse.name
+    direction = ellipse.direction
+    position = NodeProperty(provider: KeyframeInterpolator(keyframes: ellipse.position.keyframes))
+    size = NodeProperty(provider: KeyframeInterpolator(keyframes: ellipse.size.keyframes))
+    keypathProperties = [
+      "Position" : position,
+      "Size" : size,
+    ]
+    properties = Array(keypathProperties.values)
+  }
+
+  // MARK: Internal
+
+  var keypathName: String
+
+  let direction: PathDirection
+  let position: NodeProperty<Vector3D>
+  let size: NodeProperty<Vector3D>
+
+  let keypathProperties: [String: AnyNodeProperty]
+  let properties: [AnyNodeProperty]
+}
+
+// MARK: - EllipseNode
+
+final class EllipseNode: AnimatorNode, PathNode {
+
+  // MARK: Lifecycle
+
+  init(parentNode: AnimatorNode?, ellipse: Ellipse) {
+    pathOutput = PathOutputNode(parent: parentNode?.outputNode)
+    properties = EllipseNodeProperties(ellipse: ellipse)
+    self.parentNode = parentNode
+  }
+
+  // MARK: Internal
+
+  static let ControlPointConstant: CGFloat = 0.55228
+
+  let pathOutput: PathOutputNode
+
+  let properties: EllipseNodeProperties
+
+  let parentNode: AnimatorNode?
+  var hasLocalUpdates = false
+  var hasUpstreamUpdates = false
+  var lastUpdateFrame: CGFloat? = nil
+
+  // MARK: Animator Node
+
+  var propertyMap: NodePropertyMap & KeypathSearchable {
+    properties
+  }
+
+  var isEnabled = true {
+    didSet {
+      pathOutput.isEnabled = isEnabled
+    }
+  }
+
+  func rebuildOutputs(frame: CGFloat) {
+    pathOutput.setPath(
+      .ellipse(
+        size: properties.size.value.sizeValue,
+        center: properties.position.value.pointValue,
+        direction: properties.direction),
+      updateFrame: frame)
+  }
+
+}
+
+extension BezierPath {
+  /// Constructs a `BezierPath` in the shape of an ellipse
+  static func ellipse(
+    size: CGSize,
+    center: CGPoint,
+    direction: PathDirection)
+    -> BezierPath
+  {
+    // Unfortunately we HAVE to manually build out the ellipse.
+    // Every Apple method constructs an ellipse from the 3 o-clock position
+    // After effects constructs from the Noon position.
+    // After effects does clockwise, but also has a flag for reversed.
+    var half = size * 0.5
+    if direction == .counterClockwise {
+      half.width = half.width * -1
+    }
+
+    let q1 = CGPoint(x: center.x, y: center.y - half.height)
+    let q2 = CGPoint(x: center.x + half.width, y: center.y)
+    let q3 = CGPoint(x: center.x, y: center.y + half.height)
+    let q4 = CGPoint(x: center.x - half.width, y: center.y)
+
+    let cp = half * EllipseNode.ControlPointConstant
+
+    var path = BezierPath(startPoint: CurveVertex(
+      point: q1,
+      inTangentRelative: CGPoint(x: -cp.width, y: 0),
+      outTangentRelative: CGPoint(x: cp.width, y: 0)))
+    path.addVertex(CurveVertex(
+      point: q2,
+      inTangentRelative: CGPoint(x: 0, y: -cp.height),
+      outTangentRelative: CGPoint(x: 0, y: cp.height)))
+
+    path.addVertex(CurveVertex(
+      point: q3,
+      inTangentRelative: CGPoint(x: cp.width, y: 0),
+      outTangentRelative: CGPoint(x: -cp.width, y: 0)))
+
+    path.addVertex(CurveVertex(
+      point: q4,
+      inTangentRelative: CGPoint(x: 0, y: cp.height),
+      outTangentRelative: CGPoint(x: 0, y: -cp.height)))
+
+    path.addVertex(CurveVertex(
+      point: q1,
+      inTangentRelative: CGPoint(x: -cp.width, y: 0),
+      outTangentRelative: CGPoint(x: cp.width, y: 0)))
+    path.close()
+    return path
+  }
+}

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/PathNodes/PolygonNode.swift

@@ -0,0 +1,170 @@
+//
+//  PolygonNode.swift
+//  lottie-swift
+//
+//  Created by Brandon Withrow on 1/21/19.
+//
+
+import Foundation
+import QuartzCore
+
+// MARK: - PolygonNodeProperties
+
+final class PolygonNodeProperties: NodePropertyMap, KeypathSearchable {
+
+  // MARK: Lifecycle
+
+  init(star: Star) {
+    keypathName = star.name
+    direction = star.direction
+    position = NodeProperty(provider: KeyframeInterpolator(keyframes: star.position.keyframes))
+    outerRadius = NodeProperty(provider: KeyframeInterpolator(keyframes: star.outerRadius.keyframes))
+    outerRoundedness = NodeProperty(provider: KeyframeInterpolator(keyframes: star.outerRoundness.keyframes))
+    rotation = NodeProperty(provider: KeyframeInterpolator(keyframes: star.rotation.keyframes))
+    points = NodeProperty(provider: KeyframeInterpolator(keyframes: star.points.keyframes))
+    keypathProperties = [
+      "Position" : position,
+      "Outer Radius" : outerRadius,
+      "Outer Roundedness" : outerRoundedness,
+      "Rotation" : rotation,
+      "Points" : points,
+    ]
+    properties = Array(keypathProperties.values)
+  }
+
+  // MARK: Internal
+
+  var keypathName: String
+
+  var childKeypaths: [KeypathSearchable] = []
+
+  let keypathProperties: [String: AnyNodeProperty]
+  let properties: [AnyNodeProperty]
+
+  let direction: PathDirection
+  let position: NodeProperty<Vector3D>
+  let outerRadius: NodeProperty<Vector1D>
+  let outerRoundedness: NodeProperty<Vector1D>
+  let rotation: NodeProperty<Vector1D>
+  let points: NodeProperty<Vector1D>
+}
+
+// MARK: - PolygonNode
+
+final class PolygonNode: AnimatorNode, PathNode {
+
+  // MARK: Lifecycle
+
+  init(parentNode: AnimatorNode?, star: Star) {
+    pathOutput = PathOutputNode(parent: parentNode?.outputNode)
+    properties = PolygonNodeProperties(star: star)
+    self.parentNode = parentNode
+  }
+
+  // MARK: Internal
+
+  /// Magic number needed for constructing path.
+  static let PolygonConstant: CGFloat = 0.25
+
+  let properties: PolygonNodeProperties
+
+  let pathOutput: PathOutputNode
+
+  let parentNode: AnimatorNode?
+  var hasLocalUpdates = false
+  var hasUpstreamUpdates = false
+  var lastUpdateFrame: CGFloat? = nil
+
+  // MARK: Animator Node
+
+  var propertyMap: NodePropertyMap & KeypathSearchable {
+    properties
+  }
+
+  var isEnabled = true {
+    didSet {
+      pathOutput.isEnabled = isEnabled
+    }
+  }
+
+  func rebuildOutputs(frame: CGFloat) {
+    let path = BezierPath.polygon(
+      position: properties.position.value.pointValue,
+      numberOfPoints: properties.points.value.cgFloatValue,
+      outerRadius: properties.outerRadius.value.cgFloatValue,
+      outerRoundedness: properties.outerRoundedness.value.cgFloatValue,
+      rotation: properties.rotation.value.cgFloatValue,
+      direction: properties.direction)
+
+    pathOutput.setPath(path, updateFrame: frame)
+  }
+
+}
+
+extension BezierPath {
+  /// Creates a `BezierPath` in the shape of a polygon
+  static func polygon(
+    position: CGPoint,
+    numberOfPoints: CGFloat,
+    outerRadius: CGFloat,
+    outerRoundedness inputOuterRoundedness: CGFloat,
+    rotation: CGFloat,
+    direction: PathDirection)
+    -> BezierPath
+  {
+    var currentAngle = (rotation - 90).toRadians()
+    let anglePerPoint = ((2 * CGFloat.pi) / numberOfPoints)
+    let outerRoundedness = inputOuterRoundedness * 0.01
+
+    var point = CGPoint(
+      x: outerRadius * cos(currentAngle),
+      y: outerRadius * sin(currentAngle))
+    var vertices = [CurveVertex(point: point + position, inTangentRelative: .zero, outTangentRelative: .zero)]
+
+    var previousPoint = point
+    currentAngle += anglePerPoint;
+    for _ in 0..<Int(ceil(numberOfPoints)) {
+      previousPoint = point
+      point = CGPoint(
+        x: outerRadius * cos(currentAngle),
+        y: outerRadius * sin(currentAngle))
+
+      if outerRoundedness != 0 {
+        let cp1Theta = (atan2(previousPoint.y, previousPoint.x) - CGFloat.pi / 2)
+        let cp1Dx = cos(cp1Theta);
+        let cp1Dy = sin(cp1Theta);
+
+        let cp2Theta = (atan2(point.y, point.x) - CGFloat.pi / 2)
+        let cp2Dx = cos(cp2Theta)
+        let cp2Dy = sin(cp2Theta)
+
+        let cp1 = CGPoint(
+          x: outerRadius * outerRoundedness * PolygonNode.PolygonConstant * cp1Dx,
+          y: outerRadius * outerRoundedness * PolygonNode.PolygonConstant * cp1Dy)
+        let cp2 = CGPoint(
+          x: outerRadius * outerRoundedness * PolygonNode.PolygonConstant * cp2Dx,
+          y: outerRadius * outerRoundedness * PolygonNode.PolygonConstant * cp2Dy)
+
+        let previousVertex = vertices[vertices.endIndex - 1]
+        vertices[vertices.endIndex - 1] = CurveVertex(
+          previousVertex.inTangent,
+          previousVertex.point,
+          previousVertex.point - cp1)
+        vertices.append(CurveVertex(point: point + position, inTangentRelative: cp2, outTangentRelative: .zero))
+      } else {
+        vertices.append(CurveVertex(point: point + position, inTangentRelative: .zero, outTangentRelative: .zero))
+      }
+      currentAngle += anglePerPoint;
+    }
+    let reverse = direction == .counterClockwise
+    if reverse {
+      vertices = vertices.reversed()
+    }
+    var path = BezierPath()
+    for vertex in vertices {
+      path.addVertex(reverse ? vertex.reversed() : vertex)
+    }
+    path.close()
+    return path
+  }
+}

package/{lottie-swift/src/Private → Sources/Private/MainThread}/NodeRenderSystem/Nodes/PathNodes/RectNode.swift

@@ -5,102 +5,140 @@
 //  Created by Brandon Withrow on 1/21/19.
 //
 
-import Foundation
 import CoreGraphics
+import Foundation
+
+// MARK: - RectNodeProperties
 
 final class RectNodeProperties: NodePropertyMap, KeypathSearchable {
-  
-  var keypathName: String
+
+  // MARK: Lifecycle
 
   init(rectangle: Rectangle) {
-    self.keypathName = rectangle.name
-    self.direction = rectangle.direction
-    self.position = NodeProperty(provider: KeyframeInterpolator(keyframes: rectangle.position.keyframes))
-    self.size = NodeProperty(provider: KeyframeInterpolator(keyframes: rectangle.size.keyframes))
-    self.cornerRadius = NodeProperty(provider: KeyframeInterpolator(keyframes: rectangle.cornerRadius.keyframes))
- 
-    self.keypathProperties =  [
+    keypathName = rectangle.name
+    direction = rectangle.direction
+    position = NodeProperty(provider: KeyframeInterpolator(keyframes: rectangle.position.keyframes))
+    size = NodeProperty(provider: KeyframeInterpolator(keyframes: rectangle.size.keyframes))
+    cornerRadius = NodeProperty(provider: KeyframeInterpolator(keyframes: rectangle.cornerRadius.keyframes))
+
+    keypathProperties = [
       "Position" : position,
       "Size" : size,
-      "Roundness" : cornerRadius
+      "Roundness" : cornerRadius,
     ]
-    
-    self.properties = Array(keypathProperties.values)
+
+    properties = Array(keypathProperties.values)
   }
-  
-  let keypathProperties: [String : AnyNodeProperty]
+
+  // MARK: Internal
+
+  var keypathName: String
+
+  let keypathProperties: [String: AnyNodeProperty]
   let properties: [AnyNodeProperty]
-  
+
   let direction: PathDirection
   let position: NodeProperty<Vector3D>
   let size: NodeProperty<Vector3D>
   let cornerRadius: NodeProperty<Vector1D>
-  
+
 }
 
+// MARK: - RectangleNode
+
 final class RectangleNode: AnimatorNode, PathNode {
-  
-  let properties: RectNodeProperties
-  
-  let pathOutput: PathOutputNode
-  
+
+  // MARK: Lifecycle
+
   init(parentNode: AnimatorNode?, rectangle: Rectangle) {
-    self.properties = RectNodeProperties(rectangle: rectangle)
-    self.pathOutput = PathOutputNode(parent: parentNode?.outputNode)
+    properties = RectNodeProperties(rectangle: rectangle)
+    pathOutput = PathOutputNode(parent: parentNode?.outputNode)
     self.parentNode = parentNode
   }
 
+  // MARK: Internal
+
+  let properties: RectNodeProperties
+
+  let pathOutput: PathOutputNode
+  let parentNode: AnimatorNode?
+  var hasLocalUpdates = false
+  var hasUpstreamUpdates = false
+  var lastUpdateFrame: CGFloat? = nil
+
   // MARK: Animator Node
-  
+
   var propertyMap: NodePropertyMap & KeypathSearchable {
-    return properties
+    properties
   }
 
-  let parentNode: AnimatorNode?
-  var hasLocalUpdates: Bool = false
-  var hasUpstreamUpdates: Bool = false
-  var lastUpdateFrame: CGFloat? = nil
-  var isEnabled: Bool = true {
-    didSet{
-      self.pathOutput.isEnabled = self.isEnabled
+  var isEnabled = true {
+    didSet {
+      pathOutput.isEnabled = isEnabled
     }
   }
-  
+
   func rebuildOutputs(frame: CGFloat) {
-    
-    let size = properties.size.value.sizeValue * 0.5
-    let radius = min(min(properties.cornerRadius.value.cgFloatValue, size.width) , size.height)
-    let position = properties.position.value.pointValue
+    pathOutput.setPath(
+      .rectangle(
+        position: properties.position.value.pointValue,
+        size: properties.size.value.sizeValue,
+        cornerRadius: properties.cornerRadius.value.cgFloatValue,
+        direction: properties.direction),
+      updateFrame: frame)
+  }
+
+}
+
+// MARK: - BezierPath + rectangle
+
+extension BezierPath {
+  /// Constructs a `BezierPath` in the shape of a rectangle, optionally with rounded corners
+  static func rectangle(
+    position: CGPoint,
+    size inputSize: CGSize,
+    cornerRadius: CGFloat,
+    direction: PathDirection)
+    -> BezierPath
+  {
+    let size = inputSize * 0.5
+    let radius = min(min(cornerRadius, size.width) , size.height)
+
     var bezierPath = BezierPath()
     let points: [CurveVertex]
-    
+
     if radius <= 0 {
       /// No Corners
       points = [
         /// Lead In
-        CurveVertex(point: CGPoint(x: size.width, y: -size.height),
-                    inTangentRelative: .zero,
-                    outTangentRelative: .zero)
+        CurveVertex(
+          point: CGPoint(x: size.width, y: -size.height),
+          inTangentRelative: .zero,
+          outTangentRelative: .zero)
           .translated(position),
         /// Corner 1
-        CurveVertex(point: CGPoint(x: size.width, y: size.height),
-                    inTangentRelative: .zero,
-                    outTangentRelative: .zero)
+        CurveVertex(
+          point: CGPoint(x: size.width, y: size.height),
+          inTangentRelative: .zero,
+          outTangentRelative: .zero)
           .translated(position),
         /// Corner 2
-        CurveVertex(point: CGPoint(x: -size.width, y: size.height),
-                    inTangentRelative: .zero,
-                    outTangentRelative: .zero)
+        CurveVertex(
+          point: CGPoint(x: -size.width, y: size.height),
+          inTangentRelative: .zero,
+          outTangentRelative: .zero)
           .translated(position),
         /// Corner 3
-        CurveVertex(point: CGPoint(x: -size.width, y: -size.height),
-                    inTangentRelative: .zero,
-                    outTangentRelative: .zero)
+        CurveVertex(
+          point: CGPoint(x: -size.width, y: -size.height),
+          inTangentRelative: .zero,
+          outTangentRelative: .zero)
           .translated(position),
         /// Corner 4
-        CurveVertex(point: CGPoint(x: size.width, y: -size.height),
-                    inTangentRelative: .zero,
-                    outTangentRelative: .zero)
+        CurveVertex(
+          point: CGPoint(x: size.width, y: -size.height),
+          inTangentRelative: .zero,
+          outTangentRelative: .zero)
           .translated(position),
       ]
     } else {
@@ -176,13 +214,12 @@ final class RectangleNode: AnimatorNode, PathNode {
           .translated(position),
       ]
     }
-    let reversed = properties.direction == .counterClockwise
+    let reversed = direction == .counterClockwise
     let pathPoints = reversed ? points.reversed() : points
     for point in pathPoints {
       bezierPath.addVertex(reversed ? point.reversed() : point)
     }
     bezierPath.close()
-    pathOutput.setPath(bezierPath, updateFrame: frame)
+    return bezierPath
   }
-  
 }

package/{lottie-swift/src/Private → Sources/Private/MainThread}/NodeRenderSystem/Nodes/PathNodes/ShapeNode.swift

@@ -5,57 +5,70 @@
 //  Created by Brandon Withrow on 1/16/19.
 //
 
-import Foundation
 import CoreGraphics
+import Foundation
+
+// MARK: - ShapeNodeProperties
 
 final class ShapeNodeProperties: NodePropertyMap, KeypathSearchable {
-  
-  var keypathName: String
-  
+
+  // MARK: Lifecycle
+
   init(shape: Shape) {
-    self.keypathName = shape.name
-    self.path = NodeProperty(provider: KeyframeInterpolator(keyframes: shape.path.keyframes))
-    self.keypathProperties = [
-      "Path" : path
+    keypathName = shape.name
+    path = NodeProperty(provider: KeyframeInterpolator(keyframes: shape.path.keyframes))
+    keypathProperties = [
+      "Path" : path,
     ]
-    self.properties = Array(keypathProperties.values)
+    properties = Array(keypathProperties.values)
   }
-  
+
+  // MARK: Internal
+
+  var keypathName: String
+
   let path: NodeProperty<BezierPath>
-  let keypathProperties: [String : AnyNodeProperty]
+  let keypathProperties: [String: AnyNodeProperty]
   let properties: [AnyNodeProperty]
-  
+
 }
 
+// MARK: - ShapeNode
+
 final class ShapeNode: AnimatorNode, PathNode {
-  
-  let properties: ShapeNodeProperties
 
-  let pathOutput: PathOutputNode
-  
+  // MARK: Lifecycle
+
   init(parentNode: AnimatorNode?, shape: Shape) {
-    self.pathOutput = PathOutputNode(parent: parentNode?.outputNode)
-    self.properties = ShapeNodeProperties(shape: shape)
+    pathOutput = PathOutputNode(parent: parentNode?.outputNode)
+    properties = ShapeNodeProperties(shape: shape)
     self.parentNode = parentNode
   }
 
+  // MARK: Internal
+
+  let properties: ShapeNodeProperties
+
+  let pathOutput: PathOutputNode
+
+  let parentNode: AnimatorNode?
+  var hasLocalUpdates = false
+  var hasUpstreamUpdates = false
+  var lastUpdateFrame: CGFloat? = nil
+
   // MARK: Animator Node
   var propertyMap: NodePropertyMap & KeypathSearchable {
-    return properties
+    properties
   }
-  
-  let parentNode: AnimatorNode?
-  var hasLocalUpdates: Bool = false
-  var hasUpstreamUpdates: Bool = false
-  var lastUpdateFrame: CGFloat? = nil
-  var isEnabled: Bool = true {
-    didSet{
-      self.pathOutput.isEnabled = self.isEnabled
+
+  var isEnabled = true {
+    didSet {
+      pathOutput.isEnabled = isEnabled
     }
   }
-  
+
   func rebuildOutputs(frame: CGFloat) {
     pathOutput.setPath(properties.path.value, updateFrame: frame)
   }
-  
+
 }