NLA SoC: Merge from 2.5
[blender.git] / source / gameengine / Ketsji / KX_NearSensor.h
1 /**
2  * Sense if other objects are near
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #ifndef KX_NEARSENSOR_H
33 #define KX_NEARSENSOR_H
34
35 #include "KX_TouchSensor.h"
36 #include "KX_ClientObjectInfo.h"
37
38 class KX_Scene;
39 struct PHY_CollData;
40
41 class KX_NearSensor : public KX_TouchSensor
42 {
43         Py_Header;
44 protected:
45         float   m_Margin;
46         float  m_ResetMargin;
47         KX_Scene*       m_scene;
48         KX_ClientObjectInfo*    m_client_info;
49 public:
50         KX_NearSensor(class SCA_EventManager* eventmgr,
51                         class KX_GameObject* gameobj,
52                         float margin,
53                         float resetmargin,
54                         bool bFindMaterial,
55                         const STR_String& touchedpropname,
56                         class KX_Scene* scene,
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 bool Evaluate();
73
74         virtual void ReParent(SCA_IObject* parent);
75         virtual bool    NewHandleCollision(void* obj1,void* obj2,
76                                                  const PHY_CollData * coll_data); 
77         virtual bool    BroadPhaseFilterCollision(void*obj1,void*obj2);
78         virtual bool    BroadPhaseSensorFilterCollision(void*obj1,void*obj2) { return false; };
79         virtual sensortype GetSensorType() { return ST_NEAR; }
80
81         /* --------------------------------------------------------------------- */
82         /* Python interface ---------------------------------------------------- */
83         /* --------------------------------------------------------------------- */
84
85         //No methods
86
87         //This method is used to make sure the distance does not exceed the reset distance
88         static int CheckResetDistance(void *self, const PyAttributeDef*)
89         {
90                 KX_NearSensor* sensor = reinterpret_cast<KX_NearSensor*>(self);
91
92                 if (sensor->m_Margin > sensor->m_ResetMargin)
93                         sensor->m_ResetMargin = sensor->m_Margin;
94
95                 return 0;
96         }
97
98 };
99
100 #endif //KX_NEARSENSOR_H
101