source/gameengine/Ketsji/KX_NearSensor.h

   1 /*
   2  * ***** BEGIN GPL LICENSE BLOCK *****
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  19  * All rights reserved.
  20  *
  21  * The Original Code is: all of this file.
  22  *
  23  * Contributor(s): none yet.
  24  *
  25  * ***** END GPL LICENSE BLOCK *****
  26  */
  27
  28 /** \file KX_NearSensor.h
  29  *  \ingroup ketsji
  30  *  \brief Sense if other objects are near
  31  */
  32
  33 #ifndef __KX_NEARSENSOR_H__
  34 #define __KX_NEARSENSOR_H__
  35
  36 #include "KX_TouchSensor.h"
  37 #include "KX_ClientObjectInfo.h"
  38
  39 class KX_Scene;
  40 struct PHY_CollData;
  41
  42 class KX_NearSensor : public KX_TouchSensor
  43 {
  44         Py_Header
  45 protected:
  46         float   m_Margin;
  47         float  m_ResetMargin;
  48
  49         KX_ClientObjectInfo*    m_client_info;
  50 public:
  51         KX_NearSensor(class SCA_EventManager* eventmgr,
  52                       class KX_GameObject* gameobj,
  53                       float margin,
  54                       float resetmargin,
  55                       bool bFindMaterial,
  56                       const STR_String& touchedpropname,
  57                       PHY_IPhysicsController*   ctrl);
  58 /*
  59 public:
  60         KX_NearSensor(class SCA_EventManager* eventmgr,
  61                         class KX_GameObject* gameobj,
  62                         double margin,
  63                         double resetmargin,
  64                         bool bFindMaterial,
  65                         const STR_String& touchedpropname,
  66                         class KX_Scene* scene);
  67 */
  68         virtual ~KX_NearSensor();
  69         virtual void SynchronizeTransform();
  70         virtual CValue* GetReplica();
  71         virtual void ProcessReplica();
  72         virtual void SetPhysCtrlRadius();
  73         virtual bool Evaluate();
  74
  75         virtual void ReParent(SCA_IObject* parent);
  76         virtual bool    NewHandleCollision(void* obj1,void* obj2,
  77                                                  const PHY_CollData * coll_data);
  78         virtual bool    BroadPhaseFilterCollision(void*obj1,void*obj2);
  79         virtual bool    BroadPhaseSensorFilterCollision(void*obj1,void*obj2) { return false; };
  80         virtual sensortype GetSensorType() { return ST_NEAR; }
  81
  82 #ifdef WITH_PYTHON
  83
  84         /* --------------------------------------------------------------------- */
  85         /* Python interface ---------------------------------------------------- */
  86         /* --------------------------------------------------------------------- */
  87
  88         //No methods
  89
  90         //This method is used to make sure the distance does not exceed the reset distance
  91         static int CheckResetDistance(void *self, const PyAttributeDef*)
  92         {
  93                 KX_NearSensor* sensor = reinterpret_cast<KX_NearSensor*>(self);
  94
  95                 if (sensor->m_Margin > sensor->m_ResetMargin)
  96                         sensor->m_ResetMargin = sensor->m_Margin;
  97
  98                 sensor->SetPhysCtrlRadius();
  99
 100                 return 0;
 101         }
 102
 103 #endif // WITH_PYTHON
 104
 105 };
 106
 107 #endif //__KX_NEARSENSOR_H__
 108