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/classNL3D_1_1CPSSound.html | 1571 +++++++++++++++++++++++++++ 1 file changed, 1571 insertions(+) create mode 100644 docs/doxygen/nel/classNL3D_1_1CPSSound.html (limited to 'docs/doxygen/nel/classNL3D_1_1CPSSound.html') diff --git a/docs/doxygen/nel/classNL3D_1_1CPSSound.html b/docs/doxygen/nel/classNL3D_1_1CPSSound.html new file mode 100644 index 00000000..a150b894 --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1CPSSound.html @@ -0,0 +1,1571 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +

Home

nevrax.com

+ + + + +

+ + + + + + + + + + +

+ + +

+ Nevrax.org

+ + + + + + + +

	News
	Mailing-list
	Documentation
	CVS
	Bugs
	License

+ + +

+ + + + + + +

Documentation

+ + +Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search +

NL3D::CPSSound Class Reference

This is a goup of sound instances sound instance. +More... +

+#include <ps_sound.h> +

Inheritance diagram for NL3D::CPSSound: +

+ + + + + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods
uint32	getType (void) const
	return this bindable type. More...
virtual uint32	getPriority (void) const
	return priority. More...
virtual void	step (TPSProcessPass pass, TAnimationTime ellapsedTime, TAnimationTime realEt)
	process one pass for the sound. More...
void	setSoundName (const std::string &soundName)
	set the name of the sound. More...
const std::string &	getSoundName (void) const
	get the name of the sound. More...
void	setGain (float gain)
	set a constant gain. Any previous gain scheme is discarded. More...
float	getGain (void) const
	get the current gain. meaningful only if a scheme is not used. More...
void	setGainScheme (CPSAttribMaker< float > *gain)
	Set a gain scheme. More...
CPSAttribMaker< float > *	getGainScheme (void)
	get the current gain scheme. More...
const CPSAttribMaker< float > *	getGainScheme (void) const
	get the current gain scheme (const version). More...
void	setPitch (float pitch)
	set a constant pitch. Any previous pitch scheme is discarded. More...
float	getPitch (void) const
	get the current pitch. meaningful only if a scheme is not used. More...
void	setPitchScheme (CPSAttribMaker< float > *pitch)
	Set a pitch scheme. More...
CPSAttribMaker< float > *	getPitchScheme (void)
	get the current pitch scheme. More...
const CPSAttribMaker< float > *	getPitchScheme (void) const
	get the current pitch scheme (const version). More...
void	setEmissionPercent (float percent)
	set a percent of sound emission. If set to 1, it try to emit all sounds. More...
float	getEmissionPercent (void) const
	get the percent of sound emission. More...
void	setSpawn (bool enabled=true)
	tells wether sound emissions are spawned or not. More...
bool	getSpawn (void) const
	test wether sound spawning is enabled. More...
void	setMute (bool enabled=true)
	set mute on/off. The default is off. WARNING : It is not saved by this object. More...
bool	getMute (void) const
	test wether mute has been activated. More...
void	stopSound ()
void	reactivateSound ()
object
	CPSSound ()
	ctor. More...
	~CPSSound ()
	dtor. More...
virtual void	serial (NLMISC::IStream &f) throw (NLMISC::EStream)
	serialisation. Derivers must override this, and call their parent version. More...
	NLMISC_DECLARE_CLASS (CPSSound)
Protected Methods
virtual void	newElement (CPSLocated *emitterLocated, uint32 emitterIndex)
	Generate a new element for this bindable. More...
virtual void	deleteElement (uint32 index)
	Delete an element given its index Attributes of the located that hold this bindable (pos etc...) are still accessible for the given index. More...
virtual void	resize (uint32 size)
	Resize the bindable attributes containers should not be called directly. More...
void	removeAllSources ()
Protected Attributes
CPSAttrib< UPSSoundInstance * >	_Sounds
std::string	_SoundName
float	_Gain
CPSAttribMaker< float > *	_GainScheme
float	_Pitch
CPSAttribMaker< float > *	_PitchScheme
float	_EmissionPercent
bool	_SpawnSounds
bool	_Mute
bool	_SoundStopped
bool	_SoundReactivated

Detailed Description

+This is a goup of sound instances sound instance. +

