fixed spacing in the headers to get rid of some warnings and some other
[blender.git] / source / gameengine / GameLogic / SCA_IActuator.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32 #ifndef __KX_IACTUATOR
33 #define __KX_IACTUATOR
34
35 #include "SCA_ILogicBrick.h"
36 #include <vector>
37
38 class SCA_IActuator : public SCA_ILogicBrick
39 {
40 protected:
41         std::vector<CValue*> m_events;
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          * Update(...)
54          * Update the actuator based upon the events received since 
55          * the last call to Update, the current time and deltatime the
56          * time elapsed in this frame ?
57          * It is the responsibility of concrete Actuators to clear
58          * their event's. This is usually done in the Update() method via 
59          * a call to RemoveAllEvents()
60          */
61
62
63         virtual bool Update(double curtime,
64                                                 double deltatime);
65
66         /** 
67          * Add an event to an actuator.
68          */ 
69         void AddEvent(CValue* event);
70         virtual void ProcessReplica();
71
72         /** 
73          * Return true iff all the current events 
74          * are negative. The definition of negative event is
75          * not immediately clear. But usually refers to key-up events
76          * or events where no action is required.
77          */
78         bool IsNegativeEvent() const;
79         virtual ~SCA_IActuator();
80 };
81
82 #endif //__KX_IACTUATOR
83