Struct oxygengine_physics_2d::prelude::object::DefaultColliderSet
source · pub struct DefaultColliderSet<N, Handle = Index>where
N: RealField + Copy,
Handle: BodyHandle,{ /* private fields */ }
Expand description
The default set containing all the colliders added to the world.
It is based on an arena using generational indices to avoid the ABA problem.
Implementations§
source§impl<N, Handle> DefaultColliderSet<N, Handle>where
N: RealField + Copy,
Handle: BodyHandle,
impl<N, Handle> DefaultColliderSet<N, Handle>where N: RealField + Copy, Handle: BodyHandle,
sourcepub fn new() -> DefaultColliderSet<N, Handle>
pub fn new() -> DefaultColliderSet<N, Handle>
Creates an empty set.
sourcepub fn remove(&mut self, to_remove: Index) -> Option<Collider<N, Handle>>
pub fn remove(&mut self, to_remove: Index) -> Option<Collider<N, Handle>>
Removes a collider from this set.
sourcepub fn get(&self, handle: Index) -> Option<&Collider<N, Handle>>
pub fn get(&self, handle: Index) -> Option<&Collider<N, Handle>>
Gets a reference to the collider identified by handle
.
sourcepub fn get_mut(&mut self, handle: Index) -> Option<&mut Collider<N, Handle>>
pub fn get_mut(&mut self, handle: Index) -> Option<&mut Collider<N, Handle>>
Gets a mutable reference to the collider identified by handle
.
Trait Implementations§
source§impl<N, Handle> ColliderSet<N, Handle> for DefaultColliderSet<N, Handle>where
N: RealField + Copy,
Handle: BodyHandle,
impl<N, Handle> ColliderSet<N, Handle> for DefaultColliderSet<N, Handle>where N: RealField + Copy, Handle: BodyHandle,
source§fn get(
&self,
handle: <DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle
) -> Option<&Collider<N, Handle>>
fn get( &self, handle: <DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle ) -> Option<&Collider<N, Handle>>
Gets a reference to the collider identified by
handle
.source§fn get_mut(
&mut self,
handle: <DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle
) -> Option<&mut Collider<N, Handle>>
fn get_mut( &mut self, handle: <DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle ) -> Option<&mut Collider<N, Handle>>
Gets a mutable reference to the collider identified by
handle
.source§fn contains(
&self,
handle: <DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle
) -> bool
fn contains( &self, handle: <DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle ) -> bool
Check if this set contains a collider identified by
handle
.source§fn foreach(
&self,
f: impl FnMut(<DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle, &Collider<N, Handle>)
)
fn foreach( &self, f: impl FnMut(<DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle, &Collider<N, Handle>) )
Iterate through all the colliders on this set, applying the closure
f
on them.source§fn foreach_mut(
&mut self,
f: impl FnMut(<DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle, &mut Collider<N, Handle>)
)
fn foreach_mut( &mut self, f: impl FnMut(<DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle, &mut Collider<N, Handle>) )
Mutable iterates through all the colliders on this set, applying the closure
f
on them.source§fn pop_insertion_event(
&mut self
) -> Option<<DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle>
fn pop_insertion_event( &mut self ) -> Option<<DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle>
Gets the handle of one collider that has been inserted. Read more
source§fn pop_removal_event(
&mut self
) -> Option<(<DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle, ColliderRemovalData<N, Handle>)>
fn pop_removal_event( &mut self ) -> Option<(<DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle, ColliderRemovalData<N, Handle>)>
Gets the handle and removal data of one collider that has been removed. Read more
source§fn remove(
&mut self,
to_remove: <DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle
) -> Option<&mut ColliderRemovalData<N, Handle>>
fn remove( &mut self, to_remove: <DefaultColliderSet<N, Handle> as ColliderSet<N, Handle>>::Handle ) -> Option<&mut ColliderRemovalData<N, Handle>>
Removes a collider from this set. Read more
source§impl<N, Handle> CollisionObjectSet<N> for DefaultColliderSet<N, Handle>where
N: RealField + Copy,
Handle: BodyHandle,
impl<N, Handle> CollisionObjectSet<N> for DefaultColliderSet<N, Handle>where N: RealField + Copy, Handle: BodyHandle,
§type CollisionObject = Collider<N, Handle>
type CollisionObject = Collider<N, Handle>
Type of the collision object stored into this set.
§type CollisionObjectHandle = Index
type CollisionObjectHandle = Index
Type of the handles identifying collision objects.
source§fn collision_object(
&self,
handle: <DefaultColliderSet<N, Handle> as CollisionObjectSet<N>>::CollisionObjectHandle
) -> Option<&<DefaultColliderSet<N, Handle> as CollisionObjectSet<N>>::CollisionObject>
fn collision_object( &self, handle: <DefaultColliderSet<N, Handle> as CollisionObjectSet<N>>::CollisionObjectHandle ) -> Option<&<DefaultColliderSet<N, Handle> as CollisionObjectSet<N>>::CollisionObject>
Gets the collision object identified by the given
handle
.source§fn foreach(
&self,
f: impl FnMut(<DefaultColliderSet<N, Handle> as CollisionObjectSet<N>>::CollisionObjectHandle, &<DefaultColliderSet<N, Handle> as CollisionObjectSet<N>>::CollisionObject)
)
fn foreach( &self, f: impl FnMut(<DefaultColliderSet<N, Handle> as CollisionObjectSet<N>>::CollisionObjectHandle, &<DefaultColliderSet<N, Handle> as CollisionObjectSet<N>>::CollisionObject) )
Applies a closure to every collision object (and their handle) stored into this set.
Auto Trait Implementations§
impl<N, Handle = Index> !RefUnwindSafe for DefaultColliderSet<N, Handle>
impl<N, Handle> Send for DefaultColliderSet<N, Handle>
impl<N, Handle> Sync for DefaultColliderSet<N, Handle>
impl<N, Handle> Unpin for DefaultColliderSet<N, Handle>where Handle: Unpin, N: Unpin,
impl<N, Handle = Index> !UnwindSafe for DefaultColliderSet<N, Handle>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
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
.§fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.