Undo revision 23130 which was a merge with 2.5, a messy one because I did something...
[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         : SCA_ISensor(gameobj,eventmgr),
45           m_checkactname(actname)
46 {
47         m_actuator = GetParent()->FindActuator(m_checkactname);
48         Init();
49 }
50
51 void SCA_ActuatorSensor::Init()
52 {
53         m_lastresult = m_invert?true:false;
54         m_midresult = m_lastresult;
55         m_reset = true;
56 }
57
58 CValue* SCA_ActuatorSensor::GetReplica()
59 {
60         SCA_ActuatorSensor* replica = new SCA_ActuatorSensor(*this);
61         // m_range_expr must be recalculated on replica!
62         replica->ProcessReplica();
63         replica->Init();
64
65         return replica;
66 }
67
68 void SCA_ActuatorSensor::ReParent(SCA_IObject* parent)
69 {
70         m_actuator = parent->FindActuator(m_checkactname);
71         SCA_ISensor::ReParent(parent);
72 }
73
74 bool SCA_ActuatorSensor::IsPositiveTrigger()
75 {
76         bool result = m_lastresult;
77         if (m_invert)
78                 result = !result;
79
80         return result;
81 }
82
83
84
85 SCA_ActuatorSensor::~SCA_ActuatorSensor()
86 {
87 }
88
89
90
91 bool SCA_ActuatorSensor::Evaluate()
92 {
93         if (m_actuator)
94         {
95                 bool result = m_actuator->IsActive();
96                 bool reset = m_reset && m_level;
97                 
98                 m_reset = false;
99                 if (m_lastresult != result || m_midresult != result)
100                 {
101                         m_lastresult = m_midresult = result;
102                         return true;
103                 }
104                 return (reset) ? true : false;
105         }
106         return false;
107 }
108
109 void SCA_ActuatorSensor::Update()
110 {
111         if (m_actuator)
112         {
113                 m_midresult = m_actuator->IsActive() && !m_actuator->IsNegativeEvent();
114         }
115 }
116
117
118 /* ------------------------------------------------------------------------- */
119 /* Python functions                                                          */
120 /* ------------------------------------------------------------------------- */
121
122 /* Integration hooks ------------------------------------------------------- */
123 PyTypeObject SCA_ActuatorSensor::Type = {
124         PyVarObject_HEAD_INIT(NULL, 0)
125         "SCA_ActuatorSensor",
126         sizeof(PyObjectPlus_Proxy),
127         0,
128         py_base_dealloc,
129         0,
130         0,
131         0,
132         0,
133         py_base_repr,
134         0,0,0,0,0,0,0,0,0,
135         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
136         0,0,0,0,0,0,0,
137         Methods,
138         0,
139         0,
140         &SCA_ISensor::Type,
141         0,0,0,0,0,0,
142         py_base_new
143 };
144
145 PyMethodDef SCA_ActuatorSensor::Methods[] = {
146         //Deprecated functions ------>
147         {"getActuator", (PyCFunction) SCA_ActuatorSensor::sPyGetActuator, METH_NOARGS, (const char *)GetActuator_doc},
148         {"setActuator", (PyCFunction) SCA_ActuatorSensor::sPySetActuator, METH_VARARGS, (const char *)SetActuator_doc},
149         //<----- Deprecated
150         {NULL,NULL} //Sentinel
151 };
152
153 PyAttributeDef SCA_ActuatorSensor::Attributes[] = {
154         KX_PYATTRIBUTE_STRING_RW_CHECK("actuator",0,100,false,SCA_ActuatorSensor,m_checkactname,CheckActuator),
155         { NULL }        //Sentinel
156 };
157
158 int SCA_ActuatorSensor::CheckActuator(void *self, const PyAttributeDef*)
159 {
160         SCA_ActuatorSensor* sensor = reinterpret_cast<SCA_ActuatorSensor*>(self);
161         SCA_IActuator* act = sensor->GetParent()->FindActuator(sensor->m_checkactname);
162         if (act) {
163                 sensor->m_actuator = act;
164                 return 0;
165         }
166         PyErr_SetString(PyExc_AttributeError, "string does not correspond to an actuator");
167         return 1;
168 }
169
170 /* 3. getActuator */
171 const char SCA_ActuatorSensor::GetActuator_doc[] = 
172 "getActuator()\n"
173 "\tReturn the Actuator with which the sensor operates.\n";
174 PyObject* SCA_ActuatorSensor::PyGetActuator() 
175 {
176         ShowDeprecationWarning("getActuator()", "the actuator property");
177         return PyUnicode_FromString(m_checkactname);
178 }
179
180 /* 4. setActuator */
181 const char SCA_ActuatorSensor::SetActuator_doc[] = 
182 "setActuator(name)\n"
183 "\t- name: string\n"
184 "\tSets the Actuator with which to operate. If there is no Actuator\n"
185 "\tof this name, the call is ignored.\n";
186 PyObject* SCA_ActuatorSensor::PySetActuator(PyObject* args) 
187 {
188         ShowDeprecationWarning("setActuator()", "the actuator property");
189         /* We should query whether the name exists. Or should we create a prop   */
190         /* on the fly?                                                           */
191         char *actNameArg = NULL;
192
193         if (!PyArg_ParseTuple(args, "s:setActuator", &actNameArg)) {
194                 return NULL;
195         }
196
197         SCA_IActuator* act = GetParent()->FindActuator(STR_String(actNameArg));
198         if (act) {
199                 m_checkactname = actNameArg;
200                 m_actuator = act;
201         } else {
202                 ; /* error: bad actuator name */
203         }
204         Py_RETURN_NONE;
205 }
206
207 /* eof */