Merged 15170:15635 from trunk (no conflicts or even merges)
[blender.git] / source / gameengine / Ketsji / KX_RaySensor.h
1 /**
2  * Cast a ray and feel for objects
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_RAYSENSOR_H
33 #define __KX_RAYSENSOR_H
34
35 #include "SCA_ISensor.h"
36 #include "MT_Point3.h"
37
38 struct KX_ClientObjectInfo;
39
40 class KX_RaySensor : public SCA_ISensor
41 {
42         Py_Header;
43         STR_String              m_propertyname;
44         bool                    m_bFindMaterial;
45         double                  m_distance;
46         class KX_Scene* m_scene;
47         bool                    m_bTriggered;
48         int                             m_axis;
49         bool                    m_rayHit;
50         MT_Point3               m_hitPosition;
51         SCA_IObject*    m_hitObject;
52         MT_Vector3              m_hitNormal;
53         MT_Vector3              m_rayDirection;
54
55 public:
56         KX_RaySensor(class SCA_EventManager* eventmgr,
57                                         SCA_IObject* gameobj,
58                                         const STR_String& propname,
59                                         bool fFindMaterial,
60                                         double distance,
61                                         int axis,
62                                         class KX_Scene* ketsjiScene,
63                                         PyTypeObject* T = &Type);
64         virtual ~KX_RaySensor();
65         virtual CValue* GetReplica();
66
67         virtual bool Evaluate(CValue* event);
68         virtual bool IsPositiveTrigger();
69         virtual void Init();
70
71         bool RayHit(KX_ClientObjectInfo* client, MT_Point3& hit_point, MT_Vector3& hit_normal, void * const data);
72         
73         KX_PYMETHOD_DOC(KX_RaySensor,GetHitObject);
74         KX_PYMETHOD_DOC(KX_RaySensor,GetHitPosition);
75         KX_PYMETHOD_DOC(KX_RaySensor,GetHitNormal);
76         KX_PYMETHOD_DOC(KX_RaySensor,GetRayDirection);
77
78         virtual PyObject* _getattr(const STR_String& attr);
79         
80 };
81
82 #endif //__KX_RAYSENSOR_H
83