2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r19323...
[blender.git] / source / gameengine / GameLogic / SCA_ISensor.cpp
index 1a65f8311ed9a0a797720580fdc3aaced831b3a3..68f5653d53ae9a08e7281b0bd6fabdd178c9c35d 100644 (file)
@@ -3,15 +3,12 @@
  *
  * $Id$
  *
- * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
+ * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version. The Blender
- * Foundation also sells licenses for use in proprietary software under
- * the Blender License.  See http://www.blender.org/BL/ for information
- * about this.
+ * of the License, or (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  *
  * Contributor(s): none yet.
  *
- * ***** END GPL/BL DUAL LICENSE BLOCK *****
+ * ***** END GPL LICENSE BLOCK *****
  */
 
 #include "SCA_ISensor.h"
 #include "SCA_EventManager.h"
 #include "SCA_LogicManager.h"
+// needed for IsTriggered()
+#include "SCA_PythonController.h"
 
 #ifdef HAVE_CONFIG_H
 #include <config.h>
@@ -44,7 +43,8 @@
 void   SCA_ISensor::ReParent(SCA_IObject* parent)
 {
        SCA_ILogicBrick::ReParent(parent);
-       m_eventmgr->RegisterSensor(this);
+       // will be done when the sensor is activated
+       //m_eventmgr->RegisterSensor(this);
        this->SetActive(false);
 }
 
@@ -55,8 +55,11 @@ SCA_ISensor::SCA_ISensor(SCA_IObject* gameobj,
        SCA_ILogicBrick(gameobj,T),
        m_triggered(false)
 {
+       m_links = 0;
        m_suspended = false;
        m_invert = false;
+       m_level = false;
+       m_reset = false;
        m_pos_ticks = 0;
        m_neg_ticks = 0;
        m_pos_pulsemode = false;
@@ -97,8 +100,12 @@ void SCA_ISensor::SetInvert(bool inv) {
        m_invert = inv;
 }
 
+void SCA_ISensor::SetLevel(bool lvl) {
+       m_level = lvl;
+}
+
 
-float SCA_ISensor::GetNumber() {
+double SCA_ISensor::GetNumber() {
        return IsPositiveTrigger();
 }
 
@@ -114,78 +121,49 @@ void SCA_ISensor::Resume() {
        m_suspended = false;
 }
 
-/* python integration */
-
-PyTypeObject SCA_ISensor::Type = {
-       PyObject_HEAD_INIT(&PyType_Type)
-       0,
-       "SCA_ISensor",
-       sizeof(SCA_ISensor),
-       0,
-       PyDestructor,
-       0,
-       __getattr,
-       __setattr,
-       0, //&MyPyCompare,
-       __repr,
-       0, //&cvalue_as_number,
-       0,
-       0,
-       0,
-       0
-};
-
-PyParentObject SCA_ISensor::Parents[] = {
-       &SCA_ISensor::Type,
-       &SCA_ILogicBrick::Type,
-       &CValue::Type,
-       NULL
-};
-PyMethodDef SCA_ISensor::Methods[] = {
-       {"isPositive", (PyCFunction) SCA_ISensor::sPyIsPositive, 
-        METH_VARARGS, IsPositive_doc},
-       {"getUsePosPulseMode", (PyCFunction) SCA_ISensor::sPyGetUsePosPulseMode, 
-        METH_VARARGS, GetUsePosPulseMode_doc},
-       {"setUsePosPulseMode", (PyCFunction) SCA_ISensor::sPySetUsePosPulseMode, 
-        METH_VARARGS, SetUsePosPulseMode_doc},
-       {"getFrequency", (PyCFunction) SCA_ISensor::sPyGetFrequency, 
-        METH_VARARGS, GetFrequency_doc},
-       {"setFrequency", (PyCFunction) SCA_ISensor::sPySetFrequency, 
-        METH_VARARGS, SetFrequency_doc},
-       {"getUseNegPulseMode", (PyCFunction) SCA_ISensor::sPyGetUseNegPulseMode, 
-        METH_VARARGS, GetUseNegPulseMode_doc},
-       {"setUseNegPulseMode", (PyCFunction) SCA_ISensor::sPySetUseNegPulseMode, 
-        METH_VARARGS, SetUseNegPulseMode_doc},
-       {"getInvert", (PyCFunction) SCA_ISensor::sPyGetInvert, 
-        METH_VARARGS, GetInvert_doc},
-       {"setInvert", (PyCFunction) SCA_ISensor::sPySetInvert, 
-        METH_VARARGS, SetInvert_doc},
-       {"evaluate", (PyCFunction) SCA_ISensor::sPyEvaluate, 
-        METH_VARARGS, Evaluate_doc},
-       {NULL,NULL} //Sentinel
-};
-
-
-PyObject*
-SCA_ISensor::_getattr(const STR_String& attr)
-{
-  _getattr_up(SCA_ILogicBrick);
+void SCA_ISensor::Init() {
+       printf("Sensor %s has no init function, please report this bug to Blender.org\n", m_name.Ptr());
 }
 
+void SCA_ISensor::DecLink() {
+       m_links--;
+       if (m_links < 0) 
+       {
+               printf("Warning: sensor %s has negative m_links: %d\n", m_name.Ptr(), m_links);
+               m_links = 0;
+       }
+       if (!m_links)
+       {
+               // sensor is detached from all controllers, remove it from manager
+               UnregisterToManager();
+       }
+}
 
 void SCA_ISensor::RegisterToManager()
 {
+       // sensor is just activated, initialize it
+       Init();
+       m_newControllers.erase(m_newControllers.begin(), m_newControllers.end());
        m_eventmgr->RegisterSensor(this);
 }
 
+void SCA_ISensor::UnregisterToManager()
+{
+       m_eventmgr->RemoveSensor(this);
+}
+
 void SCA_ISensor::Activate(class SCA_LogicManager* logicmgr,     CValue* event)
 {
        
        // calculate if a __triggering__ is wanted
-       if (!m_suspended) {
+       // don't evaluate a sensor that is not connected to any controller
+       if (m_links && !m_suspended) {
                bool result = this->Evaluate(event);
                if (result) {
                        logicmgr->AddActivatedSensor(this);     
+                       // reset these counters so that pulse are synchronized with transition
+                       m_pos_ticks = 0;
+                       m_neg_ticks = 0;
                } else
                {
                        /* First, the pulsing behaviour, if pulse mode is
@@ -214,70 +192,107 @@ void SCA_ISensor::Activate(class SCA_LogicManager* logicmgr,       CValue* event)
                                }
                        }
                }
+               if (!m_newControllers.empty())
+               {
+                       if (!IsActive() && m_level)
+                       {
+                               // This level sensor is connected to at least one controller that was just made 
+                               // active but it did not generate an event yet, do it now to those controllers only 
+                               for (std::vector<SCA_IController*>::iterator ci=m_newControllers.begin();
+                                        ci != m_newControllers.end(); ci++)
+                               {
+                                       logicmgr->AddTriggeredController(*ci, this);
+                               }
+                       }
+                       // clear the list. Instead of using clear, which also release the memory,
+                       // use erase, which keeps the memory available for next time.
+                       m_newControllers.erase(m_newControllers.begin(), m_newControllers.end());
+               }
        } 
 }
+/* ----------------------------------------------- */
+/* Python Functions                                                       */
+/* ----------------------------------------------- */
 
-/* Python functions: */
-char SCA_ISensor::IsPositive_doc[] = 
+//Deprecated Functions ------>
+const char SCA_ISensor::IsPositive_doc[] = 
 "isPositive()\n"
-"\tReturns whether the sensor is registered a positive event.\n";
-PyObject* SCA_ISensor::PyIsPositive(PyObject* self, PyObject* args, PyObject* kwds)
+"\tReturns whether the sensor is in an active state.\n";
+PyObject* SCA_ISensor::PyIsPositive()
 {
+       ShowDeprecationWarning("isPositive()", "the read-only positive property");
        int retval = IsPositiveTrigger();
        return PyInt_FromLong(retval);
 }
 
+const char SCA_ISensor::IsTriggered_doc[] = 
+"isTriggered()\n"
+"\tReturns whether the sensor has triggered the current controller.\n";
+PyObject* SCA_ISensor::PyIsTriggered()
+{
+       ShowDeprecationWarning("isTriggered()", "the read-only triggered property");
+       // check with the current controller
+       int retval = 0;
+       if (SCA_PythonController::m_sCurrentController)
+               retval = SCA_PythonController::m_sCurrentController->IsTriggered(this);
+       return PyInt_FromLong(retval);
+}
+
 /**
  * getUsePulseMode: getter for the pulse mode (KX_TRUE = on)
  */
-char SCA_ISensor::GetUsePosPulseMode_doc[] = 
+const char SCA_ISensor::GetUsePosPulseMode_doc[] = 
 "getUsePosPulseMode()\n"
 "\tReturns whether positive pulse mode is active.\n";
-PyObject* SCA_ISensor::PyGetUsePosPulseMode(PyObject* self, PyObject* args, PyObject* kwds)
+PyObject* SCA_ISensor::PyGetUsePosPulseMode()
 {
+       ShowDeprecationWarning("getUsePosPulseMode()", "the usePosPulseMode property");
        return BoolToPyArg(m_pos_pulsemode);
 }
 
 /**
  * setUsePulseMode: setter for the pulse mode (KX_TRUE = on)
  */
-char SCA_ISensor::SetUsePosPulseMode_doc[] = 
+const char SCA_ISensor::SetUsePosPulseMode_doc[] = 
 "setUsePosPulseMode(pulse?)\n"
 "\t - pulse? : Pulse when a positive event occurs?\n"
 "\t            (KX_TRUE, KX_FALSE)\n"
 "\tSet whether to do pulsing when positive pulses occur.\n";
-PyObject* SCA_ISensor::PySetUsePosPulseMode(PyObject* self, PyObject* args, PyObject* kwds)
+PyObject* SCA_ISensor::PySetUsePosPulseMode(PyObject* args)
 {
+       ShowDeprecationWarning("setUsePosPulseMode()", "the usePosPulseMode property");
        int pyarg = 0;
-       if(!PyArg_ParseTuple(args, "i", &pyarg)) { return NULL; }
+       if(!PyArg_ParseTuple(args, "i:setUsePosPulseMode", &pyarg)) { return NULL; }
        m_pos_pulsemode = PyArgToBool(pyarg);
-       Py_Return;
+       Py_RETURN_NONE;
 }
 
 /**
  * getFrequency: getter for the pulse mode interval
  */
-char SCA_ISensor::GetFrequency_doc[] = 
+const char SCA_ISensor::GetFrequency_doc[] = 
 "getFrequency()\n"
 "\tReturns the frequency of the updates in pulse mode.\n" ;
-PyObject* SCA_ISensor::PyGetFrequency(PyObject* self, PyObject* args, PyObject* kwds)
+PyObject* SCA_ISensor::PyGetFrequency()
 {
+       ShowDeprecationWarning("getFrequency()", "the frequency property");
        return PyInt_FromLong(m_pulse_frequency);
 }
 
 /**
  * setFrequency: setter for the pulse mode (KX_TRUE = on)
  */
-char SCA_ISensor::SetFrequency_doc[] = 
+const char SCA_ISensor::SetFrequency_doc[] = 
 "setFrequency(pulse_frequency)\n"
 "\t- pulse_frequency: The frequency of the updates in pulse mode (integer)"
 "\tSet the frequency of the updates in pulse mode.\n"
 "\tIf the frequency is negative, it is set to 0.\n" ;
-PyObject* SCA_ISensor::PySetFrequency(PyObject* self, PyObject* args, PyObject* kwds)
+PyObject* SCA_ISensor::PySetFrequency(PyObject* args)
 {
+       ShowDeprecationWarning("setFrequency()", "the frequency property");
        int pulse_frequencyArg = 0;
 
-       if(!PyArg_ParseTuple(args, "i", &pulse_frequencyArg)) {
+       if(!PyArg_ParseTuple(args, "i:setFrequency", &pulse_frequencyArg)) {
                return NULL;
        }
        
@@ -288,59 +303,186 @@ PyObject* SCA_ISensor::PySetFrequency(PyObject* self, PyObject* args, PyObject*
        };      
        m_pulse_frequency = pulse_frequencyArg;
 
-       Py_Return;
+       Py_RETURN_NONE;
 }
 
 
-char SCA_ISensor::GetInvert_doc[] = 
+const char SCA_ISensor::GetInvert_doc[] = 
 "getInvert()\n"
 "\tReturns whether or not pulses from this sensor are inverted.\n" ;
-PyObject* SCA_ISensor::PyGetInvert(PyObject* self, PyObject* args, PyObject* kwds)
+PyObject* SCA_ISensor::PyGetInvert()
 {
+       ShowDeprecationWarning("getInvert()", "the invert property");
        return BoolToPyArg(m_invert);
 }
 
-char SCA_ISensor::SetInvert_doc[] = 
+const char SCA_ISensor::SetInvert_doc[] = 
 "setInvert(invert?)\n"
 "\t- invert?: Invert the event-values? (KX_TRUE, KX_FALSE)\n"
 "\tSet whether to invert pulses.\n";
-PyObject* SCA_ISensor::PySetInvert(PyObject* self, PyObject* args, PyObject* kwds)
+PyObject* SCA_ISensor::PySetInvert(PyObject* args)
 {
+       ShowDeprecationWarning("setInvert()", "the invert property");
        int pyarg = 0;
-       if(!PyArg_ParseTuple(args, "i", &pyarg)) { return NULL; }
+       if(!PyArg_ParseTuple(args, "i:setInvert", &pyarg)) { return NULL; }
        m_invert = PyArgToBool(pyarg);
-       Py_Return;
+       Py_RETURN_NONE;
 }
 
-char SCA_ISensor::GetUseNegPulseMode_doc[] = 
+const char SCA_ISensor::GetLevel_doc[] = 
+"getLevel()\n"
+"\tReturns whether this sensor is a level detector or a edge detector.\n"
+"\tIt makes a difference only in case of logic state transition (state actuator).\n"
+"\tA level detector will immediately generate a pulse, negative or positive\n"
+"\tdepending on the sensor condition, as soon as the state is activated.\n"
+"\tA edge detector will wait for a state change before generating a pulse.\n";
+PyObject* SCA_ISensor::PyGetLevel()
+{
+       ShowDeprecationWarning("getLevel()", "the level property");
+       return BoolToPyArg(m_level);
+}
+
+const char SCA_ISensor::SetLevel_doc[] = 
+"setLevel(level?)\n"
+"\t- level?: Detect level instead of edge? (KX_TRUE, KX_FALSE)\n"
+"\tSet whether to detect level or edge transition when entering a state.\n";
+PyObject* SCA_ISensor::PySetLevel(PyObject* args)
+{
+       ShowDeprecationWarning("setLevel()", "the level property");
+       int pyarg = 0;
+       if(!PyArg_ParseTuple(args, "i:setLevel", &pyarg)) { return NULL; }
+       m_level = PyArgToBool(pyarg);
+       Py_RETURN_NONE;
+}
+
+const char SCA_ISensor::GetUseNegPulseMode_doc[] = 
 "getUseNegPulseMode()\n"
 "\tReturns whether negative pulse mode is active.\n";
-PyObject* SCA_ISensor::PyGetUseNegPulseMode(PyObject* self, PyObject* args, PyObject* kwds)
+PyObject* SCA_ISensor::PyGetUseNegPulseMode()
 {
+       ShowDeprecationWarning("getUseNegPulseMode()", "the useNegPulseMode property");
        return BoolToPyArg(m_neg_pulsemode);
 }
 
-char SCA_ISensor::SetUseNegPulseMode_doc[] = 
+const char SCA_ISensor::SetUseNegPulseMode_doc[] = 
 "setUseNegPulseMode(pulse?)\n"
 "\t - pulse? : Pulse when a negative event occurs?\n"
 "\t            (KX_TRUE, KX_FALSE)\n"
 "\tSet whether to do pulsing when negative pulses occur.\n";
-PyObject* SCA_ISensor::PySetUseNegPulseMode(PyObject* self, PyObject* args, PyObject* kwds)
+PyObject* SCA_ISensor::PySetUseNegPulseMode(PyObject* args)
 {
+       ShowDeprecationWarning("setUseNegPulseMode()", "the useNegPulseMode property");
        int pyarg = 0;
-       if(!PyArg_ParseTuple(args, "i", &pyarg)) { return NULL; }
+       if(!PyArg_ParseTuple(args, "i:setUseNegPulseMode", &pyarg)) { return NULL; }
        m_neg_pulsemode = PyArgToBool(pyarg);
-       Py_Return;
+       Py_RETURN_NONE;
+}
+//<------Deprecated
+
+KX_PYMETHODDEF_DOC_NOARGS(SCA_ISensor, reset,
+"reset()\n"
+"\tReset sensor internal state, effect depends on the type of sensor and settings.\n"
+"\tThe sensor is put in its initial state as if it was just activated.\n")
+{
+       Init();
+       Py_RETURN_NONE;
+}
+
+/* ----------------------------------------------- */
+/* Python Integration Hooks                                           */
+/* ----------------------------------------------- */
+
+PyTypeObject SCA_ISensor::Type = {
+       PyObject_HEAD_INIT(NULL)
+       0,
+       "SCA_ISensor",
+       sizeof(PyObjectPlus_Proxy),
+       0,
+       py_base_dealloc,
+       0,
+       0,
+       0,
+       0,
+       py_base_repr,
+       0,0,0,0,0,0,
+       py_base_getattro,
+       py_base_setattro,
+       0,0,0,0,0,0,0,0,0,
+       Methods
+};
+
+PyParentObject SCA_ISensor::Parents[] = {
+       &SCA_ISensor::Type,
+       &SCA_ILogicBrick::Type,
+       &CValue::Type,
+       NULL
+};
+PyMethodDef SCA_ISensor::Methods[] = {
+       //Deprecated functions ----->
+       {"isPositive", (PyCFunction) SCA_ISensor::sPyIsPositive, 
+        METH_NOARGS, (PY_METHODCHAR)IsPositive_doc},
+       {"isTriggered", (PyCFunction) SCA_ISensor::sPyIsTriggered, 
+        METH_VARARGS, (PY_METHODCHAR)IsTriggered_doc},
+       {"getUsePosPulseMode", (PyCFunction) SCA_ISensor::sPyGetUsePosPulseMode, 
+        METH_NOARGS, (PY_METHODCHAR)GetUsePosPulseMode_doc},
+       {"setUsePosPulseMode", (PyCFunction) SCA_ISensor::sPySetUsePosPulseMode, 
+        METH_VARARGS, (PY_METHODCHAR)SetUsePosPulseMode_doc},
+       {"getFrequency", (PyCFunction) SCA_ISensor::sPyGetFrequency, 
+        METH_NOARGS, (PY_METHODCHAR)GetFrequency_doc},
+       {"setFrequency", (PyCFunction) SCA_ISensor::sPySetFrequency, 
+        METH_VARARGS, (PY_METHODCHAR)SetFrequency_doc},
+       {"getUseNegPulseMode", (PyCFunction) SCA_ISensor::sPyGetUseNegPulseMode, 
+        METH_NOARGS, (PY_METHODCHAR)GetUseNegPulseMode_doc},
+       {"setUseNegPulseMode", (PyCFunction) SCA_ISensor::sPySetUseNegPulseMode, 
+        METH_VARARGS, (PY_METHODCHAR)SetUseNegPulseMode_doc},
+       {"getInvert", (PyCFunction) SCA_ISensor::sPyGetInvert, 
+        METH_NOARGS, (PY_METHODCHAR)GetInvert_doc},
+       {"setInvert", (PyCFunction) SCA_ISensor::sPySetInvert, 
+        METH_VARARGS, (PY_METHODCHAR)SetInvert_doc},
+       {"getLevel", (PyCFunction) SCA_ISensor::sPyGetLevel, 
+        METH_NOARGS, (PY_METHODCHAR)GetLevel_doc},
+       {"setLevel", (PyCFunction) SCA_ISensor::sPySetLevel, 
+        METH_VARARGS, (PY_METHODCHAR)SetLevel_doc},
+        //<----- Deprecated
+       KX_PYMETHODTABLE_NOARGS(SCA_ISensor, reset),
+       {NULL,NULL} //Sentinel
+};
+
+PyAttributeDef SCA_ISensor::Attributes[] = {
+       KX_PYATTRIBUTE_BOOL_RW("usePosPulseMode",SCA_ISensor,m_pos_pulsemode),
+       KX_PYATTRIBUTE_BOOL_RW("useNegPulseMode",SCA_ISensor,m_neg_pulsemode),
+       KX_PYATTRIBUTE_INT_RW("frequency",0,100000,true,SCA_ISensor,m_pulse_frequency),
+       KX_PYATTRIBUTE_BOOL_RW("invert",SCA_ISensor,m_invert),
+       KX_PYATTRIBUTE_BOOL_RW("level",SCA_ISensor,m_level),
+       KX_PYATTRIBUTE_RO_FUNCTION("triggered", SCA_ISensor, pyattr_get_triggered),
+       KX_PYATTRIBUTE_RO_FUNCTION("positive", SCA_ISensor, pyattr_get_positive),
+       { NULL }        //Sentinel
+};
+
+PyObject*
+SCA_ISensor::py_getattro(PyObject *attr)
+{
+       py_getattro_up(SCA_ILogicBrick);
 }
 
-char SCA_ISensor::Evaluate_doc[] = 
-"evaluate()\n"
-"\tRe-evaluate the sensor so that isPositive() and other methods are up to date\n"
-"\twith current game conditions. BGE does it automatically on each frame so it's\n"
-"\tnot usually needed.\n"
-"\tReturns True or False if the sensor evaluates positively or negatively\n";
-PyObject* SCA_ISensor::PyEvaluate(PyObject* self, PyObject* args, PyObject* kwds)
+int SCA_ISensor::py_setattro(PyObject *attr, PyObject *value)
 {
-       return BoolToPyArg(Evaluate(NULL));
+       py_setattro_up(SCA_ILogicBrick);
 }
+
+PyObject* SCA_ISensor::pyattr_get_triggered(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
+{
+       SCA_ISensor* self= static_cast<SCA_ISensor*>(self_v);
+       int retval = 0;
+       if (SCA_PythonController::m_sCurrentController)
+               retval = SCA_PythonController::m_sCurrentController->IsTriggered(self);
+       return PyInt_FromLong(retval);
+}
+
+PyObject* SCA_ISensor::pyattr_get_positive(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
+{
+       SCA_ISensor* self= static_cast<SCA_ISensor*>(self_v);
+       return PyInt_FromLong(self->IsPositiveTrigger());
+}
+
 /* eof */