Struct rapier3d::geometry::ColliderSet[−][src]

pub struct ColliderSet { /* fields omitted */ }

Expand description

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

Implementations

`impl ColliderSet`[src]

`pub fn new() -> Self`[src]

Create a new empty set of colliders.

`pub fn invalid_handle() -> ColliderHandle`[src]

An always-invalid collider handle.

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

Iterate through all the colliders on this set.

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

Iterates mutably through all the colliders on this set.

`pub fn len(&self) -> usize`[src]

The number of colliders on this set.

`pub fn is_empty(&self) -> bool`[src]

true if there are no colliders in this set.

`pub fn contains(&self, handle: ColliderHandle) -> bool`[src]

Is this collider handle valid?

`pub fn insert(&mut self, coll: Collider) -> ColliderHandle`[src]

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`[src]

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>`[src]

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)>`[src]

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)>`[src]

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>`[src]

Get the collider with the given handle.

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

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

Trait Implementations

`impl Clone for ColliderSet`[src]

`fn clone(&self) -> ColliderSet`[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from source. Read more

`impl ComponentSet<ColliderBroadPhaseData> for ColliderSet`[src]

`fn size_hint(&self) -> usize`[src]

The estimated number of elements in this set. Read more

`fn for_each(&self, f: impl FnMut(Index, &ColliderBroadPhaseData))`[src]

Iterate through all the elements on this set.

`fn index(&self, handle: Index) -> &T`[src]

Get the element associated to the given handle.

`impl ComponentSet<ColliderChanges> for ColliderSet`[src]

`fn size_hint(&self) -> usize`[src]

The estimated number of elements in this set. Read more

`fn for_each(&self, f: impl FnMut(Index, &ColliderChanges))`[src]

Iterate through all the elements on this set.

`fn index(&self, handle: Index) -> &T`[src]

Get the element associated to the given handle.

`impl ComponentSet<ColliderFlags> for ColliderSet`[src]

`fn size_hint(&self) -> usize`[src]

The estimated number of elements in this set. Read more

`fn for_each(&self, f: impl FnMut(Index, &ColliderFlags))`[src]

Iterate through all the elements on this set.

`fn index(&self, handle: Index) -> &T`[src]

Get the element associated to the given handle.

`impl ComponentSet<ColliderMassProps> for ColliderSet`[src]

`fn size_hint(&self) -> usize`[src]

The estimated number of elements in this set. Read more

`fn for_each(&self, f: impl FnMut(Index, &ColliderMassProps))`[src]

Iterate through all the elements on this set.

`fn index(&self, handle: Index) -> &T`[src]

Get the element associated to the given handle.

`impl ComponentSet<ColliderMaterial> for ColliderSet`[src]

`fn size_hint(&self) -> usize`[src]

The estimated number of elements in this set. Read more

`fn for_each(&self, f: impl FnMut(Index, &ColliderMaterial))`[src]

Iterate through all the elements on this set.

`fn index(&self, handle: Index) -> &T`[src]

Get the element associated to the given handle.

`impl ComponentSet<ColliderPosition> for ColliderSet`[src]

`fn size_hint(&self) -> usize`[src]

The estimated number of elements in this set. Read more

`fn for_each(&self, f: impl FnMut(Index, &ColliderPosition))`[src]

Iterate through all the elements on this set.

`fn index(&self, handle: Index) -> &T`[src]

Get the element associated to the given handle.

`impl ComponentSet<ColliderType> for ColliderSet`[src]

`fn size_hint(&self) -> usize`[src]

The estimated number of elements in this set. Read more

`fn for_each(&self, f: impl FnMut(Index, &ColliderType))`[src]

Iterate through all the elements on this set.

`fn index(&self, handle: Index) -> &T`[src]

Get the element associated to the given handle.

`impl ComponentSet<SharedShape> for ColliderSet`[src]

`fn size_hint(&self) -> usize`[src]

The estimated number of elements in this set. Read more

`fn for_each(&self, f: impl FnMut(Index, &ColliderShape))`[src]

Iterate through all the elements on this set.

`fn index(&self, handle: Index) -> &T`[src]

Get the element associated to the given handle.

`impl ComponentSetMut<ColliderBroadPhaseData> for ColliderSet`[src]

`fn set_internal(&mut self, handle: Index, val: ColliderBroadPhaseData)`[src]

Set the value of this element.

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

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

`impl ComponentSetMut<ColliderChanges> for ColliderSet`[src]

`fn set_internal(&mut self, handle: Index, val: ColliderChanges)`[src]

Set the value of this element.

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

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

`impl ComponentSetMut<ColliderFlags> for ColliderSet`[src]

`fn set_internal(&mut self, handle: Index, val: ColliderFlags)`[src]

Set the value of this element.

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

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

`impl ComponentSetMut<ColliderMassProps> for ColliderSet`[src]

`fn set_internal(&mut self, handle: Index, val: ColliderMassProps)`[src]

Set the value of this element.

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

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

`impl ComponentSetMut<ColliderMaterial> for ColliderSet`[src]

`fn set_internal(&mut self, handle: Index, val: ColliderMaterial)`[src]

Set the value of this element.

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

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

`impl ComponentSetMut<ColliderPosition> for ColliderSet`[src]

`fn set_internal(&mut self, handle: Index, val: ColliderPosition)`[src]

Set the value of this element.

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

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

`impl ComponentSetMut<ColliderType> for ColliderSet`[src]

`fn set_internal(&mut self, handle: Index, val: ColliderType)`[src]

Set the value of this element.

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

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

`impl ComponentSetMut<SharedShape> for ColliderSet`[src]

`fn set_internal(&mut self, handle: Index, val: ColliderShape)`[src]

Set the value of this element.