Struct rapier3d::dynamics::RigidBodySet
source · [−]pub struct RigidBodySet { /* private fields */ }
Expand description
A set of rigid bodies that can be handled by a physics pipeline.
Implementations
sourceimpl RigidBodySet
impl RigidBodySet
sourcepub fn contains(&self, handle: RigidBodyHandle) -> bool
pub fn contains(&self, handle: RigidBodyHandle) -> bool
Is the given body handle valid?
sourcepub fn insert(&mut self, rb: impl Into<RigidBody>) -> RigidBodyHandle
pub fn insert(&mut self, rb: impl Into<RigidBody>) -> RigidBodyHandle
Insert a rigid body into this set and retrieve its handle.
sourcepub fn remove(
&mut self,
handle: RigidBodyHandle,
islands: &mut IslandManager,
colliders: &mut ColliderSet,
impulse_joints: &mut ImpulseJointSet,
multibody_joints: &mut MultibodyJointSet,
remove_attached_colliders: bool
) -> Option<RigidBody>
pub fn remove(
&mut self,
handle: RigidBodyHandle,
islands: &mut IslandManager,
colliders: &mut ColliderSet,
impulse_joints: &mut ImpulseJointSet,
multibody_joints: &mut MultibodyJointSet,
remove_attached_colliders: bool
) -> Option<RigidBody>
Removes a rigid-body, and all its attached colliders and impulse_joints, from these sets.
sourcepub fn get_unknown_gen(&self, i: u32) -> Option<(&RigidBody, RigidBodyHandle)>
pub fn get_unknown_gen(&self, i: u32) -> Option<(&RigidBody, RigidBodyHandle)>
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.
sourcepub fn get_unknown_gen_mut(
&mut self,
i: u32
) -> Option<(&mut RigidBody, RigidBodyHandle)>
pub fn get_unknown_gen_mut(
&mut self,
i: u32
) -> Option<(&mut RigidBody, RigidBodyHandle)>
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.
sourcepub fn get(&self, handle: RigidBodyHandle) -> Option<&RigidBody>
pub fn get(&self, handle: RigidBodyHandle) -> Option<&RigidBody>
Gets the rigid-body with the given handle.
sourcepub fn get_mut(&mut self, handle: RigidBodyHandle) -> Option<&mut RigidBody>
pub fn get_mut(&mut self, handle: RigidBodyHandle) -> Option<&mut RigidBody>
Gets a mutable reference to the rigid-body with the given handle.
sourcepub fn iter(&self) -> impl Iterator<Item = (RigidBodyHandle, &RigidBody)>
pub fn iter(&self) -> impl Iterator<Item = (RigidBodyHandle, &RigidBody)>
Iterates through all the rigid-bodies on this set.
sourcepub fn iter_mut(
&mut self
) -> impl Iterator<Item = (RigidBodyHandle, &mut RigidBody)>
pub fn iter_mut(
&mut self
) -> impl Iterator<Item = (RigidBodyHandle, &mut RigidBody)>
Iterates mutably through all the rigid-bodies on this set.
sourcepub fn propagate_modified_body_positions_to_colliders(
&self,
colliders: &mut ColliderSet
)
pub fn propagate_modified_body_positions_to_colliders(
&self,
colliders: &mut ColliderSet
)
Update colliders positions after rigid-bodies moved.
When a rigid-body moves, the positions of the colliders attached to it need to be updated.
This update is generally automatically done at the beggining and the end of each simulation
step with PhysicsPipeline::step
. If the positions need to be updated without running a
simulation step (for example when using the QueryPipeline
alone), this method can be called
manually.
Trait Implementations
sourceimpl Clone for RigidBodySet
impl Clone for RigidBodySet
sourcefn clone(&self) -> RigidBodySet
fn clone(&self) -> RigidBodySet
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 RigidBodySet
impl Default for RigidBodySet
sourcefn default() -> RigidBodySet
fn default() -> RigidBodySet
Returns the “default value” for a type. Read more
sourceimpl Index<Index> for RigidBodySet
impl Index<Index> for RigidBodySet
sourceimpl Index<RigidBodyHandle> for RigidBodySet
impl Index<RigidBodyHandle> for RigidBodySet
sourceimpl IndexMut<RigidBodyHandle> for RigidBodySet
impl IndexMut<RigidBodyHandle> for RigidBodySet
sourcefn index_mut(&mut self, handle: RigidBodyHandle) -> &mut RigidBody
fn index_mut(&mut self, handle: RigidBodyHandle) -> &mut RigidBody
Performs the mutable indexing (container[index]
) operation. Read more
Auto Trait Implementations
impl RefUnwindSafe for RigidBodySet
impl Send for RigidBodySet
impl Sync for RigidBodySet
impl Unpin for RigidBodySet
impl UnwindSafe for RigidBodySet
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