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