rapier3d 0.12.0-alpha.1

3-dimensional physics engine in Rust.
Documentation
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
use crate::data::{BundleSet, ComponentSet};
use crate::dynamics::solver::{GenericRhs, VelocityConstraint};
use crate::dynamics::{
    IntegrationParameters, MultibodyJointSet, RigidBodyIds, RigidBodyMassProps, RigidBodyType,
    RigidBodyVelocity,
};
use crate::geometry::{ContactManifold, ContactManifoldIndex};
use crate::math::{Real, DIM, MAX_MANIFOLD_POINTS};
use crate::utils::{WAngularInertia, WCross, WDot};

use super::{DeltaVel, VelocityConstraintElement, VelocityConstraintNormalPart};
use crate::dynamics::solver::GenericVelocityGroundConstraint;
#[cfg(feature = "dim2")]
use crate::utils::WBasis;
use na::DVector;

#[derive(Copy, Clone, Debug)]
pub(crate) enum AnyGenericVelocityConstraint {
    NongroupedGround(GenericVelocityGroundConstraint),
    Nongrouped(GenericVelocityConstraint),
}

impl AnyGenericVelocityConstraint {
    pub fn solve(
        &mut self,
        jacobians: &DVector<Real>,
        mj_lambdas: &mut [DeltaVel<Real>],
        generic_mj_lambdas: &mut DVector<Real>,
        solve_restitution: bool,
        solve_friction: bool,
    ) {
        match self {
            AnyGenericVelocityConstraint::Nongrouped(c) => c.solve(
                jacobians,
                mj_lambdas,
                generic_mj_lambdas,
                solve_restitution,
                solve_friction,
            ),
            AnyGenericVelocityConstraint::NongroupedGround(c) => c.solve(
                jacobians,
                generic_mj_lambdas,
                solve_restitution,
                solve_friction,
            ),
        }
    }

    pub fn writeback_impulses(&self, manifolds_all: &mut [&mut ContactManifold]) {
        match self {
            AnyGenericVelocityConstraint::Nongrouped(c) => c.writeback_impulses(manifolds_all),
            AnyGenericVelocityConstraint::NongroupedGround(c) => {
                c.writeback_impulses(manifolds_all)
            }
        }
    }

    pub fn remove_bias_from_rhs(&mut self) {
        match self {
            AnyGenericVelocityConstraint::Nongrouped(c) => c.remove_bias_from_rhs(),
            AnyGenericVelocityConstraint::NongroupedGround(c) => c.remove_bias_from_rhs(),
        }
    }
}

#[derive(Copy, Clone, Debug)]
pub(crate) struct GenericVelocityConstraint {
    // We just build the generic constraint on top of the velocity constraint,
    // adding some information we can use in the generic case.
    pub velocity_constraint: VelocityConstraint,
    pub j_id: usize,
    pub ndofs1: usize,
    pub ndofs2: usize,
    pub generic_constraint_mask: u8,
}

