Last active
April 5, 2025 06:46
-
-
Save tcldr/204c4bc87c5239a53239a46728214715 to your computer and use it in GitHub Desktop.
For when you need the progress along an Apple Animation curve outside of CoreAnimation in a Swift 4.2 interface. Given a cubic Bezier timing curve defined by two control points, (or UIKit's `UICubicTimingParameters`), returns the progress along the curve at any given time. Includes a port of the WebKit implementation of UnitBezier which hopefull…
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// | |
// TimingFunction.swift | |
// | |
// Created by tcldr on 04/11/2018. | |
// https://github.com/tcldr | |
// Copyright © 2018 tcldr. | |
// | |
// Permission is hereby granted, free of charge, | |
// to any person obtaining a copy of this software and | |
// associated documentation files (the "Software"), to | |
// deal in the Software without restriction, including | |
// without limitation the rights to use, copy, modify, | |
// merge, publish, distribute, sublicense, and/or sell | |
// copies of the Software, and to permit persons to whom | |
// the Software is furnished to do so, | |
// subject to the following conditions: | |
// | |
// The above copyright notice and this permission notice | |
// shall be included in all copies or substantial portions of the Software. | |
// | |
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | |
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | |
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | |
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR | |
// ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, | |
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE | |
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |
// | |
/// A cubic Bézier timing curve consists of a line whose starting point is (0, 0), | |
/// whose end point is (1, 1), and whose shape is defined by two control points. | |
/// The slope of the line at each point in time defines the speed of progress | |
/// at that time. | |
/// | |
/// Usage: | |
/// ``` | |
/// | |
/// let params = UICubicTimingParameters(animationCurve: .easeIn) | |
/// let tf = TimingFunction(timingParameters: params) | |
/// tf.progress(at: 0.00) // returns 0.0 | |
/// tf.progress(at: 0.25) // returns ~0.093 | |
/// tf.progress(at: 0.50) // returns ~0.315 | |
/// tf.progress(at: 0.75) // returns ~0.621 | |
/// tf.progress(at: 1.00) // returns 1.0 | |
/// | |
/// ``` | |
public struct TimingFunction { | |
// MARK: - Properties | |
var controlPoint1: CGPoint { | |
didSet { updateUnitBezier() } | |
} | |
var controlPoint2: CGPoint { | |
didSet { updateUnitBezier() } | |
} | |
var duration: CGFloat { | |
didSet { updateEpsilon() } | |
} | |
// MARK: - Private Properties | |
private var unitBezier: UnitBezier | |
private var epsilon: CGFloat | |
// MARK: - Initialiser | |
public init(controlPoint1: CGPoint, controlPoint2: CGPoint, duration: CGFloat = 1.0) { | |
self.controlPoint1 = controlPoint1 | |
self.controlPoint2 = controlPoint2 | |
self.duration = duration | |
self.unitBezier = .init(controlPoint1: controlPoint1, controlPoint2: controlPoint2) | |
self.epsilon = TimingFunction.epsilon(for: duration) | |
} | |
// MARK: - Public API | |
/// Returns the progress along the timing function for the given time (`fractionComplete`) | |
/// with `0.0` equal to the start of the curve, and `1.0` equal to the end of the curve | |
func progress(at fractionComplete: CGFloat) -> CGFloat { | |
return unitBezier.value(for: fractionComplete, epsilon: epsilon) | |
} | |
// MARK: - Private helpers | |
mutating private func updateUnitBezier() { | |
unitBezier = UnitBezier(controlPoint1: controlPoint1, controlPoint2: controlPoint2) | |
} | |
mutating private func updateEpsilon() { | |
epsilon = TimingFunction.epsilon(for: duration) | |
} | |
} | |
// MARK: - Static methods | |
private extension TimingFunction { | |
static func epsilon(for duration: CGFloat) -> CGFloat { | |
return CGFloat(1.0 / (200.0 * duration)) | |
} | |
} | |
// MARK: - Platform specific extensions | |
#if canImport(UIKit) | |
import UIKit | |
public extension TimingFunction { | |
init(timingParameters: UICubicTimingParameters, duration: CGFloat = 1.0) { | |
self.init( | |
controlPoint1: timingParameters.controlPoint1, | |
controlPoint2: timingParameters.controlPoint2, | |
duration: duration | |
) | |
} | |
} | |
#endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/* | |
* Copyright (C) 2008 Apple Inc. All Rights Reserved. | |
* | |
* Redistribution and use in source and binary forms, with or without | |
* modification, are permitted provided that the following conditions | |
* are met: | |
* 1. Redistributions of source code must retain the above copyright | |
* notice, this list of conditions and the following disclaimer. | |
* 2. Redistributions in binary form must reproduce the above copyright | |
* notice, this list of conditions and the following disclaimer in the | |
* documentation and/or other materials provided with the distribution. | |
* | |
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY | |
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | |
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR | |
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | |
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | |
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY | |
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
*/ | |
// | |
// UnitBezier.swift | |
// | |
// Created by tcldr on 04/11/2018. | |
// https://github.com/tcldr | |
// | |
// Ported from Apple's WebKit code base: | |
// http://svn.webkit.org/repository/webkit/trunk/Source/WebCore/platform/graphics/UnitBezier.h | |
// | |
import CoreGraphics | |
public struct UnitBezier { | |
// MARK: - Properties | |
private let ax: CGFloat | |
private let bx: CGFloat | |
private let cx: CGFloat | |
private let ay: CGFloat | |
private let by: CGFloat | |
private let cy: CGFloat | |
// MARK: - Initialiser | |
public init(controlPoint1: CGPoint, controlPoint2: CGPoint) { | |
// Calculate the polynomial coefficients, implicit first | |
// and last control points are (0,0) and (1,1). | |
cx = 3.0 * controlPoint1.x | |
bx = 3.0 * (controlPoint2.x - controlPoint1.x) - cx | |
ax = 1.0 - cx - bx | |
cy = 3.0 * controlPoint1.y | |
by = 3.0 * (controlPoint2.y - controlPoint1.y) - cy | |
ay = 1.0 - cy - by | |
} | |
// MARK: - Methods | |
func value(for x: CGFloat, epsilon: CGFloat) -> CGFloat { | |
return sampleCurveY(solveCurveX(x, epsilon: epsilon)) | |
} | |
func sampleCurveX(_ t: CGFloat) -> CGFloat { | |
// `ax t^3 + bx t^2 + cx t' expanded using Horner's rule. | |
return ((ax * t + bx) * t + cx) * t | |
} | |
func sampleCurveY(_ t: CGFloat) -> CGFloat { | |
return ((ay * t + by) * t + cy) * t | |
} | |
func sampleCurveDerivativeX(_ t: CGFloat) -> CGFloat { | |
return (3.0 * ax * t + 2.0 * bx) * t + cx | |
} | |
// Given an x value, find a parametric value it came from. | |
func solveCurveX(_ x: CGFloat, epsilon: CGFloat) -> CGFloat { | |
var t0, t1, t2, x2, d2: CGFloat | |
// First try a few iterations of Newton's method -- normally very fast. | |
t2 = x | |
for _ in (0..<8) { | |
x2 = sampleCurveX(t2) - x | |
guard abs(x2) >= epsilon else { return t2 } | |
d2 = sampleCurveDerivativeX(t2) | |
guard abs(d2) >= 1e-6 else { break } | |
t2 = t2 - x2 / d2 | |
} | |
// Fall back to the bisection method for reliability. | |
t0 = 0.0 | |
t1 = 1.0 | |
t2 = x | |
guard t2 >= t0 else { return t0 } | |
guard t2 <= t1 else { return t1 } | |
while t0 < t1 { | |
x2 = sampleCurveX(t2) | |
guard abs(x2 - x) >= epsilon else { return t2 } | |
if x > x2 { | |
t0 = t2 | |
} else { | |
t1 = t2 | |
} | |
t2 = (t1 - t0) * 0.5 + t0 | |
} | |
// Failure | |
return t2 | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Thanks for sharing this! I made an extension for those using Core Animation's
CAMediaTimingFunction
: