From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/a03939.html | 299 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 299 insertions(+) create mode 100644 docs/doxygen/nel/a03939.html (limited to 'docs/doxygen/nel/a03939.html') diff --git a/docs/doxygen/nel/a03939.html b/docs/doxygen/nel/a03939.html new file mode 100644 index 00000000..b34f00b4 --- /dev/null +++ b/docs/doxygen/nel/a03939.html @@ -0,0 +1,299 @@ + + +NeL: NL3D::UPSSoundInstance struct Reference + + + +

NL3D::UPSSoundInstance Struct Reference

#include <u_ps_sound_interface.h> +

Inheritance diagram for NL3D::UPSSoundInstance: +

+ + + +

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 69 of file u_ps_sound_interface.h. + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions
virtual float getPitch () const=0
get pitch

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

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

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

virtual void setLooping (bool looping)=0
virtual void setSoundParams (float gain, const NLMISC::CVector &pos, const NLMISC::CVector &velocity, float frequency)=0
virtual void stop (void)=0
stop the sound

+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
virtual float NL3D::UPSSoundInstance::getPitch ( ) const [pure virtual]
+
+ + + + + +
+ + + +
+get pitch +
+ +
+Implemented in NL3D::CPSSoundInstanceImpl.
+

+ + + + +
+ + + + + + + + + + +
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::setLooping ( bool looping ) [pure virtual]
+
+ + + + + +
+ + + +
+ +
+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:

u_ps_sound_interface.h

Generated on Tue Mar 16 08:48:53 2004 for NeL by + +

+1.3.6

+ + -- cgit v1.2.1


Public Member Functions
virtual float	getPitch () const=0
	get pitch
virtual bool	isPlaying (void) const=0
	tells wether the sound is playing
virtual void	play (void)=0
	start to play the sound
virtual void	release (void)=0
	when this method is called, the sound is not needed anymore by the system
virtual void	setLooping (bool looping)=0
virtual void	setSoundParams (float gain, const NLMISC::CVector &pos, const NLMISC::CVector &velocity, float frequency)=0
virtual void	stop (void)=0
	stop the sound