LOTValueDelegate.h
10.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
//
// LOTValueDelegate.h
// Lottie
//
// Created by brandon_withrow on 1/5/18.
// Copyright © 2018 Airbnb. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <CoreGraphics/CoreGraphics.h>
/*!
@brief LOTValueDelegate is not intended to be used directly. It is used for type safety.
@discussion LOTValueDelegates are used to dynamically change animation data at runtime. A delegate is set for a keypath, defined by LOTKeypath. While the animation is running the delegate is asked for the value for the keypath at each frame of the animation. The delegate is given the computed animation value for the the current frame. See LOTKeypath and the setValueDelegate:forKeypath method on LOTAnimationView.
Prebuild delegates can be found in LOTBlockCallback, LOTInterpolatorCallback, and LOTValueCallback. These delegates allow direct setting and driving of an animated value.
See LOTColorValueDelegate, LOTNumberValueDelegate, LOTPointValueDelegate, LOTSizeValueDelegate, LOTPathValueDelegate.
*/
@protocol LOTValueDelegate <NSObject>
@end
@protocol LOTColorValueDelegate <LOTValueDelegate>
@required
/*!
@brief LOTColorValueDelegate is called at runtime to override the color value of a property in a LOTAnimation. The property is defined by at LOTKeypath. The delegate is set via setValueDelegate:forKeypath on LOTAnimationView.
@discussion LOTValueDelegates are used to dynamically change animation data at runtime. A delegate is set for a keypath, defined by LOTKeypath. While the animation is running the delegate is asked for the value for the keypath at each frame of the animation. The delegate is given the computed animation value for the the current frame. See LOTKeypath and the setValueDelegate:forKeypath method on LOTAnimationView.
@param currentFrame The current frame of the animation in the parent compositions time space.
@param startKeyframe When the block is called, startFrame is the most recent keyframe for the keypath in relation to the current time.
@param endKeyframe When the block is called, endFrame is the next keyframe for the keypath in relation to the current time.
@param interpolatedProgress A value from 0-1 that represents the current progress between keyframes. It respects the keyframes current easing curves.
@param startColor The color from the previous keyframe in relation to the current time.
@param endColor The color from the next keyframe in relation to the current time.
@param interpolatedColor The color interpolated at the current time between startColor and endColor. This represents the keypaths current color for the current time.
@return CGColorRef the color to set the keypath node for the current frame
*/
- (CGColorRef)colorForFrame:(CGFloat)currentFrame
startKeyframe:(CGFloat)startKeyframe
endKeyframe:(CGFloat)endKeyframe
interpolatedProgress:(CGFloat)interpolatedProgress
startColor:(CGColorRef)startColor
endColor:(CGColorRef)endColor
currentColor:(CGColorRef)interpolatedColor;
@end
@protocol LOTNumberValueDelegate <LOTValueDelegate>
@required
/*!
@brief LOTNumberValueDelegate is called at runtime to override the number value of a property in a LOTAnimation. The property is defined by at LOTKeypath. The delegate is set via setValueDelegate:forKeypath on LOTAnimationView.
@discussion LOTValueDelegates are used to dynamically change animation data at runtime. A delegate is set for a keypath, defined by LOTKeypath. While the animation is running the delegate is asked for the value for the keypath at each frame of the animation. The delegate is given the computed animation value for the the current frame. See LOTKeypath and the setValueDelegate:forKeypath method on LOTAnimationView.
@param currentFrame The current frame of the animation in the parent compositions time space.
@param startKeyframe When the block is called, startFrame is the most recent keyframe for the keypath in relation to the current time.
@param endKeyframe When the block is called, endFrame is the next keyframe for the keypath in relation to the current time.
@param interpolatedProgress A value from 0-1 that represents the current progress between keyframes. It respects the keyframes current easing curves.
@param startValue The number from the previous keyframe in relation to the current time.
@param endValue The number from the next keyframe in relation to the current time.
@param interpolatedValue The number interpolated at the current time between startNumber and endNumber. This represents the keypaths current number for the current time.
@return CGFloat the number to set the keypath node for the current frame
*/
- (CGFloat)floatValueForFrame:(CGFloat)currentFrame
startKeyframe:(CGFloat)startKeyframe
endKeyframe:(CGFloat)endKeyframe
interpolatedProgress:(CGFloat)interpolatedProgress
startValue:(CGFloat)startValue
endValue:(CGFloat)endValue
currentValue:(CGFloat)interpolatedValue;
@end
@protocol LOTPointValueDelegate <LOTValueDelegate>
@required
/*!
@brief LOTPointValueDelegate is called at runtime to override the point value of a property in a LOTAnimation. The property is defined by at LOTKeypath. The delegate is set via setValueDelegate:forKeypath on LOTAnimationView.
@discussion LOTValueDelegates are used to dynamically change animation data at runtime. A delegate is set for a keypath, defined by LOTKeypath. While the animation is running the delegate is asked for the value for the keypath at each frame of the animation. The delegate is given the computed animation value for the the current frame. See LOTKeypath and the setValueDelegate:forKeypath method on LOTAnimationView.
@param currentFrame The current frame of the animation in the parent compositions time space.
@param startKeyframe When the block is called, startFrame is the most recent keyframe for the keypath in relation to the current time.
@param endKeyframe When the block is called, endFrame is the next keyframe for the keypath in relation to the current time.
@param interpolatedProgress A value from 0-1 that represents the current progress between keyframes. It respects the keyframes current easing curves.
@param startPoint The point from the previous keyframe in relation to the current time.
@param endPoint The point from the next keyframe in relation to the current time.
@param interpolatedPoint The point interpolated at the current time between startPoint and endPoint. This represents the keypaths current point for the current time.
@return CGPoint the point to set the keypath node for the current frame
*/
- (CGPoint)pointForFrame:(CGFloat)currentFrame
startKeyframe:(CGFloat)startKeyframe
endKeyframe:(CGFloat)endKeyframe
interpolatedProgress:(CGFloat)interpolatedProgress
startPoint:(CGPoint)startPoint
endPoint:(CGPoint)endPoint
currentPoint:(CGPoint)interpolatedPoint;
@end
@protocol LOTSizeValueDelegate <LOTValueDelegate>
@required
/*!
@brief LOTSizeValueDelegate is called at runtime to override the size value of a property in a LOTAnimation. The property is defined by at LOTKeypath. The delegate is set via setValueDelegate:forKeypath on LOTAnimationView.
@discussion LOTValueDelegates are used to dynamically change animation data at runtime. A delegate is set for a keypath, defined by LOTKeypath. While the animation is running the delegate is asked for the value for the keypath at each frame of the animation. The delegate is given the computed animation value for the the current frame. See LOTKeypath and the setValueDelegate:forKeypath method on LOTAnimationView.
@param currentFrame The current frame of the animation in the parent compositions time space.
@param startKeyframe When the block is called, startFrame is the most recent keyframe for the keypath in relation to the current time.
@param endKeyframe When the block is called, endFrame is the next keyframe for the keypath in relation to the current time.
@param interpolatedProgress A value from 0-1 that represents the current progress between keyframes. It respects the keyframes current easing curves.
@param startSize The size from the previous keyframe in relation to the current time.
@param endSize The size from the next keyframe in relation to the current time.
@param interpolatedSize The size interpolated at the current time between startSize and endSize. This represents the keypaths current size for the current time.
@return CGSize the size to set the keypath node for the current frame
*/
- (CGSize)sizeForFrame:(CGFloat)currentFrame
startKeyframe:(CGFloat)startKeyframe
endKeyframe:(CGFloat)endKeyframe
interpolatedProgress:(CGFloat)interpolatedProgress
startSize:(CGSize)startSize
endSize:(CGSize)endSize
currentSize:(CGSize)interpolatedSize;
@end
@protocol LOTPathValueDelegate <LOTValueDelegate>
@required
/*!
@brief LOTPathValueDelegate is called at runtime to override the path value of a property in a LOTAnimation. The property is defined by at LOTKeypath. The delegate is set via setValueDelegate:forKeypath on LOTAnimationView.
@discussion LOTValueDelegates are used to dynamically change animation data at runtime. A delegate is set for a keypath, defined by LOTKeypath. While the animation is running the delegate is asked for the value for the keypath at each frame of the animation. The delegate is given the computed animation value for the the current frame. See LOTKeypath and the setValueDelegate:forKeypath method on LOTAnimationView.
@param currentFrame The current frame of the animation in the parent compositions time space.
@param startKeyframe When the block is called, startFrame is the most recent keyframe for the keypath in relation to the current time.
@param endKeyframe When the block is called, endFrame is the next keyframe for the keypath in relation to the current time.
@param interpolatedProgress A value from 0-1 that represents the current progress between keyframes. It respects the keyframes current easing curves.
@return CGPathRef the path to set the keypath node for the current frame
*/
- (CGPathRef)pathForFrame:(CGFloat)currentFrame
startKeyframe:(CGFloat)startKeyframe
endKeyframe:(CGFloat)endKeyframe
interpolatedProgress:(CGFloat)interpolatedProgress;
@end