Radar/Near sensor performance problem fixed
[blender-staging.git] / source / gameengine / Ketsji / KX_TouchSensor.h
1 /**
2  * Senses touch and collision events
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL/BL DUAL 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. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34
35 #ifndef __KX_TOUCHSENSOR
36 #define __KX_TOUCHSENSOR
37
38 #include "SCA_ISensor.h"
39 #include "ListValue.h"
40
41 struct PHY_CollData;
42
43 #include "KX_ClientObjectInfo.h"
44
45 class KX_TouchEventManager;
46
47 class KX_TouchSensor : public SCA_ISensor
48 {
49 protected:
50         Py_Header;
51
52         /**
53          * The sensor should only look for objects with this property.
54          */
55         STR_String                              m_touchedpropname;      
56         bool                                    m_bFindMaterial;
57         class SCA_EventManager* m_eventmgr;
58         
59         class PHY_IPhysicsController*   m_physCtrl;
60
61         bool                                    m_bCollision;
62         bool                                    m_bTriggered;
63         bool                                    m_bLastTriggered;
64         SCA_IObject*                m_hitObject;
65         class CListValue*               m_colliders;
66         
67 public:
68         KX_TouchSensor(class SCA_EventManager* eventmgr,
69                 class KX_GameObject* gameobj,
70                 bool fFindMaterial,
71                 const STR_String& touchedpropname,
72                 PyTypeObject* T=&Type) ;
73         virtual ~KX_TouchSensor();
74
75         virtual CValue* GetReplica();
76         virtual void SynchronizeTransform();
77         virtual bool Evaluate(CValue* event);
78         virtual void ReParent(SCA_IObject* parent);
79         
80         virtual void RegisterSumo(KX_TouchEventManager* touchman);
81
82 //      virtual DT_Bool HandleCollision(void* obj1,void* obj2,
83 //                                               const DT_CollData * coll_data); 
84
85         virtual bool    NewHandleCollision(void*obj1,void*obj2,const PHY_CollData* colldata);
86
87         // Allows to do pre-filtering and save computation time
88         // obj1 = sensor physical controller, obj2 = physical controller of second object
89         // return value = true if collision should be checked on pair of object
90         virtual bool    BroadPhaseFilterCollision(void*obj1,void*obj2) { return true; }
91
92   
93
94         virtual bool IsPositiveTrigger() {
95                 bool result = m_bTriggered;
96                 if (m_invert) result = !result;
97                 return result;
98         }
99
100         
101         virtual void EndFrame();
102
103         // todo: put some info for collision maybe
104
105         /* --------------------------------------------------------------------- */
106         /* Python interface ---------------------------------------------------- */
107         /* --------------------------------------------------------------------- */
108         
109         virtual PyObject* _getattr(const STR_String& attr);
110
111         /* 1. setProperty */
112         KX_PYMETHOD_DOC(KX_TouchSensor,SetProperty);
113         /* 2. getProperty */
114         KX_PYMETHOD_DOC(KX_TouchSensor,GetProperty);
115         /* 3. getHitObject */
116         KX_PYMETHOD_DOC(KX_TouchSensor,GetHitObject);
117         /* 4. getHitObject */
118         KX_PYMETHOD_DOC(KX_TouchSensor,GetHitObjectList);
119         /* 5. getTouchMaterial */
120         KX_PYMETHOD_DOC(KX_TouchSensor,GetTouchMaterial);
121         /* 6. setTouchMaterial */
122         KX_PYMETHOD_DOC(KX_TouchSensor,SetTouchMaterial);
123         
124 };
125
126 #endif //__KX_TOUCHSENSOR
127