2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r19323...
[blender.git] / source / gameengine / GameLogic / SCA_ISensor.cpp
index 260805e0aa8b8e4312a6c1a0f5554a69210cd945..68f5653d53ae9a08e7281b0bd6fabdd178c9c35d 100644 (file)
@@ -105,7 +105,7 @@ void SCA_ISensor::SetLevel(bool lvl) {
 }
 
 
-float SCA_ISensor::GetNumber() {
+double SCA_ISensor::GetNumber() {
        return IsPositiveTrigger();
 }
 
@@ -139,71 +139,6 @@ void SCA_ISensor::DecLink() {
        }
 }
 
-/* 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_NOARGS, IsPositive_doc},
-       {"isTriggered", (PyCFunction) SCA_ISensor::sPyIsTriggered, 
-        METH_VARARGS, IsTriggered_doc},
-       {"getUsePosPulseMode", (PyCFunction) SCA_ISensor::sPyGetUsePosPulseMode, 
-        METH_NOARGS, GetUsePosPulseMode_doc},
-       {"setUsePosPulseMode", (PyCFunction) SCA_ISensor::sPySetUsePosPulseMode, 
-        METH_VARARGS, SetUsePosPulseMode_doc},
-       {"getFrequency", (PyCFunction) SCA_ISensor::sPyGetFrequency, 
-        METH_NOARGS, GetFrequency_doc},
-       {"setFrequency", (PyCFunction) SCA_ISensor::sPySetFrequency, 
-        METH_VARARGS, SetFrequency_doc},
-       {"getUseNegPulseMode", (PyCFunction) SCA_ISensor::sPyGetUseNegPulseMode, 
-        METH_NOARGS, GetUseNegPulseMode_doc},
-       {"setUseNegPulseMode", (PyCFunction) SCA_ISensor::sPySetUseNegPulseMode, 
-        METH_VARARGS, SetUseNegPulseMode_doc},
-       {"getInvert", (PyCFunction) SCA_ISensor::sPyGetInvert, 
-        METH_NOARGS, GetInvert_doc},
-       {"setInvert", (PyCFunction) SCA_ISensor::sPySetInvert, 
-        METH_VARARGS, SetInvert_doc},
-       {"getLevel", (PyCFunction) SCA_ISensor::sPyGetLevel, 
-        METH_NOARGS, GetLevel_doc},
-       {"setLevel", (PyCFunction) SCA_ISensor::sPySetLevel, 
-        METH_VARARGS, SetLevel_doc},
-       {"reset", (PyCFunction) SCA_ISensor::sPyReset, 
-        METH_NOARGS, Reset_doc},
-       {NULL,NULL} //Sentinel
-};
-
-
-PyObject*
-SCA_ISensor::_getattr(const STR_String& attr)
-{
-  _getattr_up(SCA_ILogicBrick);
-}
-
-
 void SCA_ISensor::RegisterToManager()
 {
        // sensor is just activated, initialize it
@@ -275,13 +210,17 @@ void SCA_ISensor::Activate(class SCA_LogicManager* logicmgr,        CValue* event)
                }
        } 
 }
+/* ----------------------------------------------- */
+/* Python Functions                                                       */
+/* ----------------------------------------------- */
 
-/* Python functions: */
+//Deprecated Functions ------>
 const char SCA_ISensor::IsPositive_doc[] = 
 "isPositive()\n"
 "\tReturns whether the sensor is in an active state.\n";
-PyObject* SCA_ISensor::PyIsPositive(PyObject* self)
+PyObject* SCA_ISensor::PyIsPositive()
 {
+       ShowDeprecationWarning("isPositive()", "the read-only positive property");
        int retval = IsPositiveTrigger();
        return PyInt_FromLong(retval);
 }
@@ -289,8 +228,9 @@ PyObject* SCA_ISensor::PyIsPositive(PyObject* self)
 const char SCA_ISensor::IsTriggered_doc[] = 
 "isTriggered()\n"
 "\tReturns whether the sensor has triggered the current controller.\n";
