-
Notifications
You must be signed in to change notification settings - Fork 598
Expand file tree
/
Copy pathCPTAnimation.m
More file actions
652 lines (513 loc) · 22.8 KB
/
CPTAnimation.m
File metadata and controls
652 lines (513 loc) · 22.8 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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
#import "CPTAnimation.h"
#import "_CPTAnimationTimingFunctions.h"
#import "CPTAnimationOperation.h"
#import "CPTAnimationPeriod.h"
#import "CPTDefinitions.h"
#import "CPTPlotRange.h"
static const CGFloat kCPTAnimationFrameRate = CPTFloat(1.0 / 60.0); // 60 frames per second
static NSString *const CPTAnimationOperationKey = @"CPTAnimationOperationKey";
static NSString *const CPTAnimationValueKey = @"CPTAnimationValueKey";
static NSString *const CPTAnimationValueClassKey = @"CPTAnimationValueClassKey";
static NSString *const CPTAnimationStartedKey = @"CPTAnimationStartedKey";
static NSString *const CPTAnimationFinishedKey = @"CPTAnimationFinishedKey";
/// @cond
typedef NSMutableArray<CPTAnimationOperation *> CPTMutableAnimationArray;
@interface CPTAnimation()
@property (nonatomic, readwrite, assign) CGFloat timeOffset;
@property (nonatomic, readwrite, strong, nonnull) CPTMutableAnimationArray *animationOperations;
@property (nonatomic, readwrite, strong, nonnull) CPTMutableAnimationArray *runningAnimationOperations;
@property (nonatomic, readwrite, nullable) dispatch_source_t timer;
@property (nonatomic, readwrite, nonnull) dispatch_queue_t animationQueue;
+(nonnull SEL)setterFromProperty:(nonnull NSString *)property;
-(nullable CPTAnimationTimingFunction)timingFunctionForAnimationCurve:(CPTAnimationCurve)animationCurve;
-(void)updateOnMainThreadWithParameters:(nonnull CPTDictionary *)parameters;
-(void)startTimer;
-(void)cancelTimer;
-(void)update;
@end
/// @endcond
#pragma mark -
/** @brief The controller for Core Plot animations.
*
* Many Core Plot objects are subclasses of CALayer and can take advantage of all of the animation support
* provided by Core Animation. However, some objects, e.g., plot spaces, cannot be animated by Core Animation.
* It also does not support @ref NSDecimal properties that are common throughout Core Plot.
*
* CPTAnimation provides animation support for all of these things. It can animate any property (of the supported data types)
* on objects of any class.
**/
@implementation CPTAnimation
/** @property CGFloat timeOffset
* @brief The animation clock. This value is incremented for each frame while animations are running.
**/
@synthesize timeOffset;
/** @property CPTAnimationCurve defaultAnimationCurve
* @brief The animation curve used when an animation operation specifies the #CPTAnimationCurveDefault animation curve.
**/
@synthesize defaultAnimationCurve;
/** @internal
* @property nonnull CPTMutableAnimationArray *animationOperations
*
* @brief The list of animation operations currently running or waiting to run.
**/
@synthesize animationOperations;
/** @internal
* @property nonnull CPTMutableAnimationArray *runningAnimationOperations
* @brief The list of running animation operations.
**/
@synthesize runningAnimationOperations;
/** @internal
* @property nullable dispatch_source_t timer
* @brief The animation timer. Each tick of the timer corresponds to one animation frame.
**/
@synthesize timer;
#pragma mark - Init/Dealloc
/** @internal
* @property nonnull dispatch_queue_t animationQueue;
* @brief The serial dispatch queue used to synchronize animation updates.
**/
@synthesize animationQueue;
/// @name Initialization
/// @{
/** @brief Initializes a newly allocated CPTAnimation object.
*
* This is the designated initializer. The initialized object will have the following properties:
* - @ref timeOffset = @num{0.0}
* - @ref defaultAnimationCurve = #CPTAnimationCurveLinear
*
* @return The initialized object.
**/
-(nonnull instancetype)init
{
if ((self = [super init])) {
animationOperations = [[NSMutableArray alloc] init];
runningAnimationOperations = [[NSMutableArray alloc] init];
timer = NULL;
timeOffset = CPTFloat(0.0);
defaultAnimationCurve = CPTAnimationCurveLinear;
animationQueue = dispatch_queue_create("CorePlot.CPTAnimation.animationQueue", NULL);
}
return self;
}
/// @}
/// @cond
-(void)dealloc
{
[self cancelTimer];
dispatch_queue_t mainQueue = dispatch_get_main_queue();
for ( CPTAnimationOperation *animationOperation in animationOperations ) {
id<CPTAnimationDelegate> animationDelegate = animationOperation.delegate;
if ( [animationDelegate respondsToSelector:@selector(animationCancelled:)] ) {
dispatch_async(mainQueue, ^{
[animationDelegate animationCancelled:animationOperation];
});
}
}
}
/// @endcond
#pragma mark - Animation Controller Instance
/** @brief A shared CPTAnimation instance responsible for scheduling and executing animations.
* @return The shared CPTAnimation instance.
**/
+(nonnull instancetype)sharedInstance
{
static dispatch_once_t once = 0;
static CPTAnimation *shared;
dispatch_once(&once, ^{
shared = [[self alloc] init];
});
return shared;
}
#pragma mark - Property Animation
/** @brief Creates an animation operation with the given properties and adds it to the animation queue.
* @param object The object to animate.
* @param property The name of the property of @par{object} to animate. The property must have both getter and setter methods.
* @param period The animation period.
* @param animationCurve The animation curve used to animate the new operation.
* @param delegate The animation delegate (can be @nil).
* @return The queued animation operation.
**/
+(nonnull CPTAnimationOperation *)animate:(nonnull id)object property:(nonnull NSString *)property period:(nonnull CPTAnimationPeriod *)period animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationOperation *animationOperation =
[[CPTAnimationOperation alloc] initWithAnimationPeriod:period
animationCurve:animationCurve
object:object
getter:NSSelectorFromString(property)
setter:[CPTAnimation setterFromProperty:property]];
animationOperation.delegate = delegate;
[[CPTAnimation sharedInstance] addAnimationOperation:animationOperation];
return animationOperation;
}
/// @cond
+(nonnull SEL)setterFromProperty:(nonnull NSString *)property
{
return NSSelectorFromString([NSString stringWithFormat:@"set%@:", [property stringByReplacingCharactersInRange:NSMakeRange(0, 1)
withString:[property substringToIndex:1].capitalizedString]]);
}
/// @endcond
#pragma mark - Animation Management
/** @brief Adds an animation operation to the animation queue.
* @param animationOperation The animation operation to add.
* @return The queued animation operation.
**/
-(CPTAnimationOperation *)addAnimationOperation:(nonnull CPTAnimationOperation *)animationOperation
{
id boundObject = animationOperation.boundObject;
CPTAnimationPeriod *period = animationOperation.period;
if ( animationOperation.delegate || (boundObject && period && ![period.startValue isEqual:period.endValue])) {
dispatch_async(self.animationQueue, ^{
[self.animationOperations addObject:animationOperation];
if ( !self.timer ) {
[self startTimer];
}
});
}
return animationOperation;
}
/** @brief Removes an animation operation from the animation queue.
* @param animationOperation The animation operation to remove.
**/
-(void)removeAnimationOperation:(nullable CPTAnimationOperation *)animationOperation
{
if ( animationOperation ) {
dispatch_async(self.animationQueue, ^{
animationOperation.canceled = YES;
});
}
}
/** @brief Removes all animation operations from the animation queue.
**/
-(void)removeAllAnimationOperations
{
dispatch_async(self.animationQueue, ^{
for ( CPTAnimationOperation *animationOperation in self.animationOperations ) {
animationOperation.canceled = YES;
}
});
}
#pragma mark - Retrieving Animation Operations
/** @brief Gets the animation operation with the given identifier from the animation operation array.
* @param identifier An animation operation identifier.
* @return The animation operation with the given identifier or @nil if it was not found.
**/
-(nullable CPTAnimationOperation *)operationWithIdentifier:(nullable id<NSCopying, NSObject>)identifier
{
for ( CPTAnimationOperation *operation in self.animationOperations ) {
if ( [operation.identifier isEqual:identifier] ) {
return operation;
}
}
return nil;
}
#pragma mark - Animation Update
/// @cond
-(void)update
{
self.timeOffset += kCPTAnimationFrameRate;
CPTMutableAnimationArray *theAnimationOperations = self.animationOperations;
CPTMutableAnimationArray *runningOperations = self.runningAnimationOperations;
CPTMutableAnimationArray *expiredOperations = [[NSMutableArray alloc] init];
CGFloat currentTime = self.timeOffset;
CPTStringArray *runModes = @[NSRunLoopCommonModes];
dispatch_queue_t mainQueue = dispatch_get_main_queue();
// Update all waiting and running animation operations
for ( CPTAnimationOperation *animationOperation in theAnimationOperations ) {
id<CPTAnimationDelegate> animationDelegate = animationOperation.delegate;
CPTAnimationPeriod *period = animationOperation.period;
CGFloat duration = period.duration;
CGFloat startTime = period.startOffset;
CGFloat delay = period.delay;
if ( isnan(delay)) {
if ( [period canStartWithValueFromObject:animationOperation.boundObject propertyGetter:animationOperation.boundGetter] ) {
period.delay = currentTime - startTime;
startTime = currentTime;
}
else {
startTime = CPTNAN;
}
}
else {
startTime += delay;
}
CGFloat endTime = startTime + duration;
if ( animationOperation.isCanceled ) {
[expiredOperations addObject:animationOperation];
if ( [animationDelegate respondsToSelector:@selector(animationCancelled:)] ) {
dispatch_async(mainQueue, ^{
[animationDelegate animationCancelled:animationOperation];
});
}
}
else if ( currentTime >= startTime ) {
id boundObject = animationOperation.boundObject;
CPTAnimationTimingFunction timingFunction = [self timingFunctionForAnimationCurve:animationOperation.animationCurve];
if ( boundObject && timingFunction ) {
BOOL started = NO;
if ( ![runningOperations containsObject:animationOperation] ) {
// Remove any running animations for the same property
SEL boundGetter = animationOperation.boundGetter;
SEL boundSetter = animationOperation.boundSetter;
for ( CPTAnimationOperation *operation in runningOperations ) {
if ( operation.boundObject == boundObject ) {
if ((operation.boundGetter == boundGetter) && (operation.boundSetter == boundSetter)) {
operation.canceled = YES;
}
}
}
// Start the new animation
[runningOperations addObject:animationOperation];
started = YES;
}
if ( !animationOperation.isCanceled ) {
if ( !period.startValue ) {
[period setStartValueFromObject:animationOperation.boundObject propertyGetter:animationOperation.boundGetter];
}
Class valueClass = period.valueClass;
CGFloat progress = timingFunction(currentTime - startTime, duration);
CPTDictionary *parameters = @{
CPTAnimationOperationKey: animationOperation,
CPTAnimationValueKey: [period tweenedValueForProgress:progress],
CPTAnimationValueClassKey: valueClass ? valueClass : [NSNull null],
CPTAnimationStartedKey: @(started),
CPTAnimationFinishedKey: @(currentTime >= endTime)
};
// Used -performSelectorOnMainThread:... instead of GCD to ensure the animation continues to run in all run loop common modes.
[self performSelectorOnMainThread:@selector(updateOnMainThreadWithParameters:)
withObject:parameters
waitUntilDone:NO
modes:runModes];
if ( currentTime >= endTime ) {
[expiredOperations addObject:animationOperation];
}
}
}
}
}
for ( CPTAnimationOperation *animationOperation in expiredOperations ) {
[runningOperations removeObjectIdenticalTo:animationOperation];
[theAnimationOperations removeObjectIdenticalTo:animationOperation];
}
if ( theAnimationOperations.count == 0 ) {
[self cancelTimer];
}
}
// This method must be called from the main thread.
-(void)updateOnMainThreadWithParameters:(nonnull CPTDictionary *)parameters
{
CPTAnimationOperation *animationOperation = parameters[CPTAnimationOperationKey];
__block BOOL canceled;
dispatch_sync(self.animationQueue, ^{
canceled = animationOperation.isCanceled;
});
if ( !canceled ) {
@try {
Class valueClass = parameters[CPTAnimationValueClassKey];
if ( [valueClass isKindOfClass:[NSNull class]] ) {
valueClass = Nil;
}
id<CPTAnimationDelegate> delegate = animationOperation.delegate;
NSNumber *started = parameters[CPTAnimationStartedKey];
if ( started.boolValue ) {
if ( [delegate respondsToSelector:@selector(animationDidStart:)] ) {
[delegate animationDidStart:animationOperation];
}
}
if ( [delegate respondsToSelector:@selector(animationWillUpdate:)] ) {
[delegate animationWillUpdate:animationOperation];
}
SEL boundSetter = animationOperation.boundSetter;
id boundObject = animationOperation.boundObject;
id tweenedValue = parameters[CPTAnimationValueKey];
if ( !valueClass && [tweenedValue isKindOfClass:[NSDecimalNumber class]] ) {
NSDecimal buffer = ((NSDecimalNumber *)tweenedValue).decimalValue;
typedef void (*SetterType)(id, SEL, NSDecimal);
SetterType setterMethod = (SetterType)[boundObject methodForSelector:boundSetter];
setterMethod(boundObject, boundSetter, buffer);
}
else if ( valueClass && [tweenedValue isKindOfClass:[NSNumber class]] ) {
NSNumber *value = (NSNumber *)tweenedValue;
typedef void (*NumberSetterType)(id, SEL, NSNumber *);
NumberSetterType setterMethod = (NumberSetterType)[boundObject methodForSelector:boundSetter];
setterMethod(boundObject, boundSetter, value);
}
else if ( [tweenedValue isKindOfClass:[CPTPlotRange class]] ) {
CPTPlotRange *range = (CPTPlotRange *)tweenedValue;
typedef void (*RangeSetterType)(id, SEL, CPTPlotRange *);
RangeSetterType setterMethod = (RangeSetterType)[boundObject methodForSelector:boundSetter];
setterMethod(boundObject, boundSetter, range);
}
else {
// wrapped scalars and structs
NSValue *value = (NSValue *)tweenedValue;
NSUInteger bufferSize = 0;
NSGetSizeAndAlignment(value.objCType, &bufferSize, NULL);
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:[boundObject methodSignatureForSelector:boundSetter]];
invocation.target = boundObject;
invocation.selector = boundSetter;
void *buffer = calloc(1, bufferSize);
[value getValue:buffer];
[invocation setArgument:buffer atIndex:2];
free(buffer);
[invocation invoke];
}
if ( [delegate respondsToSelector:@selector(animationDidUpdate:)] ) {
[delegate animationDidUpdate:animationOperation];
}
NSNumber *finished = parameters[CPTAnimationFinishedKey];
if ( finished.boolValue ) {
if ( [delegate respondsToSelector:@selector(animationDidFinish:)] ) {
[delegate animationDidFinish:animationOperation];
}
}
}
@catch ( NSException *__unused exception ) {
// something went wrong; don't run this operation any more
dispatch_async(self.animationQueue, ^{
animationOperation.canceled = YES;
});
}
}
}
-(void)startTimer
{
dispatch_source_t newTimer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, self.animationQueue);
if ( newTimer ) {
dispatch_source_set_timer(newTimer, dispatch_time(DISPATCH_TIME_NOW, 0), (uint64_t)(kCPTAnimationFrameRate * NSEC_PER_SEC), 0);
dispatch_source_set_event_handler(newTimer, ^{
[self update];
});
dispatch_resume(newTimer);
self.timer = newTimer;
}
}
-(void)cancelTimer
{
dispatch_source_t theTimer = self.timer;
if ( theTimer ) {
dispatch_source_cancel(theTimer);
self.timer = NULL;
}
}
/// @endcond
#pragma mark - Timing Functions
/// @cond
-(nullable CPTAnimationTimingFunction)timingFunctionForAnimationCurve:(CPTAnimationCurve)animationCurve
{
CPTAnimationTimingFunction timingFunction;
if ( animationCurve == CPTAnimationCurveDefault ) {
animationCurve = self.defaultAnimationCurve;
}
switch ( animationCurve ) {
case CPTAnimationCurveLinear:
timingFunction = CPTAnimationTimingFunctionLinear;
break;
case CPTAnimationCurveBackIn:
timingFunction = CPTAnimationTimingFunctionBackIn;
break;
case CPTAnimationCurveBackOut:
timingFunction = CPTAnimationTimingFunctionBackOut;
break;
case CPTAnimationCurveBackInOut:
timingFunction = CPTAnimationTimingFunctionBackInOut;
break;
case CPTAnimationCurveBounceIn:
timingFunction = CPTAnimationTimingFunctionBounceIn;
break;
case CPTAnimationCurveBounceOut:
timingFunction = CPTAnimationTimingFunctionBounceOut;
break;
case CPTAnimationCurveBounceInOut:
timingFunction = CPTAnimationTimingFunctionBounceInOut;
break;
case CPTAnimationCurveCircularIn:
timingFunction = CPTAnimationTimingFunctionCircularIn;
break;
case CPTAnimationCurveCircularOut:
timingFunction = CPTAnimationTimingFunctionCircularOut;
break;
case CPTAnimationCurveCircularInOut:
timingFunction = CPTAnimationTimingFunctionCircularInOut;
break;
case CPTAnimationCurveElasticIn:
timingFunction = CPTAnimationTimingFunctionElasticIn;
break;
case CPTAnimationCurveElasticOut:
timingFunction = CPTAnimationTimingFunctionElasticOut;
break;
case CPTAnimationCurveElasticInOut:
timingFunction = CPTAnimationTimingFunctionElasticInOut;
break;
case CPTAnimationCurveExponentialIn:
timingFunction = CPTAnimationTimingFunctionExponentialIn;
break;
case CPTAnimationCurveExponentialOut:
timingFunction = CPTAnimationTimingFunctionExponentialOut;
break;
case CPTAnimationCurveExponentialInOut:
timingFunction = CPTAnimationTimingFunctionExponentialInOut;
break;
case CPTAnimationCurveSinusoidalIn:
timingFunction = CPTAnimationTimingFunctionSinusoidalIn;
break;
case CPTAnimationCurveSinusoidalOut:
timingFunction = CPTAnimationTimingFunctionSinusoidalOut;
break;
case CPTAnimationCurveSinusoidalInOut:
timingFunction = CPTAnimationTimingFunctionSinusoidalInOut;
break;
case CPTAnimationCurveCubicIn:
timingFunction = CPTAnimationTimingFunctionCubicIn;
break;
case CPTAnimationCurveCubicOut:
timingFunction = CPTAnimationTimingFunctionCubicOut;
break;
case CPTAnimationCurveCubicInOut:
timingFunction = CPTAnimationTimingFunctionCubicInOut;
break;
case CPTAnimationCurveQuadraticIn:
timingFunction = CPTAnimationTimingFunctionQuadraticIn;
break;
case CPTAnimationCurveQuadraticOut:
timingFunction = CPTAnimationTimingFunctionQuadraticOut;
break;
case CPTAnimationCurveQuadraticInOut:
timingFunction = CPTAnimationTimingFunctionQuadraticInOut;
break;
case CPTAnimationCurveQuarticIn:
timingFunction = CPTAnimationTimingFunctionQuarticIn;
break;
case CPTAnimationCurveQuarticOut:
timingFunction = CPTAnimationTimingFunctionQuarticOut;
break;
case CPTAnimationCurveQuarticInOut:
timingFunction = CPTAnimationTimingFunctionQuarticInOut;
break;
case CPTAnimationCurveQuinticIn:
timingFunction = CPTAnimationTimingFunctionQuinticIn;
break;
case CPTAnimationCurveQuinticOut:
timingFunction = CPTAnimationTimingFunctionQuinticOut;
break;
case CPTAnimationCurveQuinticInOut:
timingFunction = CPTAnimationTimingFunctionQuinticInOut;
break;
default:
timingFunction = NULL;
}
return timingFunction;
}
/// @endcond
#pragma mark -
#pragma mark Description
/// @cond
-(nullable NSString *)description
{
return [NSString stringWithFormat:@"<%@ timeOffset: %g; %lu active and %lu running operations>",
super.description,
(double)self.timeOffset,
(unsigned long)self.animationOperations.count,
(unsigned long)self.runningAnimationOperations.count];
}
/// @endcond
@end