ObjectAL
 All Classes Functions Variables Properties Pages
Instance Methods | Class Methods | Protected Attributes | List of all members
OALEaseAction Class Reference

Applies an easing function to another action. More...

#import <OALAction.h>

Inheritance diagram for OALEaseAction:
OALAction

Instance Methods

(id) - initWithShape:phase:action:
 Initialize an ease 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

(OALEaseAction *) + actionWithShape:phase:action:
 Create a new ease action. More...
 
(EaseFunctionPtr) + easeFunctionForShape:phase:
 Get a pointer to an ease function of the specified shape and phase. More...
 

Protected Attributes

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

Additional Inherited Members

- 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...
 

Detailed Description

Applies an easing function to another action.

Normally, an action progresses at a linear rate. An ease changes that to a curve.

Method Documentation

+ (OALEaseAction *) actionWithShape: (OALEaseShape)  shape
phase: (OALEasePhase)  phase
action: (OALAction*)  action 

Create a new ease action.

Parameters
shapeThe shape of the curve to apply.
phaseWhat phase of the action to apply the curve to. The action to apple the curve to.
Returns
A new action.
+ (EaseFunctionPtr) easeFunctionForShape: (OALEaseShape)  shape
phase: (OALEasePhase)  phase 

Get a pointer to an ease function of the specified shape and phase.

Parameters
shapeThe shape of the curve to apply.
phaseWhat phase of the action to apply the curve to.
Returns
a pointer to the appropriate function.
- (id) initWithShape: (OALEaseShape)  shape
phase: (OALEasePhase)  phase
action: (OALAction*)  action 

Initialize an ease action.

Parameters
shapeThe shape of the curve to apply.
phaseWhat phase of the action to apply the curve to. The action to apple the curve to.
Returns
The initialized action.

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