Struct bevy_rapier2d::prelude::InteractionGroups

#[repr(C)]
pub struct InteractionGroups {
    pub memberships: u32,
    pub filter: u32,
}

Pairwise filtering using bit masks.

This filtering method is based on two 32-bit values:

• The interaction groups memberships.
• The interaction groups filter.

An interaction is allowed between two filters a and b when two conditions are met simultaneously:

• The groups membership of a has at least one bit set to 1 in common with the groups filter of b.
• The groups membership of b has at least one bit set to 1 in common with the groups filter of a.

In other words, interactions are allowed between two filter iff. the following condition is met:

(self.memberships & rhs.filter) != 0 && (rhs.memberships & self.filter) != 0

Fields

memberships: u32

Groups memberships.

filter: u32

Groups filter.

Implementations

impl InteractionGroups

pub const fn new(memberships: u32, filter: u32) -> InteractionGroups

Initializes with the given interaction groups and interaction mask.

pub const fn all() -> InteractionGroups

Allow interaction with everything.

pub const fn none() -> InteractionGroups

Prevent all interactions.

pub const fn with_memberships(self, memberships: u32) -> InteractionGroups

Sets the group this filter is part of.

pub const fn with_filter(self, filter: u32) -> InteractionGroups

Sets the interaction mask of this filter.

pub const fn test(self, rhs: InteractionGroups) -> bool

Check if interactions should be allowed based on the interaction memberships and filter.

An interaction is allowed iff. the memberships of self contain at least one bit set to 1 in common with the filter of rhs, and vice-versa.

Trait Implementations

impl Clone for InteractionGroups

pub fn clone(&self) -> InteractionGroups

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InteractionGroups

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

Formats the value using the given formatter.

impl Default for InteractionGroups

pub fn default() -> InteractionGroups

Returns the “default value” for a type.

impl Hash for InteractionGroups

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<InteractionGroups> for InteractionGroups

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for InteractionGroups

impl Eq for InteractionGroups

impl StructuralEq for InteractionGroups

impl StructuralPartialEq for InteractionGroups