rna polygon access to loop vertex indicies.
[blender-staging.git] / intern / audaspace / FX / AUD_LoopFactory.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * Audaspace is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file audaspace/FX/AUD_LoopFactory.h
28  *  \ingroup audfx
29  */
30
31
32 #ifndef AUD_LOOPFACTORY
33 #define AUD_LOOPFACTORY
34
35 #include "AUD_EffectFactory.h"
36
37 /**
38  * This factory loops another factory.
39  * \note The reader has to be seekable.
40  */
41 class AUD_LoopFactory : public AUD_EffectFactory
42 {
43 private:
44         /**
45          * The loop count.
46          */
47         const int m_loop;
48
49         // hide copy constructor and operator=
50         AUD_LoopFactory(const AUD_LoopFactory&);
51         AUD_LoopFactory& operator=(const AUD_LoopFactory&);
52
53 public:
54         /**
55          * Creates a new loop factory.
56          * \param factory The input factory.
57          * \param loop The desired loop count, negative values result in endless
58          *        looping.
59          */
60         AUD_LoopFactory(AUD_IFactory* factory, int loop = -1);
61
62         /**
63          * Returns the loop count.
64          */
65         int getLoop() const;
66
67         virtual AUD_IReader* createReader() const;
68 };
69
70 #endif //AUD_LOOPFACTORY