py api: sphinx doc corrections, pep8 cleanup and style edits, also added __all__...
[blender-staging.git] / doc / python_api / rst / bge.constraints.rst
1
2 Physics Constraints (bge.constraints)
3 =====================================
4
5 .. function:: createConstraint(physicsid, physicsid2, constrainttype, [pivotX, pivotY, pivotZ, [axisX, axisY, axisZ, [flag]]]])
6
7    Creates a constraint.
8
9    :arg physicsid: the physics id of the first object in constraint
10    :type physicsid: int
11
12    :arg physicsid2: the physics id of the second object in constraint
13    :type physicsid2: int
14
15    :arg constrainttype: the type of the constraint. The constraint types are:
16
17    - :class:`POINTTOPOINT_CONSTRAINT`
18    - :class:`LINEHINGE_CONSTRAINT`
19    - :class:`ANGULAR_CONSTRAINT`
20    - :class:`CONETWIST_CONSTRAINT`
21    - :class:`VEHICLE_CONSTRAINT`
22
23    :type constrainttype: int
24
25    :arg pivotX: pivot X position
26    :type pivotX: float
27
28    :arg pivotY: pivot Y position
29    :type pivotY: float
30
31    :arg pivotZ: pivot Z position
32    :type pivotZ: float
33
34    :arg axisX: X axis
35    :type axisX: float
36
37    :arg axisY: Y axis
38    :type axisY: float
39
40    :arg axisZ: Z axis
41    :type axisZ: float
42
43    :arg flag: .. to do
44    :type flag: int
45
46 .. attribute:: error
47
48    Simbolic constant string that indicates error.
49
50 .. function:: exportBulletFile(filename)
51
52    export a .bullet file
53
54    :arg filename: File name
55    :type filename: string
56
57 .. function:: getAppliedImpulse(constraintId)
58
59    :arg constraintId: The id of the constraint.
60    :type constraintId: int
61
62    :return: the most recent applied impulse.
63    :rtype: float
64
65 .. function:: getVehicleConstraint(constraintId)
66
67    :arg constraintId: The id of the vehicle constraint.
68    :type constraintId: int
69
70    :return: a vehicle constraint object.
71    :rtype: :class:`bge.types.KX_VehicleWrapper`
72
73 .. function:: removeConstraint(constraintId)
74
75    Removes a constraint.
76
77    :arg constraintId: The id of the constraint to be removed.
78    :type constraintId: int
79
80 .. function:: setCcdMode(ccdMode)
81
82    .. note::
83       Very experimental, not recommended
84
85    Sets the CCD (Continous Colision Detection) mode in the Physics Environment.
86
87    :arg ccdMode: The new CCD mode.
88    :type ccdMode: int
89
90 .. function:: setContactBreakingTreshold(breakingTreshold)
91
92    .. note::
93       Reasonable default is 0.02 (if units are meters)
94
95    Sets tresholds to do with contact point management.
96
97    :arg breakingTreshold: The new contact breaking treshold.
98    :type breakingTreshold: float
99
100 .. function:: setDeactivationAngularTreshold(angularTreshold)
101
102    Sets the angular velocity treshold.
103
104    :arg angularTreshold: New deactivation angular treshold.
105    :type angularTreshold: float
106
107 .. function:: setDeactivationLinearTreshold(linearTreshold)
108
109    Sets the linear velocity treshold.
110
111    :arg linearTreshold: New deactivation linear treshold.
112    :type linearTreshold: float
113
114 .. function:: setDeactivationTime(time)
115
116    Sets the time after which a resting rigidbody gets deactived.
117
118    :arg time: The deactivation time.
119    :type time: float
120
121 .. function:: setDebugMode(mode)
122
123    Sets the debug mode.
124
125    Debug modes:
126       - :class:`DBG_NODEBUG`
127       - :class:`DBG_DRAWWIREFRAME`
128       - :class:`DBG_DRAWAABB`
129       - :class:`DBG_DRAWFREATURESTEXT`
130       - :class:`DBG_DRAWCONTACTPOINTS`
131       - :class:`DBG_NOHELPTEXT`
132       - :class:`DBG_DRAWTEXT`
133       - :class:`DBG_PROFILETIMINGS`
134       - :class:`DBG_ENABLESATCOMPARISION`
135       - :class:`DBG_DISABLEBULLETLCP`
136       - :class:`DBG_ENABLECCD`
137       - :class:`DBG_DRAWCONSTRAINTS`
138       - :class:`DBG_DRAWCONSTRAINTLIMITS`
139       - :class:`DBG_FASTWIREFRAME`
140
141    :arg mode: The new debug mode.
142    :type mode: int
143
144 .. function:: setGravity(x, y, z)
145
146    Sets the gravity force.
147
148    :arg x: Gravity X force.
149    :type x: float
150
151    :arg y: Gravity Y force.
152    :type y: float
153
154    :arg z: Gravity Z force.
155    :type z: float
156
157 .. function:: setLinearAirDamping(damping)
158
159    .. note::
160       Not implemented.
161
162    Sets the linear air damping for rigidbodies.
163
164 .. function:: setNumIterations(numiter)
165
166    Sets the number of iterations for an iterative constraint solver.
167
168    :arg numiter: New number of iterations.
169    :type numiter: int
170
171 .. function:: setNumTimeSubSteps(numsubstep)
172
173    Sets the number of substeps for each physics proceed. Tradeoff quality for performance.
174
175    :arg numsubstep: New number of substeps.
176    :type numsubstep: int
177
178 .. function:: setSolverDamping(damping)
179
180    .. note::
181       Very experimental, not recommended
182
183    Sets the damper constant of a penalty based solver.
184
185    :arg damping: New damping for the solver.
186    :type damping: float
187
188 .. function:: setSolverTau(tau)
189
190    .. note::
191       Very experimental, not recommended
192
193    Sets the spring constant of a penalty based solver.
194
195    :arg tau: New tau for the solver.
196    :type tau: float
197
198 .. function:: setSolverType(solverType)
199
200    .. note::
201       Very experimental, not recommended
202
203    Sets the solver type.
204
205    :arg solverType: The new type of the solver.
206    :type solverType: int
207
208 .. function:: setSorConstant(sor)
209
210    .. note::
211       Very experimental, not recommended
212
213    Sets the successive overrelaxation constant.
214
215    :arg sor: New sor value.
216    :type sor: float
217
218 .. function:: setUseEpa(epa)
219
220    Not implemented.
221
222 .. data:: DBG_NODEBUG
223    
224    .. note::
225       Debug mode to be used with function :class:`setDebugMode`
226    
227    No debug.
228
229 .. data:: DBG_DRAWWIREFRAME
230    
231    .. note::
232       Debug mode to be used with function :class:`setDebugMode`
233    
234    Draw wireframe in debug.
235
236 .. data:: DBG_DRAWAABB
237    
238    .. note::
239       Debug mode to be used with function :class:`setDebugMode`
240    
241    Draw Axis Aligned Bounding Box in debug.
242
243 .. data:: DBG_DRAWFREATURESTEXT
244    
245    .. note::
246       Debug mode to be used with function :class:`setDebugMode`
247    
248    Draw freatures text in debug.
249
250 .. data:: DBG_DRAWCONTACTPOINTS
251    
252    .. note::
253       Debug mode to be used with function :class:`setDebugMode`
254    
255    Draw contact points in debug.
256
257 .. data:: DBG_NOHELPTEXT
258    
259    .. note::
260       Debug mode to be used with function :class:`setDebugMode`
261    
262    Debug without help text.
263
264 .. data:: DBG_DRAWTEXT
265    
266    .. note::
267       Debug mode to be used with function :class:`setDebugMode`
268    
269    Draw text in debug.
270
271 .. data:: DBG_PROFILETIMINGS
272    
273    .. note::
274       Debug mode to be used with function :class:`setDebugMode`
275    
276    Draw profile timings in debug.
277
278 .. data:: DBG_ENABLESATCOMPARISION
279    
280    .. note::
281       Debug mode to be used with function :class:`setDebugMode`
282    
283    Enable sat comparision in debug.
284
285 .. data:: DBG_DISABLEBULLETLCP
286    
287    .. note::
288       Debug mode to be used with function :class:`setDebugMode`
289    
290    Disable Bullet LCP.
291
292 .. data:: DBG_ENABLECCD
293
294    .. note::
295       Debug mode to be used with function :class:`setDebugMode`
296    
297    Enable Continous Colision Detection in debug.
298
299 .. data:: DBG_DRAWCONSTRAINTS
300    
301    .. note::
302       Debug mode to be used with function :class:`setDebugMode`
303    
304    Draw constraints in debug.
305
306 .. data:: DBG_DRAWCONSTRAINTLIMITS
307    
308    .. note::
309       Debug mode to be used with function :class:`setDebugMode`
310    
311    Draw constraint limits in debug.
312
313 .. data:: DBG_FASTWIREFRAME
314    
315    .. note::
316       Debug mode to be used with function :class:`setDebugMode`
317    
318    Draw a fast wireframe in debug.
319
320 .. data:: POINTTOPOINT_CONSTRAINT
321
322    .. note::
323       Constraint type to be used with function :class:`createConstraint`
324
325    .. to do
326
327 .. data:: LINEHINGE_CONSTRAINT
328
329    .. note::
330       Constraint type to be used with function :class:`createConstraint`
331
332    .. to do
333
334 .. data:: ANGULAR_CONSTRAINT
335
336    .. note::
337       Constraint type to be used with function :class:`createConstraint`
338
339    .. to do
340
341 .. data:: CONETWIST_CONSTRAINT
342
343    .. note::
344        Constraint type to be used with function :class:`createConstraint`
345
346    .. to do
347
348 .. data:: VEHICLE_CONSTRAINT
349
350    .. note::
351       Constraint type to be used with function :class:`createConstraint`
352
353    .. to do