nw::snd::Sound3DEngine Class

Header file: nw/snd/snd_Sound3DEngine.h

Syntax

class Sound3DEngine : public nw::snd::internal::ISound3DEngine

Description

A parameter calculation engine class for 3D sounds.

Calculates various types of parameters set for sounds, such as volume and pan, from the position information of 3D sound actors and 3D sound listeners, among other information. Standard parameter calculations for 3D sounds are defined in this class.

An initialized instance of this class is registered in 3D Sound Manager.

If you wish to customize the 3D sound engine, you can inherit from this class and create a unique engine class. By registering it with the 3D Sound Manager in Sound3DManager::SetEngine, a customized engine class can be used in place of the default engine class.

Member Constants

protected S UPDATE_VOLUME Flag indicating that a volume calculation using UpdateAmbientParam is required.
protected S UPDATE_PRIORITY Flag indicating that a priority calculation using UpdateAmbientParam is required.
protected S UPDATE_PAN Flag indicating that a pan calculation using UpdateAmbientParam is required.
protected S UPDATE_PITCH Flag indicating that a pitch calculation using UpdateAmbientParam is required.
protected S UPDATE_START_PRIORITY Flag indicating that UpdateAmbientParam has been called to calculate priority before the sound starts.

Member Functions

Constructors/Destructors
Sound3DEngine Constructor.
V ~Sound3DEngine Destructor.
Settings
SetCalcPanParam Sets the parameter structure for pan calculation.
GetCalcPanParam Gets the pan calculation parameter structure that is currently set.
Parameters
protected V UpdateAmbientParam Calculates 3D sound parameters.

Class Hierarchy

nw::snd::internal::ISound3DEngine
  nw::snd::Sound3DEngine

See Also

Sound3DManager Class
Sound3DManager::SetEngine

Revision History

2010/03/12
Initial version.

CONFIDENTIAL