-PyObject* SCA_ISensor::PyIsTriggered(PyObject* self)
+PyObject* SCA_ISensor::PyIsTriggered()
 {
+       ShowDeprecationWarning("isTriggered()", "the read-only triggered property");
        // check with the current controller
        int retval = 0;
        if (SCA_PythonController::m_sCurrentController)
@@ -304,8 +244,9 @@ PyObject* SCA_ISensor::PyIsTriggered(PyObject* self)
 const char SCA_ISensor::GetUsePosPulseMode_doc[] = 
 "getUsePosPulseMode()\n"
 "\tReturns whether positive pulse mode is active.\n";
-PyObject* SCA_ISensor::PyGetUsePosPulseMode(PyObject* self)
+PyObject* SCA_ISensor::PyGetUsePosPulseMode()
 {
+       ShowDeprecationWarning("getUsePosPulseMode()", "the usePosPulseMode property");
        return BoolToPyArg(m_pos_pulsemode);
 }
 
@@ -317,12 +258,13 @@ const char SCA_ISensor::SetUsePosPulseMode_doc[] =
 "\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;
 }
 
 /**
@@ -331,8 +273,9 @@ PyObject* SCA_ISensor::PySetUsePosPulseMode(PyObject* self, PyObject* args, PyOb
 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* SCA_ISensor::PyGetFrequency()
 {
+       ShowDeprecationWarning("getFrequency()", "the frequency property");
        return PyInt_FromLong(m_pulse_frequency);
 }
 
@@ -344,11 +287,12 @@ const char SCA_ISensor::SetFrequency_doc[] =
 "\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;
        }
        
@@ -359,15 +303,16 @@ PyObject* SCA_ISensor::PySetFrequency(PyObject* self, PyObject* args, PyObject*
        };      
        m_pulse_frequency = pulse_frequencyArg;
 
-       Py_Return;
+       Py_RETURN_NONE;
 }
 
 
 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* SCA_ISensor::PyGetInvert()
 {
+       ShowDeprecationWarning("getInvert()", "the invert property");
        return BoolToPyArg(m_invert);
 }
 
@@ -375,12 +320,13 @@ 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;
 }
 
 const char SCA_ISensor::GetLevel_doc[] = 
@@ -390,8 +336,9 @@ const char SCA_ISensor::GetLevel_doc[] =
 "\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(PyObject* self)
+PyObject* SCA_ISensor::PyGetLevel()
 {
+       ShowDeprecationWarning("getLevel()", "the level property");
        return BoolToPyArg(m_level);
 }
 
@@ -399,19 +346,21 @@ 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* self, PyObject* args, PyObject* kwds)
+PyObject* SCA_ISensor::PySetLevel(PyObject* args)
 {
+       ShowDeprecationWarning("setLevel()", "the level property");
        int pyarg = 0;
-       if(!PyArg_ParseTuple(args, "i", &pyarg)) { return NULL; }
+       if(!PyArg_ParseTuple(args, "i:setLevel", &pyarg)) { return NULL; }
        m_level = PyArgToBool(pyarg);
-       Py_Return;
+       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* SCA_ISensor::PyGetUseNegPulseMode()
 {
+       ShowDeprecationWarning("getUseNegPulseMode()", "the useNegPulseMode property");
        return BoolToPyArg(m_neg_pulsemode);
 }
 
@@ -420,23 +369,120 @@ const char SCA_ISensor::SetUseNegPulseMode_doc[] =
 "\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
 
-const char SCA_ISensor::Reset_doc[] = 
+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";
-PyObject* SCA_ISensor::PyReset(PyObject* self)
+"\tThe sensor is put in its initial state as if it was just activated.\n")
 {
        Init();
-       Py_Return;
+       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);
+}
+
+int SCA_ISensor::py_setattro(PyObject *attr, PyObject *value)
+{
+       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 */