SoundI Class Reference

This class represents a sound. More...

#include "Sound.hpp"

Inheritance diagram for SoundI:

Public Member Functions
virtual bool	Play ()=0
	Plays the sound using the current sound system. More...
virtual void	Stop ()=0
	Stops the sound. More...
virtual void	Pause ()=0
	Pauses the sound. More...
virtual bool	Resume ()=0
	Resumes a previously paused sound. More...
virtual bool	IsPlaying () const =0
	Checks if the sound is currently playing. More...
virtual bool	Is3D () const =0
	Checks if the sound is for 3D playback. More...
virtual void	ResetProperties ()=0
	Resets the sound properties to those of the shader it was created from. More...
virtual void	SetPosition (const Vector3dT &Position_)=0
	Set the position from which the sound is emanating. More...
virtual void	SetVelocity (const Vector3dT &Velocity_)=0
	Sets the velocity of the source that emits the sound. More...
virtual void	SetDirection (const Vector3dT &Direction_)=0
	Sets the direction into which the sound source is moving. More...
virtual void	SetPriority (unsigned int Priority_)=0
	Sets the priority of this sound. More...
virtual void	SetInnerVolume (float InnerVolume_)=0
	Sets the volume. More...
virtual void	SetMinDistance (float MinDist_)=0
	Sets the minimal distance. More...
virtual void	SetMaxDistance (float MaxDist_)=0
	Sets the maximal distance. More...
virtual void	SetInnerConeAngle (float InnerConeAngle_)=0
	Sets the angle of the inner sound cone. More...
virtual void	SetOuterConeAngle (float OuterConeAngle_)=0
	Sets the angle of the outer sound cone. More...
virtual void	SetOuterVolume (float OuterVolume_)=0
	Sets the volume inside the outer sound cone. More...
virtual unsigned int	GetPriority () const =0
	Gets the priority of this sound. More...
virtual float	GetInnerVolume () const =0
	Gets the volume. More...
virtual float	GetMinDistance () const =0
	Gets the minimal distance. More...
virtual float	GetMaxDistance () const =0
	Gets the maximal distance. More...
virtual float	GetInnerConeAngle () const =0
	Gets the angle of the inner sound cone. More...
virtual float	GetOuterConeAngle () const =0
	Sets the angle of the outer sound cone. More...
virtual float	GetOuterVolume () const =0
	Gets the volume inside the outer sound cone. More...
virtual	~SoundI ()
	The virtual destructor makes sure that deleting derived classes via a SoundI pointer works properly. More...

Detailed Description

This class represents a sound.

Sounds are created and destroyed via the appropriate methods in the sound system.

Constructor & Destructor Documentation

virtual SoundI::~SoundI ( )

inlinevirtual

The virtual destructor makes sure that deleting derived classes via a SoundI pointer works properly.

Member Function Documentation

virtual float SoundI::GetInnerConeAngle ( ) const

pure virtual

Gets the angle of the inner sound cone.

Implemented in SoundImplT.

virtual float SoundI::GetInnerVolume ( ) const

pure virtual

Gets the volume.

Implemented in SoundImplT.

virtual float SoundI::GetMaxDistance ( ) const

pure virtual

Gets the maximal distance.

Implemented in SoundImplT.

virtual float SoundI::GetMinDistance ( ) const

pure virtual

Gets the minimal distance.

Implemented in SoundImplT.

virtual float SoundI::GetOuterConeAngle ( ) const

pure virtual

Sets the angle of the outer sound cone.

Implemented in SoundImplT.

virtual float SoundI::GetOuterVolume ( ) const

pure virtual

Gets the volume inside the outer sound cone.

Implemented in SoundImplT.

virtual unsigned int SoundI::GetPriority ( ) const

pure virtual

Gets the priority of this sound.

Implemented in SoundImplT.

virtual bool SoundI::Is3D ( ) const

pure virtual

Checks if the sound is for 3D playback.

Implemented in SoundImplT.

virtual bool SoundI::IsPlaying ( ) const

pure virtual

Checks if the sound is currently playing.

Implemented in SoundImplT.

virtual void SoundI::Pause ( )

pure virtual

Pauses the sound.

Implemented in SoundImplT.

virtual bool SoundI::Play ( )

pure virtual

Plays the sound using the current sound system.

Implemented in SoundImplT.

virtual void SoundI::ResetProperties ( )

pure virtual

Resets the sound properties to those of the shader it was created from.

Implemented in SoundImplT.

virtual bool SoundI::Resume ( )

pure virtual

Resumes a previously paused sound.

Implemented in SoundImplT.

virtual void SoundI::SetDirection ( const Vector3dT &  Direction_ )

pure virtual

Sets the direction into which the sound source is moving.

Implemented in SoundImplT.

virtual void SoundI::SetInnerConeAngle ( float  InnerConeAngle_ )

pure virtual

Sets the angle of the inner sound cone.

Implemented in SoundImplT.

virtual void SoundI::SetInnerVolume ( float  InnerVolume_ )

pure virtual

Sets the volume.

Implemented in SoundImplT.

virtual void SoundI::SetMaxDistance ( float  MaxDist_ )

pure virtual

Sets the maximal distance.

Implemented in SoundImplT.

virtual void SoundI::SetMinDistance ( float  MinDist_ )

pure virtual

Sets the minimal distance.

Implemented in SoundImplT.

virtual void SoundI::SetOuterConeAngle ( float  OuterConeAngle_ )

pure virtual

Sets the angle of the outer sound cone.

Implemented in SoundImplT.

virtual void SoundI::SetOuterVolume ( float  OuterVolume_ )

pure virtual

Sets the volume inside the outer sound cone.

Implemented in SoundImplT.

virtual void SoundI::SetPosition ( const Vector3dT &  Position_ )

pure virtual

Set the position from which the sound is emanating.

Implemented in SoundImplT.

virtual void SoundI::SetPriority ( unsigned int  Priority_ )

pure virtual

Sets the priority of this sound.

Implemented in SoundImplT.

virtual void SoundI::SetVelocity ( const Vector3dT &  Velocity_ )

pure virtual

Sets the velocity of the source that emits the sound.

Implemented in SoundImplT.

virtual void SoundI::Stop ( )

pure virtual

Stops the sound.

Implemented in SoundImplT.

---

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

• Libs/SoundSystem/Sound.hpp