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