Option for MouseFocus sensor. only used when 'Mouse over any' type is set.
[blender-staging.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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                                                 PyTypeObject* T=&Type );
62
63         virtual ~KX_MouseFocusSensor() { ; };
64         virtual CValue* GetReplica() {
65                 CValue* replica = new KX_MouseFocusSensor(*this);
66                 // this will copy properties and so on...
67                 replica->ProcessReplica();
68                 return replica;
69         };
70         /**
71          * @attention Overrides default evaluate. 
72          */
73         virtual bool Evaluate();
74         virtual void Init();
75
76         virtual bool IsPositiveTrigger() {
77                 bool result = m_positive_event;
78                 if (m_invert) result = !result;
79                 return result;
80         };
81
82         bool RayHit(KX_ClientObjectInfo* client, KX_RayCast* result, void * const data);
83         bool NeedRayCast(KX_ClientObjectInfo* client) { return true; }
84         
85         const MT_Point3& RaySource() const;
86         const MT_Point3& RayTarget() const;
87         const MT_Point3& HitPosition() const;
88         const MT_Vector3& HitNormal() const;
89         
90         /* --------------------------------------------------------------------- */
91         /* Python interface ---------------------------------------------------- */
92         /* --------------------------------------------------------------------- */
93         virtual PyObject* py_getattro(PyObject *attr);
94         virtual PyObject* py_getattro_dict();
95
96         KX_PYMETHOD_DOC_NOARGS(KX_MouseFocusSensor,GetRayTarget);
97         KX_PYMETHOD_DOC_NOARGS(KX_MouseFocusSensor,GetRaySource);
98         
99         KX_PYMETHOD_DOC_NOARGS(KX_MouseFocusSensor,GetHitObject);
100         KX_PYMETHOD_DOC_NOARGS(KX_MouseFocusSensor,GetHitPosition);
101         KX_PYMETHOD_DOC_NOARGS(KX_MouseFocusSensor,GetHitNormal);
102         KX_PYMETHOD_DOC_NOARGS(KX_MouseFocusSensor,GetRayDirection);
103
104         /* attributes */
105         static PyObject*        pyattr_get_ray_source(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
106         static PyObject*        pyattr_get_ray_target(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
107         static PyObject*        pyattr_get_ray_direction(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
108         static PyObject*        pyattr_get_hit_object(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
109         static PyObject*        pyattr_get_hit_position(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
110         static PyObject*        pyattr_get_hit_normal(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
111                 
112         /* --------------------------------------------------------------------- */
113         SCA_IObject*    m_hitObject;
114         void*                   m_hitObject_Last; /* only use for comparison, never access */
115
116  private:
117         /**
118          * The focus mode. 1 for handling focus, 0 for not handling, 2 for focus on any object
119         */
120          int    m_focusmode;
121
122         /**
123          * Flags whether the previous test showed a mouse-over.
124          */
125         bool m_mouse_over_in_previous_frame;
126
127         /**
128          * Flags whether changes in hit object should trigger a pulse
129          */
130         bool m_bTouchPulse;
131         
132         /**
133          * Flags whether the previous test evaluated positive.
134          */
135         bool m_positive_event;
136
137         /**
138          * Tests whether the object is in mouse focus for this camera
139          */
140         bool ParentObjectHasFocusCamera(KX_Camera *cam);
141         
142         /**
143          * Tests whether the object is in mouse focus in this scene.
144          */
145         bool ParentObjectHasFocus(void);
146
147         /**
148          * (in game world coordinates) the place where the object was hit.
149          */
150         MT_Point3                m_hitPosition;
151
152         /**
153          * (in game world coordinates) the position to which to shoot the ray.
154          */
155         MT_Point3                m_prevTargetPoint;
156
157         /**
158          * (in game world coordinates) the position from which to shoot the ray.
159          */
160         MT_Point3                m_prevSourcePoint;
161         
162         /**
163          * (in game world coordinates) the face normal of the vertex where
164          * the object was hit.  */
165         MT_Vector3               m_hitNormal;
166
167         /**
168          * The KX scene that holds the camera. The camera position
169          * determines a part of the start location of the picking ray.  */
170         KX_Scene* m_kxscene;
171
172         /**
173          * The KX engine is needed for computing the viewport */
174         KX_KetsjiEngine* m_kxengine;
175 };
176
177 #endif //__KX_MOUSESENSOR
178