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