Game Python Reference Manual.
[blender.git] / source / gameengine / PyDoc / KX_MouseFocusSensor.py
1 # Documentation for KX_MouseFocusSensor
2 from SCA_MouseSensor import *
3
4 class KX_MouseFocusSensor(SCA_MouseSensor):
5         """
6         The mouse focus sensor detects when the mouse is over the current game object.
7         
8         The mouse focus sensor works by transforming the mouse coordinates from 2d device
9         space to 3d space then raycasting away from the camera.
10         """
11         
12         def GetRayTarget():
13                 """
14                 Returns the end point of the sensor ray.
15                 
16                 @rtype: list [x, y, z]
17                 @return: the end point of the sensor ray, in world coordinates.
18                 """
19         def GetRaySource():
20                 """
21                 Returns the start point of the sensor ray.
22                 
23                 @rtype: list [x, y, z]
24                 @return: the start point of the sensor ray, in world coordinates.
25                 """