synched with trunk at revision 36569
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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
30 /** \file SCA_IActuator.h
31  *  \ingroup gamelogic
32  */
33
34 #ifndef __KX_IACTUATOR
35 #define __KX_IACTUATOR
36
37 #include "SCA_IController.h"
38 #include <vector>
39
40 /**
41  * Use of SG_DList : None
42  * Use of SG_QList : element of activated actuator list of their owner
43  *                   Head: SCA_IObject::m_activeActuators
44  */
45 class SCA_IActuator : public SCA_ILogicBrick
46 {
47         friend class SCA_LogicManager;
48 protected:
49         int                                      m_type;
50         int                                      m_links;       // number of active links to controllers
51                                                                         // when 0, the actuator is automatically stopped
52         //std::vector<CValue*> m_events;
53         bool                         m_posevent;
54         bool                         m_negevent;
55
56         std::vector<class SCA_IController*>             m_linkedcontrollers;
57
58         void RemoveAllEvents()
59         {
60                 m_posevent = false;
61                 m_negevent = false;
62         }
63
64
65 public:
66         /**
67          * This class also inherits the default copy constructors
68          */
69         enum KX_ACTUATOR_TYPE {
70                 KX_ACT_OBJECT,
71                 KX_ACT_IPO,
72                 KX_ACT_CAMERA,
73                 KX_ACT_SOUND,
74                 KX_ACT_PROPERTY,
75                 KX_ACT_ADD_OBJECT,
76                 KX_ACT_END_OBJECT,
77                 KX_ACT_DYNAMIC,
78                 KX_ACT_REPLACE_MESH,
79                 KX_ACT_TRACKTO,
80                 KX_ACT_CONSTRAINT,
81                 KX_ACT_SCENE,
82                 KX_ACT_RANDOM,
83                 KX_ACT_MESSAGE,
84                 KX_ACT_ACTION,
85                 KX_ACT_CD,
86                 KX_ACT_GAME,
87                 KX_ACT_VISIBILITY,
88                 KX_ACT_2DFILTER,
89                 KX_ACT_PARENT,
90                 KX_ACT_SHAPEACTION,
91                 KX_ACT_STATE,
92                 KX_ACT_ARMATURE,
93                 KX_ACT_STEERING,
94         };
95
96         SCA_IActuator(SCA_IObject* gameobj, KX_ACTUATOR_TYPE type); 
97
98         /**
99          * UnlinkObject(...)
100          * Certain actuator use gameobject pointers (like TractTo actuator)
101          * This function can be called when an object is removed to make
102          * sure that the actuator will not use it anymore.
103          */
104
105         virtual bool UnlinkObject(SCA_IObject* clientobj) { return false; }
106
107         /**
108          * Update(...)
109          * Update the actuator based upon the events received since 
110          * the last call to Update, the current time and deltatime the
111          * time elapsed in this frame ?
112          * It is the responsibility of concrete Actuators to clear
113          * their event's. This is usually done in the Update() method via 
114          * a call to RemoveAllEvents()
115          */
116
117
118         virtual bool Update(double curtime, bool frame);
119         virtual bool Update();
120
121         /** 
122          * Add an event to an actuator.
123          */ 
124         //void AddEvent(CValue* event)
125         void AddEvent(bool event)
126         {
127                 if (event)
128                         m_posevent = true;
129                 else
130                         m_negevent = true;
131         }
132
133         virtual void ProcessReplica();
134
135         /** 
136          * Return true iff all the current events 
137          * are negative. The definition of negative event is
138          * not immediately clear. But usually refers to key-up events
139          * or events where no action is required.
140          */
141         bool IsNegativeEvent() const
142         {
143                 return !m_posevent && m_negevent;
144         }
145
146         virtual ~SCA_IActuator();
147
148         /**
149          * remove this actuator from the list of active actuators
150          */
151         virtual void Deactivate();
152         virtual void Activate(SG_DList& head);
153
154         void    LinkToController(SCA_IController* controller);
155         void    UnlinkController(class SCA_IController* cont);
156         void    UnlinkAllControllers();
157
158         void ClrLink() { m_links=0; }
159         void IncLink() { m_links++; }
160         void DecLink();
161         bool IsNoLink() const { return !m_links; }
162         bool IsType(KX_ACTUATOR_TYPE type) { return m_type == type; }
163         
164 #ifdef WITH_CXX_GUARDEDALLOC
165 public:
166         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:SCA_IActuator"); }
167         void operator delete( void *mem ) { MEM_freeN(mem); }
168 #endif
169 };
170
171 #endif //__KX_IACTUATOR
172