Struct rapier3d::geometry::InteractionGroups

#[repr(transparent)]pub struct InteractionGroups(pub u32);

Pairwise filtering using bit masks.

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

• The interaction groups (the 16 left-most bits of self.0).
• The interaction mask (the 16 right-most bits of self.0).

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

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

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

((self.0 >> 16) & rhs.0) != 0 && ((rhs.0 >> 16) & self.0) != 0

Implementations

impl InteractionGroups

pub const fn new(groups: u16, masks: u16) -> Self

Initializes with the given interaction groups and interaction mask.

pub const fn all() -> Self

Allow interaction with everything.

pub const fn none() -> Self

Prevent all interactions.

pub const fn with_groups(self, groups: u16) -> Self

Sets the group this filter is part of.

pub const fn with_mask(self, mask: u16) -> Self

Sets the interaction mask of this filter.

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

Check if interactions should be allowed based on the interaction groups and mask.

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

Trait Implementations

impl Clone for InteractionGroups

fn clone(&self) -> InteractionGroups

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for InteractionGroups

impl Debug for InteractionGroups

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

Formats the value using the given formatter.

impl Default for InteractionGroups

fn default() -> Self

Returns the “default value” for a type.

impl Eq for InteractionGroups

impl Hash for InteractionGroups

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

Feeds this value into the given Hasher.

pub 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

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

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

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

This method tests for !=.

impl StructuralEq for InteractionGroups

impl StructuralPartialEq for InteractionGroups