Struct rapier2d::dynamics::RigidBodySet[][src]

pub struct RigidBodySet { /* fields omitted */ }
Expand description

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

Implementations

impl RigidBodySet[src]

pub fn new() -> Self[src]

Create a new empty set of rigid bodies.

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

The number of rigid bodies on this set.

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

true if there are no rigid bodies in this set.

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

Is the given body handle valid?

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

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

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

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

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

Gets the rigid-body with the given handle.

pub fn get_mut(&mut self, handle: RigidBodyHandle) -> Option<&mut RigidBody>[src]

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

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

Iterates through all the rigid-bodies on this set.

pub fn iter_mut(
    &mut self
) -> impl Iterator<Item = (RigidBodyHandle, &mut RigidBody)>
[src]

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

Trait Implementations

impl Clone for RigidBodySet[src]

fn clone(&self) -> RigidBodySet[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<RigidBodyActivation> for RigidBodySet[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, &RigidBodyActivation))[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<RigidBodyCcd> for RigidBodySet[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, &RigidBodyCcd))[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<RigidBodyChanges> for RigidBodySet[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, &RigidBodyChanges))[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<RigidBodyColliders> for RigidBodySet[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, &RigidBodyColliders))[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<RigidBodyDamping> for RigidBodySet[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, &RigidBodyDamping))[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<RigidBodyDominance> for RigidBodySet[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, &RigidBodyDominance))[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<RigidBodyForces> for RigidBodySet[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, &RigidBodyForces))[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<RigidBodyIds> for RigidBodySet[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, &RigidBodyIds))[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<RigidBodyMassProps> for RigidBodySet[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, &RigidBodyMassProps))[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<RigidBodyPosition> for RigidBodySet[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, &RigidBodyPosition))[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<RigidBodyType> for RigidBodySet[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, &RigidBodyType))[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<RigidBodyVelocity> for RigidBodySet[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, &RigidBodyVelocity))[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<RigidBodyActivation> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyCcd> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyChanges> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyColliders> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyDamping> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyDominance> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyForces> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyIds> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyMassProps> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyPosition> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyType> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetMut<RigidBodyVelocity> for RigidBodySet[src]

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

Set the value of this element.

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

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

impl ComponentSetOption<RigidBodyActivation> for RigidBodySet[src]

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

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

impl ComponentSetOption<RigidBodyCcd> for RigidBodySet[src]

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

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

impl ComponentSetOption<RigidBodyChanges> for RigidBodySet[src]

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

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

impl ComponentSetOption<RigidBodyColliders> for RigidBodySet[src]

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

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

impl ComponentSetOption<RigidBodyDamping> for RigidBodySet[src]

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

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

impl ComponentSetOption<RigidBodyDominance> for RigidBodySet[src]

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

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

impl ComponentSetOption<RigidBodyForces> for RigidBodySet[src]

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

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

impl ComponentSetOption<RigidBodyIds> for RigidBodySet[src]

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

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

impl ComponentSetOption<RigidBodyMassProps> for RigidBodySet[src]

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

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

impl ComponentSetOption<RigidBodyPosition> for RigidBodySet[src]

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

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

impl ComponentSetOption<RigidBodyType> for RigidBodySet[src]

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

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

impl ComponentSetOption<RigidBodyVelocity> for RigidBodySet[src]

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

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

impl Index<Index> for RigidBodySet[src]

type Output = RigidBody

The returned type after indexing.

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

Performs the indexing (container[index]) operation. Read more

impl Index<RigidBodyHandle> for RigidBodySet[src]

type Output = RigidBody

The returned type after indexing.

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

Performs the indexing (container[index]) operation. Read more

impl IndexMut<RigidBodyHandle> for RigidBodySet[src]

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

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

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
    T: Any
[src]

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>[src]

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>[src]

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)[src]

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)[src]

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
    T: Any + Send + Sync
[src]

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Sync + Send>[src]

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 
[src]

pub fn to_subset(&self) -> Option<SS>[src]

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

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

Checks if self is actually part of its subset T (and can be converted to it).

pub fn to_subset_unchecked(&self) -> SS[src]

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

pub fn from_subset(element: &SS) -> SP[src]

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.