svn merge -r 21041:21301 https://svn.blender.org/svnroot/bf-blender/branches/blender2...
[blender.git] / source / gameengine / Ketsji / KX_CDActuator.h
1 /**
2  * KX_CDActuator.h
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program 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 this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #ifndef __KX_CDACTUATOR
33 #define __KX_CDACTUATOR
34
35 #include "SCA_IActuator.h"
36 #include "SND_CDObject.h"
37
38 class KX_CDActuator : public SCA_IActuator
39 {
40         Py_Header;
41         bool                                    m_lastEvent;
42         bool                                    m_isplaying;
43         /* just some handles to the audio-data... */
44         class SND_Scene*                m_soundscene;
45         int                                             m_track;
46         float                                   m_gain;
47         short                                   m_startFrame;
48         short                                   m_endFrame;
49
50 public:
51         enum KX_CDACT_TYPE
52         {
53                         KX_CDACT_NODEF = 0,
54                         KX_CDACT_PLAY_ALL,
55                         KX_CDACT_PLAY_TRACK,
56                         KX_CDACT_LOOP_TRACK,
57                         KX_CDACT_VOLUME,
58                         KX_CDACT_STOP,
59                         KX_CDACT_PAUSE,
60                         KX_CDACT_RESUME,
61                         KX_SOUNDACT_MAX
62         };
63
64         KX_CDACT_TYPE                   m_type;
65
66         KX_CDActuator(SCA_IObject* gameobject,
67                                   SND_Scene* soundscene,
68                                   KX_CDACT_TYPE type,
69                                   int track,
70                                   short start,
71                                   short end);
72
73         ~KX_CDActuator();
74
75         virtual bool Update();
76
77         CValue* GetReplica();
78
79         /* -------------------------------------------------------------------- */
80         /* Python interface --------------------------------------------------- */
81         /* -------------------------------------------------------------------- */
82
83         // Deprecated ----->
84         KX_PYMETHOD_VARARGS(KX_CDActuator,SetGain);
85         KX_PYMETHOD_VARARGS(KX_CDActuator,GetGain);
86         // <-----
87
88         KX_PYMETHOD_DOC_NOARGS(KX_CDActuator, startCD);
89         KX_PYMETHOD_DOC_NOARGS(KX_CDActuator, pauseCD);
90         KX_PYMETHOD_DOC_NOARGS(KX_CDActuator, resumeCD);
91         KX_PYMETHOD_DOC_NOARGS(KX_CDActuator, stopCD);
92         KX_PYMETHOD_DOC_NOARGS(KX_CDActuator, playAll);
93         KX_PYMETHOD_DOC_O(KX_CDActuator, playTrack);
94
95         static int pyattr_setGain(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
96
97
98 };
99
100 #endif //__KX_CDACTUATOR
101