Struct oxygengine_physics_2d::prelude::joint::DefaultJointConstraintSet

pub struct DefaultJointConstraintSet<N, Handle = Index>where
    N: RealField + Copy,
    Handle: BodyHandle,{ /* private fields */ }

A set containing all the joint-constraints added to the world.

It is based on an arena using generational indices to avoid the ABA problem.

Implementations

impl<N, Handle> DefaultJointConstraintSet<N, Handle>where N: RealField + Copy, Handle: BodyHandle,

pub fn new() -> DefaultJointConstraintSet<N, Handle>

Creates an empty set.

pub fn insert(&mut self, constraint: impl JointConstraint<N, Handle>) -> Index

Adds a joint to this set.

pub fn insert_boxed( &mut self, constraint: Box<dyn JointConstraint<N, Handle>, Global> ) -> Index

Adds a joint (represented as a boxed trait-object) to this set.

pub fn remove( &mut self, to_remove: Index ) -> Option<Box<dyn JointConstraint<N, Handle>, Global>>

Removes a joint from this set.

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

Check if this set contains a joint identified by handle.

pub fn get( &self, handle: Index ) -> Option<&(dyn JointConstraint<N, Handle> + 'static)>

Gets a reference to the joint identified by handle.

pub fn get_mut( &mut self, handle: Index ) -> Option<&mut (dyn JointConstraint<N, Handle> + 'static)>

Gets a mutable reference to the joint identified by handle.

pub fn iter( &self ) -> impl Iterator<Item = (Index, &(dyn JointConstraint<N, Handle> + 'static))>

Iter through all the joints and their handles.

pub fn iter_mut( &mut self ) -> impl Iterator<Item = (Index, &mut (dyn JointConstraint<N, Handle> + 'static))>

Mutably iter through all the joints and their handles.

Trait Implementations

impl<N, Handle> JointConstraintSet<N, Handle> for DefaultJointConstraintSet<N, Handle>where N: RealField + Copy, Handle: BodyHandle,

type JointConstraint = dyn JointConstraint<N, Handle>

Type of a constraint-based joints stored in this set.

type Handle = Index

Type of a joint handle identifying a joint in this set.

fn get( &self, handle: <DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::Handle ) -> Option<&<DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::JointConstraint>

Gets a reference to the joint identified by handle.

fn get_mut( &mut self, handle: <DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::Handle ) -> Option<&mut <DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::JointConstraint>

Gets a mutable reference to the joint identified by handle.

fn contains( &self, handle: <DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::Handle ) -> bool

Check if this set contains a joint identified by handle.

fn foreach( &self, f: impl FnMut(<DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::Handle, &<DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::JointConstraint) )

Iterate through all the bodies on this set, applying the closure f on them.

fn foreach_mut( &mut self, f: impl FnMut(<DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::Handle, &mut <DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::JointConstraint) )

Mutable iterates through all the bodies on this set, applying the closure f on them.

fn pop_insertion_event( &mut self ) -> Option<(<DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::Handle, BodyPartHandle<Handle>, BodyPartHandle<Handle>)>

Gets the handle of one joint that has been inserted.

fn pop_removal_event( &mut self ) -> Option<(<DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::Handle, BodyPartHandle<Handle>, BodyPartHandle<Handle>)>

Gets the handle of one joint that has been removed.

fn remove( &mut self, to_remove: <DefaultJointConstraintSet<N, Handle> as JointConstraintSet<N, Handle>>::Handle )

Remove a joint from this set.