rename and negate DISABLE_PYTHON --> WITH_PYTHON
[blender.git] / source / gameengine / GameLogic / SCA_IObject.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  * An abstract object that has some logic, python scripting and
29  * reference counting Note: transformation stuff has been moved to
30  * SceneGraph
31  */
32
33 #ifndef SCA_IOBJECT_H
34 #define SCA_IOBJECT_H
35
36 #include "Value.h"
37 #include <vector>
38
39 class SCA_IObject;
40 class SCA_ISensor;
41 class SCA_IController;
42 class SCA_IActuator;
43
44 #ifdef WITH_PYTHON
45 template<class T> T PyVecTo(PyObject*);
46 #endif
47
48 typedef std::vector<SCA_ISensor *>       SCA_SensorList;
49 typedef std::vector<SCA_IController *>   SCA_ControllerList;
50 typedef std::vector<SCA_IActuator *>     SCA_ActuatorList;
51 typedef std::vector<SCA_IObject *>               SCA_ObjectList;
52
53 class SCA_IObject :     public CValue
54 {
55         
56         Py_Header;
57         
58 protected:
59         friend class KX_StateActuator;
60         friend class SCA_IActuator;
61         friend class SCA_IController;
62         SCA_SensorList         m_sensors;
63         SCA_ControllerList     m_controllers;
64         SCA_ActuatorList       m_actuators;
65         SCA_ActuatorList       m_registeredActuators;   // actuators that use a pointer to this object
66         SCA_ObjectList             m_registeredObjects;         // objects that hold reference to this object
67
68         // SG_Dlist: element of objects with active actuators
69         //           Head: SCA_LogicManager::m_activeActuators
70         // SG_QList: Head of active actuators list on this object
71         //           Elements: SCA_IActuator
72         SG_QList                           m_activeActuators;
73         // SG_Dlist: element of list os lists with active controllers
74         //           Head: SCA_LogicManager::m_activeControllers
75         // SG_QList: Head of active controller list on this object
76         //           Elements: SCA_IController
77         SG_QList                           m_activeControllers;
78         // SG_Dlist: element of list of lists of active controllers
79         //           Head: SCA_LogicManager::m_activeControllers
80         // SG_QList: Head of active bookmarked controller list globally
81         //           Elements: SCA_IController with bookmark option
82         static SG_QList            m_activeBookmarkedControllers;
83
84         static class MT_Point3 m_sDummy;
85
86         /**
87          * Ignore activity culling requests?
88          */
89         bool m_ignore_activity_culling;
90
91         /**
92          * Ignore updates?
93          */
94         bool m_suspended;
95
96         /**
97          * init state of object (used when object is created)
98          */
99         unsigned int                    m_initState;
100
101         /**
102          * current state = bit mask of state that are active
103          */
104         unsigned int                    m_state;
105
106         /**
107          * pointer inside state actuator list for sorting
108          */
109         SG_QList*                               m_firstState;
110
111 public:
112         
113         SCA_IObject();
114         virtual ~SCA_IObject();
115
116         SCA_ControllerList& GetControllers()
117         {
118                 return m_controllers;
119         }
120         SCA_SensorList& GetSensors()
121         {
122                 return m_sensors;
123         }
124         SCA_ActuatorList& GetActuators()
125         {
126                 return m_actuators;
127         }
128         SG_QList& GetActiveActuators()
129         {
130                 return m_activeActuators;
131         }
132
133         void AddSensor(SCA_ISensor* act);
134         void ReserveSensor(int num)
135         {
136                 m_sensors.reserve(num);
137         }
138         void AddController(SCA_IController* act);
139         void ReserveController(int num)
140         {
141                 m_controllers.reserve(num);
142         }
143         void AddActuator(SCA_IActuator* act);
144         void ReserveActuator(int num)
145         {
146                 m_actuators.reserve(num);
147         }
148         void RegisterActuator(SCA_IActuator* act);
149         void UnregisterActuator(SCA_IActuator* act);
150         
151         void RegisterObject(SCA_IObject* objs);
152         void UnregisterObject(SCA_IObject* objs);
153         /**
154          * UnlinkObject(...)
155          * this object is informed that one of the object to which it holds a reference is deleted
156          * returns true if there was indeed a reference.
157          */
158         virtual bool UnlinkObject(SCA_IObject* clientobj) { return false; }
159
160         SCA_ISensor* FindSensor(const STR_String& sensorname);
161         SCA_IActuator* FindActuator(const STR_String& actuatorname);
162         SCA_IController* FindController(const STR_String& controllername);
163
164         void SetCurrentTime(float currentTime) {}
165
166         virtual void ReParentLogic();
167         
168         /**
169          * Set whether or not to ignore activity culling requests
170          */
171         void SetIgnoreActivityCulling(bool b)
172         {
173                 m_ignore_activity_culling = b;
174         }
175
176         /**
177          * Set whether or not this object wants to ignore activity culling
178          * requests
179          */
180         bool GetIgnoreActivityCulling()
181         {
182                 return m_ignore_activity_culling;
183         }
184
185         /**
186          * Suspend all progress.
187          */
188         void Suspend(void);
189         
190         /**
191          * Resume progress
192          */
193         void Resume(void);
194
195         /**
196          * Set init state
197          */
198         void SetInitState(unsigned int initState) { m_initState = initState; }
199
200         /**
201          * initialize the state when object is created
202          */
203         void ResetState(void) { SetState(m_initState); }
204
205         /**
206          * Set the object state
207          */
208         void SetState(unsigned int state);
209
210         /**
211          * Get the object state
212          */
213         unsigned int GetState(void)     { return m_state; }
214
215 //      const class MT_Point3&  ConvertPythonPylist(PyObject* pylist);
216
217         virtual int GetGameObjectType() {return -1;}
218         
219         typedef enum ObjectTypes {
220                 OBJ_ARMATURE=0,
221                 OBJ_CAMERA=1,
222                 OBJ_LIGHT=2,
223         }ObjectTypes;
224
225 };
226
227 #endif //SCA_IOBJECT_H
228