Merge pull request #354 from zats/master

Add convenience initializer for custom animation

Author: Adam Bell

Podfile.lock

@@ -9,4 +9,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: 06e2f62938dff5782de5abf2adf6966a85f24637
 
-COCOAPODS: 1.0.0
+COCOAPODS: 1.1.1

pop.podspec

@@ -7,7 +7,7 @@ Pod::Spec.new do |spec|
   spec.summary      = 'Extensible animation framework for iOS and OS X.'
   spec.source       = { :git => 'https://github.com/facebook/pop.git', :tag => '1.0.9' }
   spec.source_files = 'pop/**/*.{h,m,mm,cpp}'
-  spec.public_header_files = 'pop/{POP,POPAnimatableProperty,POPAnimation,POPAnimationEvent,POPAnimationExtras,POPAnimationTracer,POPAnimator,POPBasicAnimation,POPCustomAnimation,POPDecayAnimation,POPDefines,POPGeometry,POPLayerExtras,POPPropertyAnimation,POPSpringAnimation}.h'
+  spec.public_header_files = 'pop/{POP,POPAnimatableProperty,POPAnimatablePropertyTypes,POPAnimation,POPAnimationEvent,POPAnimationExtras,POPAnimationTracer,POPAnimator,POPBasicAnimation,POPCustomAnimation,POPDecayAnimation,POPDefines,POPGeometry,POPLayerExtras,POPPropertyAnimation,POPSpringAnimation}.h'
   spec.requires_arc = true
   spec.social_media_url = 'https://twitter.com/fbOpenSource'
   spec.library = 'c++'

pop.xcodeproj/project.pbxproj

@@ -13,6 +13,7 @@
 #import <pop/POPDefines.h>
 
 #import <pop/POPAnimatableProperty.h>
+#import <pop/POPAnimatablePropertyTypes.h>
 #import <pop/POPAnimation.h>
 #import <pop/POPAnimationEvent.h>
 #import <pop/POPAnimationExtras.h>

pop/POP.h

@@ -12,6 +12,7 @@
 #import <Foundation/NSObject.h>
 
 #import <pop/POPDefines.h>
+#import <pop/POPAnimatablePropertyTypes.h>
 
 @class POPMutableAnimatableProperty;
 
@@ -46,12 +47,12 @@
 /**
  @abstract Block used to read values from a property into an array of floats.
  */
-@property (readonly, nonatomic, copy) void (^readBlock)(id obj, CGFloat values[]);
+@property (readonly, nonatomic, copy) POPAnimatablePropertyReadBlock readBlock;
 
 /**
  @abstract Block used to write values from an array of floats into a property.
  */
-@property (readonly, nonatomic, copy) void (^writeBlock)(id obj, const CGFloat values[]);
+@property (readonly, nonatomic, copy) POPAnimatablePropertyWriteBlock writeBlock;
 
 /**
  @abstract The threshold value used when determining completion of dynamics simulations.
@@ -73,12 +74,12 @@
 /**
  @abstract A read-write version of POPAnimatableProperty readBlock property.
  */
-@property (readwrite, nonatomic, copy) void (^readBlock)(id obj, CGFloat values[]);
+@property (readwrite, nonatomic, copy) POPAnimatablePropertyReadBlock readBlock;
 
 /**
  @abstract A read-write version of POPAnimatableProperty writeBlock property.
  */
-@property (readwrite, nonatomic, copy) void (^writeBlock)(id obj, const CGFloat values[]);
+@property (readwrite, nonatomic, copy) POPAnimatablePropertyWriteBlock writeBlock;
 
 /**
  @abstract A read-write version of POPAnimatableProperty threshold property.

pop/POPAnimatableProperty.h

@@ -166,8 +166,8 @@
 typedef struct
 {
   NSString *name;
-  pop_animatable_read_block readBlock;
-  pop_animatable_write_block writeBlock;
+  POPAnimatablePropertyReadBlock readBlock;
+  POPAnimatablePropertyWriteBlock writeBlock;
   CGFloat threshold;
 } _POPStaticAnimatablePropertyState;
 typedef _POPStaticAnimatablePropertyState POPStaticAnimatablePropertyState;
@@ -1144,12 +1144,12 @@ - (NSString *)name
   return _state->name;
 }
 
-- (pop_animatable_read_block)readBlock
+- (POPAnimatablePropertyReadBlock)readBlock
 {
   return _state->readBlock;
 }
 
-- (pop_animatable_write_block)writeBlock
+- (POPAnimatablePropertyWriteBlock)writeBlock
 {
   return _state->writeBlock;
 }
@@ -1167,15 +1167,15 @@ - (CGFloat)threshold
  Concrete immutable property class.
  */
 @interface POPConcreteAnimatableProperty : POPAnimatableProperty
