Wallpaper_Home/wallpaper_project/Pods/lottie-ios/Sources/Public/Animation/LottieAnimationViewInitializers.swift
2024-04-17 14:37:20 +08:00

223 lines
9.4 KiB
Swift

//
// AnimationViewInitializers.swift
// lottie-swift-iOS
//
// Created by Brandon Withrow on 2/6/19.
//
import Foundation
extension LottieAnimationView {
// MARK: Lifecycle
/// Loads a Lottie animation from a JSON file in the supplied bundle.
///
/// - Parameter name: The string name of the lottie animation with no file extension provided.
/// - Parameter bundle: The bundle in which the animation is located. Defaults to the Main bundle.
/// - Parameter subdirectory: A subdirectory in the bundle in which the animation is located. Optional.
/// - Parameter imageProvider: An image provider for the animation's image data.
/// If none is supplied Lottie will search in the supplied bundle for images.
public convenience init(
name: String,
bundle: Bundle = Bundle.main,
subdirectory: String? = nil,
imageProvider: AnimationImageProvider? = nil,
animationCache: AnimationCacheProvider? = LottieAnimationCache.shared,
configuration: LottieConfiguration = .shared)
{
let animation = LottieAnimation.named(name, bundle: bundle, subdirectory: subdirectory, animationCache: animationCache)
let provider = imageProvider ?? BundleImageProvider(bundle: bundle, searchPath: nil)
self.init(animation: animation, imageProvider: provider, configuration: configuration)
}
/// Loads a Lottie animation from a JSON file in a specific path on disk.
///
/// - Parameter name: The absolute path of the Lottie Animation.
/// - Parameter imageProvider: An image provider for the animation's image data.
/// If none is supplied Lottie will search in the supplied filepath for images.
public convenience init(
filePath: String,
imageProvider: AnimationImageProvider? = nil,
animationCache: AnimationCacheProvider? = LottieAnimationCache.shared,
configuration: LottieConfiguration = .shared)
{
let animation = LottieAnimation.filepath(filePath, animationCache: animationCache)
let provider = imageProvider ??
FilepathImageProvider(filepath: URL(fileURLWithPath: filePath).deletingLastPathComponent().path)
self.init(animation: animation, imageProvider: provider, configuration: configuration)
}
/// Loads a Lottie animation asynchronously from the URL
///
/// - Parameter url: The url to load the animation from.
/// - Parameter imageProvider: An image provider for the animation's image data.
/// If none is supplied Lottie will search in the main bundle for images.
/// - Parameter closure: A closure to be called when the animation has loaded.
public convenience init(
url: URL,
imageProvider: AnimationImageProvider? = nil,
session: URLSession = .shared,
closure: @escaping LottieAnimationView.DownloadClosure,
animationCache: AnimationCacheProvider? = LottieAnimationCache.shared,
configuration: LottieConfiguration = .shared)
{
if let animationCache, let animation = animationCache.animation(forKey: url.absoluteString) {
self.init(animation: animation, imageProvider: imageProvider, configuration: configuration)
closure(nil)
} else {
self.init(animation: nil, imageProvider: imageProvider, configuration: configuration)
LottieAnimation.loadedFrom(url: url, session: session, closure: { animation in
if let animation {
self.animation = animation
closure(nil)
} else {
closure(LottieDownloadError.downloadFailed)
}
}, animationCache: animationCache)
}
}
/// Loads a Lottie animation from a JSON file located in the Asset catalog of the supplied bundle.
/// - Parameter name: The string name of the lottie animation in the asset catalog.
/// - Parameter bundle: The bundle in which the animation is located.
/// Defaults to the Main bundle.
/// - Parameter imageProvider: An image provider for the animation's image data.
/// If none is supplied Lottie will search in the supplied bundle for images.
public convenience init(
asset name: String,
bundle: Bundle = Bundle.main,
imageProvider: AnimationImageProvider? = nil,
animationCache: AnimationCacheProvider? = LottieAnimationCache.shared,
configuration: LottieConfiguration = .shared)
{
let animation = LottieAnimation.asset(name, bundle: bundle, animationCache: animationCache)
let provider = imageProvider ?? BundleImageProvider(bundle: bundle, searchPath: nil)
self.init(animation: animation, imageProvider: provider, configuration: configuration)
}
// MARK: DotLottie
/// Loads a Lottie animation from a .lottie file in the supplied bundle.
///
/// - Parameter dotLottieName: The name of the lottie file without the lottie extension. EG "StarAnimation"
/// - Parameter bundle: The bundle in which the lottie is located. Defaults to `Bundle.main`
/// - Parameter subdirectory: A subdirectory in the bundle in which the lottie is located. Optional.
/// - Parameter animationId: Animation id to play. Optional
/// - Parameter completion: A closure that is called when the .lottie file is finished loading
/// Defaults to first animation in file
public convenience init(
dotLottieName name: String,
bundle: Bundle = Bundle.main,
subdirectory: String? = nil,
animationId: String? = nil,
dotLottieCache: DotLottieCacheProvider? = DotLottieCache.sharedCache,
configuration: LottieConfiguration = .shared,
completion: ((LottieAnimationView, Error?) -> Void)? = nil)
{
self.init(dotLottie: nil, animationId: animationId, configuration: configuration)
DotLottieFile.named(name, bundle: bundle, subdirectory: subdirectory, dotLottieCache: dotLottieCache) { result in
switch result {
case .success(let dotLottieFile):
self.loadAnimation(animationId, from: dotLottieFile)
completion?(self, nil)
case .failure(let error):
completion?(self, error)
}
}
}
/// Loads a Lottie from a .lottie file in a specific path on disk.
///
/// - Parameter dotLottieFilePath: The absolute path of the Lottie file.
/// - Parameter animationId: Animation id to play. Optional
/// - Parameter completion: A closure that is called when the .lottie file is finished loading
/// Defaults to first animation in file
public convenience init(
dotLottieFilePath filePath: String,
animationId: String? = nil,
dotLottieCache: DotLottieCacheProvider? = DotLottieCache.sharedCache,
configuration: LottieConfiguration = .shared,
completion: ((LottieAnimationView, Error?) -> Void)? = nil)
{
self.init(dotLottie: nil, animationId: animationId, configuration: configuration)
DotLottieFile.loadedFrom(filepath: filePath, dotLottieCache: dotLottieCache) { result in
switch result {
case .success(let dotLottieFile):
self.loadAnimation(animationId, from: dotLottieFile)
completion?(self, nil)
case .failure(let error):
completion?(self, error)
}
}
}
/// Loads a Lottie file asynchronously from the URL
///
/// - Parameter dotLottieUrl: The url to load the lottie file from.
/// - Parameter animationId: Animation id to play. Optional. Defaults to first animation in file.
/// - Parameter completion: A closure to be called when the animation has loaded.
public convenience init(
dotLottieUrl url: URL,
animationId: String? = nil,
dotLottieCache: DotLottieCacheProvider? = DotLottieCache.sharedCache,
configuration: LottieConfiguration = .shared,
session: URLSession = .shared,
completion: ((LottieAnimationView, Error?) -> Void)? = nil)
{
if let dotLottieCache, let lottie = dotLottieCache.file(forKey: url.absoluteString) {
self.init(dotLottie: lottie, animationId: animationId, configuration: configuration)
completion?(self, nil)
} else {
self.init(dotLottie: nil, configuration: configuration)
DotLottieFile.loadedFrom(url: url, session: session, dotLottieCache: dotLottieCache) { result in
switch result {
case .success(let lottie):
self.loadAnimation(animationId, from: lottie)
completion?(self, nil)
case .failure(let error):
completion?(self, error)
}
}
}
}
/// Loads a Lottie from a .lottie file located in the Asset catalog of the supplied bundle.
/// - Parameter name: The string name of the lottie file in the asset catalog.
/// - Parameter bundle: The bundle in which the file is located. Defaults to the Main bundle.
/// - Parameter animationId: Animation id to play. Optional
/// - Parameter completion: A closure that is called when the .lottie file is finished loading
/// Defaults to first animation in file
public convenience init(
dotLottieAsset name: String,
bundle: Bundle = Bundle.main,
animationId: String? = nil,
dotLottieCache: DotLottieCacheProvider? = DotLottieCache.sharedCache,
configuration: LottieConfiguration = .shared,
completion: ((LottieAnimationView, Error?) -> Void)? = nil)
{
self.init(dotLottie: nil, animationId: animationId, configuration: configuration)
DotLottieFile.asset(named: name, bundle: bundle, dotLottieCache: dotLottieCache) { result in
switch result {
case .success(let dotLottieFile):
self.loadAnimation(animationId, from: dotLottieFile)
completion?(self, nil)
case .failure(let error):
completion?(self, error)
}
}
}
// MARK: Public
public typealias DownloadClosure = (Error?) -> Void
}
// MARK: - LottieDownloadError
enum LottieDownloadError: Error {
case downloadFailed
}