Trait nphysics3d::object::BodySet[−][src]

pub trait BodySet<N: RealField + Copy> {
    type Handle: BodyHandle;
    fn get(&self, handle: Self::Handle) -> Option<&dyn Body<N>>;

    fn get_mut(&mut self, handle: Self::Handle) -> Option<&mut dyn Body<N>>;

    fn contains(&self, handle: Self::Handle) -> bool;

    fn foreach(&self, f: &mut dyn FnMut(Self::Handle, &dyn Body<N>));

    fn foreach_mut(&mut self, f: &mut dyn FnMut(Self::Handle, &mut dyn Body<N>));

    fn pop_removal_event(&mut self) -> Option<Self::Handle>;

    fn get_pair(
        &self, 
        handle1: Self::Handle, 
        handle2: Self::Handle
    ) -> (Option<&dyn Body<N>>, Option<&dyn Body<N>>) { ... }
}
Expand description

Trait implemented by sets of bodies.

A set of bodies maps a body handle to a body instance. In addition, it must maintain a set of body handle of bodies that have been removed (see the pop_removal_event method for details).

Associated Types

Type of a body handle identifying a body in this set.

Required methods

Gets a reference to the body identified by handle.

Gets a mutable reference to the body identified by handle.

Check if this set contains a body identified by handle.

Iterate through all the bodies on this set, applying the closure f on them.

Mutable iterate through all the bodies on this set, applying the closure f on them.

Gets the handle of one body that has been removed.

A body set must keep track (using typically a stack or a queue) of every body that has been removed from it. This is used by nphysics to perform some internal cleanup actions, or physical actions like waking bodies touching one that has been removed.

This method should return a removed body handle only once.

Provided methods

Gets a reference to the two bodies identified by handle1 and handle2.

Both handles are allowed to be equal.

Implementors