Public Types | Public Member Functions | Protected Member Functions | Private Attributes | Friends

sound::Sample Class Reference

Base class for a sound sample. More...

#include <_src_sound_sound_sample.hh>

Inheritance diagram for sound::Sample:
sound::SampleNOP sound::SamplePLIB

List of all members.

Public Types

typedef string Name
 filename

Public Member Functions

const Name GetName (void)
virtual bool IfPlaying (void)=0
virtual bool Play (const defs::ePlayLoop playLoop, const fp volume=sound::defs::DEFAULT_VOLUME)=0
virtual bool Stop (void)=0
virtual bool SetVolume (const fp volume)=0
virtual fp GetVolume (void)=0

Protected Member Functions

 Sample (const Sample::Name &sampleName)
virtual ~Sample ()

Private Attributes

const Name mName
 filename

Friends

class shptr< Sample >

Detailed Description

Base class for a sound sample.

Class design: ------------- See SoundBase.

Notes: ------ Samples don't know if sound is disabled (responsibility of Sound class).

Member Typedef Documentation

typedef string sound::Sample::Name

filename

Constructor & Destructor Documentation

sound::Sample::Sample ( const Sample::Name &  sampleName  )  [inline, protected]
virtual sound::Sample::~Sample (  )  [inline, protected, virtual]

Member Function Documentation

const Name sound::Sample::GetName ( void   )  [inline]
virtual fp sound::Sample::GetVolume ( void   )  [pure virtual]

Implemented in sound::SampleNOP, and sound::SamplePLIB.

virtual bool sound::Sample::IfPlaying ( void   )  [pure virtual]

Implemented in sound::SampleNOP, and sound::SamplePLIB.

virtual bool sound::Sample::Play ( const defs::ePlayLoop  playLoop,
const fp  volume = sound::defs::DEFAULT_VOLUME 
) [pure virtual]

Implemented in sound::SampleNOP, and sound::SamplePLIB.

virtual bool sound::Sample::SetVolume ( const fp  volume  )  [pure virtual]

Implemented in sound::SampleNOP, and sound::SamplePLIB.

virtual bool sound::Sample::Stop ( void   )  [pure virtual]

Implemented in sound::SampleNOP, and sound::SamplePLIB.

Friends And Related Function Documentation

friend class shptr< Sample > [friend]

Member Data Documentation

const Name sound::Sample::mName [private]

filename

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Palomino Flight Simulator documents generated by doxygen 1.7.1 on Tue May 15 2012 22:40:12