b802aa4b298924621101ca41e30b5dacee318295
[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 protected:
38         std::vector<CValue*> m_events;
39         void RemoveAllEvents();
40
41 public:
42         /**
43          * This class also inherits the default copy constructors
44          */
45
46         SCA_IActuator(SCA_IObject* gameobj,
47                                   PyTypeObject* T =&Type); 
48
49         /**
50          * UnlinkObject(...)
51          * Certain actuator use gameobject pointers (like TractTo actuator)
52          * This function can be called when an object is removed to make
53          * sure that the actuator will not use it anymore.
54          */
55
56         virtual bool UnlinkObject(SCA_IObject* clientobj) { return false; }
57
58         /**
59          * Update(...)
60          * Update the actuator based upon the events received since 
61          * the last call to Update, the current time and deltatime the
62          * time elapsed in this frame ?
63          * It is the responsibility of concrete Actuators to clear
64          * their event's. This is usually done in the Update() method via 
65          * a call to RemoveAllEvents()
66          */
67
68
69         virtual bool Update(double curtime, bool frame);
70         virtual bool Update();
71
72         /** 
73          * Add an event to an actuator.
74          */ 
75         void AddEvent(CValue* event);
76         virtual void ProcessReplica();
77
78         /** 
79          * Return true iff all the current events 
80          * are negative. The definition of negative event is
81          * not immediately clear. But usually refers to key-up events
82          * or events where no action is required.
83          */
84         bool IsNegativeEvent() const;
85         virtual ~SCA_IActuator();
86 };
87
88 #endif //__KX_IACTUATOR
89