Struct heron::rapier_plugin::rapier2d::prelude::JointSet [−]
pub struct JointSet { /* fields omitted */ }
Expand description
A set of joints that can be handled by a physics World
.
Implementations
impl JointSet
impl JointSet
pub fn joint_graph(&self) -> &InteractionGraph<RigidBodyHandle, Joint>
pub fn joint_graph(&self) -> &InteractionGraph<RigidBodyHandle, Joint>
Retrieve the joint graph where edges are joints and nodes are rigid body handles.
pub fn joints_with(
&'a self,
body: RigidBodyHandle
) -> impl Iterator<Item = (RigidBodyHandle, RigidBodyHandle, &'a Joint)>
pub fn joints_with(
&'a self,
body: RigidBodyHandle
) -> impl Iterator<Item = (RigidBodyHandle, RigidBodyHandle, &'a Joint)>
Iterates through all the joitns attached to the given rigid-body.
pub fn contains(&self, handle: JointHandle) -> bool
pub fn contains(&self, handle: JointHandle) -> bool
Is the given joint handle valid?
pub fn get(&self, handle: JointHandle) -> Option<&Joint>
pub fn get(&self, handle: JointHandle) -> Option<&Joint>
Gets the joint with the given handle.
pub fn get_mut(&mut self, handle: JointHandle) -> Option<&mut Joint>
pub fn get_mut(&mut self, handle: JointHandle) -> Option<&mut Joint>
Gets a mutable reference to the joint with the given handle.
pub fn get_unknown_gen(&self, i: u32) -> Option<(&Joint, JointHandle)>
pub fn get_unknown_gen(&self, i: u32) -> Option<(&Joint, JointHandle)>
Gets the joint with the given handle without a known generation.
This is useful when you know you want the joint 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 joint 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.
pub fn get_unknown_gen_mut(
&mut self,
i: u32
) -> Option<(&mut Joint, JointHandle)>
pub fn get_unknown_gen_mut(
&mut self,
i: u32
) -> Option<(&mut Joint, JointHandle)>
Gets a mutable reference to the joint with the given handle without a known generation.
This is useful when you know you want the joint 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 joint 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.
Iterates through all the joint on this set.
Iterates mutably through all the joint on this set.
pub fn insert<J>(
&mut self,
body1: RigidBodyHandle,
body2: RigidBodyHandle,
joint_params: J
) -> JointHandle where
J: Into<JointParams>,
pub fn insert<J>(
&mut self,
body1: RigidBodyHandle,
body2: RigidBodyHandle,
joint_params: J
) -> JointHandle where
J: Into<JointParams>,
Inserts a new joint into this set and retrieve its handle.
pub fn remove<Bodies>(
&mut self,
handle: JointHandle,
islands: &mut IslandManager,
bodies: &mut Bodies,
wake_up: bool
) -> Option<Joint> where
Bodies: ComponentSetMut<RigidBodyActivation> + ComponentSet<RigidBodyType> + ComponentSetMut<RigidBodyIds>,
pub fn remove<Bodies>(
&mut self,
handle: JointHandle,
islands: &mut IslandManager,
bodies: &mut Bodies,
wake_up: bool
) -> Option<Joint> where
Bodies: ComponentSetMut<RigidBodyActivation> + ComponentSet<RigidBodyType> + ComponentSetMut<RigidBodyIds>,
Removes a joint from this set.
If wake_up
is set to true
, then the bodies attached to this joint will be
automatically woken up.
pub fn remove_joints_attached_to_rigid_body<Bodies>(
&mut self,
handle: RigidBodyHandle,
islands: &mut IslandManager,
bodies: &mut Bodies
) -> Vec<JointHandle, Global> where
Bodies: ComponentSetMut<RigidBodyActivation> + ComponentSet<RigidBodyType> + ComponentSetMut<RigidBodyIds>,
pub fn remove_joints_attached_to_rigid_body<Bodies>(
&mut self,
handle: RigidBodyHandle,
islands: &mut IslandManager,
bodies: &mut Bodies
) -> Vec<JointHandle, Global> where
Bodies: ComponentSetMut<RigidBodyActivation> + ComponentSet<RigidBodyType> + ComponentSetMut<RigidBodyIds>,
Deletes all the joints attached to the given rigid-body.
The provided rigid-body handle is not required to identify a rigid-body that
is still contained by the bodies
component set.
Returns the (now invalid) handles of the removed joints.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for JointSet
impl UnwindSafe for JointSet
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
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
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub 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
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub 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
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more