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