Welcome to mirror list, hosted at ThFree Co, Russian Federation.

bge.constraints.rst « rst « python_api « doc - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 882bbc39b9f49ac23629d9cf68de623868b6e8d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

Game Engine bge.constraints Module
==================================

.. note::
   This documentation is still very weak, and needs some help!

.. function:: createConstraint([obj1, [obj2, [restLength, [restitution, [damping]]]]])

   Creates a constraint.

   :arg obj1: first object on Constraint
   :type obj1: :class:'bge.types.KX_GameObject' #I think, there is no error when I use one

   :arg obj2: second object on Constraint
   :type obj2: :class:'bge.types.KX_GameObject' #too

   :arg restLength: #to be filled
   :type restLength: float

   :arg restitution: #to be filled
   :type restitution: float

   :arg damping: #to be filled
   :type damping: float

.. attribute:: error

   Simbolic constant string that indicates error.

.. function:: exportBulletFile(filename)

   export a .bullet file

   :arg filename: File name
   :type filename: string

.. function:: getAppliedImpulse(constraintId)

   :arg constraintId: The id of the constraint.
   :type constraintId: int

   :return: the most recent applied impulse.
   :rtype: float

.. function:: getVehicleConstraint(constraintId)

   :arg constraintId: The id of the vehicle constraint.
   :type constraintId: int

   :return: a vehicle constraint object.
   :rtype: :class:'KX_VehicleWrapper'

.. function:: removeConstraint(constraintId)

   Removes a constraint.

   :arg constraintId: The id of the constraint to be removed.
   :type constraintId: int

.. function:: setCcdMode(ccdMode)

   ..note::
      Very experimental, not recommended

   Sets the CCD mode in the Physics Environment.

   :arg ccdMode: The new CCD mode.
   :type ccdMode: int

.. function:: setContactBreakingTreshold(breakingTreshold)

   .. note::
      Reasonable default is 0.02 (if units are meters)

   Sets the contact breaking treshold in the Physics Environment.

   :arg breakingTreshold: The new contact breaking treshold.
   :type breakingTreshold: float

.. function:: setDeactivationAngularTreshold(angularTreshold)

   Sets the deactivation angular treshold.

   :arg angularTreshold: New deactivation angular treshold.
   :type angularTreshold: float

.. function:: setDeactivationLinearTreshold(linearTreshold)

   Sets the deactivation linear treshold.

   :arg linearTreshold: New deactivation linear treshold.
   :type linearTreshold: float

.. function:: setDeactivationTime(time)

   Sets the time after which a resting rigidbody gets deactived.

   :arg time: The deactivation time.
   :type time: float

.. function:: setDebugMode(mode)

   Sets the debug mode.

   Debug modes:
      - No debug: 0
      - Draw wireframe: 1
      - Draw Aabb: 2 #What's Aabb?
      - Draw freatures text: 4
      - Draw contact points: 8
      - No deactivation: 16
      - No help text: 32
      - Draw text: 64
      - Profile timings: 128
      - Enable sat comparision: 256
      - Disable Bullet LCP: 512
      - Enable CCD: 1024
      - Draw Constraints: #(1 << 11) = ?
      - Draw Constraint Limits: #(1 << 12) = ?
      - Fast Wireframe: #(1 << 13) = ?

   :arg mode: The new debug mode.
   :type mode: int

.. function:: setGravity(x, y, z)

   Sets the gravity force.

   :arg x: Gravity X force.
   :type x: float

   :arg y: Gravity Y force.
   :type y: float

   :arg z: Gravity Z force.
   :type z: float

.. function:: setLinearAirDamping(damping)

   Not implemented.

.. function:: setNumIterations(numiter)

   Sets the number of iterations for an iterative constraint solver.

   :arg numiter: New number of iterations.
   :type numiter: int

.. function:: setNumTimeSubSteps(numsubstep)

   Sets the number of substeps for each physics proceed. Tradeoff quality for performance.

   :arg numsubstep: New number of substeps.
   :type numsubstep: int

.. function:: setSolverDamping(damping)

   ..note::
      Very experimental, not recommended

   Sets the solver damping.

   :arg damping: New damping for the solver.
   :type damping: float

.. function:: setSolverTau(tau)

   .. note::
      Very experimental, not recommended

   Sets the solver tau.

   :arg tau: New tau for the solver.
   :type tau: float

.. function:: setSolverType(solverType)

   .. note::
      Very experimental, not recommended

   Sets the solver type.

   :arg solverType: The new type of the solver.
   :type solverType: int

.. function:: setSorConstant(sor)

   .. note::
      Very experimental, not recommended

   Sets the sor constant.

   :arg sor: New sor value.
   :type sor: float

.. function:: setUseEpa(epa)

   Not implemented.