Python BGE API
[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         SCA_SensorList         m_sensors;
56         SCA_ControllerList     m_controllers;
57         SCA_ActuatorList       m_actuators;
58         SCA_ActuatorList       m_registeredActuators;   // actuators that use a pointer to this object
59         static class MT_Point3 m_sDummy;
60
61         /**
62          * Ignore activity culling requests?
63          */
64         bool m_ignore_activity_culling;
65
66         /**
67          * Ignore updates?
68          */
69         bool m_suspended;
70
71         /**
72          * init state of object (used when object is created)
73          */
74         unsigned int                    m_initState;
75
76         /**
77          * current state = bit mask of state that are active
78          */
79         unsigned int                    m_state;
80
81 public:
82         
83         SCA_IObject(PyTypeObject* T=&Type);
84         virtual ~SCA_IObject();
85
86         SCA_ControllerList& GetControllers();
87         SCA_SensorList& GetSensors();
88         SCA_ActuatorList& GetActuators();
89
90         void AddSensor(SCA_ISensor* act);
91         void AddController(SCA_IController* act);
92         void AddActuator(SCA_IActuator* act);
93         void RegisterActuator(SCA_IActuator* act);
94         void UnregisterActuator(SCA_IActuator* act);
95         
96         SCA_ISensor* FindSensor(const STR_String& sensorname);
97         SCA_IActuator* FindActuator(const STR_String& actuatorname);
98         SCA_IController* FindController(const STR_String& controllername);
99
100         void SetCurrentTime(float currentTime);
101
102         void ReParentLogic();
103         
104         /**
105          * Set whether or not to ignore activity culling requests
106          */
107         void SetIgnoreActivityCulling(bool b);
108
109         /**
110          * Set whether or not this object wants to ignore activity culling
111          * requests
112          */
113         bool GetIgnoreActivityCulling();
114
115         /**
116          * Suspend all progress.
117          */
118         void Suspend(void);
119         
120         /**
121          * Resume progress
122          */
123         void Resume(void);
124
125         /**
126          * Set init state
127          */
128         void SetInitState(unsigned int initState) { m_initState = initState; }
129
130         /**
131          * initialize the state when object is created
132          */
133         void ResetState(void) { SetState(m_initState); }
134
135         /**
136          * Set the object state
137          */
138         void SetState(unsigned int state);
139
140         /**
141          * Get the object state
142          */
143         unsigned int GetState(void)     { return m_state; }
144
145 //      const class MT_Point3&  ConvertPythonPylist(PyObject* pylist);
146         
147         // here come the python forwarded methods
148         virtual PyObject* py_getattro(PyObject *attr);
149
150         virtual int GetGameObjectType() {return -1;}
151         
152         typedef enum ObjectTypes {
153                 OBJ_ARMATURE=0,
154         }ObjectTypes;
155
156 };
157
158 #endif //SCA_IOBJECT_H
159