BGE API cleanup: apply patch from Moguri: Near, Radar, Touch sensor updated.
[blender.git] / source / gameengine / PyDoc / KX_RadarSensor.py
1 # $Id$
2 # Documentation for KX_RadarSensor
3 from KX_NearSensor import *
4
5 class KX_RadarSensor(KX_NearSensor):
6         """
7         Radar sensor is a near sensor with a conical sensor object.
8         
9         @ivar coneOrigin: The origin of the cone with which to test. The origin
10                                                 is in the middle of the cone.
11                                                 (Read only)
12         @type coneOrigin: list of floats [x, y, z]
13         @ivar coneTarget: The center of the bottom face of the cone with which to test.
14                                                 (Read only)
15         @type coneTarget: list of floats [x, y, z]
16         @ivar distance: The height of the cone with which to test.
17         @type distance: float
18         @ivar angle: The angle of the cone (in degrees) with which to test.
19         @type angle: float from 0 to 360
20         @ivar axis: The axis on which the radar cone is cast
21         @type axis: int from 0 to 5
22                 KX_RADAR_AXIS_POS_X, KX_RADAR_AXIS_POS_Y, KX_RADAR_AXIS_POS_Z,
23                 KX_RADAR_AXIS_NEG_X, KX_RADAR_AXIS_NEG_Y, KX_RADAR_AXIS_NEG_Z
24         """
25         
26         
27         #--The following methods are deprecated, please use properties instead.
28         def getConeOrigin():
29                 """
30                 Returns the origin of the cone with which to test. The origin
31                 is in the middle of the cone.
32                 
33                 @rtype: list [x, y, z]
34                 """
35
36         def getConeTarget():
37                 """
38                 Returns the center of the bottom face of the cone with which to test.
39                 
40                 @rtype: list [x, y, z]
41                 """
42         
43         def getConeHeight():
44                 """
45                 Returns the height of the cone with which to test.
46                 
47                 @rtype: float
48                 """
49