/***************************************************************************
                          sensor.h  -  description
                             -------------------
    begin                : Tue Dec 19 2000
    copyright            : (C) 2000 by Jan Walter
    email                : jan@blender.nl
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef SENSOR_H
#define SENSOR_H

#include <logicbrick.h>

/**Baseclass for all sensors.
  *@author Jan Walter
  */

class Sensor : public LogicBrick  {
public: 
	Sensor();
	~Sensor();
  /** Returns a Python integer. */
  PyObject* isPositive();
  /** Returns TRUE if positive pulse mode is active, FALSE if positive pulse mode is not active. */
  PyObject* getUsePosPulseMode();
  /** Set flag to TRUE to switch on positive pulse mode, FALSE to switch off positive pulse mode. */
  PyObject* setUsePosPulseMode(int flag);
  /** Return the frequency of the updates in positive pulse mode. */
  PyObject* getPosFrequency();
  /** Set the frequency of the updates in positive pulse mode. If the frequency is negative, it is set to 0. */
  PyObject* setPosFrequency(int pulse_frequency);
  /** Returns TRUE if negative pulse mode is active, FALSE if negative pulse mode is not active. */
  PyObject* getUseNegPulseMode();
  /** Set flag to TRUE to switch on negative pulse mode, FALSE to switch off negative pulse mode. */
  PyObject* setUseNegPulseMode(int flag);
  /** Return the frequency of the updates in negative pulse mode. */
  PyObject* getNegFrequency();
  /** Set the frequency of the updates in negative pulse mode. If the frequency is negative, it is set to 0. */
  PyObject* setNegFrequency(int pulse_frequency);
  /** Returns whether or not pulses from this sensor are inverted. */
  PyObject* getInvert();
  /** Set to TRUE to invert the responses of this sensor, set to KX_FALSE to keep the normal response. */
  PyObject* setInvert(int invert);
};

#endif

Documentation generated by jan@nvidea on Thu Dec 21 14:04:43 CET 2000