BGE patch: New Delay sensor (derived from patch #17472)

Introduction of a new Delay sensor that can be used to 
generate positive and negative triggers at precise time,
expressed in number of frames. 
The delay parameter defines the length of the initial 
OFF period. A positive trigger is generated at the end
of this period. The duration parameter defines the 
length of the ON period following the OFF period.
A negative trigger is generated at the end of the ON period. 
If duration is 0, the sensor stays ON and there is no 
negative trigger. 
The sensor runs the OFF-ON cycle once unless the repeat 
option is set: the OFF-ON cycle repeats indefinately 
(or the OFF cycle if duration is 0).

The new generic SCA_ISensor::reset() Python function
can be used at any time to restart the sensor: the
current cycle is interrupted and no trigger is generated.

4 files changed, 348 insertions, 0 deletions

diff --git a/source/gameengine/GameLogic/SCA_DelaySensor.cpp b/source/gameengine/GameLogic/SCA_DelaySensor.cpp
new file mode 100644
index 00000000000..4d05250e91c
--- /dev/null
+++ b/source/gameengine/GameLogic/SCA_DelaySensor.cpp
@@ -0,0 +1,257 @@
+/**
+ * Delay trigger
+ *
+ * $Id$
+ *
+ * ***** 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.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ *
+ * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
+ * All rights reserved.
+ *
+ * The Original Code is: all of this file.
+ *
+ * Contributor(s): none yet.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#ifdef WIN32
+// This warning tells us about truncation of __long__ stl-generated names.
+// It can occasionally cause DevStudio to have internal compiler warnings.
+#pragma warning( disable : 4786 )     
+#endif
+
+#include "SCA_DelaySensor.h"
+#include "SCA_LogicManager.h"
+#include "SCA_EventManager.h"
+
+/* ------------------------------------------------------------------------- */
+/* Native functions                                                          */
+/* ------------------------------------------------------------------------- */
+
+SCA_DelaySensor::SCA_DelaySensor(class SCA_EventManager* eventmgr,
+								 SCA_IObject* gameobj,
+								 int delay,
+								 int duration,
+								 bool repeat,
+								 PyTypeObject* T)
+	: SCA_ISensor(gameobj,eventmgr, T), 
+	m_delay(delay),
+	m_duration(duration),
+	m_repeat(repeat)
+{
+	Init();
+}
+
+void SCA_DelaySensor::Init()
+{
+	m_lastResult = false;
+	m_frameCount = -1;
+	m_reset = true;
+}
+
+SCA_DelaySensor::~SCA_DelaySensor()
+{
+	/* intentionally empty */
+}
+
+CValue* SCA_DelaySensor::GetReplica()
+{
+	CValue* replica = new SCA_DelaySensor(*this);
+	// this will copy properties and so on...
+	CValue::AddDataToReplica(replica);
+
+	return replica;
+}
+
+
+
+bool SCA_DelaySensor::IsPositiveTrigger()
+{ 
+	return (m_invert ? !m_lastResult : m_lastResult);
+}
+
+bool SCA_DelaySensor::Evaluate(CValue* event)
+{
+	bool trigger = false;
+	bool result;
+
+	if (m_frameCount==-1) {
+		// this is needed to ensure ON trigger in case delay==0
+		// and avoid spurious OFF trigger when duration==0
+		m_lastResult = false;
+		m_frameCount = 0;
+	}
+
+	if (m_frameCount<m_delay) {
+		m_frameCount++;
+		result = false;
+	} else if (m_duration > 0) {
+		if (m_frameCount < m_delay+m_duration) {
+			m_frameCount++;
+			result = true;
+		} else {
+			result = false;
+			if (m_repeat)
+				m_frameCount = -1;
+		}
+	} else {
+		result = true;
+		if (m_repeat)
+			m_frameCount = -1;
+	}
+	if ((m_reset && m_level) || result != m_lastResult)
+		trigger = true;
+	m_reset = false;
+	m_lastResult = result;
+	return trigger;
+}
+
+/* ------------------------------------------------------------------------- */
+/* Python functions                                                          */
+/* ------------------------------------------------------------------------- */
+
+/* Integration hooks ------------------------------------------------------- */
+PyTypeObject SCA_DelaySensor::Type = {
+	PyObject_HEAD_INIT(&PyType_Type)
+	0,
+	"SCA_DelaySensor",
+	sizeof(SCA_DelaySensor),
+	0,
+	PyDestructor,
+	0,
+	__getattr,
+	__setattr,
+	0, //&MyPyCompare,
+	__repr,
+	0, //&cvalue_as_number,
+	0,
+	0,
+	0,
+	0
+};
+
+PyParentObject SCA_DelaySensor::Parents[] = {
+	&SCA_DelaySensor::Type,
+	&SCA_ISensor::Type,
+	&SCA_ILogicBrick::Type,
+	&CValue::Type,
+	NULL
+};
+
+PyMethodDef SCA_DelaySensor::Methods[] = {
+	/* setProperty */
+	{"setDelay", (PyCFunction) SCA_DelaySensor::sPySetDelay, METH_VARARGS, SetDelay_doc},
+	{"setDuration", (PyCFunction) SCA_DelaySensor::sPySetDuration, METH_VARARGS, SetDuration_doc},
+	{"setRepeat", (PyCFunction) SCA_DelaySensor::sPySetRepeat, METH_VARARGS, SetRepeat_doc},
+	/* getProperty */
+	{"getDelay", (PyCFunction) SCA_DelaySensor::sPyGetDelay, METH_NOARGS, GetDelay_doc},
+	{"getDuration", (PyCFunction) SCA_DelaySensor::sPyGetDuration, METH_NOARGS, GetDuration_doc},
+	{"getRepeat", (PyCFunction) SCA_DelaySensor::sPyGetRepeat, METH_NOARGS, GetRepeat_doc},
+	{NULL,NULL} //Sentinel
+};
+
+PyObject* SCA_DelaySensor::_getattr(const STR_String& attr) {
+	_getattr_up(SCA_ISensor);
+}
+
+char SCA_DelaySensor::SetDelay_doc[] = 
+"setDelay(delay)\n"
+"\t- delay: length of the initial OFF period as number of frame\n"
+"\t         0 for immediate trigger\n"
+"\tSet the initial delay before the positive trigger\n";
+PyObject* SCA_DelaySensor::PySetDelay(PyObject* self, PyObject* args, PyObject* kwds)
+{
+	int delay;
+	
+	if(!PyArg_ParseTuple(args, "i", &delay)) {
+		return NULL;
+	}
+	if (delay < 0) {
+		PyErr_SetString(PyExc_ValueError, "Delay cannot be negative");
+		return NULL;
+	}
+	m_delay = delay;
+	Py_Return;
+}
+
+char SCA_DelaySensor::SetDuration_doc[] = 
+"setDuration(duration)\n"
+"\t- duration: length of the ON period in number of frame after the initial off period\n"
+"\t            0 for no ON period\n"
+"\tSet the duration of the ON pulse after initial delay.\n"
+"\tIf > 0, a negative trigger is fired at the end of the ON pulse.\n";
+PyObject* SCA_DelaySensor::PySetDuration(PyObject* self, PyObject* args, PyObject* kwds)
+{
+	int duration;
+	
+	if(!PyArg_ParseTuple(args, "i", &duration)) {
+		return NULL;
+	}
+	if (duration < 0) {
+		PyErr_SetString(PyExc_ValueError, "Duration cannot be negative");
+		return NULL;
+	}
+	m_duration = duration;
+	Py_Return;
+}
+
+char SCA_DelaySensor::SetRepeat_doc[] = 
+"setRepeat(repeat)\n"
+"\t- repeat: 1 if the initial OFF-ON cycle should be repeated indefinately\n"
+"\t          0 if the initial OFF-ON cycle should run only once\n"
+"\tSet the sensor repeat mode\n";
+PyObject* SCA_DelaySensor::PySetRepeat(PyObject* self, PyObject* args, PyObject* kwds)
+{
+	int repeat;
+	
+	if(!PyArg_ParseTuple(args, "i", &repeat)) {
+		return NULL;
+	}
+	m_repeat = (repeat != 0);
+	Py_Return;
+}
+
+char SCA_DelaySensor::GetDelay_doc[] = 
+"getDelay()\n"
+"\tReturn the delay parameter value\n";
+PyObject* SCA_DelaySensor::PyGetDelay(PyObject* self)
+{
+	return PyInt_FromLong(m_delay);
+}
+
+char SCA_DelaySensor::GetDuration_doc[] = 
+"getDuration()\n"
+"\tReturn the duration parameter value\n";
+PyObject* SCA_DelaySensor::PyGetDuration(PyObject* self)
+{
+	return PyInt_FromLong(m_duration);
+}
+
+char SCA_DelaySensor::GetRepeat_doc[] = 
+"getRepeat()\n"
+"\tReturn the repeat parameter value\n";
+PyObject* SCA_DelaySensor::PyGetRepeat(PyObject* self)
+{
+	return BoolToPyArg(m_repeat);
+}
+
+/* eof */
diff --git a/source/gameengine/GameLogic/SCA_DelaySensor.h b/source/gameengine/GameLogic/SCA_DelaySensor.h
new file mode 100644
index 00000000000..a997fabe3cd
--- /dev/null
+++ b/source/gameengine/GameLogic/SCA_DelaySensor.h
@@ -0,0 +1,77 @@
+/**
+ * SCA_DelaySensor.h
+ *
+ * $Id$
+ *
+ * ***** 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.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ *
+ * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
+ * All rights reserved.
+ *
+ * The Original Code is: all of this file.
+ *
+ * Contributor(s): none yet.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+#ifndef __KX_DELAYSENSOR
+#define __KX_DELAYSENSOR
+#include "SCA_ISensor.h"
+
+class SCA_DelaySensor : public SCA_ISensor
+{
+	Py_Header;
+	bool			m_lastResult;
+	bool			m_repeat;
+	int				m_delay; 
+	int				m_duration;
+	int				m_frameCount;
+
+public:
+	SCA_DelaySensor(class SCA_EventManager* eventmgr,
+					SCA_IObject* gameobj,
+					int delay,
+					int duration,
+					bool repeat,
+					PyTypeObject* T =&Type);
+	virtual ~SCA_DelaySensor();
+	virtual CValue* GetReplica();
+	virtual bool Evaluate(CValue* event);
+	virtual bool IsPositiveTrigger();
+	virtual void Init();
+
+
+	/* --------------------------------------------------------------------- */
+	/* Python interface ---------------------------------------------------- */
+	/* --------------------------------------------------------------------- */
+	
+	virtual PyObject* _getattr(const STR_String& attr);
+
+	/* setProperty */
+	KX_PYMETHOD_DOC(SCA_DelaySensor,SetDelay);
+	KX_PYMETHOD_DOC(SCA_DelaySensor,SetDuration);
+	KX_PYMETHOD_DOC(SCA_DelaySensor,SetRepeat);
+	/* getProperty */
+	KX_PYMETHOD_DOC_NOARGS(SCA_DelaySensor,GetDelay);
+	KX_PYMETHOD_DOC_NOARGS(SCA_DelaySensor,GetDuration);
+	KX_PYMETHOD_DOC_NOARGS(SCA_DelaySensor,GetRepeat);
+
+};
+
+#endif //__KX_ALWAYSSENSOR
+
diff --git a/source/gameengine/GameLogic/SCA_ISensor.cpp b/source/gameengine/GameLogic/SCA_ISensor.cpp
index 2dc49924062..f99b9b789d7 100644
--- a/source/gameengine/GameLogic/SCA_ISensor.cpp
+++ b/source/gameengine/GameLogic/SCA_ISensor.cpp
@@ -189,6 +189,8 @@ PyMethodDef SCA_ISensor::Methods[] = {
 	 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
 };
 
@@ -390,4 +392,15 @@ PyObject* SCA_ISensor::PySetUseNegPulseMode(PyObject* self, PyObject* args, PyOb
 	Py_Return;
 }
 
+char SCA_ISensor::Reset_doc[] = 
+"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)
+{
+	Init();
+	Py_Return;
+}
+
+
 /* eof */
diff --git a/source/gameengine/GameLogic/SCA_ISensor.h b/source/gameengine/GameLogic/SCA_ISensor.h
index d5dabbce3ee..fc8f0bd0011 100644
--- a/source/gameengine/GameLogic/SCA_ISensor.h
+++ b/source/gameengine/GameLogic/SCA_ISensor.h
@@ -148,6 +148,7 @@ public:
 	KX_PYMETHOD_DOC(SCA_ISensor,SetInvert);
 	KX_PYMETHOD_DOC_NOARGS(SCA_ISensor,GetLevel);
 	KX_PYMETHOD_DOC(SCA_ISensor,SetLevel);
+	KX_PYMETHOD_DOC_NOARGS(SCA_ISensor,Reset);
 
 };