BGE: bookmark option on controller to make them run before all other controllers.
[blender.git] / source / gameengine / GameLogic / SCA_ActuatorSensor.cpp
1 /**
2  * Actuator sensor
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #include <iostream>
33 #include "SCA_ActuatorSensor.h"
34 #include "SCA_EventManager.h"
35 #include "SCA_LogicManager.h"
36
37 #ifdef HAVE_CONFIG_H
38 #include <config.h>
39 #endif
40
41 SCA_ActuatorSensor::SCA_ActuatorSensor(SCA_EventManager* eventmgr,
42                                                                          SCA_IObject* gameobj,
43                                                                          const STR_String& actname,
44                                                                          PyTypeObject* T )
45         : SCA_ISensor(gameobj,eventmgr,T),
46           m_checkactname(actname)
47 {
48         m_actuator = GetParent()->FindActuator(m_checkactname);
49         Init();
50 }
51
52 void SCA_ActuatorSensor::Init()
53 {
54         m_lastresult = m_invert?true:false;
55         m_midresult = m_lastresult;
56         m_reset = true;
57 }
58
59 CValue* SCA_ActuatorSensor::GetReplica()
60 {
61         SCA_ActuatorSensor* replica = new SCA_ActuatorSensor(*this);
62         // m_range_expr must be recalculated on replica!
63         replica->ProcessReplica();
64         replica->Init();
65
66         return replica;
67 }
68
69 void SCA_ActuatorSensor::ReParent(SCA_IObject* parent)
70 {
71         m_actuator = parent->FindActuator(m_checkactname);
72         SCA_ISensor::ReParent(parent);
73 }
74
75 bool SCA_ActuatorSensor::IsPositiveTrigger()
76 {
77         bool result = m_lastresult;
78         if (m_invert)
79                 result = !result;
80
81         return result;
82 }
83
84
85
86 SCA_ActuatorSensor::~SCA_ActuatorSensor()
87 {
88 }
89
90
91
92 bool SCA_ActuatorSensor::Evaluate()
93 {
94         if (m_actuator)
95         {
96                 bool result = m_actuator->IsActive();
97                 bool reset = m_reset && m_level;
98                 
99                 m_reset = false;
100                 if (m_lastresult != result || m_midresult != result)
101                 {
102                         m_lastresult = m_midresult = result;
103                         return true;
104                 }
105                 return (reset) ? true : false;
106         }
107         return false;
108 }
109
110 void SCA_ActuatorSensor::Update()
111 {
112         if (m_actuator)
113         {
114                 m_midresult = m_actuator->IsActive() && !m_actuator->IsNegativeEvent();
115         }
116 }
117
118
119 /* ------------------------------------------------------------------------- */
120 /* Python functions                                                          */
121 /* ------------------------------------------------------------------------- */
122
123 /* Integration hooks ------------------------------------------------------- */
124 PyTypeObject SCA_ActuatorSensor::Type = {
125 #if (PY_VERSION_HEX >= 0x02060000)
126         PyVarObject_HEAD_INIT(NULL, 0)
127 #else
128         /* python 2.5 and below */
129         PyObject_HEAD_INIT( NULL )  /* required py macro */
130         0,                          /* ob_size */
131 #endif
132         "SCA_ActuatorSensor",
133         sizeof(PyObjectPlus_Proxy),
134         0,
135         py_base_dealloc,
136         0,
137         0,
138         0,
139         0,
140         py_base_repr,
141         0,0,0,0,0,0,
142         py_base_getattro,
143         py_base_setattro,
144         0,0,0,0,0,0,0,0,0,
145         Methods
146 };
147
148 PyParentObject SCA_ActuatorSensor::Parents[] = {
149         &SCA_ActuatorSensor::Type,
150         &SCA_ISensor::Type,
151         &SCA_ILogicBrick::Type,
152         &CValue::Type,
153         NULL
154 };
155
156 PyMethodDef SCA_ActuatorSensor::Methods[] = {
157         //Deprecated functions ------>
158         {"getActuator", (PyCFunction) SCA_ActuatorSensor::sPyGetActuator, METH_NOARGS, (PY_METHODCHAR)GetActuator_doc},
159         {"setActuator", (PyCFunction) SCA_ActuatorSensor::sPySetActuator, METH_VARARGS, (PY_METHODCHAR)SetActuator_doc},
160         //<----- Deprecated
161         {NULL,NULL} //Sentinel
162 };
163
164 PyAttributeDef SCA_ActuatorSensor::Attributes[] = {
165         KX_PYATTRIBUTE_STRING_RW_CHECK("actuator",0,100,false,SCA_ActuatorSensor,m_checkactname,CheckActuator),
166         { NULL }        //Sentinel
167 };
168
169 PyObject* SCA_ActuatorSensor::py_getattro(PyObject *attr) {
170         py_getattro_up(SCA_ISensor);
171 }
172
173 PyObject* SCA_ActuatorSensor::py_getattro_dict() {
174         py_getattro_dict_up(SCA_ISensor);
175 }
176
177 int SCA_ActuatorSensor::py_setattro(PyObject *attr, PyObject *value) {
178         py_setattro_up(SCA_ISensor);
179 }
180
181 int SCA_ActuatorSensor::CheckActuator(void *self, const PyAttributeDef*)
182 {
183         SCA_ActuatorSensor* sensor = reinterpret_cast<SCA_ActuatorSensor*>(self);
184         SCA_IActuator* act = sensor->GetParent()->FindActuator(sensor->m_checkactname);
185         if (act) {
186                 sensor->m_actuator = act;
187                 return 0;
188         }
189         PyErr_SetString(PyExc_AttributeError, "string does not correspond to an actuator");
190         return 1;
191 }
192
193 /* 3. getActuator */
194 const char SCA_ActuatorSensor::GetActuator_doc[] = 
195 "getActuator()\n"
196 "\tReturn the Actuator with which the sensor operates.\n";
197 PyObject* SCA_ActuatorSensor::PyGetActuator() 
198 {
199         ShowDeprecationWarning("getActuator()", "the actuator property");
200         return PyString_FromString(m_checkactname);
201 }
202
203 /* 4. setActuator */
204 const char SCA_ActuatorSensor::SetActuator_doc[] = 
205 "setActuator(name)\n"
206 "\t- name: string\n"
207 "\tSets the Actuator with which to operate. If there is no Actuator\n"
208 "\tof this name, the call is ignored.\n";
209 PyObject* SCA_ActuatorSensor::PySetActuator(PyObject* args) 
210 {
211         ShowDeprecationWarning("setActuator()", "the actuator property");
212         /* We should query whether the name exists. Or should we create a prop   */
213         /* on the fly?                                                           */
214         char *actNameArg = NULL;
215
216         if (!PyArg_ParseTuple(args, "s:setActuator", &actNameArg)) {
217                 return NULL;
218         }
219
220         SCA_IActuator* act = GetParent()->FindActuator(STR_String(actNameArg));
221         if (act) {
222                 m_checkactname = actNameArg;
223                 m_actuator = act;
224         } else {
225                 ; /* error: bad actuator name */
226         }
227         Py_RETURN_NONE;
228 }
229
230 /* eof */