BGE Python API
[blender.git] / source / gameengine / Ketsji / KX_TouchSensor.h
1 /**
2  * Senses touch and collision events
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_TOUCHSENSOR
33 #define __KX_TOUCHSENSOR
34
35 #include "SCA_ISensor.h"
36 #include "ListValue.h"
37
38 struct PHY_CollData;
39
40 #include "KX_ClientObjectInfo.h"
41
42 class KX_TouchEventManager;
43
44 class KX_TouchSensor : public SCA_ISensor
45 {
46 protected:
47         Py_Header;
48
49         /**
50          * The sensor should only look for objects with this property.
51          */
52         STR_String                              m_touchedpropname;      
53         bool                                    m_bFindMaterial;
54         class SCA_EventManager* m_eventmgr;
55         
56         class PHY_IPhysicsController*   m_physCtrl;
57
58         bool                                    m_bCollision;
59         bool                                    m_bTriggered;
60         bool                                    m_bLastTriggered;
61         SCA_IObject*                m_hitObject;
62         class CListValue*               m_colliders;
63         
64 public:
65         KX_TouchSensor(class SCA_EventManager* eventmgr,
66                 class KX_GameObject* gameobj,
67                 bool fFindMaterial,
68                 const STR_String& touchedpropname,
69                 PyTypeObject* T=&Type) ;
70         virtual ~KX_TouchSensor();
71
72         virtual CValue* GetReplica();
73         virtual void SynchronizeTransform();
74         virtual bool Evaluate(CValue* event);
75         virtual void Init();
76         virtual void ReParent(SCA_IObject* parent);
77         
78         virtual void RegisterSumo(KX_TouchEventManager* touchman);
79         virtual void UnregisterSumo(KX_TouchEventManager* touchman);
80         virtual void UnregisterToManager();
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 char *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