NLA SoC: Merge from 2.5
[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_IController.h"
33 #include <vector>
34
35 /*
36  * Use of SG_DList : None
37  * Use of SG_QList : element of activated actuator list of their owner
38  *                   Head: SCA_IObject::m_activeActuators
39  */
40 class SCA_IActuator : public SCA_ILogicBrick
41 {
42         friend class SCA_LogicManager;
43 protected:
44         int                                      m_links;       // number of active links to controllers
45                                                                         // when 0, the actuator is automatically stopped
46         //std::vector<CValue*> m_events;
47         bool                         m_posevent;
48         bool                         m_negevent;
49
50         std::vector<class SCA_IController*>             m_linkedcontrollers;
51
52         void RemoveAllEvents()
53         {
54                 m_posevent = false;
55                 m_negevent = false;
56         }
57
58
59 public:
60         /**
61          * This class also inherits the default copy constructors
62          */
63
64         SCA_IActuator(SCA_IObject* gameobj); 
65
66         /**
67          * UnlinkObject(...)
68          * Certain actuator use gameobject pointers (like TractTo actuator)
69          * This function can be called when an object is removed to make
70          * sure that the actuator will not use it anymore.
71          */
72
73         virtual bool UnlinkObject(SCA_IObject* clientobj) { return false; }
74
75         /**
76          * Update(...)
77          * Update the actuator based upon the events received since 
78          * the last call to Update, the current time and deltatime the
79          * time elapsed in this frame ?
80          * It is the responsibility of concrete Actuators to clear
81          * their event's. This is usually done in the Update() method via 
82          * a call to RemoveAllEvents()
83          */
84
85
86         virtual bool Update(double curtime, bool frame);
87         virtual bool Update();
88
89         /** 
90          * Add an event to an actuator.
91          */ 
92         //void AddEvent(CValue* event)
93         void AddEvent(bool event)
94         {
95                 if (event)
96                         m_posevent = true;
97                 else
98                         m_negevent = true;
99         }
100
101         virtual void ProcessReplica();
102
103         /** 
104          * Return true iff all the current events 
105          * are negative. The definition of negative event is
106          * not immediately clear. But usually refers to key-up events
107          * or events where no action is required.
108          */
109         bool IsNegativeEvent() const
110         {
111                 return !m_posevent && m_negevent;
112         }
113
114         virtual ~SCA_IActuator();
115
116         /**
117          * remove this actuator from the list of active actuators
118          */
119         virtual void Deactivate();
120         virtual void Activate(SG_DList& head);
121
122         void    LinkToController(SCA_IController* controller);
123         void    UnlinkController(class SCA_IController* cont);
124         void    UnlinkAllControllers();
125
126         void ClrLink() { m_links=0; }
127         void IncLink() { m_links++; }
128         void DecLink();
129         bool IsNoLink() const { return !m_links; }
130 };
131
132 #endif //__KX_IACTUATOR
133