Home

nevrax.com

Nevrax.org News Mailing-list Documentation CVS Bugs License

Documentation                       Search   NL3D::CPSSoundInstanceImpl Class Reference This class implement a sound instance (a sound source). More... #include <u_ps_sound_impl.h> Inheritance diagram for NL3D::CPSSoundInstanceImpl: List of all members. Public Methods   CPSSoundInstanceImpl ()   The system will call this method to set the parameters of the sound. More... void  init (NLSOUND::USource *source, CPSSoundServImpl *soundServImp, bool spawned)   init this sound instance parameters. More... virtual void  setSoundParams (float gain, const NLMISC::CVector &pos, const NLMISC::CVector &velocity, float pitch)   change this sound source paramerters. More... virtual void  play (void)   start to play the sound. More... virtual bool  isPlaying (void) const   tells wether the sound is playing. More... virtual void  stop (void)   stop the sound. More... virtual void  release (void)   release the sound source. More... Protected Attributes NLSOUND::USource *  _Source bool  _Spawned CPSSoundServImpl *  _SoundServImpl Friends void  SpawnedSourceEndedCallback (NLSOUND::USource *source, void *userParam)   this callback is called when a spawned source has ended, so that we know that the pointer to it is invalid... More... Detailed Description This class implement a sound instance (a sound source). Definition at line 53 of file u_ps_sound_impl.h. Constructor & Destructor Documentation NL3D::CPSSoundInstanceImpl::CPSSoundInstanceImpl (    )  [inline]   The system will call this method to set the parameters of the sound. Definition at line 59 of file u_ps_sound_impl.h. References _SoundServImpl, _Source, _Spawned, and NL3D_MEM_PS_SOUND. Member Function Documentation void NL3D::CPSSoundInstanceImpl::init (  NLSOUND::USource *    source, CPSSoundServImpl *    soundServImp, bool    spawned )  [inline]   init this sound instance parameters. Definition at line 66 of file u_ps_sound_impl.h. References _SoundServImpl, _Source, _Spawned, NL3D_MEM_PS_SOUND, and nlassert. virtual bool NL3D::CPSSoundInstanceImpl::isPlaying (  void    )  const [inline, virtual]   tells wether the sound is playing. Implements NL3D::UPSSoundInstance. Definition at line 103 of file u_ps_sound_impl.h. References _Source, NLSOUND::USource::isPlaying, and NL3D_MEM_PS_SOUND. virtual void NL3D::CPSSoundInstanceImpl::play (  void    )  [inline, virtual]   start to play the sound. Implements NL3D::UPSSoundInstance. Definition at line 95 of file u_ps_sound_impl.h. References _Source, NL3D_MEM_PS_SOUND, and NLSOUND::USource::play. void NL3D::CPSSoundInstanceImpl::release (  void    )  [virtual]   release the sound source. Implements NL3D::UPSSoundInstance. Definition at line 201 of file u_ps_sound_impl.h. References _SoundServImpl, _Source, _Spawned, and NLSOUND::USource::unregisterSpawnCallBack. virtual void NL3D::CPSSoundInstanceImpl::setSoundParams (  float    gain, const NLMISC::CVector &    pos, const NLMISC::CVector &    velocity, float    pitch )  [inline, virtual]   change this sound source paramerters. Implements NL3D::UPSSoundInstance. Definition at line 76 of file u_ps_sound_impl.h. References _Source, NL3D_MEM_PS_SOUND, NLSOUND::USource::setPitch, NLSOUND::USource::setPos, NLSOUND::USource::setRelativeGain, and NLSOUND::USource::setVelocity. virtual void NL3D::CPSSoundInstanceImpl::stop (  void    )  [inline, virtual]   stop the sound. Implements NL3D::UPSSoundInstance. Definition at line 111 of file u_ps_sound_impl.h. References _Source, NL3D_MEM_PS_SOUND, and NLSOUND::USource::stop. Friends And Related Function Documentation void SpawnedSourceEndedCallback (  NLSOUND::USource *    source, void *    userParam )  [friend]   this callback is called when a spawned source has ended, so that we know that the pointer to it is invalid... Definition at line 193 of file u_ps_sound_impl.h. Member Data Documentation CPSSoundServImpl* NL3D::CPSSoundInstanceImpl::_SoundServImpl [protected]   Definition at line 125 of file u_ps_sound_impl.h. Referenced by CPSSoundInstanceImpl, init, and release. NLSOUND::USource* NL3D::CPSSoundInstanceImpl::_Source [protected]   Definition at line 123 of file u_ps_sound_impl.h. Referenced by CPSSoundInstanceImpl, init, isPlaying, play, release, setSoundParams, and stop. bool NL3D::CPSSoundInstanceImpl::_Spawned [protected]   Definition at line 124 of file u_ps_sound_impl.h. Referenced by CPSSoundInstanceImpl, init, and release. The documentation for this class was generated from the following file: u_ps_sound_impl.h