svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r22875:22935
[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., 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  * 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_ISensor;
40 class SCA_IController;
41 class SCA_IActuator;
42
43 template<class T> T PyVecTo(PyObject*);
44
45 typedef std::vector<SCA_ISensor *>       SCA_SensorList;
46 typedef std::vector<SCA_IController *>   SCA_ControllerList;
47 typedef std::vector<SCA_IActuator *>     SCA_ActuatorList;
48
49 class SCA_IObject :     public CValue
50 {
51         
52         Py_Header;
53         
54 protected:
55         friend class KX_StateActuator;
56         friend class SCA_IActuator;
57         friend class SCA_IController;
58         SCA_SensorList         m_sensors;
59         SCA_ControllerList     m_controllers;
60         SCA_ActuatorList       m_actuators;
61         SCA_ActuatorList       m_registeredActuators;   // actuators that use a pointer to this object
62
63         // SG_Dlist: element of objects with active actuators
64         //           Head: SCA_LogicManager::m_activeActuators
65         // SG_QList: Head of active actuators list on this object
66         //           Elements: SCA_IActuator
67         SG_QList                           m_activeActuators;
68         // SG_Dlist: element of list os lists with active controllers
69         //           Head: SCA_LogicManager::m_activeControllers
70         // SG_QList: Head of active controller list on this object
71         //           Elements: SCA_IController
72         SG_QList                           m_activeControllers;
73         // SG_Dlist: element of list of lists of active controllers
74         //           Head: SCA_LogicManager::m_activeControllers
75         // SG_QList: Head of active bookmarked controller list globally
76         //           Elements: SCA_IController with bookmark option
77         static SG_QList            m_activeBookmarkedControllers;
78
79         static class MT_Point3 m_sDummy;
80
81         /**
82          * Ignore activity culling requests?
83          */
84         bool m_ignore_activity_culling;
85
86         /**
87          * Ignore updates?
88          */
89         bool m_suspended;
90
91         /**
92          * init state of object (used when object is created)
93          */
94         unsigned int                    m_initState;
95
96         /**
97          * current state = bit mask of state that are active
98          */
99         unsigned int                    m_state;
100
101         /**
102          * pointer inside state actuator list for sorting
103          */
104         SG_QList*                               m_firstState;
105
106 public:
107         
108         SCA_IObject();
109         virtual ~SCA_IObject();
110
111         SCA_ControllerList& GetControllers()
112         {
113                 return m_controllers;
114         }
115         SCA_SensorList& GetSensors()
116         {
117                 return m_sensors;
118         }
119         SCA_ActuatorList& GetActuators()
120         {
121                 return m_actuators;
122         }
123         SG_QList& GetActiveActuators()
124         {
125                 return m_activeActuators;
126         }
127
128         void AddSensor(SCA_ISensor* act);
129         void ReserveSensor(int num)
130         {
131                 m_sensors.reserve(num);
132         }
133         void AddController(SCA_IController* act);
134         void ReserveController(int num)
135         {
136                 m_controllers.reserve(num);
137         }
138         void AddActuator(SCA_IActuator* act);
139         void ReserveActuator(int num)
140         {
141                 m_actuators.reserve(num);
142         }
143         void RegisterActuator(SCA_IActuator* act);
144         void UnregisterActuator(SCA_IActuator* act);
145         
146         SCA_ISensor* FindSensor(const STR_String& sensorname);
147         SCA_IActuator* FindActuator(const STR_String& actuatorname);
148         SCA_IController* FindController(const STR_String& controllername);
149
150         void SetCurrentTime(float currentTime) {}
151
152         void ReParentLogic();
153         
154         /**
155          * Set whether or not to ignore activity culling requests
156          */
157         void SetIgnoreActivityCulling(bool b)
158         {
159                 m_ignore_activity_culling = b;
160         }
161
162         /**
163          * Set whether or not this object wants to ignore activity culling
164          * requests
165          */
166         bool GetIgnoreActivityCulling()
167         {
168                 return m_ignore_activity_culling;
169         }
170
171         /**
172          * Suspend all progress.
173          */
174         void Suspend(void);
175         
176         /**
177          * Resume progress
178          */
179         void Resume(void);
180
181         /**
182          * Set init state
183          */
184         void SetInitState(unsigned int initState) { m_initState = initState; }
185
186         /**
187          * initialize the state when object is created
188          */
189         void ResetState(void) { SetState(m_initState); }
190
191         /**
192          * Set the object state
193          */
194         void SetState(unsigned int state);
195
196         /**
197          * Get the object state
198          */
199         unsigned int GetState(void)     { return m_state; }
200
201 //      const class MT_Point3&  ConvertPythonPylist(PyObject* pylist);
202
203         virtual int GetGameObjectType() {return -1;}
204         
205         typedef enum ObjectTypes {
206                 OBJ_ARMATURE=0,
207                 OBJ_CAMERA=1,
208         }ObjectTypes;
209
210 };
211
212 #endif //SCA_IOBJECT_H
213