9630690e572ea8297e8b3c431ba20da1beaddf0d
[blender.git] / source / gameengine / PyDoc / KX_ConstraintActuator.py
1 # $Id$
2 # Documentation for KX_ConstraintActuator
3 from SCA_IActuator import *
4
5 class KX_ConstraintActuator(SCA_IActuator):
6         """
7         A constraint actuator limits the position or orientation of an object.
8         """
9         def setDamp(time):
10                 """
11                 Sets the time this constraint is delayed.
12                 
13                 @param time: The number of frames to delay.  
14                              Negative values are ignored.
15                 @type time: integer
16                 """
17         def getDamp():
18                 """
19                 Returns the damping time of the constraint.
20                 
21                 @rtype: integer
22                 """
23         def setMin(lower):
24                 """
25                 Sets the lower bound of the constraint.
26                 
27                 For rotational constraints, lower is specified in degrees.
28                 
29                 @type lower: float
30                 """
31         def getMin():
32                 """
33                 Gets the lower bound of the constraint.
34                 
35                 For rotational constraints, the lower bound is returned in radians.
36                 
37                 @rtype: float
38                 """
39         def setMax(upper):
40                 """
41                 Sets the upper bound of the constraint.
42                 
43                 For rotational constraints, upper is specified in degrees.
44                 
45                 @type upper: float
46                 """
47         def getMax():
48                 """
49                 Gets the upper bound of the constraint.
50                 
51                 For rotational constraints, the upper bound is returned in radians.
52                 
53                 @rtype: float
54                 """
55         def setLimit(limit):
56                 """
57                 Sets the type of constraint.
58                 
59                 See module L{GameLogic} for valid constraint types.
60                 
61                 @param limit: Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, 
62                               Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY or KX_CONSTRAINTACT_ROTZ
63                 """
64         def getLimit():
65                 """
66                 Gets the type of constraint.
67                 
68                 See module L{GameLogic} for valid constraints.
69                 
70                 @return: Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, 
71                          Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY or KX_CONSTRAINTACT_ROTZ
72                 """