Pydoc: Fix multiple bpy.type modules
[blender.git] / doc / python_api / rst / bge_types / bge.types.KX_ConstraintWrapper.rst
1 KX_ConstraintWrapper(PyObjectPlus)
2 ==================================
3
4 base class --- :class:`PyObjectPlus`
5
6 .. class:: KX_ConstraintWrapper(PyObjectPlus)
7
8    KX_ConstraintWrapper
9
10    .. method:: getConstraintId(val)
11
12       Returns the contraint ID
13
14       :return: the constraint ID
15       :rtype: integer
16
17    .. method:: setParam(axis, value0, value1)
18
19       Set the contraint limits
20
21       :arg axis:
22       :type axis: integer
23
24       .. note::
25          * Lowerlimit == Upperlimit -> axis is locked
26          * Lowerlimit > Upperlimit -> axis is free
27          * Lowerlimit < Upperlimit -> axis it limited in that range
28
29       For PHY_LINEHINGE_CONSTRAINT = 2 or PHY_ANGULAR_CONSTRAINT = 3:
30
31       axis = 3 is a constraint limit, with low/high limit value
32          * 3: X axis angle
33
34       :arg value0 (min): Set the minimum limit of the axis
35       :type value0: float
36       :arg value1 (max): Set the maximum limit of the axis
37       :type value1: float
38
39       For PHY_CONE_TWIST_CONSTRAINT = 4:
40
41       axis = 3..5 are constraint limits, high limit values
42          * 3: X axis angle
43          * 4: Y axis angle
44          * 5: Z axis angle
45
46       :arg value0 (min): Set the minimum limit of the axis
47       :type value0: float
48       :arg value1 (max): Set the maximum limit of the axis
49       :type value1: float
50
51       For PHY_GENERIC_6DOF_CONSTRAINT = 12:
52
53       axis = 0..2 are constraint limits, with low/high limit value
54          * 0: X axis position
55          * 1: Y axis position
56          * 2: Z axis position
57
58       axis = 3..5 are relative constraint (Euler) angles in radians
59          * 3: X axis angle
60          * 4: Y axis angle
61          * 5: Z axis angle
62
63       :arg value0 (min): Set the minimum limit of the axis
64       :type value0: float
65       :arg value1 (max): Set the maximum limit of the axis
66       :type value1: float
67
68       axis = 6..8 are translational motors, with value0=target velocity, value1 = max motor force
69          * 6: X axis position
70          * 7: Y axis position
71          * 8: Z axis position
72
73       axis = 9..11 are rotational motors, with value0=target velocity, value1 = max motor force
74          * 9: X axis angle
75          * 10: Y axis angle
76          * 11: Z axis angle
77
78       :arg value0 (speed): Set the linear velocity of the axis
79       :type value0: float Range: -10,000.00 to 10,000.00
80       :arg value1 (force): Set the maximum force limit of the axis
81       :type value1: float Range: -10,000.00 to 10,000.00
82
83       axis = 12..14 are for linear springs on each of the position of freedom
84          * 12: X axis position
85          * 13: Y axis position
86          * 14: Z axis position
87
88       axis = 15..17 are for angular springs on each of the angle of freedom in radians
89          * 15: X axis angle
90          * 16: Y axis angle
91          * 17: Z axis angle
92
93       :arg value0 (stiffness): Set the stiffness of the spring
94       :type value0: float
95       :arg value1 (damping): Tendency of the spring to return to it's original position
96       :type value1: float
97                     1.0 = springs back to original position (no damping)
98                     0.0 = don't springs back
99
100    .. method:: getParam(axis)
101
102       Get the contraint position or euler angle of a generic 6DOF constraint
103
104       :arg axis:
105       :type axis: integer
106
107       axis = 0..2 are linear constraint values
108          * 0: X axis position
109          * 1: Y axis position
110          * 2: Z axis position
111
112       :return: position
113       :rtype: float
114
115       axis = 3..5 are relative constraint (Euler) angles in radians 
116          * 3: X axis angle
117          * 4: Y axis angle
118          * 5: Z axis angle
119
120       :return: angle
121       :rtype: float
122
123    .. attribute:: constraint_id
124
125       Returns the contraint ID  (read only)
126
127       :type: integer
128
129    .. attribute:: constraint_type
130
131       Returns the contraint type (read only)
132
133       :type: integer
134
135          - :class:`~bge.constraints.POINTTOPOINT_CONSTRAINT`
136          - :class:`~bge.constraints.LINEHINGE_CONSTRAINT`
137          - :class:`~bge.constraints.ANGULAR_CONSTRAINT`
138          - :class:`~bge.constraints.CONETWIST_CONSTRAINT`
139          - :class:`~bge.constraints.VEHICLE_CONSTRAINT`
140          - :class:`~bge.constraints.GENERIC_6DOF_CONSTRAINT`