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