BGE: bookmark option on controller to make them run before all other controllers.
[blender.git] / source / gameengine / GameLogic / SCA_LogicManager.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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  * Regulates the top-level logic behaviour for one scene.
29  */
30 #include "Value.h"
31 #include "SCA_LogicManager.h"
32 #include "SCA_ISensor.h"
33 #include "SCA_IController.h"
34 #include "SCA_IActuator.h"
35 #include "SCA_EventManager.h"
36 #include "SCA_PythonController.h"
37 #include <set>
38
39 #ifdef HAVE_CONFIG_H
40 #include <config.h>
41 #endif
42
43
44 SCA_LogicManager::SCA_LogicManager()
45 {
46 }
47
48
49
50 SCA_LogicManager::~SCA_LogicManager()
51 {
52         for (vector<SCA_EventManager*>::iterator it = m_eventmanagers.begin();!(it==m_eventmanagers.end());++it)
53         {
54                 delete (*it);
55         }
56         m_eventmanagers.clear();
57         assert(m_activeActuators.Empty());
58 }
59
60 /*
61 // this kind of fixes bug 398 but breakes games, so better leave it out for now.
62 // a removed object's gameobject (and logicbricks and stuff) didn't get released
63 // because it was still in the m_mapStringToGameObjects map.
64 void SCA_LogicManager::RemoveGameObject(const STR_String& gameobjname)
65 {
66         int numgameobj = m_mapStringToGameObjects.size();
67         for (int i = 0; i < numgameobj; i++)
68         {
69                 CValue** gameobjptr = m_mapStringToGameObjects.at(i);
70                 assert(gameobjptr);
71
72                 if (gameobjptr)
73                 {
74                         if ((*gameobjptr)->GetName() == gameobjname)
75                                 (*gameobjptr)->Release();
76                 }
77         }
78
79         m_mapStringToGameObjects.remove(gameobjname);
80 }
81 */
82
83
84 void SCA_LogicManager::RegisterEventManager(SCA_EventManager* eventmgr)
85 {
86         m_eventmanagers.push_back(eventmgr);
87 }
88
89
90
91 void SCA_LogicManager::RegisterGameObjectName(const STR_String& gameobjname,
92                                                                                           CValue* gameobj)
93 {
94         STR_HashedString mn = gameobjname;
95         m_mapStringToGameObjects.insert(mn,gameobj);
96 }
97
98
99
100 void SCA_LogicManager::RegisterGameMeshName(const STR_String& gamemeshname, void* blendobj)
101 {
102         STR_HashedString mn = gamemeshname;
103         m_map_gamemeshname_to_blendobj.insert(mn, blendobj);
104 }
105
106
107
108 void SCA_LogicManager::RegisterGameObj(void* blendobj, CValue* gameobj) 
109 {
110         m_map_blendobj_to_gameobj.insert(CHashedPtr(blendobj), gameobj);
111 }
112
113 void SCA_LogicManager::UnregisterGameObj(void* blendobj, CValue* gameobj) 
114 {
115         void **obp = m_map_blendobj_to_gameobj[CHashedPtr(blendobj)];
116         if (obp && (CValue*)(*obp) == gameobj)
117                 m_map_blendobj_to_gameobj.remove(CHashedPtr(blendobj));
118 }
119
120 CValue* SCA_LogicManager::GetGameObjectByName(const STR_String& gameobjname)
121 {
122         STR_HashedString mn = "OB"+gameobjname;
123         CValue** gameptr = m_mapStringToGameObjects[mn];
124         
125         if (gameptr)
126                 return *gameptr;
127
128         return NULL;
129 }
130
131
132 CValue* SCA_LogicManager::FindGameObjByBlendObj(void* blendobj) 
133 {
134         void **obp= m_map_blendobj_to_gameobj[CHashedPtr(blendobj)];
135         return obp?(CValue*)(*obp):NULL;
136 }
137
138
139
140 void* SCA_LogicManager::FindBlendObjByGameMeshName(const STR_String& gamemeshname) 
141 {
142         STR_HashedString mn = gamemeshname;
143         void **obp= m_map_gamemeshname_to_blendobj[mn];
144         return obp?*obp:NULL;
145 }
146
147
148
149 void SCA_LogicManager::RemoveSensor(SCA_ISensor* sensor)
150 {
151         sensor->UnlinkAllControllers();
152         sensor->UnregisterToManager();
153 }
154
155 void SCA_LogicManager::RemoveController(SCA_IController* controller)
156 {
157         controller->UnlinkAllSensors();
158         controller->UnlinkAllActuators();
159         controller->Deactivate();
160 }
161
162
163 void SCA_LogicManager::RemoveActuator(SCA_IActuator* actuator)
164 {
165         actuator->UnlinkAllControllers();
166         actuator->Deactivate();
167         actuator->SetActive(false);
168 }
169
170
171
172 void SCA_LogicManager::RegisterToSensor(SCA_IController* controller,SCA_ISensor* sensor)
173 {
174         sensor->LinkToController(controller);
175         controller->LinkToSensor(sensor);
176 }
177
178
179
180 void SCA_LogicManager::RegisterToActuator(SCA_IController* controller,SCA_IActuator* actua)
181 {
182         actua->LinkToController(controller);
183         controller->LinkToActuator(actua);
184 }
185
186
187
188 void SCA_LogicManager::BeginFrame(double curtime, double fixedtime)
189 {
190         for (vector<SCA_EventManager*>::const_iterator ie=m_eventmanagers.begin(); !(ie==m_eventmanagers.end()); ie++)
191                 (*ie)->NextFrame(curtime, fixedtime);
192
193         for(SG_QList* obj = (SG_QList*)m_triggeredControllerSet.Remove();
194                 obj != NULL;
195                 obj = (SG_QList*)m_triggeredControllerSet.Remove())
196         {
197                 for(SCA_IController* contr = (SCA_IController*)obj->QRemove();
198                         contr != NULL;
199                         contr = (SCA_IController*)obj->QRemove())
200                 {
201                         contr->Trigger(this);
202                         contr->ClrJustActivated();
203                 }
204         }
205 }
206
207
208
209 void SCA_LogicManager::UpdateFrame(double curtime, bool frame)
210 {
211         for (vector<SCA_EventManager*>::const_iterator ie=m_eventmanagers.begin(); !(ie==m_eventmanagers.end()); ie++)
212                 (*ie)->UpdateFrame();
213
214         SG_DList::iterator<SG_QList> io(m_activeActuators);
215         for (io.begin(); !io.end(); ++io)
216         {
217                 SG_QList::iterator<SCA_IActuator> ia(*(*io));
218                 for (ia.begin(); !ia.end(); ++ia)
219                 {
220                         SCA_IActuator* actua = *ia;
221                         if (!actua->Update(curtime, frame))
222                         {
223                                 // cannot deactive the actuator now as it will disturb the list
224                                 m_removedActuators.AddBack(actua);
225                                 actua->SetActive(false);
226                         } else if (actua->IsNoLink())
227                         {
228                                 // This actuator has no more links but it still active
229                                 // make sure it will get a negative event on next frame to stop it
230                                 // Do this check after Update() rather than before to make sure
231                                 // that all the actuators that are activated at same time than a state
232                                 // actuator have a chance to execute. 
233                                 bool event = false;
234                                 actua->RemoveAllEvents();
235                                 actua->AddEvent(event);
236                         }
237                 }
238         }
239
240         for (SCA_IActuator* act = (SCA_IActuator*)m_removedActuators.Remove();
241                 act != NULL;
242                 act = (SCA_IActuator*)m_removedActuators.Remove())
243         {
244                 act->Deactivate();
245                 act->SetActive(false);
246         }
247 }
248
249
250
251 void* SCA_LogicManager::GetActionByName (const STR_String& actname)
252 {
253         STR_HashedString an = "AC"+actname;
254         void** actptr = m_mapStringToActions[an];
255
256         if (actptr)
257                 return *actptr;
258
259         return NULL;
260 }
261
262
263
264 void* SCA_LogicManager::GetMeshByName(const STR_String& meshname)
265 {
266         STR_HashedString mn = "ME"+meshname;
267         void** meshptr = m_mapStringToMeshes[mn];
268
269         if (meshptr)
270                 return *meshptr;
271
272         return NULL;
273 }
274
275
276
277 void SCA_LogicManager::RegisterMeshName(const STR_String& meshname,void* mesh)
278 {
279         STR_HashedString mn = meshname;
280         m_mapStringToMeshes.insert(mn,mesh);
281 }
282
283
284
285 void SCA_LogicManager::RegisterActionName(const STR_String& actname,void* action)
286 {
287         STR_HashedString an = actname;
288         m_mapStringToActions.insert(an, action);
289 }
290
291
292
293 void SCA_LogicManager::EndFrame()
294 {
295         for (vector<SCA_EventManager*>::const_iterator ie=m_eventmanagers.begin();
296         !(ie==m_eventmanagers.end());ie++)
297         {
298                 (*ie)->EndFrame();
299         }
300 }
301
302
303 void SCA_LogicManager::AddTriggeredController(SCA_IController* controller, SCA_ISensor* sensor)
304 {
305         controller->Activate(m_triggeredControllerSet);
306         // so that the controller knows which sensor has activited it
307         // only needed for python controller
308         if (controller->GetType() == &SCA_PythonController::Type)
309         {
310                 SCA_PythonController* pythonController = (SCA_PythonController*)controller;
311                 pythonController->AddTriggeredSensor(sensor);
312         }
313 }
314
315 SCA_EventManager* SCA_LogicManager::FindEventManager(int eventmgrtype)
316 {
317         // find an eventmanager of a certain type
318         SCA_EventManager* eventmgr = NULL;
319
320         for (vector<SCA_EventManager*>::const_iterator i=
321         m_eventmanagers.begin();!(i==m_eventmanagers.end());i++)
322         {
323                 SCA_EventManager* emgr = *i;
324                 if (emgr->GetType() == eventmgrtype)
325                 {
326                         eventmgr = emgr;
327                         break;
328                 }
329         }
330         return eventmgr;
331 }