BGE API cleanup: action actuator.
[blender.git] / source / gameengine / Converter / BL_ActionActuator.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BL_ACTIONACTUATOR
31 #define BL_ACTIONACTUATOR
32
33 #include "GEN_HashedPtr.h"
34 #include "SCA_IActuator.h"
35 #include "MT_Point3.h"
36
37 class BL_ActionActuator : public SCA_IActuator  
38 {
39 public:
40         Py_Header;
41         BL_ActionActuator(SCA_IObject* gameobj,
42                                                 const STR_String& propname,
43                                                 const STR_String& framepropname,
44                                                 float starttime,
45                                                 float endtime,
46                                                 struct bAction *action,
47                                                 short   playtype,
48                                                 short   blendin,
49                                                 short   priority,
50                                                 short   end_reset,
51                                                 float   stride,
52                                                 PyTypeObject* T=&Type) 
53                 : SCA_IActuator(gameobj,T),
54                 
55                 m_lastpos(0, 0, 0),
56                 m_blendframe(0),
57                 m_flag(0),
58                 m_startframe (starttime),
59                 m_endframe(endtime) ,
60                 m_starttime(0),
61                 m_localtime(starttime),
62                 m_lastUpdate(-1),
63                 m_blendin(blendin),
64                 m_blendstart(0),
65                 m_stridelength(stride),
66                 m_playtype(playtype),
67                 m_priority(priority),
68                 m_end_reset(end_reset),
69                 m_pose(NULL),
70                 m_blendpose(NULL),
71                 m_userpose(NULL),
72                 m_action(action),
73                 m_propname(propname),
74                 m_framepropname(framepropname)          
75         {
76         };
77         virtual ~BL_ActionActuator();
78         virtual bool Update(double curtime, bool frame);
79         virtual CValue* GetReplica();
80         virtual void ProcessReplica();
81         
82         void SetBlendTime (float newtime);
83
84         //Deprecated ----->
85         KX_PYMETHOD_DOC(BL_ActionActuator,SetAction);
86         KX_PYMETHOD_DOC(BL_ActionActuator,SetBlendin);
87         KX_PYMETHOD_DOC(BL_ActionActuator,SetPriority);
88         KX_PYMETHOD_DOC(BL_ActionActuator,SetStart);
89         KX_PYMETHOD_DOC(BL_ActionActuator,SetEnd);
90         KX_PYMETHOD_DOC(BL_ActionActuator,SetFrame);
91         KX_PYMETHOD_DOC(BL_ActionActuator,SetProperty);
92         KX_PYMETHOD_DOC(BL_ActionActuator,SetFrameProperty);
93         KX_PYMETHOD_DOC(BL_ActionActuator,SetBlendtime);
94
95         KX_PYMETHOD_DOC(BL_ActionActuator,GetAction);
96         KX_PYMETHOD_DOC(BL_ActionActuator,GetBlendin);
97         KX_PYMETHOD_DOC(BL_ActionActuator,GetPriority);
98         KX_PYMETHOD_DOC(BL_ActionActuator,GetStart);
99         KX_PYMETHOD_DOC(BL_ActionActuator,GetEnd);
100         KX_PYMETHOD_DOC(BL_ActionActuator,GetFrame);
101         KX_PYMETHOD_DOC(BL_ActionActuator,GetProperty);
102         KX_PYMETHOD_DOC(BL_ActionActuator,GetFrameProperty);
103 //      KX_PYMETHOD(BL_ActionActuator,GetChannel);
104         KX_PYMETHOD_DOC(BL_ActionActuator,GetType);
105         KX_PYMETHOD_DOC(BL_ActionActuator,SetType);
106         KX_PYMETHOD_NOARGS(BL_ActionActuator,GetContinue);
107         KX_PYMETHOD_O(BL_ActionActuator,SetContinue);
108         //<-----
109
110         KX_PYMETHOD_DOC(BL_ActionActuator,setChannel);
111
112         virtual PyObject* _getattr(const STR_String& attr);
113         virtual int _setattr(const STR_String& attr, PyObject* value);
114
115         enum ActionActType
116         {
117                 KX_ACT_ACTION_PLAY = 0,
118                 KX_ACT_ACTION_FLIPPER = 2,
119                 KX_ACT_ACTION_LOOPSTOP,
120                 KX_ACT_ACTION_LOOPEND,
121                 KX_ACT_ACTION_PROPERTY = 6
122         };
123
124         /* attribute check */
125         static int CheckFrame(void *self, const PyAttributeDef*)
126         {
127                 BL_ActionActuator* act = reinterpret_cast<BL_ActionActuator*>(self);
128
129                 if (act->m_localtime < act->m_startframe)
130                         act->m_localtime = act->m_startframe;
131                 else if (act->m_localtime > act->m_endframe)
132                         act->m_localtime = act->m_endframe;
133
134                 return 0;
135         }
136
137         static int CheckBlendTime(void *self, const PyAttributeDef*)
138         {
139                 BL_ActionActuator* act = reinterpret_cast<BL_ActionActuator*>(self);
140
141                 if (act->m_blendframe < act->m_blendin)
142                         act->m_blendframe = act->m_blendin;
143
144                 return 0;
145         }
146
147         static int CheckType(void *self, const PyAttributeDef*)
148         {
149                 BL_ActionActuator* act = reinterpret_cast<BL_ActionActuator*>(self);
150
151                 switch (act->m_playtype) {
152                         case KX_ACT_ACTION_PLAY:
153                         case KX_ACT_ACTION_FLIPPER:
154                         case KX_ACT_ACTION_LOOPSTOP:
155                         case KX_ACT_ACTION_LOOPEND:
156                         case KX_ACT_ACTION_PROPERTY:
157                                 return 0;
158                         default:
159                                 PyErr_SetString(PyExc_ValueError, "invalid type supplied");
160                                 return 1;
161                 }
162
163         }
164 protected:
165
166         void SetStartTime(float curtime);
167         void SetLocalTime(float curtime);
168         bool ClampLocalTime();
169
170         MT_Point3       m_lastpos;
171         float   m_blendframe;
172         int             m_flag;
173         /** The frame this action starts */
174         float   m_startframe;
175         /** The frame this action ends */
176         float   m_endframe;
177         /** The time this action started */
178         float   m_starttime;
179         /** The current time of the action */
180         float   m_localtime;
181         
182         float   m_lastUpdate;
183         float   m_blendin;
184         float   m_blendstart;
185         float   m_stridelength;
186         short   m_playtype;
187         short   m_priority;
188         bool    m_end_reset;
189         struct bPose* m_pose;
190         struct bPose* m_blendpose;
191         struct bPose* m_userpose;
192         struct bAction *m_action;
193         STR_String      m_propname;
194         STR_String      m_framepropname;
195 };
196
197 enum {
198         ACT_FLAG_REVERSE        = 0x00000001,
199         ACT_FLAG_LOCKINPUT      = 0x00000002,
200         ACT_FLAG_KEYUP          = 0x00000004,
201         ACT_FLAG_ACTIVE         = 0x00000008
202 };
203
204 #endif
205