BGE Epydocs were missing some functions
[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 getHitNormal():
14                 """
15                 Returns the normal (in worldcoordinates) at the point of collision where the object was hit by this ray.
16                 
17                 @rtype: list [x, y, z]
18                 @return: the ray collision normal.
19                 """
20         def getHitObject():
21                 """
22                 Returns the object that was hit by this ray or None.
23                 
24                 @rtype: L{KX_GameObject} or None
25                 @return: the collision object.
26                 """
27         def getHitPosition():
28                 """
29                 Returns the position (in worldcoordinates) at the point of collision where the object was hit by this ray.
30                 
31                 @rtype: list [x, y, z]
32                 @return: the ray collision position.
33                 """
34         def getRayDirection():
35                 """
36                 Returns the normalized direction (in worldcoordinates) of the ray cast by the mouse.
37                 
38                 @rtype: list [x, y, z]
39                 @return: the ray direction.
40                 """
41         def getRaySource():
42                 """
43                 Returns the position (in worldcoordinates) the ray was cast from by the mouse.
44                 
45                 @rtype: list [x, y, z]
46                 @return: the ray source.
47                 """
48         def getRayTarget():
49                 """
50                 Returns the target of the ray (in worldcoordinates) that seeks the focus object.
51                 
52                 @rtype: list [x, y, z]
53                 @return: the ray target.
54                 """