# Home    # nevrax.com   
Nevrax
Nevrax.org
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
Docs
 
Documentation  
Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  

NL3D::UPSSoundInstance Struct Reference

This is an interface between the particle system and a sound instance. More...

#include <u_ps_sound_interface.h>

Inheritance diagram for NL3D::UPSSoundInstance:

NL3D::CPSSoundInstanceImpl List of all members.

Public Methods

virtual void setSoundParams (float gain, const NLMISC::CVector &pos, const NLMISC::CVector &velocity, float frequency)=0
 The system will call this method to set the parameters of the sound Values are clamped. More...

virtual void play (void)=0
 start to play the sound. More...

virtual bool isPlaying (void) const=0
 tells wether the sound is playing. More...

virtual void stop (void)=0
 stop the sound. More...

virtual void release (void)=0
 when this method is called, the sound is not needed anymore by the system. More...


Detailed Description

This is an interface between the particle system and a sound instance.

When the system call 'release' on this interface , the sound must be detroyed. If a sound stop before relese is called, this interface must remains valid, however.

Definition at line 68 of file u_ps_sound_interface.h.


Member Function Documentation

virtual bool NL3D::UPSSoundInstance::isPlaying void    const [pure virtual]
 

tells wether the sound is playing.

Implemented in NL3D::CPSSoundInstanceImpl.

virtual void NL3D::UPSSoundInstance::play void    [pure virtual]
 

start to play the sound.

Implemented in NL3D::CPSSoundInstanceImpl.

virtual void NL3D::UPSSoundInstance::release void    [pure virtual]
 

when this method is called, the sound is not needed anymore by the system.

Implemented in NL3D::CPSSoundInstanceImpl.

virtual void NL3D::UPSSoundInstance::setSoundParams float    gain,
const NLMISC::CVector   pos,
const NLMISC::CVector   velocity,
float    frequency
[pure virtual]
 

The system will call this method to set the parameters of the sound Values are clamped.

Implemented in NL3D::CPSSoundInstanceImpl.

virtual void NL3D::UPSSoundInstance::stop void    [pure virtual]
 

stop the sound.

Implemented in NL3D::CPSSoundInstanceImpl.


The documentation for this struct was generated from the following file: