doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Ketsji / KX_RaySensor.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_RaySensor.h
31  *  \ingroup ketsji
32  *  \brief Cast a ray and feel for objects
33  */
34
35 #ifndef __KX_RAYSENSOR_H
36 #define __KX_RAYSENSOR_H
37
38 #include "SCA_ISensor.h"
39 #include "MT_Point3.h"
40 #include "SCA_IScene.h" /* only for scene replace */
41 #include "KX_Scene.h" /* only for scene replace */
42
43 struct KX_ClientObjectInfo;
44 class KX_RayCast;
45
46 class KX_RaySensor : public SCA_ISensor
47 {
48         Py_Header;
49         STR_String              m_propertyname;
50         bool                    m_bFindMaterial;
51         bool                    m_bXRay;
52         float                   m_distance;
53         class KX_Scene* m_scene;
54         bool                    m_bTriggered;
55         int                             m_axis;
56         bool                    m_rayHit;
57         float                   m_hitPosition[3];
58         SCA_IObject*    m_hitObject;
59         float                   m_hitNormal[3];
60         float                   m_rayDirection[3];
61
62 public:
63         KX_RaySensor(class SCA_EventManager* eventmgr,
64                                         SCA_IObject* gameobj,
65                                         const STR_String& propname,
66                                         bool bFindMaterial,
67                                         bool bXRay,
68                                         double distance,
69                                         int axis,
70                                         class KX_Scene* ketsjiScene);
71         virtual ~KX_RaySensor();
72         virtual CValue* GetReplica();
73
74         virtual bool Evaluate();
75         virtual bool IsPositiveTrigger();
76         virtual void Init();
77
78         bool RayHit(KX_ClientObjectInfo* client, KX_RayCast* result, void * const data);
79         bool NeedRayCast(KX_ClientObjectInfo* client);
80
81         virtual void            Replace_IScene(SCA_IScene *val) 
82         {       
83                 m_scene= static_cast<KX_Scene *>(val); 
84         }
85
86         //Python Interface
87         enum RayAxis {
88                 KX_RAY_AXIS_POS_Y = 0,
89                 KX_RAY_AXIS_POS_X,
90                 KX_RAY_AXIS_POS_Z,
91                 KX_RAY_AXIS_NEG_X,
92                 KX_RAY_AXIS_NEG_Y,
93                 KX_RAY_AXIS_NEG_Z
94         };
95         
96 #ifdef WITH_PYTHON
97
98         /* Attributes */
99         static PyObject* pyattr_get_hitobject(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
100         
101 #endif // WITH_PYTHON
102
103 };
104
105 #endif //__KX_RAYSENSOR_H
106