Source Code for Module KX_TrackToActuator

 1  # $Id: KX_TrackToActuator.py 3082 2004-09-19 01:33:08Z kester $ 
 2  # Documentation for KX_TrackToActuator 
 3  from SCA_IActuator import * 
 4   
 5 -class KX_TrackToActuator(SCA_IActuator): 
 6          """ 
 7          Edit Object actuator in Track To mode. 
 8           
 9          @warning: Track To Actuators will be ignored if at game start, the 
10                  object to track to is invalid. 
11                   
12                  This will generate a warning in the console: 
13                   
14                  C{ERROR: GameObject I{OBName} no object in EditObjectActuator I{ActuatorName}} 
15   
16          """ 
17 -        def setObject(object): 
18                  """ 
19                  Sets the object to track. 
20                   
21                  @type object: L{KX_GameObject} or string 
22                  @param object: Either a reference to a game object or the name of the object to track. 
23                  """ 
24 -        def getObject(): 
25                  """ 
26                  Returns the name of the object to track. 
27                   
28                  Returns None if no object has been set to track. 
29                   
30                  @rtype: string 
31                  """ 
32 -        def setTime(time): 
33                  """ 
34                  Sets the time in frames with which to delay the tracking motion. 
35                   
36                  @type time: integer 
37                  """ 
38 -        def getTime(): 
39                  """ 
40                  Returns the time in frames with which the tracking motion is delayed. 
41                   
42                  @rtype: integer 
43                  """ 
44 -        def setUse3D(use3d): 
45                  """ 
46                  Sets the tracking motion to use 3D. 
47                   
48                  @type use3d: boolean 
49                  @param use3d: - True: allow the tracking motion to extend in the z-direction. 
50                                - False: lock the tracking motion to the x-y plane. 
51                  """ 
52 -        def getUse3D(): 
53                  """ 
54                  Returns True if the tracking motion will track in the z direction. 
55                   
56                  @rtype: boolean 
57                  """ 
58