Struct SolverBodies 

pub struct SolverBodies { /* private fields */ }

A resource storing solver bodies and their inertial properties contiguously for awake, active rigid bodies.

Each entity with a solver body stores an index into this resource in a SolverBodyIndex component.

Implementations

impl SolverBodies

pub const fn new() -> Self

Creates a new empty collection of solver bodies.

pub fn len(&self) -> usize

Returns the number of solver bodies.

pub fn is_empty(&self) -> bool

Returns true if there are no solver bodies.

pub fn entities(&self) -> &[Entity]

Returns a slice of the entities that have solver bodies.

pub fn bodies(&self) -> &[SolverBody]

Returns a slice of the solver bodies.

pub fn bodies_mut(&mut self) -> &mut [SolverBody]

Returns a mutable slice of the solver bodies.

pub fn inertias(&self) -> &[SolverBodyInertia]

Returns a slice of the solver body inertias.

pub fn inertias_mut(&mut self) -> &mut [SolverBodyInertia]

Returns a mutable slice of the solver body inertias.

pub fn contains_index(&self, index: SolverBodyIndex) -> bool

Returns true if the given SolverBodyIndex refers to a body in this collection.

pub fn contains_entity(&self, entity: Entity) -> bool

Returns true if the given entity has a solver body in this collection.

pub fn get_entity(&self, index: SolverBodyIndex) -> Option<Entity>

Returns the Entity associated with the given solver body index, if any.

pub fn get(&self, index: SolverBodyIndex) -> Option<&SolverBody>

Returns a reference to the SolverBody with the given index, if it exists.

pub fn get_mut(&mut self, index: SolverBodyIndex) -> Option<&mut SolverBody>

Returns a mutable reference to the SolverBody with the given index, if it exists.

pub fn get_inertia(&self, index: SolverBodyIndex) -> Option<&SolverBodyInertia>

Returns a reference to the SolverBodyInertia with the given index, if it exists.

pub fn get_inertia_mut( &mut self, index: SolverBodyIndex, ) -> Option<&mut SolverBodyInertia>

Returns a mutable reference to the SolverBodyInertia with the given index, if it exists.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut SolverBody>

Returns an iterator over mutable references to the solver bodies.

pub fn push( &mut self, entity: Entity, body: SolverBody, inertia: SolverBodyInertia, ) -> SolverBodyIndex

Adds a new solver body for the given entity, returning its SolverBodyIndex.

pub fn swap_remove(&mut self, index: SolverBodyIndex) -> Option<Entity>

Removes the solver body with the given index, swapping in the last body to fill the gap.

Returns the entity whose body was moved into index, so that its SolverBodyIndex component can be updated. Returns None if the removed body was the last one.

Panics

Panics if the index is out of bounds.

pub fn clear(&mut self)

Clears all solver bodies.

pub fn access(&mut self) -> SolverBodiesAccess<'_>

Returns a SolverBodiesAccess that allows obtaining mutable references to solver bodies from parallel closures via raw pointers.

This allows the solver to hand out mutable references to disjoint bodies concurrently, which is sound as long as the caller ensures that no two closures access the same body at the same time. This is guaranteed by constraint graph coloring.

Trait Implementations

impl Component for SolverBodies

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = ::bevy::ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Default for SolverBodies

fn default() -> SolverBodies

Returns the “default value” for a type.

impl Resource for SolverBodies

where Self: Send + Sync + 'static,