Skip to main content

CollisionGroup

Struct CollisionGroup 

Source
pub struct CollisionGroup { /* private fields */ }
Expand description

The collision group of a body (Jolt CollisionGroup): a group id and a sub group of a GroupFilterTable.

Jolt’s rule for two bodies that both have a group: different group ids collide; the same group id with different tables never collides; within one table the same sub group never collides, and different sub groups collide when the table says so. A body without a group collides by its object layer alone. The group only filters what the solver collides: scene queries, character movement and vehicle wheel casts do not look at it.

Implementations§

Source§

impl CollisionGroup

Source

pub const MAX_GROUP_ID: u32

The largest group id a caller may use. The ids above it belong to ragdolls: the parts of a ragdoll use group id 2^31 + RagdollId::to_raw.

Source

pub fn new( table: &GroupFilterTable, group_id: u32, sub_group_id: u32, ) -> Result<Self, CollisionGroupError>

The group group_id with sub group sub_group_id of table. Refused for a group id above MAX_GROUP_ID and a sub group not in the table.

Source

pub fn table(&self) -> &GroupFilterTable

The table of the group.

Source

pub fn group_id(&self) -> u32

The group id.

Source

pub fn sub_group_id(&self) -> u32

The sub group, below the table’s sub_groups.

Source

pub fn can_collide(&self, other: &CollisionGroup) -> bool

Whether bodies of the two groups collide, by Jolt’s rule (CollisionGroup::CanCollide).

Trait Implementations§

Source§

impl Clone for CollisionGroup

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CollisionGroup

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CollisionGroup

Source§

impl PartialEq for CollisionGroup

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CollisionGroup

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.