+sounds are produced during the motion pass

+Author:: +Nicolas Vizerie , Nevrax France

+Date:: +2001

+ +

+Definition at line 49 of file ps_sound.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
NL3D::CPSSound::CPSSound ( )
+
+ + + + + +
+ + + +
+ctor. +
+ +
+Definition at line 42 of file ps_sound.cpp. +
+References NL3D::CPSLocatedBindable::_Name.
+

+ + + + +
+ + + + + + + + + +
NL3D::CPSSound::~CPSSound ( )
+
+ + + + + +
+ + + +
+dtor. +
+ +
+Definition at line 90 of file ps_sound.cpp. +
+References _GainScheme, _PitchScheme, and removeAllSources.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSSound::deleteElement ( uint32 index ) [protected, virtual]
+
+ + + + + +
+ + + +
+Delete an element given its index Attributes of the located that hold this bindable (pos etc...) are still accessible for the given index. +
+index out of range -> nl_assert +
+Implements NL3D::CPSLocatedBindable. +
+Definition at line 355 of file ps_sound.cpp. +
+References _GainScheme, _PitchScheme, _Sounds, and index. +
+Referenced by removeAllSources.
+

+ + + + +
+ + + + + + + + + + +
float NL3D::CPSSound::getEmissionPercent ( void ) const [inline]
+
+ + + + + +
+ + + +
+get the percent of sound emission. +
+ +
+Definition at line 143 of file ps_sound.h. +
+References _EmissionPercent.
+

+ + + + +
+ + + + + + + + + + +
float NL3D::CPSSound::getGain ( void ) const [inline]
+
+ + + + + +
+ + + +
+get the current gain. meaningful only if a scheme is not used. +
+ +
+Definition at line 92 of file ps_sound.h. +
+References _Gain.
+

+ + + + +
+ + + + + + + + + + +
const CPSAttribMaker<float>* NL3D::CPSSound::getGainScheme ( void ) const [inline]
+
+ + + + + +
+ + + +
+get the current gain scheme (const version). +
+ +
+Definition at line 108 of file ps_sound.h. +
+References _GainScheme.
+

+ + + + +
+ + + + + + + + + + +
CPSAttribMaker<float>* NL3D::CPSSound::getGainScheme ( void ) [inline]
+
+ + + + + +
+ + + +
+get the current gain scheme. +
+ +
+Definition at line 102 of file ps_sound.h. +
+References _GainScheme.
+

+ + + + +
+ + + + + + + + + + +
bool NL3D::CPSSound::getMute ( void ) const [inline]
+
+ + + + + +
+ + + +
+test wether mute has been activated. +
+ +
+Definition at line 155 of file ps_sound.h. +
+References _Mute.
+

+ + + + +
+ + + + + + + + + + +
float NL3D::CPSSound::getPitch ( void ) const [inline]
+
+ + + + + +
+ + + +
+get the current pitch. meaningful only if a scheme is not used. +
+ +
+Definition at line 117 of file ps_sound.h. +
+References _Pitch.
+

+ + + + +
+ + + + + + + + + + +
const CPSAttribMaker<float>* NL3D::CPSSound::getPitchScheme ( void ) const [inline]
+
+ + + + + +
+ + + +
+get the current pitch scheme (const version). +
+ +
+Definition at line 133 of file ps_sound.h. +
+References _PitchScheme.
+

+ + + + +
+ + + + + + + + + + +
CPSAttribMaker<float>* NL3D::CPSSound::getPitchScheme ( void ) [inline]
+
+ + + + + +
+ + + +
+get the current pitch scheme. +
+ +
+Definition at line 127 of file ps_sound.h. +
+References _PitchScheme.
+

+ + + + +
+ + + + + + + + + + +
virtual uint32 NL3D::CPSSound::getPriority ( void ) const [inline, virtual]
+
+ + + + + +
+ + + +
+return priority. +
+ +
+Implements NL3D::CPSLocatedBindable. +
+Definition at line 69 of file ps_sound.h.
+

+ + + + +
+ + + + + + + + + + +
const std::string& NL3D::CPSSound::getSoundName ( void ) const [inline]
+
+ + + + + +
+ + + +
+get the name of the sound. +
+ +
+Definition at line 83 of file ps_sound.h. +
+References _SoundName.
+

