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