322748ad5717918350034d2f553a852d0b1d7436
[blender.git] / intern / audaspace / intern / AUD_AnimateableProperty.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_AnimateableProperty.h
26  *  \ingroup audaspaceintern
27  */
28
29
30 #ifndef __AUD_ANIMATEABLEPROPERTY_H__
31 #define __AUD_ANIMATEABLEPROPERTY_H__
32
33 #include "AUD_Buffer.h"
34 #include "AUD_ILockable.h"
35
36 #include <pthread.h>
37
38 /**
39  * This class saves animation data for float properties.
40  */
41 class AUD_AnimateableProperty : private AUD_Buffer, public AUD_ILockable
42 {
43 private:
44         /// The count of floats for a single property.
45         const int m_count;
46
47         /// Whether the property is animated or not.
48         bool m_isAnimated;
49
50         /// The mutex for locking.
51         pthread_mutex_t m_mutex;
52
53         // hide copy constructor and operator=
54         AUD_AnimateableProperty(const AUD_AnimateableProperty&);
55         AUD_AnimateableProperty& operator=(const AUD_AnimateableProperty&);
56
57 public:
58         /**
59          * Creates a new animateable property.
60          * \param count The count of floats for a single property.
61          */
62         AUD_AnimateableProperty(int count = 1);
63
64         /**
65          * Destroys the animateable property.
66          */
67         ~AUD_AnimateableProperty();
68
69         /**
70          * Locks the property.
71          */
72         virtual void lock();
73
74         /**
75          * Unlocks the previously locked property.
76          */
77         virtual void unlock();
78
79         /**
80          * Writes the properties value and marks it non-animated.
81          * \param data The new value.
82          */
83         void write(const float* data);
84
85         /**
86          * Writes the properties value and marks it animated.
87          * \param data The new value.
88          * \param position The position in the animation in frames.
89          * \param count The count of frames to write.
90          */
91         void write(const float* data, int position, int count);
92
93         /**
94          * Reads the properties value.
95          * \param position The position in the animation in frames.
96          * \param[out] out Where to write the value to.
97          */
98         void read(float position, float* out);
99
100         /**
101          * Returns whether the property is animated.
102          * \return Whether the property is animated.
103          */
104         bool isAnimated() const;
105 };
106
107 #endif //__AUD_ANIMATEABLEPROPERTY_H__