NLA SoC: Merge from 2.5 - 21179 to 21209
[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 class KX_RayCast;
40
41 class KX_RaySensor : public SCA_ISensor
42 {
43         Py_Header;
44         STR_String              m_propertyname;
45         bool                    m_bFindMaterial;
46         bool                    m_bXRay;
47         float                   m_distance;
48         class KX_Scene* m_scene;
49         bool                    m_bTriggered;
50         int                             m_axis;
51         bool                    m_rayHit;
52         float                   m_hitPosition[3];
53         SCA_IObject*    m_hitObject;
54         float                   m_hitNormal[3];
55         float                   m_rayDirection[3];
56
57 public:
58         KX_RaySensor(class SCA_EventManager* eventmgr,
59                                         SCA_IObject* gameobj,
60                                         const STR_String& propname,
61                                         bool bFindMaterial,
62                                         bool bXRay,
63                                         double distance,
64                                         int axis,
65                                         class KX_Scene* ketsjiScene,
66                                         PyTypeObject* T = &Type);
67         virtual ~KX_RaySensor();
68         virtual CValue* GetReplica();
69
70         virtual bool Evaluate();
71         virtual bool IsPositiveTrigger();
72         virtual void Init();
73
74         bool RayHit(KX_ClientObjectInfo* client, KX_RayCast* result, void * const data);
75         bool NeedRayCast(KX_ClientObjectInfo* client);
76
77
78         //Python Interface
79         enum RayAxis {
80                 KX_RAY_AXIS_POS_Y = 0,
81                 KX_RAY_AXIS_POS_X,
82                 KX_RAY_AXIS_POS_Z,
83                 KX_RAY_AXIS_NEG_X,
84                 KX_RAY_AXIS_NEG_Y,
85                 KX_RAY_AXIS_NEG_Z
86         };
87
88
89         virtual PyObject* py_getattro(PyObject *attr);
90         virtual PyObject* py_getattro_dict();
91         virtual int py_setattro(PyObject *attr, PyObject *value);
92         
93         // Deprecated ----->
94         KX_PYMETHOD_DOC_NOARGS(KX_RaySensor,GetHitObject);
95         KX_PYMETHOD_DOC_NOARGS(KX_RaySensor,GetHitPosition);
96         KX_PYMETHOD_DOC_NOARGS(KX_RaySensor,GetHitNormal);
97         KX_PYMETHOD_DOC_NOARGS(KX_RaySensor,GetRayDirection);
98         // <-----
99
100         /* Attributes */
101         static PyObject* pyattr_get_hitobject(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
102         
103 };
104
105 #endif //__KX_RAYSENSOR_H
106