+ + + + +
+ + + + + + + + + + +
bool NL3D::CPSSound::getSpawn ( void ) const [inline]
+
+ + + + + +
+ + + +
+test wether sound spawning is enabled. +
+ +
+Definition at line 149 of file ps_sound.h. +
+References _SpawnSounds.
+

+ + + + +
+ + + + + + + + + + +
uint32 NL3D::CPSSound::getType ( void ) const [virtual]
+
+ + + + + +
+ + + +
+return this bindable type. +
+ +
+Implements NL3D::CPSLocatedBindable. +
+Definition at line 97 of file ps_sound.cpp. +
+References NL3D::PSSound.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CPSSound::newElement ( CPSLocated * emitterLocated,
uint32 emitterIndex
) [protected, virtual]
+
+ + + + + +
+ + + +
+Generate a new element for this bindable. +
+They are generated according to the propertie of the class +
+Implements NL3D::CPSLocatedBindable. +
+Definition at line 320 of file ps_sound.cpp. +
+References _EmissionPercent, _GainScheme, _Mute, NL3D::CPSLocatedBindable::_Owner, _PitchScheme, _SoundName, _Sounds, _SoundStopped, _SpawnSounds, NL3D::CPSLocatedBindable::getOwner, NLMISC::CMatrix::Identity, index, and nlassert. +
+Referenced by step.
+

+ + + + +
+ + + + + + + + + + +
NL3D::CPSSound::NLMISC_DECLARE_CLASS ( CPSSound )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + +
void NL3D::CPSSound::reactivateSound ( )
+
+ + + + + +
+ + + +
+ +
+Definition at line 74 of file ps_sound.cpp. +
+References _SoundReactivated.
+

+ + + + +
+ + + + + + + + + +
void NL3D::CPSSound::removeAllSources ( ) [protected]
+
+ + + + + +
+ + + +
+ +
+Definition at line 80 of file ps_sound.cpp. +
+References _Sounds, and deleteElement. +
+Referenced by step, and ~CPSSound.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSSound::resize ( uint32 size ) [protected, virtual]
+
+ + + + + +
+ + + +
+Resize the bindable attributes containers should not be called directly. +
+Call CPSLocated::resize instead +
+Implements NL3D::CPSLocatedBindable. +
+Definition at line 366 of file ps_sound.cpp. +
+References _GainScheme, _PitchScheme, _Sounds, NL3D::CPSLocatedBindable::getOwner, and nlassert.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSSound::serial ( NLMISC::IStream & f ) throw (NLMISC::EStream) [virtual]
+
+ + + + + +
+ + + +
+serialisation. Derivers must override this, and call their parent version. +
+ +
+Reimplemented from NL3D::CPSLocatedBindable. +
+Definition at line 245 of file ps_sound.cpp.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSSound::setEmissionPercent ( float percent ) [inline]
+
+ + + + + +
+ + + +
+set a percent of sound emission. If set to 1, it try to emit all sounds. +
+ +
+Definition at line 139 of file ps_sound.h. +
+References _EmissionPercent.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSSound::setGain ( float gain )
+
+ + + + + +
+ + + +
+set a constant gain. Any previous gain scheme is discarded. +
+ +
+Definition at line 212 of file ps_sound.cpp. +
+References _Gain, and _GainScheme.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSSound::setGainScheme ( CPSAttribMaker< float > * gain )
+
+ + + + + +
+ + + +
+Set a gain scheme. +
+It must have been allocated by new, and is then owned by this object +
+Definition at line 220 of file ps_sound.cpp. +
+References _GainScheme.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSSound::setMute ( bool enabled = true ) [inline]
+
+ + + + + +
+ + + +
+set mute on/off. The default is off. WARNING : It is not saved by this object. +
+ +
+Definition at line 152 of file ps_sound.h. +
+References _Mute.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSSound::setPitch ( float pitch )
+
+ + + + + +
+ + + +
+set a constant pitch. Any previous pitch scheme is discarded. +
+ +
+Definition at line 229 of file ps_sound.cpp. +
+References _Pitch, and _PitchScheme.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSSound::setPitchScheme ( CPSAttribMaker< float > * pitch )
+
+ + + + + +
+ + + +
+Set a pitch scheme. +
+It must have been allocated by new, and is then owned by this object +
+Definition at line 236 of file ps_sound.cpp. +
+References _PitchScheme.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSSound::setSoundName ( const std::string & soundName ) [inline]
+
+ + + + + +
+ + + +
+set the name of the sound. +
+ +
+Definition at line 77 of file ps_sound.h. +
+References _SoundName.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSSound::setSpawn ( bool enabled = true ) [inline]
+
+ + + + + +
+ + + +
+tells wether sound emissions are spawned or not. +
+ +
+Definition at line 146 of file ps_sound.h. +
+References _SpawnSounds.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void NL3D::CPSSound::step ( TPSProcessPass pass,
TAnimationTime ellapsedTime,
TAnimationTime realEt
) [virtual]
+
+ + + + + +
+ + + +
+process one pass for the sound. +
+This is usually done during the motion pass +
+Implements NL3D::CPSLocatedBindable. +
+Definition at line 102 of file ps_sound.cpp. +
+References _Gain, _GainScheme, _Mute, NL3D::CPSLocatedBindable::_Owner, _Pitch, _PitchScheme, _SoundReactivated, _Sounds, _SoundStopped, NL3D::CPSLocatedBindable::getOwner, newElement, nlassert, NL3D::PSMotion, removeAllSources, NL3D::SoundBufSize, NL3D::TAnimationTime, and NL3D::TPSProcessPass.
+

