Struct rapier3d::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 len(&self) -> usize

The number of rigid bodies on this set.

pub fn is_empty(&self) -> bool

true if there are no rigid bodies in 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 remove(
    &mut self,
    handle: RigidBodyHandle,
    islands: &mut IslandManager,
    colliders: &mut ColliderSet,
    joints: &mut JointSet
) -> Option<RigidBody>

Removes a rigid-body, and all its attached colliders and joints, from these sets.

pub fn get_unknown_gen(&self, i: u32) -> 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: u32
) -> 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<&mut RigidBody>

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, &mut RigidBody)>

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

Trait Implementations

impl Clone for RigidBodySet

fn clone(&self) -> RigidBodySet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComponentSet<RigidBodyActivation> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSet<RigidBodyCcd> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSet<RigidBodyChanges> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSet<RigidBodyColliders> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSet<RigidBodyDamping> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSet<RigidBodyDominance> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSet<RigidBodyForces> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSet<RigidBodyIds> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSet<RigidBodyMassProps> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSet<RigidBodyPosition> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSet<RigidBodyType> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSet<RigidBodyVelocity> for RigidBodySet

fn size_hint(&self) -> usize

The estimated number of elements in this set.

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

Iterate through all the elements on this set.

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

Get the element associated to the given handle.

impl ComponentSetMut<RigidBodyActivation> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyCcd> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyChanges> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyColliders> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyDamping> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyDominance> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyForces> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyIds> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyMassProps> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyPosition> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyType> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyVelocity> for RigidBodySet

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

Set the value of this element.

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

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

impl ComponentSetOption<RigidBodyActivation> for RigidBodySet

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

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

impl ComponentSetOption<RigidBodyCcd> for RigidBodySet

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

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

impl ComponentSetOption<RigidBodyChanges> for RigidBodySet

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

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

impl ComponentSetOption<RigidBodyColliders> for RigidBodySet

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

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

impl ComponentSetOption<RigidBodyDamping> for RigidBodySet

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

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

impl ComponentSetOption<RigidBodyDominance> for RigidBodySet

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

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

impl ComponentSetOption<RigidBodyForces> for RigidBodySet

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

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

impl ComponentSetOption<RigidBodyIds> for RigidBodySet

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

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

impl ComponentSetOption<RigidBodyMassProps> for RigidBodySet

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

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

impl ComponentSetOption<RigidBodyPosition> for RigidBodySet

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

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

impl ComponentSetOption<RigidBodyType> for RigidBodySet

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

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

impl ComponentSetOption<RigidBodyVelocity> for RigidBodySet

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

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

impl Index<Index> for RigidBodySet

type Output = RigidBody

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RigidBodyHandle> for RigidBodySet

type Output = RigidBody

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<RigidBodyHandle> for RigidBodySet

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

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