BGE animations: This is an attempt to help smooth out some more compatibility issues...
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /** \file BL_ActionActuator.h
31  *  \ingroup bgeconv
32  */
33
34 #ifndef BL_ACTIONACTUATOR
35 #define BL_ACTIONACTUATOR
36
37 #include "CTR_HashedPtr.h"
38 #include "SCA_IActuator.h"
39 #include "DNA_actuator_types.h"
40 #include "MT_Point3.h"
41
42 class BL_ActionActuator : public SCA_IActuator  
43 {
44 public:
45         Py_Header;
46         BL_ActionActuator(SCA_IObject* gameobj,
47                                                 const STR_String& propname,
48                                                 const STR_String& framepropname,
49                                                 float starttime,
50                                                 float endtime,
51                                                 struct bAction *action,
52                                                 short   playtype,
53                                                 short   blendin,
54                                                 short   priority,
55                                                 short   layer,
56                                                 float   layer_weight,
57                                                 short   ipo_flags,
58                                                 short   end_reset,
59                                                 float   stride);
60
61         virtual ~BL_ActionActuator();
62         virtual bool Update(double curtime, bool frame);
63         virtual CValue* GetReplica();
64         virtual void ProcessReplica();
65         
66         void SetBlendTime (float newtime);
67         void SetLocalTime (float curtime);
68         void ResetStartTime (float curtime);
69         
70         bAction*        GetAction() { return m_action; }
71         void            SetAction(bAction* act) { m_action= act; }
72
73 #ifdef WITH_PYTHON
74
75         KX_PYMETHOD_O(BL_ActionActuator,GetChannel);
76         KX_PYMETHOD_DOC(BL_ActionActuator,setChannel);
77
78         static PyObject*        pyattr_get_action(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
79         static int                      pyattr_set_action(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
80         static PyObject*        pyattr_get_channel_names(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
81         static PyObject*        pyattr_get_use_continue(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
82         static int                      pyattr_set_use_continue(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
83         static PyObject*        pyattr_get_frame(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
84         static int                      pyattr_set_frame(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
85
86         static int CheckBlendTime(void *self, const PyAttributeDef*)
87         {
88                 BL_ActionActuator* act = reinterpret_cast<BL_ActionActuator*>(self);
89
90                 if (act->m_blendframe > act->m_blendin)
91                         act->m_blendframe = act->m_blendin;
92
93                 return 0;
94         }
95
96         static int CheckType(void *self, const PyAttributeDef*)
97         {
98                 BL_ActionActuator* act = reinterpret_cast<BL_ActionActuator*>(self);
99
100                 switch (act->m_playtype) {
101                         case ACT_ACTION_PLAY:
102                         case ACT_ACTION_PINGPONG:
103                         case ACT_ACTION_FLIPPER:
104                         case ACT_ACTION_LOOP_STOP:
105                         case ACT_ACTION_LOOP_END:
106                         case ACT_ACTION_FROM_PROP:
107                                 return 0;
108                         default:
109                                 PyErr_SetString(PyExc_ValueError, "Action Actuator, invalid play type supplied");
110                                 return 1;
111                 }
112         }
113 #endif // WITH_PYTHON
114         
115 protected:
116         MT_Point3       m_lastpos;
117         float   m_blendframe;
118         int             m_flag;
119         /** The frame this action starts */
120         float   m_startframe;
121         /** The frame this action ends */
122         float   m_endframe;
123         /** The time this action started */
124         float   m_starttime;
125         /** The current time of the action */
126         float   m_localtime;
127         
128         float   m_lastUpdate;
129         float   m_blendin;
130         float   m_blendstart;
131         float   m_stridelength;
132         float   m_layer_weight;
133         short   m_playtype;
134         short   m_priority;
135         short   m_layer;
136         short   m_ipo_flags;
137         struct bPose* m_pose;
138         struct bPose* m_blendpose;
139         struct bPose* m_userpose;
140         struct bAction *m_action;
141         STR_String      m_propname;
142         STR_String      m_framepropname;
143 };
144
145 // Not all of these values are used in BL_ActionActuator anymore,
146 // but BL_ShapeActionActuator still uses them, so we keep them around
147 // for now.
148 enum {
149         ACT_FLAG_REVERSE        = 1<<0,
150         ACT_FLAG_LOCKINPUT      = 1<<1,
151         ACT_FLAG_KEYUP          = 1<<2,
152         ACT_FLAG_ACTIVE         = 1<<3,
153         ACT_FLAG_CONTINUE       = 1<<4,
154         ACT_FLAG_PLAY_END       = 1<<5,
155         ACT_FLAG_ATTEMPT_PLAY = 1<<6,
156 };
157
158 #endif
159