Initial revision
[blender.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 /*  #include "SCA_IInputDevice.h" */
39
40 /**
41  * The mouse focus sensor extends the basic SCA_MouseSensor. It has
42  * been placed in KX because it needs access to the rasterizer and
43  * SuMO.
44  *
45  * - extend the valid modes?
46  * - */
47 class KX_MouseFocusSensor : public SCA_MouseSensor
48 {
49
50         Py_Header;
51         
52  public:
53         
54         KX_MouseFocusSensor(class SCA_MouseManager* keybdmgr,
55                                                 int startx,
56                                                 int starty,
57                                                 short int mousemode,
58                                                 bool focusmode,
59                                                 RAS_ICanvas* canvas,
60                                                 KX_Scene* kxscene,
61                                                 SCA_IObject* gameobj,
62                                                 PyTypeObject* T=&Type );
63
64         virtual ~KX_MouseFocusSensor() { ; };
65         virtual CValue* GetReplica() {
66                 CValue* replica = new KX_MouseFocusSensor(*this);
67                 // this will copy properties and so on...
68                 CValue::AddDataToReplica(replica);
69                 return replica;
70         };
71         /**
72          * @attention Overrides default evaluate. 
73          */
74         virtual bool Evaluate(CValue* event);
75
76         virtual bool IsPositiveTrigger() {
77                 bool result = m_positive_event;
78                 if (m_invert) result = !result;
79                 return result;
80         };
81
82         
83         /* --------------------------------------------------------------------- */
84         /* Python interface ---------------------------------------------------- */
85         /* --------------------------------------------------------------------- */
86         virtual PyObject*  _getattr(char *attr);
87
88         KX_PYMETHOD_DOC(KX_MouseFocusSensor,GetRayTarget);
89         KX_PYMETHOD_DOC(KX_MouseFocusSensor,GetRaySource);
90
91         /* --------------------------------------------------------------------- */
92
93  private:
94         /**
95          * The focus mode. True for handling focus, false for not handling
96          * it. */
97         bool m_focusmode;
98
99         /**
100          * Flags whether the previous test showed a mouse-over.
101          */
102         bool m_mouse_over_in_previous_frame;
103
104         /**
105          * Flags whether the previous test evaluated positive.
106          */
107         bool m_positive_event;
108
109         
110         /**
111          * Tests whether the object is in mouse focus in this frame.
112          */
113         bool ParentObjectHasFocus(void);
114
115         /**
116          * (in game world coordinates) the place where the object was hit.
117          */
118         MT_Point3                m_hitPosition;
119
120         /**
121          * (in game world coordinates) the position to which to shoot the ray.
122          */
123         MT_Point3                m_prevTargetPoint;
124
125         /**
126          * (in game world coordinates) the position from which to shoot the ray.
127          */
128         MT_Point3                m_prevSourcePoint;
129         
130         /**
131          * (in game world coordinates) the face normal of the vertex where
132          * the object was hit.  */
133         MT_Vector3               m_hitNormal;
134
135         /**
136          * Ref to the engine, for retrieving a reference to the current
137          * scene.  */
138         class KX_KetsjiEngine* m_engine;
139
140         /**
141          * The active canvas. The size of this canvas determines a part of
142          * the start position of the picking ray.  */
143         RAS_ICanvas* m_gp_canvas;
144
145         /**
146          * The KX scene that holds the camera. The camera position
147          * determines a part of the start location of the picking ray.  */
148         KX_Scene* m_kxscene;
149
150 };
151
152 #endif //__KX_MOUSESENSOR