Audio::SimpleSource Class Reference

#include <SimpleSource.h>

Inheritance diagram for Audio::SimpleSource:

Public Member Functions
virtual	~SimpleSource ()
	SimpleSource (SharedPtr< Sound > sound, bool looping=false) throw ()
void	notifySceneAttached (SimpleScene *scene) throw ()
SimpleScene *	getScene () const throw ()
Public Member Functions inherited from Audio::Source
virtual	~Source ()
LVector3	getPosition () const throw ()
void	setPosition (LVector3 x) throw ()
Vector3	getDirection () const throw ()
void	setDirection (Vector3 x) throw ()
Vector3	getVelocity () const throw ()
void	setVelocity (Vector3 x) throw ()
Range< Scalar >	getAngleRange () const throw ()
void	setAngleRange (Range< Scalar > r) throw ()
Range< Scalar >	getCosAngleRange () const throw ()
void	setCosAngleRange (Range< Scalar > r) throw ()
Scalar	getRadius () const throw ()
void	setRadius (Scalar r) throw ()
PerFrequency< Scalar >	getPerFrequencyRadiusRatios () const throw ()
void	setPerFrequencyRadiusRatios (PerFrequency< Scalar > val) throw ()
PerFrequency< Scalar >	getReferenceFreqs () const throw ()
void	setReferenceFreqs (PerFrequency< Scalar > val) throw ()
Scalar	getGain () const throw ()
void	setGain (Scalar g) throw ()
bool	isLooping () const throw ()
void	setLooping (bool loop) throw ()
bool	isAttenuated () const throw ()
void	setAttenuated (bool attenuated) throw ()
bool	isRelative () const throw ()
void	setRelative (bool relative) throw ()
void	startPlaying (Timestamp start=0) throw (Exception)
void	stopPlaying () throw ()
void	pausePlaying () throw ()
void	continuePlaying () throw (Exception)
bool	isPlaying () const throw ()
bool	isActive () const throw ()
Timestamp	getPlayingTime () const throw ()
Timestamp	getWouldbePlayingTime () const throw ()
SharedPtr< RenderableSource >	getRenderable () const throw ()
void	setRenderable (SharedPtr< RenderableSource > ptr) throw ()
SharedPtr< UserData >	getUserDataPtr () const throw ()
void	setUserDataLong (SharedPtr< UserData > ptr) throw ()
long	getUserDataLong () const throw ()
void	setUserDataLong (long data) throw ()
SharedPtr< SourceListener >	getSourceListener () const throw ()
void	setSourceListener (SharedPtr< SourceListener > ptr) throw ()
SharedPtr< Sound >	getSound () const throw ()
void	setSound (SharedPtr< Sound > ptr) throw ()
void	updateRenderable (int flags, const Listener &sceneListener) throw ()
void	seek (Timestamp time) throw (Exception)
void	_notifyPlaying () throw ()

Protected Member Functions
virtual void	startPlayingImpl (Timestamp start) throw (Exception)
virtual void	stopPlayingImpl () throw (Exception)
virtual bool	isPlayingImpl () const throw (Exception)
Protected Member Functions inherited from Audio::Source
	Source (SharedPtr< Sound > sound, bool looping=false) throw ()
Timestamp	setLastKnownPlayingTime (Timestamp timestamp) throw ()

Additional Inherited Members
Protected Attributes inherited from Audio::Source
LVector3	position
Vector3	direction
Vector3	velocity
Range< Scalar >	cosAngleRange
Scalar	radius
PerFrequency< Scalar >	pfRadiusRatios
PerFrequency< Scalar >	referenceFreqs
Scalar	gain
struct {
int   looping: 1
int   attenuated: 1
int   relative: 1
}	flags
Timestamp	lastKnownPlayingTime
Timestamp	lastKnownPlayingTimeTime
struct {
int   location: 1
int   attributes: 1
int   gain: 1
int   soundPtr: 1
int   soundAttributes: 1
}	dirty

Detailed Description

SimpleSource implementation of the Source interface for the basic SceneManager

Remarks

This implementation merely tracks playing state with a boolean, and notifies the attached scene of any changes. It also keeps track of the scene to which it is attached through a raw pointer, to avoid circular references.

The scene attached must be a SimpleScene derivative, since the scene itself is

responsible for detaching itself when destroyed.

Definition at line 26 of file SimpleSource.h.

Constructor & Destructor Documentation

Audio::SimpleSource::~SimpleSource ( )

virtual

Definition at line 10 of file SimpleSource.cpp.

    {
    }

Audio::SimpleSource::SimpleSource	(	SharedPtr< Sound >	sound,
		bool	looping = false
	)
throw	(
	)

Construct a simple source

Definition at line 14 of file SimpleSource.cpp.

                                                                           :
        Source(sound, looping),
        playing(false),
        scene(0)
    {
    }

Member Function Documentation

SimpleScene * Audio::SimpleSource::getScene	(	)		const
throw	(
	)

Get the scene to which it is attached

Definition at line 26 of file SimpleSource.cpp.

Referenced by stopPlayingImpl().

    {
        return scene;
    }

bool Audio::SimpleSource::isPlayingImpl ( ) const throw ( Exception )

protectedvirtual

See Also

isPlaying.

Implements Audio::Source.

Definition at line 54 of file SimpleSource.cpp.

    {
        return playing;
    }

void Audio::SimpleSource::notifySceneAttached	(	SimpleScene *	scene)
throw	(
	)

Notify attachment to a scene

Definition at line 21 of file SimpleSource.cpp.

    {
        scene = scn;
    }

void Audio::SimpleSource::startPlayingImpl ( Timestamp  start) throw ( Exception )

protectedvirtual

See Also

startPlaying

Parameters

start

The starting position.

Implements Audio::Source.

Definition at line 31 of file SimpleSource.cpp.

References start.

    {
        // If it's playing, must stop and restart - cannot simply play again.
        if (isPlaying())
            stopPlaying();
        
        setLastKnownPlayingTime(start);
        playing = true;
        
        if (getScene())
            getScene()->notifySourcePlaying(shared_from_this(), true);
    }

void Audio::SimpleSource::stopPlayingImpl ( ) throw ( Exception )

protectedvirtual

See Also

stopPlaying.

Implements Audio::Source.

Definition at line 44 of file SimpleSource.cpp.

References getScene(), Audio::Source::isPlaying(), and Audio::SimpleScene::notifySourcePlaying().

    {
        if (isPlaying()) {
            playing = false;
            
            if (getScene())
                getScene()->notifySourcePlaying(shared_from_this(), false);
        }
    }

---

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

• src/audio/SimpleSource.h
• src/audio/SimpleSource.cpp