OALMoveByAction Class Reference

Moves the target from its current position by the specified delta over time in 3D space. More...

#import <OALAudioActions.h>

Inheritance diagram for OALMoveByAction:

Instance Methods
(id)	- initWithDuration:delta:
	Initialize an action. More...
(id)	- initWithUnitsPerSecond:delta:
	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:delta:
	Create a new action. More...
(id)	+ actionWithUnitsPerSecond:delta:
	Create a new action. More...

Protected Attributes
ALPoint	startPoint
	The point this move is starting at. More...
Protected Attributes inherited from OALAction
bool	runningInManager_
	If TRUE, this action is running via OALActionManager. More...

Properties
ALPoint	delta
	The amount to move the target by. More...
float	unitsPerSecond
	The speed at which to move the target. 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...

Detailed Description

Moves the target from its current position by the specified delta over time in 3D space.

Method Documentation

+ (id) actionWithDuration:		(float)	duration
delta:		(ALPoint)	delta

Create a new action.

Parameters

duration	The duration of the move.
delta	The amount to move by.

Returns

A new action.

+ (id) actionWithUnitsPerSecond:		(float)	unitsPerSecond
delta:		(ALPoint)	delta

Create a new action.

Parameters

unitsPerSecond	The rate of movement.
delta	The amount to move by.

Returns

A new action.

- (id) initWithDuration:		(float)	duration
delta:		(ALPoint)	delta

Initialize an action.

Parameters

duration	The duration of the move.
delta	The amount to move by.

Returns

The initialized action.

- (id) initWithUnitsPerSecond:		(float)	unitsPerSecond
delta:		(ALPoint)	delta

Initialize an action.

Parameters

unitsPerSecond	The rate of movement.
delta	The amount to move by.

Returns

The initialized action.

Member Data Documentation

- (ALPoint) startPoint

protected

The point this move is starting at.

Property Documentation

- (ALPoint) delta

readwritenonatomicassign

The amount to move the target by.

- (float) unitsPerSecond

readwritenonatomicassign

The speed at which to move the target.

If this is 0, the target will be moved at the speed determined by duration.

---

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

• OALAudioActions.h
• OALAudioActions.m