nw::snd::Sound3DActor Classclass Sound3DActor :
public nw::snd::SoundActor,
public nw::snd::internal::BasicSound::AmbientArgUpdateCallback
A 3D sound actor class used to represent an audio source within a 3D space.
A single actor can simultaneously manage multiple sounds.
During the time an actor instance exists, the nw::snd::Sound3DManager class calculates and sets the sound's parameters, based on the position information set in the actor. If the instance of an actor ceases to exist, sound playback for that actor will continue, but the 3D parameters are no longer updated.
| S |
ACTOR_PLAYER_COUNT
|
const int |
The number of actor players that are retained.(Inherited from SoundArchive.) |
|---|
| Constructors/Destructors | ||
|---|---|---|
| Sound3DActor | Constructor. | |
| V | ~Sound3DActor | Destructor. |
| Initialization | ||
Initialize
|
Initializes the 3D sound actor. | |
| Finalize | Destroys the 3D sound actor. | |
| Sets or gets position and velocity. | ||
| SetPosition | This function sets actor position information. | |
| GetPosition | This function gets actor position information. | |
| ResetPosition | Resets actor position information. | |
| SetVelocity | This function sets an actor's velocity. | |
| GetVelocity | Gets the actor's velocity. | |
| Setting, Getting Parameters | ||
| SetUserParam | Sets the user parameter for an actor. | |
| GetUserParam | Gets the actor's user parameter. | |
| SetVolume | Changes the volume of the actor.(Inherited from SoundArchive.) |
|
GetVolume
|
Gets the volume set for the actor.(Inherited from SoundArchive.) |
|
| SetPitch | Changes the pitch of the actor.(Inherited from SoundArchive.) |
|
GetPitch
|
Gets the pitch set for the actor.(Inherited from SoundArchive.) |
|
| SetPan | Changes the pan (left/right orientation) of the actor.(Inherited from SoundArchive.) |
|
| GetPan | Gets the pan set for the actor.(Inherited from SoundArchive.) |
|
GetPlayingSoundCount
|
Returns the number of sounds currently playing in the actor player.(Inherited from SoundArchive.) |
|
SetPlayableSoundCount
|
Sets the number of sounds that are simultaneously playable.(Inherited from SoundArchive.) |
|
GetPlayableSoundCount
|
Gets the number of sounds that can be simultaneously played by the actor player.(Inherited from SoundArchive.) |
|
| Play | ||
| StopAllSound | Stops all sounds currently playing on the actor.(Inherited from SoundArchive.) |
|
| PauseAllSound | Pauses or restarts all sounds that the actor is currently playing.(Inherited from SoundArchive.) |
|
StartSound
|
Plays the sound having the specified ID.(Inherited from SoundStartable. |
|
HoldSound
|
Plays or continues the sound with the specified ID.(Inherited from SoundStartable. |
|
PrepareSound
|
Prepares to play the sound with the specified ID.(Inherited from SoundStartable. |
|
| Other | ||
| ForEachSound | Performs processing for all sounds that the actor is currently playing.(Inherited from SoundArchive.) |
|
| protected V |
SetupSound
|
Virtual function called when a sound is played. |
nw::snd::SoundStartable
nw::snd::SoundActor
nw::snd::Sound3DActor
Sound3DManager Class
CONFIDENTIAL