BGE API cleanup: shape 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 "DNA_actuator_types.h"
36 #include "MT_Point3.h"
37
38 class BL_ActionActuator : public SCA_IActuator  
39 {
40 public:
41         Py_Header;
42         BL_ActionActuator(SCA_IObject* gameobj,
43                                                 const STR_String& propname,
44                                                 const STR_String& framepropname,
45                                                 float starttime,
46                                                 float endtime,
47                                                 struct bAction *action,
48                                                 short   playtype,
49                                                 short   blendin,
50                                                 short   priority,
51                                                 short   end_reset,
52                                                 float   stride,
53                                                 PyTypeObject* T=&Type) 
54                 : SCA_IActuator(gameobj,T),
55                 
56                 m_lastpos(0, 0, 0),
57                 m_blendframe(0),
58                 m_flag(0),
59                 m_startframe (starttime),
60                 m_endframe(endtime) ,
61                 m_starttime(0),
62                 m_localtime(starttime),
63                 m_lastUpdate(-1),
64                 m_blendin(blendin),
65                 m_blendstart(0),
66                 m_stridelength(stride),
67                 m_playtype(playtype),
68                 m_priority(priority),
69                 m_end_reset(end_reset),
70                 m_pose(NULL),
71                 m_blendpose(NULL),
72                 m_userpose(NULL),
73                 m_action(action),
74                 m_propname(propname),
75                 m_framepropname(framepropname)          
76         {
77         };
78         virtual ~BL_ActionActuator();
79         virtual bool Update(double curtime, bool frame);
80         virtual CValue* GetReplica();
81         virtual void ProcessReplica();
82         
83         void SetBlendTime (float newtime);
84
85         //Deprecated ----->
86         KX_PYMETHOD_DOC(BL_ActionActuator,SetAction);
87         KX_PYMETHOD_DOC(BL_ActionActuator,SetBlendin);
88         KX_PYMETHOD_DOC(BL_ActionActuator,SetPriority);
89         KX_PYMETHOD_DOC(BL_ActionActuator,SetStart);
90         KX_PYMETHOD_DOC(BL_ActionActuator,SetEnd);
91         KX_PYMETHOD_DOC(BL_ActionActuator,SetFrame);
92         KX_PYMETHOD_DOC(BL_ActionActuator,SetProperty);
93         KX_PYMETHOD_DOC(BL_ActionActuator,SetFrameProperty);
94         KX_PYMETHOD_DOC(BL_ActionActuator,SetBlendtime);
95
96         KX_PYMETHOD_DOC(BL_ActionActuator,GetAction);
97         KX_PYMETHOD_DOC(BL_ActionActuator,GetBlendin);
98         KX_PYMETHOD_DOC(BL_ActionActuator,GetPriority);
99         KX_PYMETHOD_DOC(BL_ActionActuator,GetStart);
100         KX_PYMETHOD_DOC(BL_ActionActuator,GetEnd);
101         KX_PYMETHOD_DOC(BL_ActionActuator,GetFrame);
102         KX_PYMETHOD_DOC(BL_ActionActuator,GetProperty);
103         KX_PYMETHOD_DOC(BL_ActionActuator,GetFrameProperty);
104 //      KX_PYMETHOD(BL_ActionActuator,GetChannel);
105         KX_PYMETHOD_DOC(BL_ActionActuator,GetType);
106         KX_PYMETHOD_DOC(BL_ActionActuator,SetType);
107         KX_PYMETHOD_NOARGS(BL_ActionActuator,GetContinue);
108         KX_PYMETHOD_O(BL_ActionActuator,SetContinue);
109         //<-----
110
111         KX_PYMETHOD_DOC(BL_ActionActuator,setChannel);
112
113         virtual PyObject* _getattr(const STR_String& attr);
114         virtual int _setattr(const STR_String& attr, PyObject* value);
115
116         /* attribute check */
117         static int CheckFrame(void *self, const PyAttributeDef*)
118         {
119                 BL_ActionActuator* act = reinterpret_cast<BL_ActionActuator*>(self);
120
121                 if (act->m_localtime < act->m_startframe)
122                         act->m_localtime = act->m_startframe;
123                 else if (act->m_localtime > act->m_endframe)
124                         act->m_localtime = act->m_endframe;
125
126                 return 0;
127         }
128
129         static int CheckBlendTime(void *self, const PyAttributeDef*)
130         {
131                 BL_ActionActuator* act = reinterpret_cast<BL_ActionActuator*>(self);
132
133                 if (act->m_blendframe > act->m_blendin)
134                         act->m_blendframe = act->m_blendin;
135
136                 return 0;
137         }
138
139         static int CheckType(void *self, const PyAttributeDef*)
140         {
141                 BL_ActionActuator* act = reinterpret_cast<BL_ActionActuator*>(self);
142
143                 switch (act->m_playtype) {
144                         case ACT_ACTION_PLAY:
145                         case ACT_ACTION_FLIPPER:
146                         case ACT_ACTION_LOOP_STOP:
147                         case ACT_ACTION_LOOP_END:
148                         case ACT_ACTION_FROM_PROP:
149                                 return 0;
150                         default:
151                                 PyErr_SetString(PyExc_ValueError, "invalid type supplied");
152                                 return 1;
153                 }
154
155         }
156 protected:
157
158         void SetStartTime(float curtime);
159         void SetLocalTime(float curtime);
160         bool ClampLocalTime();
161
162         MT_Point3       m_lastpos;
163         float   m_blendframe;
164         int             m_flag;
165         /** The frame this action starts */
166         float   m_startframe;
167         /** The frame this action ends */
168         float   m_endframe;
169         /** The time this action started */
170         float   m_starttime;
171         /** The current time of the action */
172         float   m_localtime;
173         
174         float   m_lastUpdate;
175         float   m_blendin;
176         float   m_blendstart;
177         float   m_stridelength;
178         short   m_playtype;
179         short   m_priority;
180         bool    m_end_reset;
181         struct bPose* m_pose;
182         struct bPose* m_blendpose;
183         struct bPose* m_userpose;
184         struct bAction *m_action;
185         STR_String      m_propname;
186         STR_String      m_framepropname;
187 };
188
189 enum {
190         ACT_FLAG_REVERSE        = 0x00000001,
191         ACT_FLAG_LOCKINPUT      = 0x00000002,
192         ACT_FLAG_KEYUP          = 0x00000004,
193         ACT_FLAG_ACTIVE         = 0x00000008
194 };
195
196 #endif
197