optionally use guarded alloc for tiles compositor, also replace allocation functions...
[blender.git] / source / gameengine / GameLogic / SCA_IActuator.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file SCA_IActuator.h
29  *  \ingroup gamelogic
30  */
31
32 #ifndef __SCA_IACTUATOR_H__
33 #define __SCA_IACTUATOR_H__
34
35 #include "SCA_IController.h"
36 #include <vector>
37
38 /**
39  * Use of SG_DList : None
40  * Use of SG_QList : element of activated actuator list of their owner
41  *                   Head: SCA_IObject::m_activeActuators
42  */
43 class SCA_IActuator : public SCA_ILogicBrick
44 {
45         friend class SCA_LogicManager;
46 protected:
47         int                                      m_type;
48         int                                      m_links;       // number of active links to controllers
49                                                                         // when 0, the actuator is automatically stopped
50         //std::vector<CValue*> m_events;
51         bool                         m_posevent;
52         bool                         m_negevent;
53
54         std::vector<class SCA_IController*>             m_linkedcontrollers;
55
56         void RemoveAllEvents()
57         {
58                 m_posevent = false;
59                 m_negevent = false;
60         }
61
62
63 public:
64         /**
65          * This class also inherits the default copy constructors
66          */
67         enum KX_ACTUATOR_TYPE {
68                 KX_ACT_OBJECT,
69                 KX_ACT_IPO,
70                 KX_ACT_CAMERA,
71                 KX_ACT_SOUND,
72                 KX_ACT_PROPERTY,
73                 KX_ACT_ADD_OBJECT,
74                 KX_ACT_END_OBJECT,
75                 KX_ACT_DYNAMIC,
76                 KX_ACT_REPLACE_MESH,
77                 KX_ACT_TRACKTO,
78                 KX_ACT_CONSTRAINT,
79                 KX_ACT_SCENE,
80                 KX_ACT_RANDOM,
81                 KX_ACT_MESSAGE,
82                 KX_ACT_ACTION,
83                 KX_ACT_CD,
84                 KX_ACT_GAME,
85                 KX_ACT_VISIBILITY,
86                 KX_ACT_2DFILTER,
87                 KX_ACT_PARENT,
88                 KX_ACT_SHAPEACTION,
89                 KX_ACT_STATE,
90                 KX_ACT_ARMATURE,
91                 KX_ACT_STEERING,
92         };
93
94         SCA_IActuator(SCA_IObject* gameobj, KX_ACTUATOR_TYPE type); 
95
96         /**
97          * UnlinkObject(...)
98          * Certain actuator use gameobject pointers (like TractTo actuator)
99          * This function can be called when an object is removed to make
100          * sure that the actuator will not use it anymore.
101          */
102
103         virtual bool UnlinkObject(SCA_IObject* clientobj) { return false; }
104
105         /**
106          * Update(...)
107          * Update the actuator based upon the events received since 
108          * the last call to Update, the current time and deltatime the
109          * time elapsed in this frame ?
110          * It is the responsibility of concrete Actuators to clear
111          * their event's. This is usually done in the Update() method via 
112          * a call to RemoveAllEvents()
113          */
114
115
116         virtual bool Update(double curtime, bool frame);
117         virtual bool Update();
118
119         /** 
120          * Add an event to an actuator.
121          */ 
122         //void AddEvent(CValue* event)
123         void AddEvent(bool event)
124         {
125                 if (event)
126                         m_posevent = true;
127                 else
128                         m_negevent = true;
129         }
130
131         virtual void ProcessReplica();
132
133         /** 
134          * Return true iff all the current events 
135          * are negative. The definition of negative event is
136          * not immediately clear. But usually refers to key-up events
137          * or events where no action is required.
138          */
139         bool IsNegativeEvent() const
140         {
141                 return !m_posevent && m_negevent;
142         }
143
144         virtual ~SCA_IActuator();
145
146         /**
147          * remove this actuator from the list of active actuators
148          */
149         virtual void Deactivate();
150         virtual void Activate(SG_DList& head);
151
152         void    LinkToController(SCA_IController* controller);
153         void    UnlinkController(class SCA_IController* cont);
154         void    UnlinkAllControllers();
155
156         void ClrLink() { m_links=0; }
157         void IncLink() { m_links++; }
158         void DecLink();
159         bool IsNoLink() const { return !m_links; }
160         bool IsType(KX_ACTUATOR_TYPE type) { return m_type == type; }
161         
162 #ifdef WITH_CXX_GUARDEDALLOC
163         MEM_CXX_CLASS_ALLOC_FUNCS("GE:SCA_IActuator")
164 #endif
165 };
166
167 #endif //__SCA_IACTUATOR_H__
168