Struct ncollide2d::pipeline::object::CollisionObjectSlab

pub struct CollisionObjectSlab<N: RealField, T> { /* fields omitted */ }

A set of collision objects that can be indexed by collision object handles.

Methods

impl<N: RealField, T> CollisionObjectSlab<N, T>

pub fn new() -> CollisionObjectSlab<N, T>

Creates a new empty collection of collision objects.

pub fn insert(&mut self, co: CollisionObject<N, T>) -> CollisionObjectSlabHandle

Inserts a new collision object into this collection and returns the corresponding handle.

pub fn remove(
    &mut self,
    handle: CollisionObjectSlabHandle
) -> CollisionObject<N, T>

Removes from this collection the collision object identified by the given handle.

The removed collision object structure is returned.

pub fn get(
    &self,
    handle: CollisionObjectSlabHandle
) -> Option<&CollisionObject<N, T>>

If it exists, retrieves a reference to the collision object identified by the given handle.

pub fn get_mut(
    &mut self,
    handle: CollisionObjectSlabHandle
) -> Option<&mut CollisionObject<N, T>>

If it exists, retrieves a mutable reference to the collision object identified by the given handle.

pub fn get_pair_mut(
    &mut self,
    handle1: CollisionObjectSlabHandle,
    handle2: CollisionObjectSlabHandle
) -> (Option<&mut CollisionObject<N, T>>, Option<&mut CollisionObject<N, T>>)

If they exists, retrieves a mutable reference to the two collision object identified by the given handles.

Panics if both handles are equal.

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

Returns true if the specified handle identifies a collision object stored in this collection.

Important traits for CollisionObjects<'a, N, T>

impl<'a, N: 'a + RealField, T: 'a> Iterator for CollisionObjects<'a, N, T> type Item = (CollisionObjectSlabHandle, &'a CollisionObject<N, T>);

pub fn iter(&self) -> CollisionObjects<N, T>

Retrieves an iterator yielding references to each collision object.

pub fn iter_mut(&mut self) -> CollisionObjectsMut<N, T>

Retrieves an iterator yielding references to each collision object.

pub fn len(&self) -> usize

The number of collision objects on this slab.

Trait Implementations

impl<N: RealField, T> CollisionObjectSet<N> for CollisionObjectSlab<N, T>

type CollisionObject = CollisionObject<N, T>

Type of the collision object stored into this set.

type CollisionObjectHandle = CollisionObjectSlabHandle

Type of the handles identifying collision objects.

fn collision_object(
    &self,
    handle: Self::CollisionObjectHandle
) -> Option<&Self::CollisionObject>

Gets the collision object identified by the given handle.

fn foreach(
    &self,
    f: impl FnMut(Self::CollisionObjectHandle, &Self::CollisionObject)
)

Applies a closure to every collision object (and their handle) stored into this set.

impl<N: RealField, T> Index<CollisionObjectSlabHandle> for CollisionObjectSlab<N, T>

type Output = CollisionObject<N, T>

The returned type after indexing.

fn index(&self, handle: CollisionObjectSlabHandle) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<N: RealField, T> IndexMut<CollisionObjectSlabHandle> for CollisionObjectSlab<N, T>

fn index_mut(&mut self, handle: CollisionObjectSlabHandle) -> &mut Self::Output

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