impl GenericVelocityConstraint {
    pub fn generate<Bodies>(
        params: &IntegrationParameters,
        manifold_id: ContactManifoldIndex,
        manifold: &ContactManifold,
        bodies: &Bodies,
        multibodies: &MultibodyJointSet,
        out_constraints: &mut Vec<AnyGenericVelocityConstraint>,
        jacobians: &mut DVector<Real>,
        jacobian_id: &mut usize,
        push: bool,
    ) where
        Bodies: ComponentSet<RigidBodyIds>
            + ComponentSet<RigidBodyVelocity>
            + ComponentSet<RigidBodyMassProps>
            + ComponentSet<RigidBodyType>,
    {
        let inv_dt = params.inv_dt();
        let erp_inv_dt = params.erp_inv_dt();

        let handle1 = manifold.data.rigid_body1.unwrap();
        let handle2 = manifold.data.rigid_body2.unwrap();
        let (rb_ids1, rb_vels1, rb_mprops1, rb_type1): (
            &RigidBodyIds,
            &RigidBodyVelocity,
            &RigidBodyMassProps,
            &RigidBodyType,
        ) = bodies.index_bundle(handle1.0);
        let (rb_ids2, rb_vels2, rb_mprops2, rb_type2): (
            &RigidBodyIds,
            &RigidBodyVelocity,
            &RigidBodyMassProps,
            &RigidBodyType,
        ) = bodies.index_bundle(handle2.0);

        let multibody1 = multibodies
            .rigid_body_link(handle1)
            .map(|m| (&multibodies[m.multibody], m.id));
        let multibody2 = multibodies
            .rigid_body_link(handle2)
            .map(|m| (&multibodies[m.multibody], m.id));
        let mj_lambda1 = multibody1
            .map(|mb| mb.0.solver_id)
            .unwrap_or(if rb_type1.is_dynamic() {
                rb_ids1.active_set_offset
            } else {
                0
            });
        let mj_lambda2 = multibody2
            .map(|mb| mb.0.solver_id)
            .unwrap_or(if rb_type2.is_dynamic() {
                rb_ids2.active_set_offset
            } else {
                0
            });
        let force_dir1 = -manifold.data.normal;

        #[cfg(feature = "dim2")]
        let tangents1 = force_dir1.orthonormal_basis();
        #[cfg(feature = "dim3")]
        let tangents1 = super::compute_tangent_contact_directions(
            &force_dir1,
            &rb_vels1.linvel,
            &rb_vels2.linvel,
        );

        let multibodies_ndof = multibody1.map(|m| m.0.ndofs()).unwrap_or(0)
            + multibody2.map(|m| m.0.ndofs()).unwrap_or(0);
        // For each solver contact we generate DIM constraints, and each constraints appends
        // the multibodies jacobian and weighted jacobians
        let required_jacobian_len =
            *jacobian_id + manifold.data.solver_contacts.len() * multibodies_ndof * 2 * DIM;

        if jacobians.nrows() < required_jacobian_len {
            jacobians.resize_vertically_mut(required_jacobian_len, 0.0);
        }

        for (_l, manifold_points) in manifold
            .data
            .solver_contacts
            .chunks(MAX_MANIFOLD_POINTS)
            .enumerate()
        {
            let chunk_j_id = *jacobian_id;
            let mut constraint = VelocityConstraint {
                dir1: force_dir1,
                #[cfg(feature = "dim3")]
                tangent1: tangents1[0],
                elements: [VelocityConstraintElement::zero(); MAX_MANIFOLD_POINTS],
                im1: if rb_type1.is_dynamic() {
                    rb_mprops1.effective_inv_mass
                } else {
                    na::zero()
                },
                im2: if rb_type2.is_dynamic() {
                    rb_mprops2.effective_inv_mass
                } else {
                    na::zero()
                },
                limit: 0.0,
                mj_lambda1,
                mj_lambda2,
                manifold_id,
                manifold_contact_id: [0; MAX_MANIFOLD_POINTS],
                num_contacts: manifold_points.len() as u8,
            };

            for k in 0..manifold_points.len() {
                let manifold_point = &manifold_points[k];
                let dp1 = manifold_point.point - rb_mprops1.world_com;
                let dp2 = manifold_point.point - rb_mprops2.world_com;

                let vel1 = rb_vels1.linvel + rb_vels1.angvel.gcross(dp1);
                let vel2 = rb_vels2.linvel + rb_vels2.angvel.gcross(dp2);

                constraint.limit = manifold_point.friction;
                constraint.manifold_contact_id[k] = manifold_point.contact_id;

                // Normal part.
                {
                    let torque_dir1 = dp1.gcross(force_dir1);
                    let torque_dir2 = dp2.gcross(-force_dir1);

                    let gcross1 = if rb_type1.is_dynamic() {
                        rb_mprops1
                            .effective_world_inv_inertia_sqrt
                            .transform_vector(torque_dir1)
                    } else {
                        na::zero()
                    };
                    let gcross2 = if rb_type2.is_dynamic() {
                        rb_mprops2
                            .effective_world_inv_inertia_sqrt
                            .transform_vector(torque_dir2)
                    } else {
                        na::zero()
                    };

                    let inv_r1 = if let Some((mb1, link_id1)) = multibody1.as_ref() {
                        mb1.fill_jacobians(
                            *link_id1,
                            force_dir1,
                            #[cfg(feature = "dim2")]
                            na::vector!(torque_dir1),
                            #[cfg(feature = "dim3")]
                            torque_dir1,
                            jacobian_id,
                            jacobians,
                        )
                        .0
                    } else if rb_type1.is_dynamic() {
                        force_dir1.dot(&rb_mprops1.effective_inv_mass.component_mul(&force_dir1))
                            + gcross1.gdot(gcross1)
                    } else {
                        0.0
                    };

                    let inv_r2 = if let Some((mb2, link_id2)) = multibody2.as_ref() {
                        mb2.fill_jacobians(
                            *link_id2,
                            -force_dir1,
                            #[cfg(feature = "dim2")]
                            na::vector!(torque_dir2),
                            #[cfg(feature = "dim3")]
                            torque_dir2,
                            jacobian_id,
                            jacobians,
                        )
                        .0
                    } else if rb_type2.is_dynamic() {
                        force_dir1.dot(&rb_mprops2.effective_inv_mass.component_mul(&force_dir1))
                            + gcross2.gdot(gcross2)
                    } else {
                        0.0
                    };

                    let r = crate::utils::inv(inv_r1 + inv_r2);

                    let is_bouncy = manifold_point.is_bouncy() as u32 as Real;
                    let is_resting = 1.0 - is_bouncy;

                    let mut rhs_wo_bias = (1.0 + is_bouncy * manifold_point.restitution)
                        * (vel1 - vel2).dot(&force_dir1);
                    rhs_wo_bias += manifold_point.dist.max(0.0) * inv_dt;
                    rhs_wo_bias *= is_bouncy + is_resting * params.velocity_solve_fraction;
                    let rhs_bias =
                        /* is_resting * */ erp_inv_dt * manifold_point.dist.min(0.0);

                    constraint.elements[k].normal_part = VelocityConstraintNormalPart {
                        gcross1,
                        gcross2,
                        rhs: rhs_wo_bias + rhs_bias,
                        rhs_wo_bias,
                        impulse: na::zero(),
                        r,
                    };
                }

                // Tangent parts.
                {
                    constraint.elements[k].tangent_part.impulse = na::zero();

                    for j in 0..DIM - 1 {
                        let torque_dir1 = dp1.gcross(tangents1[j]);
                        let gcross1 = if rb_type1.is_dynamic() {
                            rb_mprops1
                                .effective_world_inv_inertia_sqrt
                                .transform_vector(torque_dir1)
                        } else {
                            na::zero()
                        };
                        constraint.elements[k].tangent_part.gcross1[j] = gcross1;

                        let torque_dir2 = dp2.gcross(-tangents1[j]);
                        let gcross2 = if rb_type2.is_dynamic() {
                            rb_mprops2
                                .effective_world_inv_inertia_sqrt
                                .transform_vector(torque_dir2)
                        } else {
                            na::zero()
                        };
                        constraint.elements[k].tangent_part.gcross2[j] = gcross2;

                        let inv_r1 = if let Some((mb1, link_id1)) = multibody1.as_ref() {
                            mb1.fill_jacobians(
                                *link_id1,
                                tangents1[j],
                                #[cfg(feature = "dim2")]
                                na::vector![torque_dir1],
                                #[cfg(feature = "dim3")]
                                torque_dir1,
                                jacobian_id,
                                jacobians,
                            )
                            .0
                        } else if rb_type1.is_dynamic() {
                            force_dir1
                                .dot(&rb_mprops1.effective_inv_mass.component_mul(&force_dir1))
                                + gcross1.gdot(gcross1)
                        } else {
                            0.0
                        };

                        let inv_r2 = if let Some((mb2, link_id2)) = multibody2.as_ref() {
                            mb2.fill_jacobians(
                                *link_id2,
                                -tangents1[j],
                                #[cfg(feature = "dim2")]
                                na::vector![torque_dir2],
                                #[cfg(feature = "dim3")]
                                torque_dir2,
                                jacobian_id,
                                jacobians,
                            )
                            .0
                        } else if rb_type2.is_dynamic() {
                            force_dir1
                                .dot(&rb_mprops2.effective_inv_mass.component_mul(&force_dir1))
                                + gcross2.gdot(gcross2)
                        } else {
                            0.0
                        };

                        let r = crate::utils::inv(inv_r1 + inv_r2);

                        let rhs =
                            (vel1 - vel2 + manifold_point.tangent_velocity).dot(&tangents1[j]);

                        constraint.elements[k].tangent_part.rhs[j] = rhs;
                        // FIXME: in 3D, we should take into account gcross[0].dot(gcross[1])
                        // in lhs. See the corresponding code on the `velocity_constraint.rs`
                        // file.
                        constraint.elements[k].tangent_part.r[j] = r;
                    }
                }
            }

            let ndofs1 = multibody1.map(|mb| mb.0.ndofs()).unwrap_or(0);
            let ndofs2 = multibody2.map(|mb| mb.0.ndofs()).unwrap_or(0);
            // NOTE: we use the generic constraint for non-dynamic bodies because this will
            //       reduce all ops to nothing because its ndofs will be zero.
            let generic_constraint_mask = (multibody1.is_some() as u8)
                | ((multibody2.is_some() as u8) << 1)
                | (!rb_type1.is_dynamic() as u8)
                | ((!rb_type2.is_dynamic() as u8) << 1);

            let constraint = GenericVelocityConstraint {
                velocity_constraint: constraint,
                j_id: chunk_j_id,
                ndofs1,
                ndofs2,
                generic_constraint_mask,
            };

            if push {
                out_constraints.push(AnyGenericVelocityConstraint::Nongrouped(constraint));
            } else {
                out_constraints[manifold.data.constraint_index + _l] =
                    AnyGenericVelocityConstraint::Nongrouped(constraint);
            }
        }
    }

