Audaspace:
[blender.git] / intern / audaspace / intern / AUD_IFactory.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * Copyright 2009-2011 Jörg Hermann Müller
5  *
6  * This file is part of AudaSpace.
7  *
8  * Audaspace is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * AudaSpace is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with Audaspace; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file audaspace/intern/AUD_IFactory.h
26  *  \ingroup audaspaceintern
27  */
28
29
30 #ifndef __AUD_IFACTORY_H__
31 #define __AUD_IFACTORY_H__
32
33 #include "AUD_Space.h"
34 #include "AUD_IReader.h"
35
36 #include <boost/shared_ptr.hpp>
37
38 /**
39  * This class represents a type of sound source and saves the necessary values
40  * for it. It is able to create a reader that is actually usable for playback
41  * of the respective sound source through the factory method createReader.
42  */
43 class AUD_IFactory
44 {
45 public:
46         /**
47          * Destroys the factory.
48          */
49         virtual ~AUD_IFactory() {}
50
51         /**
52          * Creates a reader for playback of the sound source.
53          * \return A pointer to an AUD_IReader object or NULL if there has been an
54          *         error.
55          * \exception AUD_Exception An exception may be thrown if there has been
56          *            a more unexpected error during reader creation.
57          */
58         virtual boost::shared_ptr<AUD_IReader> createReader()=0;
59 };
60
61 #endif //__AUD_IFACTORY_H__