BGE Animations: Adding shape actions to BL_Action. This means Shape Actions now work...
[blender.git] / source / gameengine / Ketsji / BL_Action.cpp
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 #include <cstdlib>
31
32 #include "BL_Action.h"
33 #include "BL_ArmatureObject.h"
34 #include "BL_DeformableGameObject.h"
35 #include "BL_ShapeDeformer.h"
36 #include "KX_IpoConvert.h"
37 #include "KX_GameObject.h"
38
39 // These three are for getting the action from the logic manager
40 #include "KX_Scene.h"
41 #include "KX_PythonInit.h"
42 #include "SCA_LogicManager.h"
43
44 extern "C" {
45 #include "BKE_animsys.h"
46 #include "BKE_action.h"
47 #include "RNA_access.h"
48 #include "RNA_define.h"
49 }
50
51 BL_Action::BL_Action(class KX_GameObject* gameobj)
52 :
53         m_obj(gameobj),
54         m_startframe(0.f),
55         m_endframe(0.f),
56         m_blendin(0.f),
57         m_playmode(0),
58         m_endtime(0.f),
59         m_localtime(0.f),
60         m_blendframe(0.f),
61         m_blendstart(0.f),
62         m_speed(0.f),
63         m_ipo_flags(0),
64         m_pose(NULL),
65         m_blendpose(NULL),
66         m_sg_contr(NULL),
67         m_ptrrna(NULL),
68         m_done(true)
69 {
70         if (m_obj->GetGameObjectType() == SCA_IObject::OBJ_ARMATURE)
71         {
72                 BL_ArmatureObject *obj = (BL_ArmatureObject*)m_obj;
73
74                 m_ptrrna = new PointerRNA();
75                 RNA_id_pointer_create(&obj->GetArmatureObject()->id, m_ptrrna);
76         }
77         else
78         {
79                 BL_DeformableGameObject *obj = (BL_DeformableGameObject*)m_obj;
80                 BL_ShapeDeformer *shape_deformer = dynamic_cast<BL_ShapeDeformer*>(obj->GetDeformer());
81
82                 if (shape_deformer)
83                 {
84                         m_ptrrna = new PointerRNA();
85                         RNA_id_pointer_create(&shape_deformer->GetKey()->id, m_ptrrna);
86                 }
87         }
88 }
89
90 BL_Action::~BL_Action()
91 {
92         if (m_pose)
93                 game_free_pose(m_pose);
94         if (m_blendpose)
95                 game_free_pose(m_blendpose);
96         if (m_sg_contr)
97         {
98                 m_obj->GetSGNode()->RemoveSGController(m_sg_contr);
99                 delete m_sg_contr;
100         }
101         if (m_ptrrna)
102                 delete m_ptrrna;
103 }
104
105 void BL_Action::Play(const char* name,
106                                         float start,
107                                         float end,
108                                         float blendin,
109                                         short play_mode,
110                                         short blend_mode,
111                                         short ipo_flags,
112                                         float playback_speed)
113 {
114         bAction* prev_action = m_action;
115
116         // First try to load the action
117         m_action = (bAction*)KX_GetActiveScene()->GetLogicManager()->GetActionByName(name);
118         if (!m_action)
119         {
120                 printf("Failed to load action: %s\n", name);
121                 m_done = true;
122                 return;
123         }
124
125         if (prev_action != m_action)
126         {
127                 // Create an SG_Controller
128                 m_sg_contr = BL_CreateIPO(m_action, m_obj, KX_GetActiveScene()->GetSceneConverter());
129                 m_obj->GetSGNode()->AddSGController(m_sg_contr);
130                 m_sg_contr->SetObject(m_obj->GetSGNode());
131         }
132         
133         m_ipo_flags = ipo_flags;
134         InitIPO();
135
136         // Now that we have an action, we have something we can play
137         m_starttime = KX_GetActiveEngine()->GetFrameTime();
138         m_startframe = m_localtime = start;
139         m_endframe = end;
140         m_blendin = blendin;
141         m_playmode = play_mode;
142         m_endtime = 0.f;
143         m_blendframe = 0.f;
144         m_blendstart = 0.f;
145         m_speed = playback_speed;
146         
147         m_done = false;
148 }
149
150 void BL_Action::Stop()
151 {
152         m_done = true;
153 }
154
155 void BL_Action::InitIPO()
156 {
157                 // Initialize the IPO
158                 m_sg_contr->SetOption(SG_Controller::SG_CONTR_IPO_RESET, true);
159                 m_sg_contr->SetOption(SG_Controller::SG_CONTR_IPO_IPO_AS_FORCE, m_ipo_flags & ACT_IPOFLAG_FORCE);
160                 m_sg_contr->SetOption(SG_Controller::SG_CONTR_IPO_IPO_ADD, m_ipo_flags & ACT_IPOFLAG_ADD);
161                 m_sg_contr->SetOption(SG_Controller::SG_CONTR_IPO_LOCAL, m_ipo_flags & ACT_IPOFLAG_LOCAL);
162 }
163
164 float BL_Action::GetFrame()
165 {
166         return m_localtime;
167 }
168
169 void BL_Action::SetFrame(float frame)
170 {
171         float dt;
172
173         // Clamp the frame to the start and end frame
174         if (frame < min(m_startframe, m_endframe))
175                 frame = min(m_startframe, m_endframe);
176         else if (frame > max(m_startframe, m_endframe))
177                 frame = max(m_startframe, m_endframe);
178
179         // We don't set m_localtime directly since it's recalculated
180         // in the next update. So, we modify the value (m_starttime) 
181         // used to calculate m_localtime the next time SetLocalTime() is called.
182
183         dt = frame-m_startframe;
184
185         if (m_endframe < m_startframe)
186                 dt = -dt;
187
188         m_starttime -= dt / (KX_KetsjiEngine::GetAnimFrameRate()*m_speed);
189 }
190
191 void BL_Action::SetLocalTime(float curtime)
192 {
193         float dt = (curtime-m_starttime)*KX_KetsjiEngine::GetAnimFrameRate()*m_speed;
194
195         if (m_endframe < m_startframe)
196                 dt = -dt;
197
198         m_localtime = m_startframe + dt;
199 }
200
201 void BL_Action::Update(float curtime)
202 {
203         // Don't bother if we're done with the animation
204         if (m_done)
205                 return;
206
207         curtime -= KX_KetsjiEngine::GetSuspendedDelta();
208
209         SetLocalTime(curtime);
210
211         // Handle wrap around
212         if (m_localtime < min(m_startframe, m_endframe) || m_localtime > max(m_startframe, m_endframe))
213         {
214                 switch(m_playmode)
215                 {
216                 case ACT_MODE_PLAY:
217                         // Clamp
218                         m_localtime = m_endframe;
219                         m_done = true;
220                         break;
221                 case ACT_MODE_LOOP:
222                         // Put the time back to the beginning
223                         m_localtime = m_startframe;
224                         m_starttime = curtime;
225                         break;
226                 case ACT_MODE_PING_PONG:
227                         // Swap the start and end frames
228                         float temp = m_startframe;
229                         m_startframe = m_endframe;
230                         m_endframe = temp;
231
232                         m_starttime = curtime;
233
234                         break;
235                 }
236
237                 if (!m_done && m_sg_contr)
238                         InitIPO();
239         }
240
241         if (m_obj->GetGameObjectType() == SCA_IObject::OBJ_ARMATURE)
242         {
243                 BL_ArmatureObject *obj = (BL_ArmatureObject*)m_obj;
244                 obj->GetPose(&m_pose);
245
246                 // Extract the pose from the action
247                 {
248                         Object *arm = obj->GetArmatureObject();
249                         bPose *temp = arm->pose;
250
251                         arm->pose = m_pose;
252                         animsys_evaluate_action(m_ptrrna, m_action, NULL, m_localtime);
253
254                         arm->pose = temp;
255                 }
256
257                 // Handle blending between actions
258                 if (m_blendin && m_blendframe<m_blendin)
259                 {
260                         if (!m_blendpose)
261                         {
262                                 obj->GetMRDPose(&m_blendpose);
263                                 m_blendstart = curtime;
264                         }
265
266                         // Calculate weight
267                         float weight = 1.f - (m_blendframe/m_blendin);
268                         game_blend_poses(m_pose, m_blendpose, weight);
269
270                         // Bump the blend frame
271                         m_blendframe = (curtime - m_blendstart)*KX_KetsjiEngine::GetAnimFrameRate();
272
273                         // Clamp
274                         if (m_blendframe>m_blendin)
275                                 m_blendframe = m_blendin;
276                 }
277
278                 obj->SetPose(m_pose);
279
280                 obj->SetActiveAction(NULL, 0, curtime);
281         }
282         else
283         {
284                 BL_DeformableGameObject *obj = (BL_DeformableGameObject*)m_obj;
285                 BL_ShapeDeformer *shape_deformer = dynamic_cast<BL_ShapeDeformer*>(obj->GetDeformer());
286
287                 // Handle shape actions if we have any
288                 if (shape_deformer)
289                 {
290                         Key *key = shape_deformer->GetKey();
291
292                         // We go through and clear out the keyblocks so there isn't any interference
293                         // from other shape actions
294                         KeyBlock *kb;
295                         for (kb=(KeyBlock*)key->block.first; kb; kb=(KeyBlock*)kb->next)
296                                 kb->curval = 0.f;
297
298                         animsys_evaluate_action(m_ptrrna, m_action, NULL, m_localtime);
299
300                         // XXX TODO handle blendin
301
302                         obj->SetActiveAction(NULL, 0, m_localtime);
303                 }
304
305
306                 InitIPO();
307                 m_obj->UpdateIPO(m_localtime, m_ipo_flags & ACT_IPOFLAG_CHILD);
308         }
309 }