Audio::Scene Class Reference

#include <Scene.h>

Inheritance diagram for Audio::Scene:

Public Member Functions
virtual	~Scene ()
const std::string &	getName () const throw ()
virtual void	add (SharedPtr< Source > source)=0 throw (Exception)
virtual void	remove (SharedPtr< Source > source)=0 throw (NotFoundException)
virtual Listener &	getListener ()=0 throw ()

Protected Member Functions
	Scene (const std::string &name) throw ()

Detailed Description

Scene abstract class

Remarks

This class represents a scene and the interface to manipulating them. A scene is a collection of sources and ONE listener. The ability to have multiple scenes (active or not) is of great use, so the possibility of a scene manager containing multiple scenes is given.

Implementations of the Scene interface is required for any given

SceneManager. In fact, it is expected that each SceneManager will provide its own Scene implementation. Therefore, a concrete Scene class can be thought of as part of a SceneManager's implementation.

Definition at line 30 of file Scene.h.

Constructor & Destructor Documentation

Audio::Scene::Scene ( const std::string &  name) throw ( )

protected

Internal constructor used by derived classes

Definition at line 10 of file Scene.cpp.

                                             :
        name(nam)
    {
    }

Audio::Scene::~Scene ( )

virtual

Definition at line 15 of file Scene.cpp.

    {
    }

Member Function Documentation

virtual void Audio::Scene::add ( SharedPtr< Source >  source) throw ( Exception )

pure virtual

Attach a source to this scene.

Remarks

The must be stopped. Adding a playing source is an error.

Implemented in Audio::SimpleScene.

virtual Listener& Audio::Scene::getListener ( ) throw ( )

pure virtual

Get the scene's listener

Implemented in Audio::SimpleScene.

const std::string& Audio::Scene::getName ( ) const throw ( )

inline

Definition at line 41 of file Scene.h.

{ return name; }

virtual void Audio::Scene::remove ( SharedPtr< Source >  source) throw ( NotFoundException )

pure virtual

Detach a source from this scene

Remarks

The source is implicitly stopped.

Implemented in Audio::SimpleScene.

---

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

• src/audio/Scene.h
• src/audio/Scene.cpp