Struct rapier2d::geometry::ColliderSet
source · [−]pub struct ColliderSet { /* private fields */ }
Expand description
A set of colliders that can be handled by a physics World
.
Implementations
sourceimpl ColliderSet
impl ColliderSet
sourcepub fn invalid_handle() -> ColliderHandle
pub fn invalid_handle() -> ColliderHandle
An always-invalid collider handle.
sourcepub fn iter(&self) -> impl ExactSizeIterator<Item = (ColliderHandle, &Collider)>
pub fn iter(&self) -> impl ExactSizeIterator<Item = (ColliderHandle, &Collider)>
Iterate through all the colliders on this set.
sourcepub fn iter_mut(
&mut self
) -> impl Iterator<Item = (ColliderHandle, &mut Collider)>
pub fn iter_mut(
&mut self
) -> impl Iterator<Item = (ColliderHandle, &mut Collider)>
Iterates mutably through all the colliders on this set.
sourcepub fn contains(&self, handle: ColliderHandle) -> bool
pub fn contains(&self, handle: ColliderHandle) -> bool
Is this collider handle valid?
sourcepub fn insert(&mut self, coll: impl Into<Collider>) -> ColliderHandle
pub fn insert(&mut self, coll: impl Into<Collider>) -> ColliderHandle
Inserts a new collider to this set and retrieve its handle.
sourcepub fn insert_with_parent(
&mut self,
coll: impl Into<Collider>,
parent_handle: RigidBodyHandle,
bodies: &mut RigidBodySet
) -> ColliderHandle
pub fn insert_with_parent(
&mut self,
coll: impl Into<Collider>,
parent_handle: RigidBodyHandle,
bodies: &mut RigidBodySet
) -> ColliderHandle
Inserts a new collider to this set, attach it to the given rigid-body, and retrieve its handle.
sourcepub fn set_parent(
&mut self,
handle: ColliderHandle,
new_parent_handle: Option<RigidBodyHandle>,
bodies: &mut RigidBodySet
)
pub fn set_parent(
&mut self,
handle: ColliderHandle,
new_parent_handle: Option<RigidBodyHandle>,
bodies: &mut RigidBodySet
)
Sets the parent of the given collider.
sourcepub fn remove(
&mut self,
handle: ColliderHandle,
islands: &mut IslandManager,
bodies: &mut RigidBodySet,
wake_up: bool
) -> Option<Collider>
pub fn remove(
&mut self,
handle: ColliderHandle,
islands: &mut IslandManager,
bodies: &mut RigidBodySet,
wake_up: bool
) -> Option<Collider>
Remove a collider from this set and update its parent accordingly.
If wake_up
is true
, the rigid-body the removed collider is attached to
will be woken up.
sourcepub fn get_unknown_gen(&self, i: u32) -> Option<(&Collider, ColliderHandle)>
pub fn get_unknown_gen(&self, i: u32) -> Option<(&Collider, ColliderHandle)>
Gets the collider with the given handle without a known generation.
This is useful when you know you want the collider 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 collider 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.
sourcepub fn get_unknown_gen_mut(
&mut self,
i: u32
) -> Option<(&mut Collider, ColliderHandle)>
pub fn get_unknown_gen_mut(
&mut self,
i: u32
) -> Option<(&mut Collider, ColliderHandle)>
Gets a mutable reference to the collider with the given handle without a known generation.
This is useful when you know you want the collider 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 collider 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.
sourcepub fn get(&self, handle: ColliderHandle) -> Option<&Collider>
pub fn get(&self, handle: ColliderHandle) -> Option<&Collider>
Get the collider with the given handle.
sourcepub fn get_mut(&mut self, handle: ColliderHandle) -> Option<&mut Collider>
pub fn get_mut(&mut self, handle: ColliderHandle) -> Option<&mut Collider>
Gets a mutable reference to the collider with the given handle.
Trait Implementations
sourceimpl Clone for ColliderSet
impl Clone for ColliderSet
sourcefn clone(&self) -> ColliderSet
fn clone(&self) -> ColliderSet
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Default for ColliderSet
impl Default for ColliderSet
sourcefn default() -> ColliderSet
fn default() -> ColliderSet
Returns the “default value” for a type. Read more
sourceimpl Index<ColliderHandle> for ColliderSet
impl Index<ColliderHandle> for ColliderSet
sourceimpl Index<Index> for ColliderSet
impl Index<Index> for ColliderSet
sourceimpl IndexMut<ColliderHandle> for ColliderSet
impl IndexMut<ColliderHandle> for ColliderSet
sourcefn index_mut(&mut self, handle: ColliderHandle) -> &mut Collider
fn index_mut(&mut self, handle: ColliderHandle) -> &mut Collider
Performs the mutable indexing (container[index]
) operation. Read more
Auto Trait Implementations
impl !RefUnwindSafe for ColliderSet
impl Send for ColliderSet
impl Sync for ColliderSet
impl Unpin for ColliderSet
impl !UnwindSafe for ColliderSet
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, 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
. Read more
sourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
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
sourcefn 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. Read more
sourcefn 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. Read more
sourceimpl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
sourcefn 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
sourcefn 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).
sourcefn 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.
sourcefn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more