Merged changes in the trunk up to revision 54421.
[blender.git] / doc / python_api / rst / bge_types / bge.types.KX_MouseFocusSensor.rst
1 KX_MouseFocusSensor(SCA_MouseSensor)
2 ====================================
3
4 .. module:: bge.types
5
6 base class --- :class:`SCA_MouseSensor`
7
8 .. class:: KX_MouseFocusSensor(SCA_MouseSensor)
9
10    The mouse focus sensor detects when the mouse is over the current game object.
11
12    The mouse focus sensor works by transforming the mouse coordinates from 2d device
13    space to 3d space then raycasting away from the camera.
14
15    .. attribute:: raySource
16
17       The worldspace source of the ray (the view position).
18
19       :type: list (vector of 3 floats)
20
21    .. attribute:: rayTarget
22
23       The worldspace target of the ray.
24
25       :type: list (vector of 3 floats)
26
27    .. attribute:: rayDirection
28
29       The :data:`rayTarget` - :class:`raySource` normalized.
30
31       :type: list (normalized vector of 3 floats)
32
33    .. attribute:: hitObject
34
35       the last object the mouse was over.
36
37       :type: :class:`KX_GameObject` or None
38
39    .. attribute:: hitPosition
40
41       The worldspace position of the ray intersecton.
42
43       :type: list (vector of 3 floats)
44
45    .. attribute:: hitNormal
46
47       the worldspace normal from the face at point of intersection.
48
49       :type: list (normalized vector of 3 floats)
50
51    .. attribute:: hitUV
52
53       the UV coordinates at the point of intersection.
54
55       :type: list (vector of 2 floats)
56
57       If the object has no UV mapping, it returns [0, 0].
58
59       The UV coordinates are not normalized, they can be < 0 or > 1 depending on the UV mapping.
60
61    .. attribute:: usePulseFocus
62
63       When enabled, moving the mouse over a different object generates a pulse. (only used when the 'Mouse Over Any' sensor option is set).
64
65       :type: boolean
66