Struct SoftBody 

pub struct SoftBody {
    pub builder: SoftBodyBuilder,
}

Describes a soft body to create.

The particle positions of Self::builder are expressed in the local frame of the entity (see the module documentation for the conventions). Changes made to this component after the soft body was created are ignored.

The collider-related components of the entity (crate::geometry::Friction, crate::geometry::Restitution, crate::geometry::CollisionGroups, crate::geometry::SolverGroups, crate::geometry::ActiveEvents, crate::geometry::ActiveHooks, crate::geometry::ActiveCollisionTypes, crate::geometry::ContactForceEventThreshold, crate::geometry::ContactSkin and crate::geometry::Sensor) configure the soft body’s surface colliders (see RapierRigidBodySet::soft_body_colliders), like for a Collider: they override the builder’s collider template, their changes are applied, and removing them restores the template’s values (the particle radius for the contact skin). The user_data of the builder and of its collider template are overwritten with the entity bits.

Fields

builder: SoftBodyBuilder

The Rapier builder of the soft body, in the local frame of the entity.

Implementations

impl SoftBody

pub fn new(builder: SoftBodyBuilder) -> Self

A soft body created from the given Rapier builder (positions in the entity’s local frame).

pub fn map(self, f: impl FnOnce(SoftBodyBuilder) -> SoftBodyBuilder) -> Self

Applies f to the builder of this soft body.

This is useful to chain the builder’s methods, e.g. SoftBody::rope(a, b, 20).map(|b| b.particle_mass(0.1).pinned_particles([0])).

pub fn rope(start: Vect, end: Vect, num_particles: usize) -> Self

A rope of num_particles particles from start to end (see SoftBodyBuilder::rope).

pub fn trimesh(vertices: Vec<Vect>, indices: Vec<[u32; 3]>) -> Option<Self>

A triangle-mesh soft body without volumetric cells (see SoftBodyBuilder::trimesh).

Returns None if the mesh is empty.

pub fn volumetric( vertices: &[Vect], indices: &[[u32; 2]], cell_size: Real, ) -> Option<Self>

A volumetric soft body filling a closed, outward-oriented mesh (triangles in 3D, segments in 2D) with cells of size cell_size (see SoftBodyBuilder::volumetric).

Returns None if the mesh is empty, open, or encloses nothing at that cell size.

pub fn volumetric_skinned( vertices: &[Vect], indices: &[[u32; 2]], cell_size: Real, ) -> Option<Self>

Same as Self::volumetric, keeping the given polyline as the soft body’s skin (see SoftBodyBuilder::volumetric_skinned).

pub fn polygon(points: Vec<Vect>) -> Self

A closed polygon with counter-clockwise points, with area preservation (see SoftBodyBuilder::polygon).

pub fn disk(radius: Real, num_particles: usize) -> Self

A regular polygon centered at the entity’s origin with num_particles boundary particles (see SoftBodyBuilder::disk).

pub fn grid(half_extents: Vect, nx: usize, ny: usize) -> Self

A solid rectangle centered at the entity’s origin, triangulated on a nx × ny particle grid (see SoftBodyBuilder::grid).

pub fn polyline( vertices: Vec<Vect>, indices: Option<Vec<[u32; 2]>>, ) -> Option<Self>

A soft body from a polyline (see SoftBodyBuilder::polyline).

Returns None if the polyline is empty.

Trait Implementations

impl Clone for SoftBody

fn clone(&self) -> SoftBody

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for SoftBody

where Self: Send + Sync + 'static,

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

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 Debug for SoftBody

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<SoftBodyBuilder> for SoftBody

fn from(builder: SoftBodyBuilder) -> Self

Converts to this type from the input type.