Source Code for Module KX_CameraActuator

 1  # $Id: KX_CameraActuator.py 3692 2004-12-29 01:33:15Z kester $ 
 2  # Documentation for KX_CameraActuator 
 3  from SCA_IActuator import * 
 4   
 5 -class KX_CameraActuator(SCA_IActuator): 
 6          """ 
 7          Applies changes to a camera. 
 8           
 9          @author: snail 
10          """ 
11 -        def getObject(): 
12                  """ 
13                  Returns the name of the object this actuator tracks. 
14                   
15                  rtype: string 
16                  """ 
17           
18 -        def setObject(target): 
19                  """ 
20                  Sets the object this actuator tracks. 
21                   
22                  @param target: the object to track. 
23                  @type target: string or L{KX_GameObject} 
24                  """ 
25           
26 -        def getMin(): 
27                  """ 
28                  Returns the minimum distance to target maintained by the actuator. 
29                   
30                  @rtype: float 
31                  """ 
32           
33 -        def setMin(distance): 
34                  """ 
35                  Sets the minimum distance to the target object maintained by the 
36                  actuator. 
37                   
38                  @param distance: The minimum distance to maintain. 
39                  @type distance: float 
40                  """ 
41                   
42 -        def getMax(): 
43                  """ 
44                  Gets the maximum distance to stay from the target object. 
45                   
46                  @rtype: float 
47                  """ 
48           
49 -        def setMax(distance): 
50                  """ 
51                  Sets the maximum distance to stay from the target object. 
52                   
53                  @param distance: The maximum distance to maintain. 
54                  @type distance: float 
55                  """ 
56   
57 -        def getHeight(): 
58                  """ 
59                  Returns the height to stay above the target object. 
60                   
61                  @rtype: float 
62                  """ 
63           
64 -        def setHeight(height): 
65                  """ 
66                  Sets the height to stay above the target object. 
67                   
68                  @type height: float 
69                  @param height: The height to stay above the target object. 
70                  """ 
71           
72 -        def setXY(xaxis): 
73                  """ 
74                  Sets the axis to get behind. 
75                   
76                  @param xaxis: False to track Y axis, True to track X axis. 
77                  @type xaxis: boolean 
78                  """ 
79   
80 -        def getXY(): 
81                  """ 
82                  Returns the axis this actuator is tracking. 
83                   
84                  @return: True if tracking X axis, False if tracking Y axis. 
85                  @rtype: boolean 
86                  """ 
87