Skip to main content

SoftBody

embedded_3dgfx::softbody

Struct SoftBody

pub struct SoftBody<const P: usize, const S: usize> {
    pub particles: Vec<Particle, P>,
    pub springs: Vec<Spring, S>,
    pub gravity: Vector3<f32>,
    pub damping: f32,
    pub pressure_config: PressureConfig,
    pub ground_plane: Option<f32>,
    pub ground_restitution: f32,
    pub ground_friction: f32,
}

Expand description

A soft body made of particles connected by springs.

Generic parameters:

P - Maximum number of particles
S - Maximum number of springs

Fields§

§particles: Vec<Particle, P>

Particles in the soft body

§springs: Vec<Spring, S>

Spring constraints between particles

§gravity: Vector3<f32>

Gravity acceleration applied to all particles

§damping: f32

Global damping factor (0.0 = no damping, 1.0 = full damping)

§pressure_config: PressureConfig

Pressure/volume preservation configuration

§ground_plane: Option<f32>

Ground plane height (particles bounce off this)

§ground_restitution: f32

Ground restitution (bounciness of ground collisions)

§ground_friction: f32

Ground friction coefficient

Implementations§

impl<const P: usize, const S: usize> SoftBody<P, S>

pub fn new() -> Self

Create a new empty soft body.

pub fn add_particle(&mut self, particle: Particle) -> Result<usize, ()>

Add a particle to the soft body.

pub fn add_spring( &mut self, particle_a: usize, particle_b: usize, rest_length: f32, stiffness: f32, damping: f32, ) -> Result<(), ()>

Add a spring constraint between two particles.

pub fn get_particle(&self, index: usize) -> Option<&Particle>

Get a particle by index.

pub fn get_particle_mut(&mut self, index: usize) -> Option<&mut Particle>

Get a mutable reference to a particle by index.

pub fn set_gravity(&mut self, gravity: Vector3<f32>)

Set the gravity vector for all particles.

pub fn step(&mut self, dt: f32)

Advance the soft body simulation by one timestep.

Uses semi-implicit Euler integration with spring forces.

pub fn get_vertex_positions(&self, output: &mut [[f32; 3]]) -> usize

Get vertex positions for rendering.

Converts particle positions to vertex array format.

pub fn clear_forces(&mut self)

Reset all forces on particles.

pub fn apply_global_force(&mut self, force: Vector3<f32>)

Apply an external force to all particles.

impl<const P: usize, const S: usize> SoftBody<P, S>

Helper functions for creating common soft body shapes.

pub fn create_cloth( width: usize, height: usize, spacing: f32, stiffness: f32, damping: f32, ) -> Result<Self, ()>

Create a cloth grid suspended from the top edge.

§Arguments

width - Number of particles along X axis
height - Number of particles along Y axis
spacing - Distance between particles
stiffness - Spring stiffness
damping - Spring damping

Returns the soft body with structural and shear springs, or an error if capacity exceeded.

pub fn create_jelly_cube( size: usize, spacing: f32, stiffness: f32, damping: f32, ) -> Result<Self, ()>

Create a soft cube/jelly block.

§Arguments

size - Number of particles along each axis
spacing - Distance between particles
stiffness - Spring stiffness
damping - Spring damping

pub fn create_soft_sphere( radius: f32, _subdivisions: usize, stiffness: f32, damping: f32, ) -> Result<Self, ()>

Create a soft sphere/ball.

Creates a geodesic sphere approximation with springs.

Trait Implementations§

impl<const P: usize, const S: usize> Clone for SoftBody<P, S>

fn clone(&self) -> SoftBody<P, S>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<const P: usize, const S: usize> Debug for SoftBody<P, S>

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

Formats the value using the given formatter. Read more

impl<const P: usize, const S: usize> Default for SoftBody<P, S>

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl<const P: usize, const S: usize> Freeze for SoftBody<P, S>

impl<const P: usize, const S: usize> RefUnwindSafe for SoftBody<P, S>

impl<const P: usize, const S: usize> Send for SoftBody<P, S>

impl<const P: usize, const S: usize> Sync for SoftBody<P, S>

impl<const P: usize, const S: usize> Unpin for SoftBody<P, S>

impl<const P: usize, const S: usize> UnsafeUnpin for SoftBody<P, S>

impl<const P: usize, const S: usize> UnwindSafe for SoftBody<P, S>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> UnwrappedAs for T

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

impl<T> WrappingAs for T

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.