d92cebfb4e16b01fb4259ee607292a5af5f90deb
[blender-staging.git] / source / gameengine / Ketsji / KX_MouseFocusSensor.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  * KX_MouseFocusSensor determines mouse in/out/over events.
32  */
33
34 #ifndef __KX_MOUSEFOCUSSENSOR
35 #define __KX_MOUSEFOCUSSENSOR
36
37 #include "SCA_MouseSensor.h"
38
39 /**
40  * The mouse focus sensor extends the basic SCA_MouseSensor. It has
41  * been placed in KX because it needs access to the rasterizer and
42  * SuMO.
43  *
44  * - extend the valid modes?
45  * - */
46 class KX_MouseFocusSensor : public SCA_MouseSensor
47 {
48
49         Py_Header;
50         
51  public:
52         
53         KX_MouseFocusSensor(class SCA_MouseManager* keybdmgr,
54                                                 int startx,
55                                                 int starty,
56                                                 short int mousemode,
57                                                 bool focusmode,
58                                                 RAS_ICanvas* canvas,
59                                                 KX_Scene* kxscene,
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                 CValue::AddDataToReplica(replica);
68                 return replica;
69         };
70         /**
71          * @attention Overrides default evaluate. 
72          */
73         virtual bool Evaluate(CValue* event);
74
75         virtual bool IsPositiveTrigger() {
76                 bool result = m_positive_event;
77                 if (m_invert) result = !result;
78                 return result;
79         };
80
81         bool RayHit(KX_ClientObjectInfo* client, MT_Point3& hit_point, MT_Vector3& hit_normal, void * const data);
82
83         
84         /* --------------------------------------------------------------------- */
85         /* Python interface ---------------------------------------------------- */
86         /* --------------------------------------------------------------------- */
87         virtual PyObject*  _getattr(const STR_String& attr);
88
89         KX_PYMETHOD_DOC(KX_MouseFocusSensor,GetRayTarget);
90         KX_PYMETHOD_DOC(KX_MouseFocusSensor,GetRaySource);
91
92         /* --------------------------------------------------------------------- */
93
94  private:
95         /**
96          * The focus mode. True for handling focus, false for not handling
97          * it. */
98         bool m_focusmode;
99
100         /**
101          * Flags whether the previous test showed a mouse-over.
102          */
103         bool m_mouse_over_in_previous_frame;
104
105         /**
106          * Flags whether the previous test evaluated positive.
107          */
108         bool m_positive_event;
109
110         
111         /**
112          * Tests whether the object is in mouse focus in this frame.
113          */
114         bool ParentObjectHasFocus(void);
115
116         /**
117          * (in game world coordinates) the place where the object was hit.
118          */
119         MT_Point3                m_hitPosition;
120
121         /**
122          * (in game world coordinates) the position to which to shoot the ray.
123          */
124         MT_Point3                m_prevTargetPoint;
125
126         /**
127          * (in game world coordinates) the position from which to shoot the ray.
128          */
129         MT_Point3                m_prevSourcePoint;
130         
131         /**
132          * (in game world coordinates) the face normal of the vertex where
133          * the object was hit.  */
134         MT_Vector3               m_hitNormal;
135
136         /**
137          * Ref to the engine, for retrieving a reference to the current
138          * scene.  */
139         class KX_KetsjiEngine* m_engine;
140
141         /**
142          * The active canvas. The size of this canvas determines a part of
143          * the start position of the picking ray.  */
144         RAS_ICanvas* m_gp_canvas;
145
146         /**
147          * The KX scene that holds the camera. The camera position
148          * determines a part of the start location of the picking ray.  */
149         KX_Scene* m_kxscene;
150
151 };
152
153 #endif //__KX_MOUSESENSOR
154