3D Audio GSoC:
[blender.git] / intern / audaspace / intern / AUD_AnimateableProperty.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/intern/AUD_AnimateableProperty.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_ANIMATEABLEPROPERTY
33 #define AUD_ANIMATEABLEPROPERTY
34
35 #include "AUD_Buffer.h"
36
37 #include <pthread.h>
38
39 /**
40  * This class saves animation data for float properties.
41  */
42 class AUD_AnimateableProperty : private AUD_Buffer
43 {
44 private:
45         /// The count of floats for a single property.
46         const int m_count;
47
48         /// Whether the property is animated or not.
49         bool m_isAnimated;
50
51         /// The mutex for locking.
52         pthread_mutex_t m_mutex;
53
54         /// Whether the property has been changed.
55         bool m_changed;
56
57         // hide copy constructor and operator=
58         AUD_AnimateableProperty(const AUD_AnimateableProperty&);
59         AUD_AnimateableProperty& operator=(const AUD_AnimateableProperty&);
60
61 public:
62         /**
63          * Creates a new animateable property.
64          * \param count The count of floats for a single property.
65          */
66         AUD_AnimateableProperty(int count = 1);
67
68         /**
69          * Destroys the animateable property.
70          */
71         ~AUD_AnimateableProperty();
72
73         /**
74          * Locks the property.
75          */
76         void lock();
77
78         /**
79          * Unlocks the previously locked property.
80          */
81         void unlock();
82
83         void write(const float* data);
84
85         void write(const float* data, int position, int count);
86
87         const float* read(int position) const;
88
89         bool isAnimated() const;
90
91         bool hasChanged();
92 };
93
94 #endif //AUD_ANIMATEABLEPROPERTY