-- (instancetype)initWithName:(NSString *)name readBlock:(pop_animatable_read_block)read writeBlock:(pop_animatable_write_block)write threshold:(CGFloat)threshold;
+- (instancetype)initWithName:(NSString *)name readBlock:(POPAnimatablePropertyReadBlock)read writeBlock:(POPAnimatablePropertyWriteBlock)write threshold:(CGFloat)threshold;
 @end
 
 @implementation POPConcreteAnimatableProperty
 
 // default synthesis
 @synthesize name, readBlock, writeBlock, threshold;
 
-- (instancetype)initWithName:(NSString *)aName readBlock:(pop_animatable_read_block)aReadBlock writeBlock:(pop_animatable_write_block)aWriteBlock threshold:(CGFloat)aThreshold
+- (instancetype)initWithName:(NSString *)aName readBlock:(POPAnimatablePropertyReadBlock)aReadBlock writeBlock:(POPAnimatablePropertyWriteBlock)aWriteBlock threshold:(CGFloat)aThreshold
 {
   self = [super init];
   if (nil != self) {

pop/POPAnimatableProperty.mm

@@ -0,0 +1,11 @@
+/**
+ Copyright (c) 2014-present, Facebook, Inc.
+ All rights reserved.
+
+ This source code is licensed under the BSD-style license found in the
+ LICENSE file in the root directory of this source tree. An additional grant
+ of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+typedef void (^POPAnimatablePropertyReadBlock)(id obj, CGFloat values[]);
+typedef void (^POPAnimatablePropertyWriteBlock)(id obj, const CGFloat values[]);

pop/POPAnimatablePropertyTypes.h

@@ -9,8 +9,10 @@
 
 #import <objc/runtime.h>
 
+#import <CoreGraphics/CoreGraphics.h>
 #import <Foundation/Foundation.h>
 
+#import "POPAnimatablePropertyTypes.h"
 #import "POPVector.h"
 
 enum POPValueType
@@ -77,16 +79,10 @@ extern id POPBox(VectorConstRef vec, POPValueType type, bool force = false);
  */
 extern VectorRef POPUnbox(id value, POPValueType &type, NSUInteger &count, bool validate);
 
-/**
- Read/write block typedefs for convenience.
- */
-typedef void(^pop_animatable_read_block)(id obj, CGFloat *value);
-typedef void(^pop_animatable_write_block)(id obj, const CGFloat *value);
-
 /**
  Read object value and return a Vector4r.
  */
-NS_INLINE Vector4r read_values(pop_animatable_read_block read, id obj, size_t count)
+NS_INLINE Vector4r read_values(POPAnimatablePropertyReadBlock read, id obj, size_t count)
 {
   Vector4r vec = Vector4r::Zero();
   if (0 == count)

pop/POPAnimationRuntime.h

@@ -179,7 +179,7 @@ static void updateAnimatable(id obj, POPPropertyAnimationState *anim, bool shoul
     return;
 
   if (anim->hasValue()) {
-    pop_animatable_write_block write = anim->property.writeBlock;
+    POPAnimatablePropertyWriteBlock write = anim->property.writeBlock;
     if (NULL == write)
       return;
 
@@ -191,7 +191,7 @@ static void updateAnimatable(id obj, POPPropertyAnimationState *anim, bool shoul
       // if avoiding extraneous writes and we have a read block defined
       if (shouldAvoidExtraneousWrite) {
 
-        pop_animatable_read_block read = anim->property.readBlock;
+        POPAnimatablePropertyReadBlock read = anim->property.readBlock;
         if (read) {
           // compare current animation value with object value
           Vector4r currentValue = currentVec->vector4r();
@@ -212,7 +212,7 @@ static void updateAnimatable(id obj, POPPropertyAnimationState *anim, bool shoul
         [anim->tracer writePropertyValue:POPBox(currentVec, anim->valueType, true)];
       }
     } else {
-      pop_animatable_read_block read = anim->property.readBlock;
+      POPAnimatablePropertyReadBlock read = anim->property.readBlock;
       NSCAssert(read, @"additive requires an animatable property readBlock");
       if (NULL == read) {
         return;

pop/POPAnimator.mm

@@ -63,3 +63,14 @@ typedef NS_OPTIONS(NSUInteger, POPAnimationClampFlags)
 @property (assign, nonatomic, getter = isAdditive) BOOL additive;
 
 @end
+
+@interface POPPropertyAnimation (CustomProperty)
+
++ (instancetype)animationWithCustomPropertyNamed:(NSString *)name
+                                       readBlock:(POPAnimatablePropertyReadBlock)readBlock
+                                      writeBlock:(POPAnimatablePropertyWriteBlock)writeBlock;
+
++ (instancetype)animationWithCustomPropertyReadBlock:(POPAnimatablePropertyReadBlock)readBlock
+                                          writeBlock:(POPAnimatablePropertyWriteBlock)writeBlock;
+
+@end