doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Converter / BL_ShapeActionActuator.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_ShapeActionActuator.h
31  *  \ingroup bgeconv
32  */
33
34 #ifndef BL_SHAPEACTIONACTUATOR
35 #define BL_SHAPEACTIONACTUATOR
36
37 #include "GEN_HashedPtr.h"
38 #include "SCA_IActuator.h"
39 #include "BL_ActionActuator.h"
40 #include "MT_Point3.h"
41 #include <vector>
42
43 struct Key;
44 class BL_ShapeActionActuator : public SCA_IActuator  
45 {
46 public:
47         Py_Header;
48         BL_ShapeActionActuator(SCA_IObject* gameobj,
49                                                 const STR_String& propname,
50                                                 const STR_String& framepropname,
51                                                 float starttime,
52                                                 float endtime,
53                                                 struct bAction *action,
54                                                 short   playtype,
55                                                 short   blendin,
56                                                 short   priority,
57                                                 float   stride) 
58                 : SCA_IActuator(gameobj, KX_ACT_SHAPEACTION),
59                 
60                 m_lastpos(0, 0, 0),
61                 m_blendframe(0),
62                 m_flag(0),
63                 m_startframe (starttime),
64                 m_endframe(endtime) ,
65                 m_starttime(0),
66                 m_localtime(starttime),
67                 m_lastUpdate(-1),
68                 m_blendin(blendin),
69                 m_blendstart(0),
70                 m_stridelength(stride),
71                 m_playtype(playtype),
72                 m_priority(priority),
73                 m_action(action),
74                 m_framepropname(framepropname), 
75                 m_propname(propname)
76         {
77         };
78         virtual ~BL_ShapeActionActuator();
79         virtual bool Update(double curtime, bool frame);
80         virtual CValue* GetReplica();
81         virtual void ProcessReplica();
82         
83         void SetBlendTime (float newtime);
84         void BlendShape(struct Key* key, float weigth);
85         
86         bAction*        GetAction() { return m_action; }
87         void            SetAction(bAction* act) { m_action= act; }
88
89 #ifdef WITH_PYTHON
90
91         static PyObject*        pyattr_get_action(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
92         static int                      pyattr_set_action(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
93
94         static int CheckBlendTime(void *self, const PyAttributeDef*)
95         {
96                 BL_ShapeActionActuator* act = reinterpret_cast<BL_ShapeActionActuator*>(self);
97
98                 if (act->m_blendframe > act->m_blendin)
99                         act->m_blendframe = act->m_blendin;
100
101                 return 0;
102         }
103         static int CheckFrame(void *self, const PyAttributeDef*)
104         {
105                 BL_ShapeActionActuator* act = reinterpret_cast<BL_ShapeActionActuator*>(self);
106
107                 if (act->m_localtime < act->m_startframe)
108                         act->m_localtime = act->m_startframe;
109                 else if (act->m_localtime > act->m_endframe)
110                         act->m_localtime = act->m_endframe;
111
112                 return 0;
113         }
114         static int CheckType(void *self, const PyAttributeDef*)
115         {
116                 BL_ShapeActionActuator* act = reinterpret_cast<BL_ShapeActionActuator*>(self);
117
118                 switch (act->m_playtype) {
119                         case ACT_ACTION_PLAY:
120                         case ACT_ACTION_PINGPONG:
121                         case ACT_ACTION_FLIPPER:
122                         case ACT_ACTION_LOOP_STOP:
123                         case ACT_ACTION_LOOP_END:
124                         case ACT_ACTION_FROM_PROP:
125                                 return 0;
126                         default:
127                                 PyErr_SetString(PyExc_ValueError, "Shape Action Actuator, invalid play type supplied");
128                                 return 1;
129                 }
130
131         }
132
133 #endif // WITH_PYTHON
134
135 protected:
136
137         void SetStartTime(float curtime);
138         void SetLocalTime(float curtime);
139         bool ClampLocalTime();
140
141         MT_Point3       m_lastpos;
142         float   m_blendframe;
143         int             m_flag;
144         /** The frame this action starts */
145         float   m_startframe;
146         /** The frame this action ends */
147         float   m_endframe;
148         /** The time this action started */
149         float   m_starttime;
150         /** The current time of the action */
151         float   m_localtime;
152         
153         float   m_lastUpdate;
154         float   m_blendin;
155         float   m_blendstart;
156         float   m_stridelength;
157         short   m_playtype;
158         short   m_priority;
159         struct bAction *m_action;
160         STR_String      m_framepropname;
161         STR_String      m_propname;
162         vector<float> m_blendshape;
163 };
164
165 #endif
166