bonked2d 0.0.1

Simple 2D collision engine
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

//! Contact between two solid objects

use core::cmp::Ordering;
use parry::{math::Real, query::ShapeCastHit};

/// Contact data
pub struct Contact<P = ()> {
    /// parry's shape cast hit
    hit: ShapeCastHit,

    /// Weight ratio between the two objects in contact
    weight_ratio: Real,

    /// Payload of the other object
    payload: P,
}

impl<P> Contact<P> {
    /// Create a new contact result
    #[inline]
    pub fn new(hit: ShapeCastHit, weight_ratio: Real, payload: P) -> Self {
        Self {
            hit,
            weight_ratio,
            payload,
        }
    }

    /// Access parry's hit data
    #[inline]
    pub fn hit(&self) -> &ShapeCastHit {
        &self.hit
    }

    /// Get the weight ratio of this contact
    #[inline]
    pub fn weight_ratio(&self) -> Real {
        self.weight_ratio
    }

    /// Get the payload data of the other object
    #[inline]
    pub fn payload(&self) -> &P {
        &self.payload
    }

    /// Get the payload data of the other object as mutable. This makes sense
    /// if the payload is a pointer to the data stored on the actual object.
    #[inline]
    pub fn payload_mut(&mut self) -> &mut P {
        &mut self.payload
    }

    /// Compare two contact results to order them from nearest to furtherest
    pub fn order(&self, other: &Self, epsilon: Real) -> Ordering {
        let ta = self.hit.time_of_impact;
        let tb = other.hit.time_of_impact;
        if (ta - tb).abs() < epsilon {
            Ordering::Equal
        } else if ta < tb {
            Ordering::Less
        } else {
            Ordering::Greater
        }
    }
}