Struct ContactEdge

pub struct ContactEdge {
    pub id: ContactId,
    pub collider1: Entity,
    pub collider2: Entity,
    pub body1: Option<Entity>,
    pub body2: Option<Entity>,
    pub pair_index: usize,
    pub constraint_handles: SmallVec<[ContactConstraintHandle; 4]>,
    pub island: Option<IslandNode<ContactId>>,
    pub flags: ContactEdgeFlags,
}

Cold contact data stored in the ContactGraph. Used as a persistent handle for a ContactPair.

Fields

id: ContactId

The stable identifier of this contact edge.

collider1: Entity

The first collider entity in the contact.

collider2: Entity

The second collider entity in the contact.

body1: Option<Entity>

The entity of the first body involved in the contact.

body2: Option<Entity>

The entity of the second body involved in the contact.

pair_index: usize

The index of the ContactPair in the ContactGraph.

constraint_handles: SmallVec<[ContactConstraintHandle; 4]>

The handles to the constraints associated with this contact edge.

island: Option<IslandNode<ContactId>>

The IslandNode associated with this contact edge.

flags: ContactEdgeFlags

Flags for the contact edge.

Implementations

impl ContactEdge

pub fn new(collider1: Entity, collider2: Entity) -> Self

Creates a new non-touching ContactEdge with the given entities.

pub fn is_touching(&self) -> bool

Returns true if the colliders are touching.

pub fn is_sleeping(&self) -> bool

Returns true if the contact pair is between sleeping bodies.

pub fn events_enabled(&self) -> bool

Returns true if collision events are enabled for the contact.

Trait Implementations

impl Clone for ContactEdge

fn clone(&self) -> ContactEdge

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContactEdge

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ContactEdge

fn eq(&self, other: &ContactEdge) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ContactEdge