+ + + + +
+ + + + + + + + + +
void NL3D::CPSSound::stopSound ( )
+
+ + + + + +
+ + + +
+ +
+Definition at line 57 of file ps_sound.cpp. +
+References _Sounds, and _SoundStopped.
+

Member Data Documentation

+ + + + +
+ + +
float NL3D::CPSSound::_EmissionPercent [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 173 of file ps_sound.h. +
+Referenced by getEmissionPercent, newElement, and setEmissionPercent.
+

+ + + + +
+ + +
float NL3D::CPSSound::_Gain [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 169 of file ps_sound.h. +
+Referenced by getGain, setGain, and step.
+

+ + + + +
+ + +
CPSAttribMaker<float>* NL3D::CPSSound::_GainScheme [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 170 of file ps_sound.h. +
+Referenced by deleteElement, getGainScheme, newElement, resize, setGain, setGainScheme, step, and ~CPSSound.
+

+ + + + +
+ + +
bool NL3D::CPSSound::_Mute [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 175 of file ps_sound.h. +
+Referenced by getMute, newElement, setMute, and step.
+

+ + + + +
+ + +
float NL3D::CPSSound::_Pitch [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 171 of file ps_sound.h. +
+Referenced by getPitch, setPitch, and step.
+

+ + + + +
+ + +
CPSAttribMaker<float>* NL3D::CPSSound::_PitchScheme [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 172 of file ps_sound.h. +
+Referenced by deleteElement, getPitchScheme, newElement, resize, setPitch, setPitchScheme, step, and ~CPSSound.
+

+ + + + +
+ + +
std::string NL3D::CPSSound::_SoundName [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 168 of file ps_sound.h. +
+Referenced by getSoundName, newElement, and setSoundName.
+

+ + + + +
+ + +
bool NL3D::CPSSound::_SoundReactivated [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 176 of file ps_sound.h. +
+Referenced by reactivateSound, and step.
+

+ + + + +
+ + +
CPSAttrib<UPSSoundInstance *> NL3D::CPSSound::_Sounds [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 167 of file ps_sound.h. +
+Referenced by deleteElement, newElement, removeAllSources, resize, step, and stopSound.
+

+ + + + +
+ + +
bool NL3D::CPSSound::_SoundStopped [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 176 of file ps_sound.h. +
+Referenced by newElement, step, and stopSound.
+

+ + + + +
+ + +
bool NL3D::CPSSound::_SpawnSounds [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 174 of file ps_sound.h. +
+Referenced by getSpawn, newElement, and setSpawn.
+

The documentation for this class was generated from the following files:

+ + + +
+

+ + -- cgit v1.2.1

NL3D::CPSSound Class Reference

Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation