add missing files after merging
[blender.git] / source / gameengine / Ketsji / KX_TouchSensor.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file KX_TouchSensor.h
31  *  \ingroup ketsji
32  *  \brief Senses touch and collision events
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 #if defined(_WIN64)
46 typedef unsigned __int64 uint_ptr;
47 #else
48 typedef unsigned long uint_ptr;
49 #endif
50
51 class KX_TouchEventManager;
52
53 class KX_TouchSensor : public SCA_ISensor
54 {
55 protected:
56         Py_Header;
57
58         /**
59          * The sensor should only look for objects with this property.
60          */
61         STR_String                              m_touchedpropname;      
62         bool                                    m_bFindMaterial;
63         bool                                    m_bTouchPulse;          /* changes in the colliding objects trigger pulses */
64         
65         class PHY_IPhysicsController*   m_physCtrl;
66
67         bool                                    m_bCollision;
68         bool                                    m_bTriggered;
69         bool                                    m_bLastTriggered;
70
71         // Use with m_bTouchPulse to detect changes
72         int                                             m_bLastCount;           /* size of m_colliders last tick */
73         uint_ptr                                m_bColliderHash;        /* hash collision objects pointers to trigger incase one object collides and another takes its place */
74         uint_ptr                                m_bLastColliderHash;
75
76         SCA_IObject*                m_hitObject;
77         class CListValue*               m_colliders;
78         
79 public:
80         KX_TouchSensor(class SCA_EventManager* eventmgr,
81                 class KX_GameObject* gameobj,
82                 bool bFindMaterial,
83                 bool bTouchPulse,
84                 const STR_String& touchedpropname) ;
85         virtual ~KX_TouchSensor();
86
87         virtual CValue* GetReplica();
88         virtual void ProcessReplica();
89         virtual void SynchronizeTransform();
90         virtual bool Evaluate();
91         virtual void Init();
92         virtual void ReParent(SCA_IObject* parent);
93         
94         virtual void RegisterSumo(KX_TouchEventManager* touchman);
95         virtual void UnregisterSumo(KX_TouchEventManager* touchman);
96         virtual void UnregisterToManager();
97
98 //      virtual DT_Bool HandleCollision(void* obj1,void* obj2,
99 //                                               const DT_CollData * coll_data); 
100
101         virtual bool    NewHandleCollision(void*obj1,void*obj2,const PHY_CollData* colldata);
102
103         // Allows to do pre-filtering and save computation time
104         // obj1 = sensor physical controller, obj2 = physical controller of second object
105         // return value = true if collision should be checked on pair of object
106         virtual bool    BroadPhaseFilterCollision(void*obj1,void*obj2) { return true; }
107         virtual bool    BroadPhaseSensorFilterCollision(void*obj1,void*obj2);
108         virtual sensortype GetSensorType() { return ST_TOUCH; }
109   
110
111         virtual bool IsPositiveTrigger() {
112                 bool result = m_bTriggered;
113                 if (m_invert) result = !result;
114                 return result;
115         }
116         
117         virtual void EndFrame();
118
119         class PHY_IPhysicsController* GetPhysicsController() { return m_physCtrl; }
120
121
122         // todo: put some info for collision maybe
123
124 #ifdef WITH_PYTHON
125
126         /* --------------------------------------------------------------------- */
127         /* Python interface ---------------------------------------------------- */
128         /* --------------------------------------------------------------------- */
129         
130         static PyObject*        pyattr_get_object_hit(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
131         static PyObject*        pyattr_get_object_hit_list(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
132
133 #endif
134         
135 };
136
137 #endif //__KX_TOUCHSENSOR
138