added iOS source code
[wl-app.git] / iOS / Pods / Kingfisher / Sources / ImageTransition.swift
1 //
2 //  ImageTransition.swift
3 //  Kingfisher
4 //
5 //  Created by Wei Wang on 15/9/18.
6 //
7 //  Copyright (c) 2018 Wei Wang <onevcat@gmail.com>
8 //
9 //  Permission is hereby granted, free of charge, to any person obtaining a copy
10 //  of this software and associated documentation files (the "Software"), to deal
11 //  in the Software without restriction, including without limitation the rights
12 //  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 //  copies of the Software, and to permit persons to whom the Software is
14 //  furnished to do so, subject to the following conditions:
15 //
16 //  The above copyright notice and this permission notice shall be included in
17 //  all copies or substantial portions of the Software.
18 //
19 //  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 //  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 //  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 //  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 //  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 //  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 //  THE SOFTWARE.
26
27 #if os(macOS)
28 // Not implemented for macOS and watchOS yet.
29     
30 import AppKit
31
32 /// Image transition is not supported on macOS.
33 public enum ImageTransition {
34     case none
35     var duration: TimeInterval {
36         return 0
37     }
38 }
39
40 #elseif os(watchOS)
41 import UIKit
42 /// Image transition is not supported on watchOS.
43 public enum ImageTransition {
44     case none
45     var duration: TimeInterval {
46         return 0
47     }
48 }
49 #else
50 import UIKit
51
52 /**
53 Transition effect which will be used when an image downloaded and set by `UIImageView` extension API in Kingfisher.
54 You can assign an enum value with transition duration as an item in `KingfisherOptionsInfo` 
55 to enable the animation transition.
56
57 Apple's UIViewAnimationOptions is used under the hood.
58 For custom transition, you should specified your own transition options, animations and 
59 comletion handler as well.
60 */
61 public enum ImageTransition {
62     ///  No animation transistion.
63     case none
64     
65     /// Fade in the loaded image.
66     case fade(TimeInterval)
67
68     /// Flip from left transition.
69     case flipFromLeft(TimeInterval)
70
71     /// Flip from right transition.
72     case flipFromRight(TimeInterval)
73     
74     /// Flip from top transition.
75     case flipFromTop(TimeInterval)
76     
77     /// Flip from bottom transition.
78     case flipFromBottom(TimeInterval)
79     
80     /// Custom transition.
81     case custom(duration: TimeInterval,
82                  options: UIViewAnimationOptions,
83               animations: ((UIImageView, UIImage) -> Void)?,
84               completion: ((Bool) -> Void)?)
85     
86     var duration: TimeInterval {
87         switch self {
88         case .none:                          return 0
89         case .fade(let duration):            return duration
90             
91         case .flipFromLeft(let duration):    return duration
92         case .flipFromRight(let duration):   return duration
93         case .flipFromTop(let duration):     return duration
94         case .flipFromBottom(let duration):  return duration
95             
96         case .custom(let duration, _, _, _): return duration
97         }
98     }
99     
100     var animationOptions: UIViewAnimationOptions {
101         switch self {
102         case .none:                         return []
103         case .fade(_):                      return .transitionCrossDissolve
104             
105         case .flipFromLeft(_):              return .transitionFlipFromLeft
106         case .flipFromRight(_):             return .transitionFlipFromRight
107         case .flipFromTop(_):               return .transitionFlipFromTop
108         case .flipFromBottom(_):            return .transitionFlipFromBottom
109             
110         case .custom(_, let options, _, _): return options
111         }
112     }
113     
114     var animations: ((UIImageView, UIImage) -> Void)? {
115         switch self {
116         case .custom(_, _, let animations, _): return animations
117         default: return { $0.image = $1 }
118         }
119     }
120     
121     var completion: ((Bool) -> Void)? {
122         switch self {
123         case .custom(_, _, _, let completion): return completion
124         default: return nil
125         }
126     }
127 }
128 #endif