    pub fn solve(
        &mut self,
        jacobians: &DVector<Real>,
        mj_lambdas: &mut [DeltaVel<Real>],
        generic_mj_lambdas: &mut DVector<Real>,
        solve_restitution: bool,
        solve_friction: bool,
    ) {
        let mut mj_lambda1 = if self.generic_constraint_mask & 0b01 == 0 {
            GenericRhs::DeltaVel(mj_lambdas[self.velocity_constraint.mj_lambda1 as usize])
        } else {
            GenericRhs::GenericId(self.velocity_constraint.mj_lambda1 as usize)
        };

        let mut mj_lambda2 = if self.generic_constraint_mask & 0b10 == 0 {
            GenericRhs::DeltaVel(mj_lambdas[self.velocity_constraint.mj_lambda2 as usize])
        } else {
            GenericRhs::GenericId(self.velocity_constraint.mj_lambda2 as usize)
        };

        let elements = &mut self.velocity_constraint.elements
            [..self.velocity_constraint.num_contacts as usize];
        VelocityConstraintElement::generic_solve_group(
            elements,
            jacobians,
            &self.velocity_constraint.dir1,
            #[cfg(feature = "dim3")]
            &self.velocity_constraint.tangent1,
            &self.velocity_constraint.im1,
            &self.velocity_constraint.im2,
            self.velocity_constraint.limit,
            self.ndofs1,
            self.ndofs2,
            self.j_id,
            &mut mj_lambda1,
            &mut mj_lambda2,
            generic_mj_lambdas,
            solve_restitution,
            solve_friction,
        );

        if let GenericRhs::DeltaVel(mj_lambda1) = mj_lambda1 {
            mj_lambdas[self.velocity_constraint.mj_lambda1 as usize] = mj_lambda1;
        }

        if let GenericRhs::DeltaVel(mj_lambda2) = mj_lambda2 {
            mj_lambdas[self.velocity_constraint.mj_lambda2 as usize] = mj_lambda2;
        }
    }

    pub fn writeback_impulses(&self, manifolds_all: &mut [&mut ContactManifold]) {
        self.velocity_constraint.writeback_impulses(manifolds_all);
    }

    pub fn remove_bias_from_rhs(&mut self) {
        self.velocity_constraint.remove_bias_from_rhs();
    }
}