Source Code for Module KX_CameraActuator

 1  # $Id: KX_CameraActuator.py 16105 2008-08-14 08:58:25Z campbellbarton $ 
 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(name_only = 1): 
12                  """ 
13                  Returns the name of the object this actuator tracks. 
14                   
15                  @type name_only: bool 
16                  @param name_only: optional argument, when 0 return a KX_GameObject 
17                  @rtype: string, KX_GameObject or None if no object is set 
18                  """ 
19           
20 -        def setObject(target): 
21                  """ 
22                  Sets the object this actuator tracks. 
23                   
24                  @param target: the object to track. 
25                  @type target: L{KX_GameObject}, string or None 
26                  """ 
27           
28 -        def getMin(): 
29                  """ 
30                  Returns the minimum distance to target maintained by the actuator. 
31                   
32                  @rtype: float 
33                  """ 
34           
35 -        def setMin(distance): 
36                  """ 
37                  Sets the minimum distance to the target object maintained by the 
38                  actuator. 
39                   
40                  @param distance: The minimum distance to maintain. 
41                  @type distance: float 
42                  """ 
43                   
44 -        def getMax(): 
45                  """ 
46                  Gets the maximum distance to stay from the target object. 
47                   
48                  @rtype: float 
49                  """ 
50           
51 -        def setMax(distance): 
52                  """ 
53                  Sets the maximum distance to stay from the target object. 
54                   
55                  @param distance: The maximum distance to maintain. 
56                  @type distance: float 
57                  """ 
58   
59 -        def getHeight(): 
60                  """ 
61                  Returns the height to stay above the target object. 
62                   
63                  @rtype: float 
64                  """ 
65           
66 -        def setHeight(height): 
67                  """ 
68                  Sets the height to stay above the target object. 
69                   
70                  @type height: float 
71                  @param height: The height to stay above the target object. 
72                  """ 
73           
74 -        def setXY(xaxis): 
75                  """ 
76                  Sets the axis to get behind. 
77                   
78                  @param xaxis: False to track Y axis, True to track X axis. 
79                  @type xaxis: boolean 
80                  """ 
81   
82 -        def getXY(): 
83                  """ 
84                  Returns the axis this actuator is tracking. 
85                   
86                  @return: True if tracking X axis, False if tracking Y axis. 
87                  @rtype: boolean 
88                  """ 
89