AMMix3DControl Class Reference

Allows to control the 3D mix parameters. More...

#import <AMMix3DControl.h>

Inheritance diagram for AMMix3DControl:

AMControl

List of all members.

Public Member Functions

(void) - applySettingsToInstance:
 Apply the 3D parameters to the given audio object instance.

Properties

AMVec3 position
 The 3D location of the sound source.
BOOL autoDoppler
 Automatically calculate the velocity based on the location changes of the sound source if enabled.
int autoDopplerFactor
 The factor used when automatic Doppler is enabled.
AMVec3 orientation
 The orientation of the sound source, set by a 3D vector.
AMVec3 velocity
 The sound source velocity, used for the Doppler effect if enabled.
BOOL dopplerEnabled
 Enables or not the Doppler effect.
AMVec3 directivity
 The directivity of the sound source.
int occlusionHFLevel
int occlusionLevel
int rolloffMinDist
int rolloffMaxDist
int rolloffFactor
 The attenuation factor between the min.
BOOL muteAfterMax
 Sets if the sound source must be muted after the max.


Detailed Description

Allows to control the 3D mix parameters.

Member Function Documentation

- (void) applySettingsToInstance: (id)  _instance  

Apply the 3D parameters to the given audio object instance.

Parameters:
instance A CueInstance or SoundInstance object on which you want to apply these 3D parameters.


Property Documentation

- (int) autoDopplerFactor [read, write, assign]

The factor used when automatic Doppler is enabled.

Value 0 means that the velocity will always be 0.

- (BOOL) muteAfterMax [read, write, assign]

Sets if the sound source must be muted after the max.

distance.

- (int) rolloffFactor [read, write, assign]

The attenuation factor between the min.

distance and the max. distance.


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

Generated on Mon May 16 16:29:48 2011 for ARIA by  doxygen 1.5.9