Struct rapier3d::geometry::ColliderSet

pub struct ColliderSet { /* fields omitted */ }

A set of colliders that can be handled by a physics World.

Implementations

impl ColliderSet

pub fn new() -> Self

Create a new empty set of colliders.

pub fn invalid_handle() -> ColliderHandle

An always-invalid collider handle.

pub fn iter(&self) -> impl ExactSizeIterator<Item = (ColliderHandle, &Collider)>

Iterate through all the colliders on this set.

pub fn iter_mut(
    &mut self
) -> impl Iterator<Item = (ColliderHandle, &mut Collider)>

Iterates mutably through all the colliders on this set.

pub fn len(&self) -> usize

The number of colliders on this set.

pub fn is_empty(&self) -> bool

true if there are no colliders in this set.

pub fn contains(&self, handle: ColliderHandle) -> bool

Is this collider handle valid?

pub fn insert(&mut self, coll: Collider) -> ColliderHandle

Inserts a new collider to this set and retrieve its handle.

pub fn insert_with_parent(
    &mut self,
    coll: Collider,
    parent_handle: RigidBodyHandle,
    bodies: &mut RigidBodySet
) -> ColliderHandle

Inserts a new collider to this set, attach it to the given rigid-body, and retrieve its handle.

pub fn remove(
    &mut self,
    handle: ColliderHandle,
    islands: &mut IslandManager,
    bodies: &mut RigidBodySet,
    wake_up: bool
) -> Option<Collider>

Remove a collider from this set and update its parent accordingly.

If wake_up is true, the rigid-body the removed collider is attached to will be woken up.

pub fn get_unknown_gen(&self, i: u32) -> Option<(&Collider, ColliderHandle)>

Gets the collider with the given handle without a known generation.

This is useful when you know you want the collider at position i but don’t know what is its current generation number. Generation numbers are used to protect from the ABA problem because the collider position i are recycled between two insertion and a removal.

Using this is discouraged in favor of self.get(handle) which does not suffer form the ABA problem.

pub fn get_unknown_gen_mut(
    &mut self,
    i: u32
) -> Option<(&mut Collider, ColliderHandle)>

Gets a mutable reference to the collider with the given handle without a known generation.

This is useful when you know you want the collider at position i but don’t know what is its current generation number. Generation numbers are used to protect from the ABA problem because the collider position i are recycled between two insertion and a removal.

Using this is discouraged in favor of self.get_mut(handle) which does not suffer form the ABA problem.

pub fn get(&self, handle: ColliderHandle) -> Option<&Collider>

Get the collider with the given handle.

pub fn get_mut(&mut self, handle: ColliderHandle) -> Option<&mut Collider>

Gets a mutable reference to the collider with the given handle.

Trait Implementations

impl Clone for ColliderSet

fn clone(&self) -> ColliderSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComponentSet<ColliderBroadPhaseData> for ColliderSet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

fn for_each(&self, f: impl FnMut(Index, &ColliderBroadPhaseData))

Iterate through all the elements on this set.

fn index(&self, handle: Index) -> &T

Get the element associated to the given handle.

impl ComponentSet<ColliderChanges> for ColliderSet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

fn for_each(&self, f: impl FnMut(Index, &ColliderChanges))

Iterate through all the elements on this set.

fn index(&self, handle: Index) -> &T

Get the element associated to the given handle.

impl ComponentSet<ColliderFlags> for ColliderSet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

fn for_each(&self, f: impl FnMut(Index, &ColliderFlags))

Iterate through all the elements on this set.

fn index(&self, handle: Index) -> &T

Get the element associated to the given handle.

impl ComponentSet<ColliderMassProps> for ColliderSet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

fn for_each(&self, f: impl FnMut(Index, &ColliderMassProps))

Iterate through all the elements on this set.

fn index(&self, handle: Index) -> &T

Get the element associated to the given handle.

impl ComponentSet<ColliderMaterial> for ColliderSet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

fn for_each(&self, f: impl FnMut(Index, &ColliderMaterial))

Iterate through all the elements on this set.

fn index(&self, handle: Index) -> &T

Get the element associated to the given handle.

impl ComponentSet<ColliderPosition> for ColliderSet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

fn for_each(&self, f: impl FnMut(Index, &ColliderPosition))

Iterate through all the elements on this set.

fn index(&self, handle: Index) -> &T

Get the element associated to the given handle.

impl ComponentSet<ColliderType> for ColliderSet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

fn for_each(&self, f: impl FnMut(Index, &ColliderType))

Iterate through all the elements on this set.

fn index(&self, handle: Index) -> &T

Get the element associated to the given handle.

impl ComponentSet<SharedShape> for ColliderSet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

fn for_each(&self, f: impl FnMut(Index, &ColliderShape))

Iterate through all the elements on this set.

fn index(&self, handle: Index) -> &T

Get the element associated to the given handle.

impl ComponentSetMut<ColliderBroadPhaseData> for ColliderSet

fn set_internal(&mut self, handle: Index, val: ColliderBroadPhaseData)

Set the value of this element.

