ncollide3d/pipeline/narrow_phase/contact_generator/
contact_manifold_generator.rs

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
use crate::math::Isometry;
use crate::query::ContactPreprocessor;
use crate::query::{ContactManifold, ContactPrediction};
use crate::shape::Shape;
use na::RealField;
use std::any::Any;

/// An algorithm to compute contact points, normals and penetration depths between two specific
/// objects.
pub trait ContactManifoldGenerator<N: RealField + Copy>: Any + Send + Sync {
    /// Runs the collision detection on two objects. It is assumed that the same
    /// collision detector (the same structure) is always used with the same
    /// pair of objects.
    ///
    /// Returns `false` if persisting this algorithm for re-use is unlikely to improve performance,
    /// e.g. due to the objects being distant. Note that if the `ContactManifoldGenerator` would
    /// likely be immediately reconstructed in the next time-step, dropping it is sub-optimal
    /// regardless.
    fn generate_contacts(
        &mut self,
        dispatcher: &dyn ContactDispatcher<N>,
        ma: &Isometry<N>,
        a: &dyn Shape<N>,
        proc1: Option<&dyn ContactPreprocessor<N>>,
        mb: &Isometry<N>,
        b: &dyn Shape<N>,
        proc2: Option<&dyn ContactPreprocessor<N>>,
        prediction: &ContactPrediction<N>,
        manifold: &mut ContactManifold<N>,
    ) -> bool;

    /// Generate an empty contact manifold configured as required by this contact manifold generator.
    fn init_manifold(&self) -> ContactManifold<N> {
        ContactManifold::new()
    }
}

pub type ContactAlgorithm<N> = Box<dyn ContactManifoldGenerator<N>>;

pub trait ContactDispatcher<N>: Any + Send + Sync {
    /// Allocate a collision algorithm corresponding to a pair of objects with the given shapes.
    fn get_contact_algorithm(
        &self,
        a: &dyn Shape<N>,
        b: &dyn Shape<N>,
    ) -> Option<ContactAlgorithm<N>>;
}