diff options
| author | Crozet Sébastien <developer@crozet.re> | 2021-01-27 14:20:14 +0100 |
|---|---|---|
| committer | Crozet Sébastien <developer@crozet.re> | 2021-01-27 14:20:14 +0100 |
| commit | 8ff2bcc3ec666805aceedaa477bde89f2a577d1c (patch) | |
| tree | 5cb00c1003e75924b7ac9ad6dbbd509052a3def2 /src/geometry/contact_pair.rs | |
| parent | a3324f85131215613b7a8acb60d9ee9517cc803d (diff) | |
| download | rapier-8ff2bcc3ec666805aceedaa477bde89f2a577d1c.tar.gz rapier-8ff2bcc3ec666805aceedaa477bde89f2a577d1c.tar.bz2 rapier-8ff2bcc3ec666805aceedaa477bde89f2a577d1c.zip | |
Add all the missing docs.
Diffstat (limited to 'src/geometry/contact_pair.rs')
| -rw-r--r-- | src/geometry/contact_pair.rs | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/src/geometry/contact_pair.rs b/src/geometry/contact_pair.rs index cbb012a..f6c4989 100644 --- a/src/geometry/contact_pair.rs +++ b/src/geometry/contact_pair.rs @@ -62,6 +62,7 @@ pub struct ContactPair { /// /// All contact manifold contain themselves contact points between the colliders. pub manifolds: Vec<ContactManifold>, + /// Is there any active contact in this contact pair? pub has_any_active_contact: bool, pub(crate) workspace: Option<ContactManifoldsWorkspace>, } @@ -95,18 +96,31 @@ pub struct ContactManifoldData { // contact preparation method. /// Flags used to control some aspects of the constraints solver for this contact manifold. pub solver_flags: SolverFlags, + /// The world-space contact normal shared by all the contact in this contact manifold. pub normal: Vector<Real>, + /// The contacts that will be seen by the constraints solver for computing forces. pub solver_contacts: Vec<SolverContact>, } +/// A contact seen by the constraints solver for computing forces. #[derive(Copy, Clone, Debug)] #[cfg_attr(feature = "serde-serialize", derive(Serialize, Deserialize))] pub struct SolverContact { + /// The world-space contact point. pub point: Point<Real>, + /// The distance between the two original contacts points along the contact normal. + /// If negative, this is measures the penetration depth. pub dist: Real, + /// The effective friction coefficient at this contact point. pub friction: Real, + /// The effective restitution coefficient at this contact point. pub restitution: Real, + /// The artificially add relative velocity at the contact point. + /// This is set to zero by default. Set to a non-zero value to + /// simulate, e.g., conveyor belts. pub surface_velocity: Vector<Real>, + /// Associated contact data used to warm-start the constraints + /// solver. pub data: ContactData, } @@ -132,6 +146,8 @@ impl ContactManifoldData { } } + /// Number of actives contacts, i.e., contacts that will be seen by + /// the constraints solver. #[inline] pub fn num_active_contacts(&self) -> usize { self.solver_contacts.len() |
