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