-
Notifications
You must be signed in to change notification settings - Fork 597
Expand file tree
/
Copy pathCPTAnimationPeriod.m
More file actions
1038 lines (911 loc) · 53.1 KB
/
Copy pathCPTAnimationPeriod.m
File metadata and controls
1038 lines (911 loc) · 53.1 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
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#import "CPTAnimationPeriod.h"
#import "_CPTAnimationCGFloatPeriod.h"
#import "_CPTAnimationCGPointPeriod.h"
#import "_CPTAnimationCGRectPeriod.h"
#import "_CPTAnimationCGSizePeriod.h"
#import "_CPTAnimationNSDecimalPeriod.h"
#import "_CPTAnimationNSNumberPeriod.h"
#import "_CPTAnimationPlotRangePeriod.h"
#import "CPTAnimationOperation.h"
#import "CPTPlotRange.h"
#import "NSNumberExtensions.h"
/// @cond
@interface CPTAnimationPeriod()
+(nonnull instancetype)periodWithStartValue:(nullable NSValue *)aStartValue endValue:(nullable NSValue *)anEndValue ofClass:(nullable Class)class duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay;
-(nonnull instancetype)initWithStartValue:(nullable NSValue *)aStartValue endValue:(nullable NSValue *)anEndValue ofClass:(nullable Class)class duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay;
@property (nonatomic, readwrite) CGFloat startOffset;
@end
/// @endcond
#pragma mark -
/** @brief Animation timing information and animated values.
*
* The starting and ending values of the animation can be any of the following types
* wrapped in an NSValue instance:
* - @ref CGFloat
* - @ref CGPoint
* - @ref CGSize
* - @ref CGRect
* - @ref NSDecimal
* - @ref NSNumber
* - @ref CPTPlotRange (NSValue wrapper not used)
* @note The starting and ending values must be the same type.
**/
@implementation CPTAnimationPeriod
/** @property nullable NSValue *startValue
* @brief The starting value of the animation.
*
* If @nil or the encoded value is @NAN, the animation starts from the current value of the animated property.
**/
@synthesize startValue;
/** @property nullable NSValue *endValue
* @brief The ending value of the animation.
**/
@synthesize endValue;
/** @property Class valueClass
* @brief The Objective-C class of the animated object. If @nil, the value is a scalar or struct wrapped in an NSValue object.
**/
@synthesize valueClass;
/** @property CGFloat duration
* @brief The duration of the animation, in seconds.
**/
@synthesize duration;
/** @property CGFloat delay
* @brief The delay in seconds between the @ref startOffset and the time the animation will start.
* If @NAN, the animation will not start until the current value of the bound property is between @ref startValue and @ref endValue.
**/
@synthesize delay;
/** @property CGFloat startOffset
* @brief The animation time clock offset when the receiver was created.
**/
@synthesize startOffset;
#pragma mark -
#pragma mark Factory Methods
/// @cond
/** @internal
* @brief Creates and returns a new CPTAnimationPeriod instance initialized with the provided start and end values and duration.
* @param aStartValue The starting value. If @nil, the animation starts from the current value of the animated property.
* @param anEndValue The ending value.
* @param class The Objective-C class of the animated object. If @Nil, the value is a scalar or struct wrapped in an NSValue object.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
+(instancetype)periodWithStartValue:(NSValue *)aStartValue endValue:(NSValue *)anEndValue ofClass:(Class)class duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
return [[self alloc] initWithStartValue:aStartValue endValue:anEndValue ofClass:class duration:aDuration withDelay:aDelay];
}
/// @endcond
/**
* @brief Creates and returns a new CPTAnimationPeriod instance initialized with the provided start and end values and duration.
* @param aStart The starting value. If @NAN, the animation starts from the current value of the animated property.
* @param anEnd The ending value.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
+(nonnull instancetype)periodWithStart:(CGFloat)aStart end:(CGFloat)anEnd duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
NSNumber *start = isnan(aStart) ? nil : @(aStart);
return [_CPTAnimationCGFloatPeriod periodWithStartValue:start
endValue:@(anEnd)
ofClass:Nil
duration:aDuration
withDelay:aDelay];
}
/**
* @brief Creates and returns a new CPTAnimationPeriod instance initialized with the provided start and end points and duration.
* @param aStartPoint The starting point. If either coordinate is @NAN, the animation starts from the current value of the animated property.
* @param anEndPoint The ending point.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
+(nonnull instancetype)periodWithStartPoint:(CGPoint)aStartPoint endPoint:(CGPoint)anEndPoint duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
NSValue *start = nil;
if ( !isnan(aStartPoint.x) && !isnan(aStartPoint.y)) {
start = [NSValue valueWithBytes:&aStartPoint objCType:@encode(CGPoint)];
}
return [_CPTAnimationCGPointPeriod periodWithStartValue:start
endValue:[NSValue valueWithBytes:&anEndPoint objCType:@encode(CGPoint)]
ofClass:Nil
duration:aDuration
withDelay:aDelay];
}
/**
* @brief Creates and returns a new CPTAnimationPeriod instance initialized with the provided start and end sizes and duration.
* @param aStartSize The starting size. If either coordinate is @NAN, the animation starts from the current value of the animated property.
* @param anEndSize The ending size.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
+(nonnull instancetype)periodWithStartSize:(CGSize)aStartSize endSize:(CGSize)anEndSize duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
NSValue *start = nil;
if ( !isnan(aStartSize.width) && !isnan(aStartSize.height)) {
start = [NSValue valueWithBytes:&aStartSize objCType:@encode(CGSize)];
}
return [_CPTAnimationCGSizePeriod periodWithStartValue:start
endValue:[NSValue valueWithBytes:&anEndSize objCType:@encode(CGSize)]
ofClass:Nil
duration:aDuration
withDelay:aDelay];
}
/**
* @brief Creates and returns a new CPTAnimationPeriod instance initialized with the provided start and end rectangles and duration.
* @param aStartRect The starting rectangle. If @ref CGRectNull or any field is @NAN, the animation starts from the current value of the animated property.
* @param anEndRect The ending rectangle.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
+(nonnull instancetype)periodWithStartRect:(CGRect)aStartRect endRect:(CGRect)anEndRect duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
NSValue *start = nil;
if ( !CGRectEqualToRect(aStartRect, CGRectNull) && !isnan(aStartRect.origin.x) && !isnan(aStartRect.origin.y) && !isnan(aStartRect.size.width) && !isnan(aStartRect.size.height)) {
start = [NSValue valueWithBytes:&aStartRect objCType:@encode(CGRect)];
}
return [_CPTAnimationCGRectPeriod periodWithStartValue:start
endValue:[NSValue valueWithBytes:&anEndRect objCType:@encode(CGRect)]
ofClass:Nil
duration:aDuration
withDelay:aDelay];
}
/**
* @brief Creates and returns a new CPTAnimationPeriod instance initialized with the provided start and end values and duration.
* @param aStartDecimal The starting value. If @NAN, the animation starts from the current value of the animated property.
* @param anEndDecimal The ending value.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
+(nonnull instancetype)periodWithStartDecimal:(NSDecimal)aStartDecimal endDecimal:(NSDecimal)anEndDecimal duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
NSDecimalNumber *start = NSDecimalIsNotANumber(&aStartDecimal) ? nil : [NSDecimalNumber decimalNumberWithDecimal:aStartDecimal];
return [_CPTAnimationNSDecimalPeriod periodWithStartValue:start
endValue:[NSDecimalNumber decimalNumberWithDecimal:anEndDecimal]
ofClass:Nil
duration:aDuration
withDelay:aDelay];
}
/**
* @brief Creates and returns a new CPTAnimationPeriod instance initialized with the provided start and end values and duration.
* @param aStartNumber The starting value. If @NAN or @nil, the animation starts from the current value of the animated property.
* @param anEndNumber The ending value.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
+(nonnull instancetype)periodWithStartNumber:(nullable NSNumber *)aStartNumber endNumber:(nonnull NSNumber *)anEndNumber duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
return [_CPTAnimationNSNumberPeriod periodWithStartValue:aStartNumber
endValue:anEndNumber
ofClass:[NSNumber class]
duration:aDuration
withDelay:aDelay];
}
/**
* @brief Creates and returns a new CPTAnimationPeriod instance initialized with the provided start and end plot ranges and duration.
* @param aStartPlotRange The starting plot range. If @nil or any component of the range is @NAN, the animation starts from the current value of the animated property.
* @param anEndPlotRange The ending plot range.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
+(nonnull instancetype)periodWithStartPlotRange:(nonnull CPTPlotRange *)aStartPlotRange endPlotRange:(nonnull CPTPlotRange *)anEndPlotRange duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
CPTPlotRange *startRange = aStartPlotRange;
if ( isnan(aStartPlotRange.locationDouble) || isnan(aStartPlotRange.lengthDouble)) {
startRange = nil;
}
return [_CPTAnimationPlotRangePeriod periodWithStartValue:(NSValue *)startRange
endValue:(NSValue *)anEndPlotRange
ofClass:[CPTPlotRange class]
duration:aDuration
withDelay:aDelay];
}
/// @cond
/** @internal
* @brief Initializes a newly allocated CPTAnimationPeriod object with the provided start and end values and duration.
*
* This is the designated initializer. The initialized object will have the following properties:
* - @ref startValue = @par{aStartValue}
* - @ref endValue = @par{anEndValue}
* - @ref class = @par{class}
* - @ref duration = @par{aDuration}
* - @ref delay = @par{aDelay}
* - @ref startOffset = The animation time clock offset when this method is called.
*
* @param aStartValue The starting value. If @nil, the animation starts from the current value of the animated property.
* @param anEndValue The ending value.
* @param class The Objective-C class of the animated object. If @Nil, the value is a scalar or struct wrapped in an NSValue object.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
-(instancetype)initWithStartValue:(NSValue *)aStartValue endValue:(NSValue *)anEndValue ofClass:(Class)class duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
if ((self = [super init])) {
startValue = [aStartValue copy];
endValue = [anEndValue copy];
valueClass = class;
duration = aDuration;
delay = aDelay;
startOffset = [CPTAnimation sharedInstance].timeOffset;
}
return self;
}
/// @endcond
/**
* @brief Initializes a newly allocated CPTAnimationPeriod object with the provided start and end values and duration.
* @param aStart The starting value. If @NAN, the animation starts from the current value of the animated property.
* @param anEnd The ending value.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
-(nonnull instancetype)initWithStart:(CGFloat)aStart end:(CGFloat)anEnd duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
NSNumber *start = isnan(aStart) ? nil : @(aStart);
self = [[_CPTAnimationCGFloatPeriod alloc] initWithStartValue:start
endValue:@(anEnd)
ofClass:Nil
duration:aDuration
withDelay:aDelay];
return self;
}
/**
* @brief Initializes a newly allocated CPTAnimationPeriod object with the provided start and end points and duration.
* @param aStartPoint The starting point. If either coordinate is @NAN, the animation starts from the current value of the animated property.
* @param anEndPoint The ending point.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
-(nonnull instancetype)initWithStartPoint:(CGPoint)aStartPoint endPoint:(CGPoint)anEndPoint duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
NSValue *start = nil;
if ( !isnan(aStartPoint.x) && !isnan(aStartPoint.y)) {
start = [NSValue valueWithBytes:&aStartPoint objCType:@encode(CGPoint)];
}
self = [[_CPTAnimationCGPointPeriod alloc] initWithStartValue:start
endValue:[NSValue valueWithBytes:&anEndPoint objCType:@encode(CGPoint)]
ofClass:Nil
duration:aDuration
withDelay:aDelay];
return self;
}
/**
* @brief Initializes a newly allocated CPTAnimationPeriod object with the provided start and end sizes and duration.
* @param aStartSize The starting size. If either coordinate is @NAN, the animation starts from the current value of the animated property.
* @param anEndSize The ending size.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
-(nonnull instancetype)initWithStartSize:(CGSize)aStartSize endSize:(CGSize)anEndSize duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
NSValue *start = nil;
if ( !isnan(aStartSize.width) && !isnan(aStartSize.height)) {
start = [NSValue valueWithBytes:&aStartSize objCType:@encode(CGSize)];
}
self = [[_CPTAnimationCGSizePeriod alloc] initWithStartValue:start
endValue:[NSValue valueWithBytes:&anEndSize objCType:@encode(CGSize)]
ofClass:Nil
duration:aDuration
withDelay:aDelay];
return self;
}
/**
* @brief Initializes a newly allocated CPTAnimationPeriod object with the provided start and end rectangles and duration.
* @param aStartRect The starting rectangle. If @ref CGRectNull or any field is @NAN, the animation starts from the current value of the animated property.
* @param anEndRect The ending rectangle.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
-(nonnull instancetype)initWithStartRect:(CGRect)aStartRect endRect:(CGRect)anEndRect duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
NSValue *start = nil;
if ( !CGRectEqualToRect(aStartRect, CGRectNull) && !isnan(aStartRect.origin.x) && !isnan(aStartRect.origin.y) && !isnan(aStartRect.size.width) && !isnan(aStartRect.size.height)) {
start = [NSValue valueWithBytes:&aStartRect objCType:@encode(CGRect)];
}
self = [[_CPTAnimationCGRectPeriod alloc] initWithStartValue:start
endValue:[NSValue valueWithBytes:&anEndRect objCType:@encode(CGRect)]
ofClass:Nil
duration:aDuration
withDelay:aDelay];
return self;
}
/**
* @brief Initializes a newly allocated CPTAnimationPeriod object with the provided start and end values and duration.
* @param aStartDecimal The starting value. If @NAN, the animation starts from the current value of the animated property.
* @param anEndDecimal The ending value.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
-(nonnull instancetype)initWithStartDecimal:(NSDecimal)aStartDecimal endDecimal:(NSDecimal)anEndDecimal duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
NSDecimalNumber *start = NSDecimalIsNotANumber(&aStartDecimal) ? nil : [NSDecimalNumber decimalNumberWithDecimal:aStartDecimal];
self = [[_CPTAnimationNSDecimalPeriod alloc] initWithStartValue:start
endValue:[NSDecimalNumber decimalNumberWithDecimal:anEndDecimal]
ofClass:Nil
duration:aDuration
withDelay:aDelay];
return self;
}
/**
* @brief Initializes a newly allocated CPTAnimationPeriod object with the provided start and end values and duration.
* @param aStartNumber The starting value. If @NAN or @nil, the animation starts from the current value of the animated property.
* @param anEndNumber The ending value.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
-(nonnull instancetype)initWithStartNumber:(nullable NSNumber *)aStartNumber endNumber:(nonnull NSNumber *)anEndNumber duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
self = [[_CPTAnimationNSNumberPeriod alloc] initWithStartValue:aStartNumber
endValue:anEndNumber
ofClass:[NSNumber class]
duration:aDuration
withDelay:aDelay];
return self;
}
/**
* @brief Initializes a newly allocated CPTAnimationPeriod object with the provided start and end plot ranges and duration.
* @param aStartPlotRange The starting plot range. If @nil or any component of the range is @NAN, the animation starts from the current value of the animated property.
* @param anEndPlotRange The ending plot range.
* @param aDuration The animation duration in seconds.
* @param aDelay The starting delay in seconds.
* @return The initialized object.
**/
-(nonnull instancetype)initWithStartPlotRange:(nonnull CPTPlotRange *)aStartPlotRange endPlotRange:(nonnull CPTPlotRange *)anEndPlotRange duration:(CGFloat)aDuration withDelay:(CGFloat)aDelay
{
CPTPlotRange *startRange = aStartPlotRange;
if ( isnan(aStartPlotRange.locationDouble) || isnan(aStartPlotRange.lengthDouble)) {
startRange = nil;
}
self = [[_CPTAnimationPlotRangePeriod alloc] initWithStartValue:(NSValue *)startRange
endValue:(NSValue *)anEndPlotRange
ofClass:[CPTPlotRange class]
duration:aDuration
withDelay:aDelay];
return self;
}
/// @cond
/** @brief Initializes a newly allocated CPTAnimationPeriod object with no start or end values and a @par{duration} and @par{delay} of zero (@num{0}).
* @return The initialized object.
**/
-(nonnull instancetype)init
{
return [self initWithStartValue:nil endValue:@0.0 ofClass:Nil duration:CPTFloat(0.0) withDelay:CPTFloat(0.0)];
}
/// @endcond
#pragma mark -
#pragma mark Abstract Methods
/**
* @brief Initialize the start value from the property getter.
* @param boundObject The object to update for each animation frame.
* @param boundGetter The getter method for the property to update.
**/
-(void)setStartValueFromObject:(nonnull id __unused)boundObject propertyGetter:(nonnull SEL __unused)boundGetter
{
[NSException raise:NSGenericException
format:@"The -initializeStartValue method must be implemented by CPTAnimationPeriod subclasses."];
}
/** @brief Calculates a value between @link CPTAnimationPeriod::startValue startValue @endlink and @link CPTAnimationPeriod::endValue endValue @endlink.
*
* A @par{progress} value of zero (@num{0}) returns the @link CPTAnimationPeriod::startValue startValue @endlink and
* a value of one (@num{1}) returns the @link CPTAnimationPeriod::endValue endValue @endlink.
*
* @param progress The fraction of the animation progress.
* @return The computed value.
**/
-(nonnull NSValue *)tweenedValueForProgress:(CGFloat __unused)progress
{
[NSException raise:NSGenericException
format:@"The -tweenedValueForProgress: method must be implemented by CPTAnimationPeriod subclasses."];
return nil;
}
/**
* @brief Determines if the current value of the bound property is between the start and end value.
* @param boundObject The object to update for each animation frame.
* @param boundGetter The getter method for the property to update.
* @return @YES if the current value of the bound property is between the start and end value.
**/
-(BOOL)canStartWithValueFromObject:(nonnull id __unused)boundObject propertyGetter:(nonnull SEL __unused)boundGetter
{
[NSException raise:NSGenericException
format:@"The -canStartWithValueFromObject:propertyGetter: method must be implemented by CPTAnimationPeriod subclasses."];
return NO;
}
#pragma mark -
#pragma mark Description
/// @cond
-(nullable NSString *)description
{
return [NSString stringWithFormat:@"<%@ from: %@; to: %@; duration: %g, delay: %g>", super.description, self.startValue, self.endValue, (double)self.duration, (double)self.delay];
}
/// @endcond
@end
#pragma mark -
@implementation CPTAnimation(CPTAnimationPeriodAdditions)
// CGFloat
/** @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 from The starting value for the animation. If @NAN, the animation starts from the current value of the animated property.
* @param to The ending value for the animation.
* @param duration The duration of the animation.
* @param delay The starting delay of the animation in seconds.
* @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 from:(CGFloat)from to:(CGFloat)to duration:(CGFloat)duration withDelay:(CGFloat)delay animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStart:from
end:to
duration:duration
withDelay:delay];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting value for the animation. If @NAN, the animation starts from the current value of the animated property.
* @param to The ending value for the animation.
* @param duration The duration of the animation.
* @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 from:(CGFloat)from to:(CGFloat)to duration:(CGFloat)duration animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStart:from
end:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting value for the animation. If @NAN, the animation starts from the current value of the animated property.
* @param to The ending value for the animation.
* @param duration The duration of the animation.
* @return The queued animation operation.
**/
+(nonnull CPTAnimationOperation *)animate:(nonnull id)object property:(nonnull NSString *)property from:(CGFloat)from to:(CGFloat)to duration:(CGFloat)duration
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStart:from
end:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:CPTAnimationCurveDefault
delegate:nil];
}
// CGPoint
/** @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 from The starting point for the animation. If either coordinate is @NAN, the animation starts from the current value of the animated property.
* @param to The ending point for the animation.
* @param duration The duration of the animation.
* @param delay The starting delay of the animation in seconds.
* @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 fromPoint:(CGPoint)from toPoint:(CGPoint)to duration:(CGFloat)duration withDelay:(CGFloat)delay animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartPoint:from
endPoint:to
duration:duration
withDelay:delay];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting point for the animation. If either coordinate is @NAN, the animation starts from the current value of the animated property.
* @param to The ending point for the animation.
* @param duration The duration of the animation.
* @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 fromPoint:(CGPoint)from toPoint:(CGPoint)to duration:(CGFloat)duration animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartPoint:from
endPoint:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting point for the animation. If either coordinate is @NAN, the animation starts from the current value of the animated property.
* @param to The ending point for the animation.
* @param duration The duration of the animation.
* @return The queued animation operation.
**/
+(nonnull CPTAnimationOperation *)animate:(nonnull id)object property:(nonnull NSString *)property fromPoint:(CGPoint)from toPoint:(CGPoint)to duration:(CGFloat)duration
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartPoint:from
endPoint:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:CPTAnimationCurveDefault
delegate:nil];
}
// CGSize
/** @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 from The starting size for the animation. If either coordinate is @NAN, the animation starts from the current value of the animated property.
* @param to The ending size for the animation.
* @param duration The duration of the animation.
* @param delay The starting delay of the animation in seconds.
* @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 fromSize:(CGSize)from toSize:(CGSize)to duration:(CGFloat)duration withDelay:(CGFloat)delay animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartSize:from
endSize:to
duration:duration
withDelay:delay];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting size for the animation. If either coordinate is @NAN, the animation starts from the current value of the animated property.
* @param to The ending size for the animation.
* @param duration The duration of the animation.
* @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 fromSize:(CGSize)from toSize:(CGSize)to duration:(CGFloat)duration animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartSize:from
endSize:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting size for the animation. If either coordinate is @NAN, the animation starts from the current value of the animated property.
* @param to The ending size for the animation.
* @param duration The duration of the animation.
* @return The queued animation operation.
**/
+(nonnull CPTAnimationOperation *)animate:(nonnull id)object property:(nonnull NSString *)property fromSize:(CGSize)from toSize:(CGSize)to duration:(CGFloat)duration
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartSize:from
endSize:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:CPTAnimationCurveDefault
delegate:nil];
}
// CGRect
/** @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 from The starting rectangle for the animation. If @ref CGRectNull or any field is @NAN, the animation starts from the current value of the animated property.
* @param to The ending rectangle for the animation.
* @param duration The duration of the animation.
* @param delay The starting delay of the animation in seconds.
* @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 fromRect:(CGRect)from toRect:(CGRect)to duration:(CGFloat)duration withDelay:(CGFloat)delay animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartRect:from
endRect:to
duration:duration
withDelay:delay];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting rectangle for the animation. If @ref CGRectNull or any field is @NAN, the animation starts from the current value of the animated property.
* @param to The ending rectangle for the animation.
* @param duration The duration of the animation.
* @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 fromRect:(CGRect)from toRect:(CGRect)to duration:(CGFloat)duration animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartRect:from
endRect:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting rectangle for the animation. If @ref CGRectNull or any field is @NAN, the animation starts from the current value of the animated property.
* @param to The ending rectangle for the animation.
* @param duration The duration of the animation.
* @return The queued animation operation.
**/
+(nonnull CPTAnimationOperation *)animate:(nonnull id)object property:(nonnull NSString *)property fromRect:(CGRect)from toRect:(CGRect)to duration:(CGFloat)duration
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartRect:from
endRect:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:CPTAnimationCurveDefault
delegate:nil];
}
// NSDecimal
/** @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 from The starting value for the animation. If @NAN, the animation starts from the current value of the animated property.
* @param to The ending value for the animation.
* @param duration The duration of the animation.
* @param delay The starting delay of the animation in seconds.
* @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 fromDecimal:(NSDecimal)from toDecimal:(NSDecimal)to duration:(CGFloat)duration withDelay:(CGFloat)delay animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartDecimal:from
endDecimal:to
duration:duration
withDelay:delay];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting value for the animation. If @NAN, the animation starts from the current value of the animated property.
* @param to The ending value for the animation.
* @param duration The duration of the animation.
* @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 fromDecimal:(NSDecimal)from toDecimal:(NSDecimal)to duration:(CGFloat)duration animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartDecimal:from
endDecimal:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting value for the animation. If @NAN, the animation starts from the current value of the animated property.
* @param to The ending value for the animation.
* @param duration The duration of the animation.
* @return The queued animation operation.
**/
+(nonnull CPTAnimationOperation *)animate:(nonnull id)object property:(nonnull NSString *)property fromDecimal:(NSDecimal)from toDecimal:(NSDecimal)to duration:(CGFloat)duration
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartDecimal:from
endDecimal:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:CPTAnimationCurveDefault
delegate:nil];
}
// NSNumber
/** @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 from The starting value. If @NAN or @nil, the animation starts from the current value of the animated property.
* @param to The ending value.
* @param duration The duration of the animation.
* @param delay The starting delay of the animation in seconds.
* @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 fromNumber:(nullable NSNumber *)from toNumber:(nonnull NSNumber *)to duration:(CGFloat)duration withDelay:(CGFloat)delay animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartNumber:from
endNumber:to
duration:duration
withDelay:delay];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting value. If @NAN or @nil, the animation starts from the current value of the animated property.
* @param to The ending value.
* @param duration The duration of the animation.
* @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 fromNumber:(nullable NSNumber *)from toNumber:(nonnull NSNumber *)to duration:(CGFloat)duration animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartNumber:from
endNumber:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting value. If @NAN or @nil, the animation starts from the current value of the animated property.
* @param to The ending value.
* @param duration The duration of the animation.
* @return The queued animation operation.
**/
+(nonnull CPTAnimationOperation *)animate:(nonnull id)object property:(nonnull NSString *)property fromNumber:(nullable NSNumber *)from toNumber:(nonnull NSNumber *)to duration:(CGFloat)duration
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartNumber:from
endNumber:to
duration:duration
withDelay:CPTFloat(0.0)];
return [self animate:object
property:property
period:period
animationCurve:CPTAnimationCurveDefault
delegate:nil];
}
// CPTPlotRange
/** @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 from The starting plot range for the animation. If @nil or any component of the range is @NAN, the animation starts from the current value of the animated property.
* @param to The ending plot range for the animation.
* @param duration The duration of the animation.
* @param delay The starting delay of the animation in seconds.
* @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 fromPlotRange:(nonnull CPTPlotRange *)from toPlotRange:(nonnull CPTPlotRange *)to duration:(CGFloat)duration withDelay:(CGFloat)delay animationCurve:(CPTAnimationCurve)animationCurve delegate:(nullable id<CPTAnimationDelegate>)delegate
{
CPTAnimationPeriod *period = [CPTAnimationPeriod periodWithStartPlotRange:from
endPlotRange:to
duration:duration
withDelay:delay];
return [self animate:object
property:property
period:period
animationCurve:animationCurve
delegate:delegate
];
}
/** @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 from The starting plot range for the animation. If @nil or any component of the range is @NAN, the animation starts from the current value of the animated property.
* @param to The ending plot range for the animation.
* @param duration The duration of the animation.
* @param animationCurve The animation curve used to animate the new operation.
* @param delegate The animation delegate (can be @nil).
* @return The queued animation operation.
**/