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