Struct heron::rapier_plugin::rapier::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() -> ColliderSet

Create a new empty set of colliders.

pub fn invalid_handle() -> Index

An always-invalid collider handle.

pub fn iter(&self) -> impl ExactSizeIterator

Iterate through all the colliders on this set.

pub fn len(&self) -> usize

The number of colliders on this set.

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

Is this collider handle valid?

pub fn insert(
    &mut self,
    coll: Collider,
    parent_handle: Index,
    bodies: &mut RigidBodySet
) -> Index

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

pub fn remove(
    &mut self,
    handle: Index,
    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: usize) -> Option<(&Collider, Index)>

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: usize
) -> Option<(&mut Collider, Index)>

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: Index) -> Option<&Collider>

Get the collider with the given handle.

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

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

Trait Implementations

impl Clone for ColliderSet

pub fn clone(&self) -> ColliderSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Index<Index> for ColliderSet

type Output = Collider

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<Index> for ColliderSet

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

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