Transform: Replace t->imval w/ t->mouse.imval
[blender.git] / source / gameengine / Ketsji / BL_Action.cpp
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Mitchell Stokes.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file BL_Action.cpp
24  *  \ingroup ketsji
25  */
26
27 #include <cstdlib>
28 #include <stdio.h>
29
30 #include "BL_Action.h"
31 #include "BL_ArmatureObject.h"
32 #include "BL_DeformableGameObject.h"
33 #include "BL_ShapeDeformer.h"
34 #include "KX_IpoConvert.h"
35 #include "KX_GameObject.h"
36
37 #include "SG_Controller.h"
38
39 // These three are for getting the action from the logic manager
40 #include "KX_Scene.h"
41 #include "SCA_LogicManager.h"
42
43 extern "C" {
44 #include "BKE_animsys.h"
45 #include "BKE_action.h"
46 #include "RNA_access.h"
47 #include "RNA_define.h"
48
49 // Needed for material IPOs
50 #include "BKE_material.h"
51 #include "DNA_material_types.h"
52 #include "DNA_scene_types.h"
53 }
54
55 #include "MEM_guardedalloc.h"
56 #include "BKE_library.h"
57 #include "BKE_global.h"
58
59 #include "BLI_threads.h" // for lock
60
61 /* Lock to solve animation thread issues.
62  * A spin lock is better than a mutex in case of short wait 
63  * because spin lock stop the thread by a loop contrary to mutex
64  * which switch all memory, process.
65  */ 
66 static SpinLock BL_ActionLock;
67
68 BL_Action::BL_Action(class KX_GameObject* gameobj)
69 :
70         m_action(NULL),
71         m_tmpaction(NULL),
72         m_blendpose(NULL),
73         m_blendinpose(NULL),
74         m_obj(gameobj),
75         m_startframe(0.f),
76         m_endframe(0.f),
77         m_localframe(0.f),
78         m_blendin(0.f),
79         m_blendframe(0.f),
80         m_blendstart(0.f),
81         m_speed(0.f),
82         m_priority(0),
83         m_playmode(ACT_MODE_PLAY),
84         m_blendmode(ACT_BLEND_BLEND),
85         m_ipo_flags(0),
86         m_done(true),
87         m_calc_localtime(true)
88 {
89 }
90
91 BL_Action::~BL_Action()
92 {
93         if (m_blendpose)
94                 BKE_pose_free(m_blendpose);
95         if (m_blendinpose)
96                 BKE_pose_free(m_blendinpose);
97         ClearControllerList();
98
99         if (m_tmpaction) {
100                 BKE_libblock_free(G.main, m_tmpaction);
101                 m_tmpaction = NULL;
102         }
103 }
104
105 void BL_Action::ClearControllerList()
106 {
107         // Clear out the controller list
108         std::vector<SG_Controller*>::iterator it;
109         for (it = m_sg_contr_list.begin(); it != m_sg_contr_list.end(); it++)
110         {
111                 m_obj->GetSGNode()->RemoveSGController((*it));
112                 delete *it;
113         }
114
115         m_sg_contr_list.clear();
116 }
117
118 bool BL_Action::Play(const char* name,
119                                         float start,
120                                         float end,
121                                         short priority,
122                                         float blendin,
123                                         short play_mode,
124                                         float layer_weight,
125                                         short ipo_flags,
126                                         float playback_speed,
127                                         short blend_mode)
128 {
129
130         // Only start playing a new action if we're done, or if
131         // the new action has a higher priority
132         if (!IsDone() && priority > m_priority)
133                 return false;
134         m_priority = priority;
135         bAction* prev_action = m_action;
136
137         KX_Scene* kxscene = m_obj->GetScene();
138
139         // First try to load the action
140         m_action = (bAction*)kxscene->GetLogicManager()->GetActionByName(name);
141         if (!m_action)
142         {
143                 printf("Failed to load action: %s\n", name);
144                 m_done = true;
145                 return false;
146         }
147
148         // If we have the same settings, don't play again
149         // This is to resolve potential issues with pulses on sensors such as the ones
150         // reported in bug #29412. The fix is here so it works for both logic bricks and Python.
151         // However, this may eventually lead to issues where a user wants to override an already
152         // playing action with the same action and settings. If this becomes an issue,
153         // then this fix may have to be re-evaluated.
154         if (!IsDone() && m_action == prev_action && m_startframe == start && m_endframe == end
155                         && m_priority == priority && m_speed == playback_speed)
156                 return false;
157
158         // Keep a copy of the action for threading purposes
159         if (m_tmpaction) {
160                 BKE_libblock_free(G.main, m_tmpaction);
161                 m_tmpaction = NULL;
162         }
163         m_tmpaction = BKE_action_copy(m_action);
164
165         // First get rid of any old controllers
166         ClearControllerList();
167
168         // Create an SG_Controller
169         SG_Controller *sg_contr = BL_CreateIPO(m_action, m_obj, kxscene->GetSceneConverter());
170         m_sg_contr_list.push_back(sg_contr);
171         m_obj->GetSGNode()->AddSGController(sg_contr);
172         sg_contr->SetObject(m_obj->GetSGNode());
173
174         // World
175         sg_contr = BL_CreateWorldIPO(m_action, kxscene->GetBlenderScene()->world, kxscene->GetSceneConverter());
176         if (sg_contr) {
177                 m_sg_contr_list.push_back(sg_contr);
178                 m_obj->GetSGNode()->AddSGController(sg_contr);
179                 sg_contr->SetObject(m_obj->GetSGNode());
180         }
181
182         // Try obcolor
183         sg_contr = BL_CreateObColorIPO(m_action, m_obj, kxscene->GetSceneConverter());
184         if (sg_contr) {
185                 m_sg_contr_list.push_back(sg_contr);
186                 m_obj->GetSGNode()->AddSGController(sg_contr);
187                 sg_contr->SetObject(m_obj->GetSGNode());
188         }
189
190         // Now try materials
191         if (m_obj->GetBlenderObject()->totcol==1) {
192                 Material *mat = give_current_material(m_obj->GetBlenderObject(), 1);
193                 if (mat) {
194                         sg_contr = BL_CreateMaterialIpo(m_action, mat, 0, m_obj, kxscene->GetSceneConverter());
195                         if (sg_contr) {
196                                 m_sg_contr_list.push_back(sg_contr);
197                                 m_obj->GetSGNode()->AddSGController(sg_contr);
198                                 sg_contr->SetObject(m_obj->GetSGNode());
199                         }
200                 }
201         } else {
202                 Material *mat;
203                 STR_HashedString matname;
204
205                 for (int matidx = 1; matidx <= m_obj->GetBlenderObject()->totcol; ++matidx) {
206                         mat = give_current_material(m_obj->GetBlenderObject(), matidx);
207                         if (mat) {
208                                 matname = mat->id.name;
209                                 sg_contr = BL_CreateMaterialIpo(m_action, mat, matname.hash(), m_obj, kxscene->GetSceneConverter());
210                                 if (sg_contr) {
211                                         m_sg_contr_list.push_back(sg_contr);
212                                         m_obj->GetSGNode()->AddSGController(sg_contr);
213                                         sg_contr->SetObject(m_obj->GetSGNode());
214                                 }
215                         }
216                 }
217         }
218
219         // Extra controllers
220         if (m_obj->GetGameObjectType() == SCA_IObject::OBJ_LIGHT)
221         {
222                 sg_contr = BL_CreateLampIPO(m_action, m_obj, kxscene->GetSceneConverter());
223                 m_sg_contr_list.push_back(sg_contr);
224                 m_obj->GetSGNode()->AddSGController(sg_contr);
225                 sg_contr->SetObject(m_obj->GetSGNode());
226         }
227         else if (m_obj->GetGameObjectType() == SCA_IObject::OBJ_CAMERA)
228         {
229                 sg_contr = BL_CreateCameraIPO(m_action, m_obj, kxscene->GetSceneConverter());
230                 m_sg_contr_list.push_back(sg_contr);
231                 m_obj->GetSGNode()->AddSGController(sg_contr);
232                 sg_contr->SetObject(m_obj->GetSGNode());
233         }
234         
235         m_ipo_flags = ipo_flags;
236         InitIPO();
237
238         // Setup blendin shapes/poses
239         if (m_obj->GetGameObjectType() == SCA_IObject::OBJ_ARMATURE)
240         {
241                 BL_ArmatureObject *obj = (BL_ArmatureObject*)m_obj;
242                 obj->GetPose(&m_blendinpose);
243         }
244         else
245         {
246                 BL_DeformableGameObject *obj = (BL_DeformableGameObject*)m_obj;
247                 BL_ShapeDeformer *shape_deformer = dynamic_cast<BL_ShapeDeformer*>(obj->GetDeformer());
248                 
249                 if (shape_deformer && shape_deformer->GetKey())
250                 {
251                         obj->GetShape(m_blendinshape);
252
253                         // Now that we have the previous blend shape saved, we can clear out the key to avoid any
254                         // further interference.
255                         KeyBlock *kb;
256                         for (kb=(KeyBlock *)shape_deformer->GetKey()->block.first; kb; kb=(KeyBlock *)kb->next)
257                                 kb->curval = 0.f;
258                 }
259         }
260
261         // Now that we have an action, we have something we can play
262         m_starttime = -1.f; // We get the start time on our first update
263         m_startframe = m_localframe = start;
264         m_endframe = end;
265         m_blendin = blendin;
266         m_playmode = play_mode;
267         m_blendmode = blend_mode;
268         m_blendframe = 0.f;
269         m_blendstart = 0.f;
270         m_speed = playback_speed;
271         m_layer_weight = layer_weight;
272         
273         m_done = false;
274
275         return true;
276 }
277
278 bool BL_Action::IsDone()
279 {
280         return m_done;
281 }
282
283 void BL_Action::InitIPO()
284 {
285         // Initialize the IPOs
286         std::vector<SG_Controller*>::iterator it;
287         for (it = m_sg_contr_list.begin(); it != m_sg_contr_list.end(); it++)
288         {
289                 (*it)->SetOption(SG_Controller::SG_CONTR_IPO_RESET, true);
290                 (*it)->SetOption(SG_Controller::SG_CONTR_IPO_IPO_AS_FORCE, m_ipo_flags & ACT_IPOFLAG_FORCE);
291                 (*it)->SetOption(SG_Controller::SG_CONTR_IPO_IPO_ADD, m_ipo_flags & ACT_IPOFLAG_ADD);
292                 (*it)->SetOption(SG_Controller::SG_CONTR_IPO_LOCAL, m_ipo_flags & ACT_IPOFLAG_LOCAL);
293         }
294 }
295
296 bAction *BL_Action::GetAction()
297 {
298         return (IsDone()) ? NULL : m_action;
299 }
300
301 float BL_Action::GetFrame()
302 {
303         return m_localframe;
304 }
305
306 const char *BL_Action::GetName()
307 {
308         if (m_action != NULL) {
309                 return m_action->id.name + 2;
310         }
311         else {
312                 return "";
313         }
314
315                     
316 }
317
318 void BL_Action::SetFrame(float frame)
319 {
320         // Clamp the frame to the start and end frame
321         if (frame < min(m_startframe, m_endframe))
322                 frame = min(m_startframe, m_endframe);
323         else if (frame > max(m_startframe, m_endframe))
324                 frame = max(m_startframe, m_endframe);
325         
326         m_localframe = frame;
327         m_calc_localtime = false;
328 }
329
330 void BL_Action::SetPlayMode(short play_mode)
331 {
332         m_playmode = play_mode;
333 }
334
335 void BL_Action::SetTimes(float start, float end)
336 {
337         m_startframe = start;
338         m_endframe = end;
339 }
340
341 void BL_Action::SetLocalTime(float curtime)
342 {
343         float dt = (curtime-m_starttime)*KX_KetsjiEngine::GetAnimFrameRate()*m_speed;
344
345         if (m_endframe < m_startframe)
346                 dt = -dt;
347
348         m_localframe = m_startframe + dt;
349 }
350
351 void BL_Action::ResetStartTime(float curtime)
352 {
353         float dt = (m_localframe > m_startframe) ? m_localframe - m_startframe : m_startframe - m_localframe;
354
355         m_starttime = curtime - dt / (KX_KetsjiEngine::GetAnimFrameRate()*m_speed);
356         SetLocalTime(curtime);
357 }
358
359 void BL_Action::IncrementBlending(float curtime)
360 {
361         // Setup m_blendstart if we need to
362         if (m_blendstart == 0.f)
363                 m_blendstart = curtime;
364         
365         // Bump the blend frame
366         m_blendframe = (curtime - m_blendstart)*KX_KetsjiEngine::GetAnimFrameRate();
367
368         // Clamp
369         if (m_blendframe>m_blendin)
370                 m_blendframe = m_blendin;
371 }
372
373
374 void BL_Action::BlendShape(Key* key, float srcweight, std::vector<float>& blendshape)
375 {
376         vector<float>::const_iterator it;
377         float dstweight;
378         KeyBlock *kb;
379         
380         dstweight = 1.0F - srcweight;
381         //printf("Dst: %f\tSrc: %f\n", srcweight, dstweight);
382         for (it=blendshape.begin(), kb = (KeyBlock *)key->block.first; 
383              kb && it != blendshape.end();
384              kb = (KeyBlock *)kb->next, it++)
385         {
386                 //printf("OirgKeys: %f\t%f\n", kb->curval, (*it));
387                 kb->curval = kb->curval * dstweight + (*it) * srcweight;
388                 //printf("NewKey: %f\n", kb->curval);
389         }
390         //printf("\n");
391 }
392
393 void BL_Action::Update(float curtime)
394 {
395         // Don't bother if we're done with the animation
396         if (m_done)
397                 return;
398
399         curtime -= KX_KetsjiEngine::GetSuspendedDelta();
400
401         // Grab the start time here so we don't end up with a negative m_localframe when
402         // suspending and resuming scenes.
403         if (m_starttime < 0)
404                 m_starttime = curtime;
405
406         if (m_calc_localtime)
407                 SetLocalTime(curtime);
408         else
409         {
410                 ResetStartTime(curtime);
411                 m_calc_localtime = true;
412         }
413
414         // Handle wrap around
415         if (m_localframe < min(m_startframe, m_endframe) || m_localframe > max(m_startframe, m_endframe)) {
416                 switch (m_playmode) {
417                         case ACT_MODE_PLAY:
418                                 // Clamp
419                                 m_localframe = m_endframe;
420                                 m_done = true;
421                                 break;
422                         case ACT_MODE_LOOP:
423                                 // Put the time back to the beginning
424                                 m_localframe = m_startframe;
425                                 m_starttime = curtime;
426                                 break;
427                         case ACT_MODE_PING_PONG:
428                                 // Swap the start and end frames
429                                 float temp = m_startframe;
430                                 m_startframe = m_endframe;
431                                 m_endframe = temp;
432
433                                 m_starttime = curtime;
434
435                                 break;
436                 }
437         }
438
439         if (m_obj->GetGameObjectType() == SCA_IObject::OBJ_ARMATURE)
440         {
441                 BL_ArmatureObject *obj = (BL_ArmatureObject*)m_obj;
442
443                 if (m_layer_weight >= 0)
444                         obj->GetPose(&m_blendpose);
445
446                 // Extract the pose from the action
447                 obj->SetPoseByAction(m_tmpaction, m_localframe);
448
449                 // Handle blending between armature actions
450                 if (m_blendin && m_blendframe<m_blendin)
451                 {
452                         IncrementBlending(curtime);
453
454                         // Calculate weight
455                         float weight = 1.f - (m_blendframe/m_blendin);
456
457                         // Blend the poses
458                         obj->BlendInPose(m_blendinpose, weight, ACT_BLEND_BLEND);
459                 }
460
461
462                 // Handle layer blending
463                 if (m_layer_weight >= 0)
464                         obj->BlendInPose(m_blendpose, m_layer_weight, m_blendmode);
465
466                 obj->UpdateTimestep(curtime);
467         }
468         else
469         {
470                 BL_DeformableGameObject *obj = (BL_DeformableGameObject*)m_obj;
471                 BL_ShapeDeformer *shape_deformer = dynamic_cast<BL_ShapeDeformer*>(obj->GetDeformer());
472
473                 // Handle shape actions if we have any
474                 if (shape_deformer && shape_deformer->GetKey())
475                 {
476                         Key *key = shape_deformer->GetKey();
477
478                         PointerRNA ptrrna;
479                         RNA_id_pointer_create(&key->id, &ptrrna);
480
481                         animsys_evaluate_action(&ptrrna, m_tmpaction, NULL, m_localframe);
482
483                         // Handle blending between shape actions
484                         if (m_blendin && m_blendframe < m_blendin)
485                         {
486                                 IncrementBlending(curtime);
487
488                                 float weight = 1.f - (m_blendframe/m_blendin);
489
490                                 // We go through and clear out the keyblocks so there isn't any interference
491                                 // from other shape actions
492                                 KeyBlock *kb;
493                                 for (kb=(KeyBlock *)key->block.first; kb; kb=(KeyBlock *)kb->next)
494                                         kb->curval = 0.f;
495
496                                 // Now blend the shape
497                                 BlendShape(key, weight, m_blendinshape);
498                         }
499
500                         // Handle layer blending
501                         if (m_layer_weight >= 0)
502                         {
503                                 obj->GetShape(m_blendshape);
504                                 BlendShape(key, m_layer_weight, m_blendshape);
505                         }
506
507                         obj->SetActiveAction(NULL, 0, curtime);
508                 }
509         }
510
511         BLI_spin_lock(&BL_ActionLock);
512         /* This function is not thread safe because of recursive scene graph transform
513          * updates on children. e.g: If an object and one of its children is animated,
514          * the both can write transform at the same time. A thread lock avoid problems. */
515         m_obj->UpdateIPO(m_localframe, m_ipo_flags & ACT_IPOFLAG_CHILD);
516         BLI_spin_unlock(&BL_ActionLock);
517
518         if (m_done)
519                 ClearControllerList();
520 }
521
522 void BL_Action::InitLock()
523 {
524         BLI_spin_init(&BL_ActionLock);
525 }
526
527 void BL_Action::EndLock()
528 {
529         BLI_spin_end(&BL_ActionLock);
530 }