Struct heron::rapier_plugin::rapier3d::geometry::ColliderSet

pub struct ColliderSet { /* private fields */ }

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() -> ColliderHandle

An always-invalid collider handle.

pub fn iter(&self) -> impl ExactSizeIterator

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: impl Into<Collider>) -> ColliderHandle

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

pub fn insert_with_parent(
    &mut self,
    coll: impl Into<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 set_parent(
    &mut self,
    handle: ColliderHandle,
    new_parent_handle: Option<RigidBodyHandle>,
    bodies: &mut RigidBodySet
)

Sets the parent of the given collider.

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 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.