OALMoveToAction Class Reference

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

#import <OALAudioActions.h>

Inheritance diagram for OALMoveToAction:

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

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

Properties
ALPoint	position
	The position to move the target to. 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 to the specified position over time in 3D space.

Method Documentation

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

Create a new action.

Parameters

duration	The duration of the move.
position	The position to move to.

Returns

A new action.

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

Create a new action.

Parameters

unitsPerSecond	The rate of movement.
position	The position to move to.

Returns

A new action.

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

Initialize an action.

Parameters

duration	The duration of the move.
position	The position to move to.

Returns

The initialized action.

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

Initialize an action.

Parameters

unitsPerSecond	The rate of movement.
position	The position to move to.

Returns

The initialized action.

Member Data Documentation

- (ALPoint) delta

protected

The distance being moved.

- (ALPoint) startPoint

protected

The point this move is starting at.

Property Documentation

- (ALPoint) position

readwritenonatomicassign

The position to move the target to.

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