Skip to main content

SpringTimeStep

Struct SpringTimeStep 

Source
pub struct SpringTimeStep<F> { /* private fields */ }
Expand description

Cached coefficients for a spring, based on its configuration and a particular time step.

Used to efficiently update one or more springs that share the same configuration.

§Usage

To derive a SpringTimeStep, you must first get a SpringParams from a SpringConfig:

// configure your spring...
let config = SpringConfig::new(5.0, 0.75);
let mut spring = Spring::new();

// derive its state
let state = SpringParams::from(config);

// then, either create your own `SpringTimeStep`...
let time_step = SpringTimeStep::new(state, delta_time);
spring.update(time_step);

// or let `Spring::update_single` do it for you
spring.update_single(state, delta_time);

Implementations§

Source§

impl<F: Float> SpringTimeStep<F>

Source

pub fn new(state: impl Into<SpringParams<F>>, delta: F) -> Self

Derive a spring time step from a particular delta time.

Source

pub fn update_many(self, springs: &mut [&mut Spring<F>])

Update multiple springs using this time step. Simply calls Spring::update on each passed spring.

Trait Implementations§

Source§

impl<F: Clone> Clone for SpringTimeStep<F>

Source§

fn clone(&self) -> SpringTimeStep<F>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F: Debug> Debug for SpringTimeStep<F>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<F: Float> Default for SpringTimeStep<F>

Source§

fn default() -> Self

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

impl<F: PartialEq> PartialEq for SpringTimeStep<F>

Source§

fn eq(&self, other: &SpringTimeStep<F>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<F: Copy> Copy for SpringTimeStep<F>

Source§

impl<F> StructuralPartialEq for SpringTimeStep<F>

Auto Trait Implementations§

§

impl<F> Freeze for SpringTimeStep<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for SpringTimeStep<F>
where F: RefUnwindSafe,

§

impl<F> Send for SpringTimeStep<F>
where F: Send,

§

impl<F> Sync for SpringTimeStep<F>
where F: Sync,

§

impl<F> Unpin for SpringTimeStep<F>
where F: Unpin,

§

impl<F> UnwindSafe for SpringTimeStep<F>
where F: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.