Struct rapier2d::dynamics::RigidBodySet

pub struct RigidBodySet { /* fields omitted */ }

A set of rigid bodies that can be handled by a physics pipeline.

Implementations

impl RigidBodySet

pub fn new() -> Self

Create a new empty set of rigid bodies.

pub fn invalid_handle() -> RigidBodyHandle

An always-invalid rigid-body handle.

pub fn len(&self) -> usize

The number of rigid bodies on this set.

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

Is the given body handle valid?

pub fn insert(&mut self, rb: RigidBody) -> RigidBodyHandle

Insert a rigid body into this set and retrieve its handle.

pub fn wake_up(&mut self, handle: RigidBodyHandle)

Forces the specified rigid-body to wake up if it is dynamic.

pub fn get_unknown_gen(&self, i: usize) -> Option<(&RigidBody, RigidBodyHandle)>

Gets the rigid-body with the given handle without a known generation.

This is useful when you know you want the rigid-body 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 rigid-body 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 RigidBody, RigidBodyHandle)>

Gets a mutable reference to the rigid-body with the given handle without a known generation.

This is useful when you know you want the rigid-body 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 rigid-body 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: RigidBodyHandle) -> Option<&RigidBody>

Gets the rigid-body with the given handle.

pub fn get_mut(&mut self, handle: RigidBodyHandle) -> Option<RigidBodyMut<'_>>

Gets a mutable reference to the rigid-body with the given handle.

pub fn iter(&self) -> impl Iterator<Item = (RigidBodyHandle, &RigidBody)>

Iterates through all the rigid-bodies on this set.

pub fn iter_mut(
    &mut self
) -> impl Iterator<Item = (RigidBodyHandle, RigidBodyMut<'_>)>

Iterates mutably through all the rigid-bodies on this set.

pub fn iter_active_dynamic<'a>(
    &'a self
) -> impl Iterator<Item = (RigidBodyHandle, &'a RigidBody)>

Iter through all the active dynamic rigid-bodies on this set.

Trait Implementations

impl Index<Index> for RigidBodySet

type Output = RigidBody

The returned type after indexing.

fn index(&self, index: RigidBodyHandle) -> &RigidBody

Performs the indexing (container[index]) operation.

impl IndexMut<Index> for RigidBodySet

fn index_mut(&mut self, index: RigidBodyHandle) -> &mut RigidBody

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