Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Sound3DProp Struct Reference

Property class representing all commonly modified run-time sound properties. More...

#include <IAudio.h>

List of all members.

Public Methods

 Sound3DProp ()
void Clear ()

Public Attributes

AUDIOVECTOR m_vPosition
 Represents the sound's current position.

AUDIOVECTOR m_vVelocity
 Represents the sound's current velocity.

AUDIOVECTOR m_vConeOrientation
 Represents the sound's current orientation.

uint32 m_nInsideConeAngle
 Represents the inside angle of the sound cone in degrees. More...

uint32 m_nOutsideConeAngle
 Represents the outside angle of the sound cone in degrees. More...

float m_fConeOutsideVolume
 Volume outside the outer cone angle from AUD_VOLUME_MIN to AUD_VOLUME_MAX.

float m_fMinDistance
 Minimum distance at which a sound begins to attenuate with distance.

float m_fMaxDistance
 Maximum range at which a sound can be heard.

uint32 m_nMode
 Specifies the processing mode for this 3D sound. More...

float m_fVolume
 Set the volume from VOLUME_MIN (0.0) to VOLUME_MAX (1.0).

float m_fPitch
 Sets the target pitch.

uint32 m_nReadCursor
 Sets the position of the read cursor.


Detailed Description

Property class representing all commonly modified run-time sound properties.

This class represents all 3D parameters commonly modified at run-time. They are presented in a common structure to allow the game (or the engine) to retrieve and/or modify all 3D parameters of a sound with a single function call.


Constructor & Destructor Documentation

Sound3DProp::Sound3DProp ( ) [inline]
 

Sound3DProp constructor automatically calls Clear() to initialize the structure.


Member Function Documentation

void Sound3DProp::Clear ( ) [inline]
 

Sets all members either to an appropriate default value if it exists, or else to zero.


Member Data Documentation

uint32 Sound3DProp::m_nInsideConeAngle
 

Represents the inside angle of the sound cone in degrees.

This value is only valid from 0 to 360.

uint32 Sound3DProp::m_nMode
 

Specifies the processing mode for this 3D sound.

See also:
ISound3D::SetMode()

uint32 Sound3DProp::m_nOutsideConeAngle
 

Represents the outside angle of the sound cone in degrees.

This value is only valid from 0 to 360.


The documentation for this struct was generated from the following file:
Generated at Sun Jul 28 23:17:42 2002 for GAP Audio System by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001