doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Ketsji / KX_MouseFocusSensor.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_MouseFocusSensor.h
31  *  \ingroup ketsji
32  *  \brief KX_MouseFocusSensor determines mouse in/out/over events.
33  */
34
35 #ifndef __KX_MOUSEFOCUSSENSOR
36 #define __KX_MOUSEFOCUSSENSOR
37
38 #include "SCA_MouseSensor.h"
39
40 class KX_RayCast;
41
42 /**
43  * The mouse focus sensor extends the basic SCA_MouseSensor. It has
44  * been placed in KX because it needs access to the rasterizer and
45  * SuMO.
46  *
47  * - extend the valid modes?
48  * - */
49 class KX_MouseFocusSensor : public SCA_MouseSensor
50 {
51
52         Py_Header;
53         
54  public:
55         
56         KX_MouseFocusSensor(class SCA_MouseManager* eventmgr,
57                                                 int startx,
58                                                 int starty,
59                                                 short int mousemode,
60                                                 int focusmode,
61                                                 bool bTouchPulse,
62                                                 KX_Scene* kxscene,
63                                                 KX_KetsjiEngine* kxengine,
64                                                 SCA_IObject* gameobj);
65
66         virtual ~KX_MouseFocusSensor() { ; };
67         virtual CValue* GetReplica() {
68                 CValue* replica = new KX_MouseFocusSensor(*this);
69                 // this will copy properties and so on...
70                 replica->ProcessReplica();
71                 return replica;
72         };
73
74         virtual void Replace_IScene(SCA_IScene *val)
75         {
76                 m_kxscene= static_cast<KX_Scene *>(val);
77         };
78
79
80         /**
81          * @attention Overrides default evaluate. 
82          */
83         virtual bool Evaluate();
84         virtual void Init();
85
86         virtual bool IsPositiveTrigger() {
87                 bool result = m_positive_event;
88                 if (m_invert) result = !result;
89                 return result;
90         };
91
92         bool RayHit(KX_ClientObjectInfo* client, KX_RayCast* result, void * const data);
93         bool NeedRayCast(KX_ClientObjectInfo* client) { return true; }
94         
95         const MT_Point3& RaySource() const;
96         const MT_Point3& RayTarget() const;
97         const MT_Point3& HitPosition() const;
98         const MT_Vector3& HitNormal() const;
99         const MT_Vector2& HitUV() const;
100         
101 #ifdef WITH_PYTHON
102
103         /* --------------------------------------------------------------------- */
104         /* Python interface ---------------------------------------------------- */
105         /* --------------------------------------------------------------------- */
106
107         /* attributes */
108         static PyObject*        pyattr_get_ray_source(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
109         static PyObject*        pyattr_get_ray_target(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
110         static PyObject*        pyattr_get_ray_direction(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
111         static PyObject*        pyattr_get_hit_object(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
112         static PyObject*        pyattr_get_hit_position(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
113         static PyObject*        pyattr_get_hit_normal(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
114         static PyObject*        pyattr_get_hit_uv(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
115                 
116 #endif // WITH_PYTHON
117
118         /* --------------------------------------------------------------------- */
119         SCA_IObject*    m_hitObject;
120         void*                   m_hitObject_Last; /* only use for comparison, never access */
121
122  private:
123         /**
124          * The focus mode. 1 for handling focus, 0 for not handling, 2 for focus on any object
125         */
126          int    m_focusmode;
127
128         /**
129          * Flags whether the previous test showed a mouse-over.
130          */
131         bool m_mouse_over_in_previous_frame;
132
133         /**
134          * Flags whether changes in hit object should trigger a pulse
135          */
136         bool m_bTouchPulse;
137         
138         /**
139          * Flags whether the previous test evaluated positive.
140          */
141         bool m_positive_event;
142
143         /**
144          * Tests whether the object is in mouse focus for this camera
145          */
146         bool ParentObjectHasFocusCamera(KX_Camera *cam);
147         
148         /**
149          * Tests whether the object is in mouse focus in this scene.
150          */
151         bool ParentObjectHasFocus(void);
152
153         /**
154          * (in game world coordinates) the place where the object was hit.
155          */
156         MT_Point3                m_hitPosition;
157
158         /**
159          * (in game world coordinates) the position to which to shoot the ray.
160          */
161         MT_Point3                m_prevTargetPoint;
162
163         /**
164          * (in game world coordinates) the position from which to shoot the ray.
165          */
166         MT_Point3                m_prevSourcePoint;
167         
168         /**
169          * (in game world coordinates) the face normal of the vertex where
170          * the object was hit.  */
171         MT_Vector3               m_hitNormal;
172
173         /**
174          * UV texture coordinate of the hit point if any, (0,0) otherwise
175          */
176         MT_Vector2               m_hitUV;
177
178         /**
179          * The KX scene that holds the camera. The camera position
180          * determines a part of the start location of the picking ray.  */
181         KX_Scene* m_kxscene;
182
183         /**
184          * The KX engine is needed for computing the viewport */
185         KX_KetsjiEngine* m_kxengine;
186 };
187
188 #endif //__KX_MOUSESENSOR
189