javax.microedition.amms.control.audio3d
Interface MacroscopicControl

All Superinterfaces:
OrientationControl, Control

public interface MacroscopicControl
extends OrientationControl

MacroscopicControl is an interface for manipulating the macroscopic behavior of a sound source when using 3D audio. By default, sound sources act as point sources (having zero size). MacroscopicControl allows the dimensions (width, height and depth) of a sound source to be specified so that it no longer behaves as a point source. This is useful for relatively big sound sources like waterfalls.

This control, if it is supported, can be fetched from a SoundSource3D.

Default Values

The default values for the properties of all macroscopic controls (whether the application has obtained them or not) are: x = 0 y = 0z = 0

See Also:
Control, LocationControl
Since:
BlackBerry API 5.0.0

Method Summary
 int[] getSize()
          Gets the current size.
 void setSize(int x, int y, int z)
          Sets the size of the audio source.
 
Methods inherited from interface javax.microedition.amms.control.audio3d.OrientationControl
getOrientationVectors, setOrientation, setOrientation
 



Method Detail

setSize

void setSize(int x,
             int y,
             int z)
Sets the size of the audio source. Setting all the lengths to zero disables the macroscopic behavior, causing the object to revert once again to being a point source (the default state). All the lengths are specified in millimeters. The center of the macroscopic object stays at the point specified with LocationControl.

NOTE: The lengths are specified in the object's own (rotated) axes, as defined via the OrientationControl by the last call to setOrientation(int heading, int pitch, int roll) or setOrientation(int[] frontVector, int[] aboveVector).

Parameters:
x - the "width" of the sound source in its transformed X (or "right") dimension in millimeters
y - the "height" of the sound source in its transformed Y (or "up") dimension in millimeters
z - the "thickness" or "depth" of the sound source in its transformed Z (or "front") dimension in millimeters
Throws:
IllegalArgumentException - if a negative parameter is given
Since:
BlackBerry API 5.0.0

getSize

int[] getSize()
Gets the current size.

Returns:
the current size in millimeters
Since:
BlackBerry API 5.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.