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