BGE patch: add state engine support in the logic bricks.
[blender.git] / source / gameengine / GameLogic / SCA_IActuator.h
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  */
29 #ifndef __KX_IACTUATOR
30 #define __KX_IACTUATOR
31
32 #include "SCA_ILogicBrick.h"
33 #include <vector>
34
35 class SCA_IActuator : public SCA_ILogicBrick
36 {
37         friend class SCA_LogicManager;
38 protected:
39         std::vector<CValue*> m_events;
40         int                                      m_links;       // number of active links to controllers
41                                                                         // when 0, the actuator is automatically stopped
42         void RemoveAllEvents();
43
44 public:
45         /**
46          * This class also inherits the default copy constructors
47          */
48
49         SCA_IActuator(SCA_IObject* gameobj,
50                                   PyTypeObject* T =&Type); 
51
52         /**
53          * UnlinkObject(...)
54          * Certain actuator use gameobject pointers (like TractTo actuator)
55          * This function can be called when an object is removed to make
56          * sure that the actuator will not use it anymore.
57          */
58
59         virtual bool UnlinkObject(SCA_IObject* clientobj) { return false; }
60
61         /**
62          * Update(...)
63          * Update the actuator based upon the events received since 
64          * the last call to Update, the current time and deltatime the
65          * time elapsed in this frame ?
66          * It is the responsibility of concrete Actuators to clear
67          * their event's. This is usually done in the Update() method via 
68          * a call to RemoveAllEvents()
69          */
70
71
72         virtual bool Update(double curtime, bool frame);
73         virtual bool Update();
74
75         /** 
76          * Add an event to an actuator.
77          */ 
78         void AddEvent(CValue* event);
79         virtual void ProcessReplica();
80
81         /** 
82          * Return true iff all the current events 
83          * are negative. The definition of negative event is
84          * not immediately clear. But usually refers to key-up events
85          * or events where no action is required.
86          */
87         bool IsNegativeEvent() const;
88         virtual ~SCA_IActuator();
89
90         void IncLink() { m_links++; }
91         void DecLink();
92         bool IsNoLink() const { return !m_links; }
93 };
94
95 #endif //__KX_IACTUATOR
96