OALAction Class Reference

Represents an action that can be performed on an object. More...

#import <OALAction.h>

Inheritance diagram for OALAction:

Instance Methods
(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...

Protected Attributes
bool	runningInManager_
	If TRUE, this action is running via OALActionManager. More...

Properties
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

Represents an action that can be performed on an object.

Method Documentation

- (id) initWithDuration:

(float)

duration

Initialize an action.

Parameters

duration

The duration of this action in seconds.

Returns

The initialized action.

- (void) prepareWithTarget:

(id)

target

Called by runWithTraget to do any final preparations before running.

Subclasses must ensure that duration is valid when this method returns.

Parameters

target

The target to run the action on.

- (void) runWithTarget:

(id)

target

Run this action on a target.

Parameters

target

The target to run the action on.

- (void) startAction

Called by runWithTarget to start the action running.

- (void) stopAction

Stop this action.

- (void) updateCompletion:

(float)

proportionComplete

Called by OALActionManager to update this action's progress.

Parameters

proportionComplete

The proportion of this action's duration that has elapsed.

Member Data Documentation

- (bool) runningInManager_

protected

If TRUE, this action is running via OALActionManager.

Property Documentation

- (float) duration

readnonatomicassign

The duration of the action, in seconds.

- (float) elapsed

readwritenonatomicassign

The amount of time that has elapsed for this action, in seconds.

- (bool) running

readnonatomicassign

If true, the action is currently running.

- (id) target

readnonatomicassign

The target to perform the action on.

WEAK REFERENCE.

---

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

• OALAction.h
• OALAction.m