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.

1 files changed, 77 insertions, 0 deletions

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
+