fn map_mut_internal<Result>(
    &mut self,
    handle: Index,
    f: impl FnOnce(&mut ColliderBroadPhaseData) -> Result
) -> Option<Result>

Applies the given closure to the element associated to the given handle.

impl ComponentSetMut<ColliderChanges> for ColliderSet

fn set_internal(&mut self, handle: Index, val: ColliderChanges)

Set the value of this element.

fn map_mut_internal<Result>(
    &mut self,
    handle: Index,
    f: impl FnOnce(&mut ColliderChanges) -> Result
) -> Option<Result>

Applies the given closure to the element associated to the given handle.

impl ComponentSetMut<ColliderFlags> for ColliderSet

fn set_internal(&mut self, handle: Index, val: ColliderFlags)

Set the value of this element.

fn map_mut_internal<Result>(
    &mut self,
    handle: Index,
    f: impl FnOnce(&mut ColliderFlags) -> Result
) -> Option<Result>

Applies the given closure to the element associated to the given handle.

impl ComponentSetMut<ColliderMassProps> for ColliderSet

fn set_internal(&mut self, handle: Index, val: ColliderMassProps)

Set the value of this element.

fn map_mut_internal<Result>(
    &mut self,
    handle: Index,
    f: impl FnOnce(&mut ColliderMassProps) -> Result
) -> Option<Result>

Applies the given closure to the element associated to the given handle.

impl ComponentSetMut<ColliderMaterial> for ColliderSet

fn set_internal(&mut self, handle: Index, val: ColliderMaterial)

Set the value of this element.

fn map_mut_internal<Result>(
    &mut self,
    handle: Index,
    f: impl FnOnce(&mut ColliderMaterial) -> Result
) -> Option<Result>

Applies the given closure to the element associated to the given handle.

impl ComponentSetMut<ColliderPosition> for ColliderSet

fn set_internal(&mut self, handle: Index, val: ColliderPosition)

Set the value of this element.

fn map_mut_internal<Result>(
    &mut self,
    handle: Index,
    f: impl FnOnce(&mut ColliderPosition) -> Result
) -> Option<Result>

Applies the given closure to the element associated to the given handle.

impl ComponentSetMut<ColliderType> for ColliderSet

fn set_internal(&mut self, handle: Index, val: ColliderType)

Set the value of this element.

fn map_mut_internal<Result>(
    &mut self,
    handle: Index,
    f: impl FnOnce(&mut ColliderType) -> Result
) -> Option<Result>

Applies the given closure to the element associated to the given handle.

impl ComponentSetMut<SharedShape> for ColliderSet

fn set_internal(&mut self, handle: Index, val: ColliderShape)

Set the value of this element.

fn map_mut_internal<Result>(
    &mut self,
    handle: Index,
    f: impl FnOnce(&mut ColliderShape) -> Result
) -> Option<Result>

Applies the given closure to the element associated to the given handle.

impl ComponentSetOption<ColliderBroadPhaseData> for ColliderSet

fn get(&self, handle: Index) -> Option<&ColliderBroadPhaseData>

Get the element associated to the given handle, if there is one.

impl ComponentSetOption<ColliderChanges> for ColliderSet

fn get(&self, handle: Index) -> Option<&ColliderChanges>

Get the element associated to the given handle, if there is one.

impl ComponentSetOption<ColliderFlags> for ColliderSet

fn get(&self, handle: Index) -> Option<&ColliderFlags>

Get the element associated to the given handle, if there is one.

impl ComponentSetOption<ColliderMassProps> for ColliderSet

fn get(&self, handle: Index) -> Option<&ColliderMassProps>

Get the element associated to the given handle, if there is one.

impl ComponentSetOption<ColliderMaterial> for ColliderSet

fn get(&self, handle: Index) -> Option<&ColliderMaterial>

Get the element associated to the given handle, if there is one.

impl ComponentSetOption<ColliderParent> for ColliderSet

fn get(&self, handle: Index) -> Option<&ColliderParent>

Get the element associated to the given handle, if there is one.

impl ComponentSetOption<ColliderPosition> for ColliderSet

fn get(&self, handle: Index) -> Option<&ColliderPosition>

Get the element associated to the given handle, if there is one.

impl ComponentSetOption<ColliderType> for ColliderSet

fn get(&self, handle: Index) -> Option<&ColliderType>

Get the element associated to the given handle, if there is one.

impl ComponentSetOption<SharedShape> for ColliderSet

fn get(&self, handle: Index) -> Option<&ColliderShape>

Get the element associated to the given handle, if there is one.

impl Default for ColliderSet

fn default() -> ColliderSet

Returns the “default value” for a type.

impl Index<ColliderHandle> for ColliderSet

type Output = Collider

The returned type after indexing.

fn index(&self, index: ColliderHandle) -> &Collider

Performs the indexing (container[index]) operation.

impl Index<Index> for ColliderSet

type Output = Collider

The returned type after indexing.

fn index(&self, index: Index) -> &Collider

Performs the indexing (container[index]) operation.

impl IndexMut<ColliderHandle> for ColliderSet

fn index_mut(&mut self, handle: ColliderHandle) -> &mut Collider

Performs the mutable indexing (container[index]) operation.