PMTweenObjectUpdating Protocol Reference
Conforms to | NSObject |
Declared in | PMTweenObjectUpdater.h |
Overview
The PMTweenObjectUpdating
protocol declares methods that must be adopted by a class in order to be used by PMTween to update values encoded as NSValue objects.
Tasks
-
– replaceObject:newPropertyValue:propertyKeyPath:
required method -
– supportsObject:
required method -
additiveUpdates
property required method
Properties
additiveUpdates
A Boolean which determines whether to update a property value using additive tweening. When the value is YES, values passed in to replaceObject:newPropertyValue:propertyKeyPath
are added to the existing value, instead of replacing it.
@property (nonatomic, assign) BOOL additiveUpdates
Discussion
@remarks The default value is NO.
Declared In
PMTweenObjectUpdater.h
Instance Methods
replaceObject:newPropertyValue:propertyKeyPath:
This method replaces an element of a NSValue object or NSObject subclass by reassigning the parent value.
- (NSObject *)replaceObject:(NSObject *)objectToUpdate newPropertyValue:(double)propertyValue propertyKeyPath:(NSString *)propertyKeyPath
Parameters
- objectToUpdate
The NSValue object that should be updated.
- propertyValue
The value of the NSValue object property to be updated.
- propertyKeyPath
A keyPath of the object’s property.
Return Value
An updated version of the object.
Declared In
PMTweenObjectUpdater.h
supportsObject:
This method verifies whether this class can update the specified object type.
- (BOOL)supportsObject:(NSObject *)object
Parameters
- object
An object to verify support for.
Return Value
A Boolean value representing whether the object is supported by this class.
Declared In
PMTweenObjectUpdater.h