Struct bevy_rapier2d::geometry::CollisionGroups

pub struct CollisionGroups {
    pub memberships: Group,
    pub filters: Group,
}

Pairwise collision 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: Group

Groups memberships.

filters: Group

Groups filter.

Implementations

impl CollisionGroups

pub const fn new(memberships: Group, filters: Group) -> Self

Creates a new collision-groups with the given membership masks and filter masks.

Trait Implementations

impl Clone for CollisionGroups

fn clone(&self) -> CollisionGroups

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for CollisionGroupswhere
    Self: Send + Sync + 'static,

type Storage = TableStorage

impl Debug for CollisionGroups

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

Formats the value using the given formatter.

impl Default for CollisionGroups

fn default() -> CollisionGroups

Returns the “default value” for a type.

impl From<CollisionGroups> for InteractionGroups

fn from(collision_groups: CollisionGroups) -> InteractionGroups

Converts to this type from the input type.

impl FromReflect for CollisionGroupswhere
    Group: FromReflect,
    Group: FromReflect,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

impl GetTypeRegistration for CollisionGroups

fn get_type_registration() -> TypeRegistration

impl Hash for CollisionGroups

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<CollisionGroups> for CollisionGroups

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

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

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

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

impl Reflect for CollisionGroups

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the [TypeInfo] of the underlying type.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

impl Struct for CollisionGroups

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a [DynamicStruct].

impl Typed for CollisionGroups

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for CollisionGroups

impl Eq for CollisionGroups

impl StructuralEq for CollisionGroups

impl StructuralPartialEq for CollisionGroups