ObjectAL
 All Classes Functions Variables Properties Pages
Instance Methods | Class Methods | Properties | List of all members
OALPropertyAction Class Reference
Inheritance diagram for OALPropertyAction:
OALAction

Instance Methods

(id) - initWithDuration:propertyKey:endValue:
 Initialize an action using the default function. More...
 
(id) - initWithDuration:propertyKey:startValue:endValue:
 Initialize an action. More...
 
- Instance Methods inherited from OALAction
(id) - initWithDuration:
 Initialize an action. More...
 
(void) - runWithTarget:
 Run this action on a target. More...
 
(void) - prepareWithTarget:
 Called by runWithTraget to do any final preparations before running. More...
 
(void) - startAction
 Called by runWithTarget to start the action running. More...
 
(void) - updateCompletion:
 Called by OALActionManager to update this action's progress. More...
 
(void) - stopAction
 Stop this action. More...
 

Class Methods

(id) + actionWithDuration:propertyKey:endValue:
 Create a new action using the default function. More...
 
(id) + actionWithDuration:propertyKey:startValue:endValue:
 Create a new action. More...
 
(OALPropertyAction *) + pitchActionWithDuration:endValue:
 
(OALPropertyAction *) + pitchActionWithDuration:startValue:endValue:
 
(OALPropertyAction *) + panActionWithDuration:endValue:
 
(OALPropertyAction *) + panActionWithDuration:startValue:endValue:
 
(OALPropertyAction *) + gainActionWithDuration:endValue:
 
(OALPropertyAction *) + gainActionWithDuration:startValue:endValue:
 

Properties

float startValue
 The value that the property in the target will hold at the start of the action. More...
 
float endValue
 The value that the property in the target will hold at the end of the action. More...
 
- Properties inherited from OALAction
id target
 The target to perform the action on. More...
 
float duration
 The duration of the action, in seconds. More...
 
float elapsed
 The amount of time that has elapsed for this action, in seconds. More...
 
bool running
 If true, the action is currently running. More...
 

Additional Inherited Members

- Protected Attributes inherited from OALAction
bool runningInManager_
 If TRUE, this action is running via OALActionManager. More...
 

Method Documentation

+ (id) actionWithDuration: (float)  duration
propertyKey: (NSString*)  propertyKey
endValue: (float)  endValue 

Create a new action using the default function.

The start value will be the current value of the target this action is applied to.

Parameters
durationThe duration of this action in seconds.
propertyKeyThe property to modify.
endValueThe "ending" value that this action will converge upon when setting the target's property.
Returns
A new action.
+ (id) actionWithDuration: (float)  duration
propertyKey: (NSString*)  propertyKey
startValue: (float)  startValue
endValue: (float)  endValue 

Create a new action.

Parameters
durationThe duration of this action in seconds.
propertyKeyThe property to modify.
startValueThe "starting" value that this action will diverge from when setting the target's property. If NAN, use the current value from the target.
endValueThe "ending" value that this action will converge upon when setting the target's property.
Returns
A new action.
- (id) initWithDuration: (float)  duration
propertyKey: (NSString*)  propertyKey
endValue: (float)  endValue 

Initialize an action using the default function.

The start value will be the current value of the target this action is applied to.

Parameters
durationThe duration of this action in seconds.
propertyKeyThe property to modify.
endValueThe "ending" value that this action will converge upon when setting the target's property.
Returns
The initialized action.
- (id) initWithDuration: (float)  duration
propertyKey: (NSString*)  propertyKey
startValue: (float)  startValue
endValue: (float)  endValue 

Initialize an action.

Parameters
durationThe duration of this action in seconds.
propertyKeyThe property to modify.
startValueThe "starting" value that this action will diverge from when setting the target's property. If NAN, use the current value from the target.
endValueThe "ending" value that this action will converge upon when setting the target's property.
Returns
The initialized action.

Property Documentation

- (float) endValue
readwritenonatomicassign

The value that the property in the target will hold at the end of the action.

- (float) startValue
readwritenonatomicassign

The value that the property in the target will hold at the start of the action.


The documentation for this class was generated from the following files: