Struct libbismuth::SpringParams

pub struct SpringParams { /* private fields */ }

Physical parameters of a spring for SpringAnimation.

Any spring can be described by three parameters: mass, stiffness and damping.

An undamped spring will produce an oscillatory motion which will go on forever.

The frequency and amplitude of the oscillations will be determined by the stiffness (how “strong” the spring is) and its mass (how much “inertia” it has).

If damping is larger than 0, the amplitude of that oscillating motion will exponientally decrease over time. If that damping is strong enough that the spring can’t complete a full oscillation, it’s called an overdamped spring.

If we the spring can oscillate, it’s called an underdamped spring.

The value between these two behaviors is called critical damping; a critically damped spring will comes to rest in the minimum possible time without producing oscillations.

The damping can be replaced by damping ratio, which produces the following springs:

• 0: an undamped spring.
• Between 0 and 1: an underdamped spring.
• 1: a critically damped spring.
• Larger than 1: an overdamped spring.

As such

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl SpringParams

pub fn as_ptr(&self) -> *mut BisSpringParams

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut BisSpringParams) -> &Self

Borrows the underlying C value.

impl SpringParams

pub fn new(damping_ratio: f64, mass: f64, stiffness: f64) -> SpringParams

Creates a new BisSpringParams from @mass, @stiffness and @damping_ratio.

The damping value is calculated from @damping_ratio and the other two parameters.

• If @damping_ratio is 0, the spring will not be damped and will oscillate endlessly.
• If @damping_ratio is between 0 and 1, the spring is underdamped and will always overshoot.
• If @damping_ratio is 1, the spring is critically damped and will reach its resting position the quickest way possible.
• If @damping_ratio is larger than 1, the spring is overdamped and will reach its resting position faster than it can complete an oscillation.

SpringParams::new_full() allows to pass a raw damping value instead.

damping_ratio

the damping ratio of the spring

mass

the mass of the spring

stiffness

the stiffness of the spring

Returns

the newly created spring parameters

pub fn new_full(damping: f64, mass: f64, stiffness: f64) -> SpringParams

Creates a new BisSpringParams from @mass, @stiffness and @damping.

See SpringParams::new() for a simplified constructor using damping ratio instead of @damping.

damping

the damping of the spring

mass

the mass of the spring

stiffness

the stiffness of the spring

Returns

the newly created spring parameters

pub fn damping(&self) -> f64

Gets the damping of @self.

Returns

the damping

pub fn damping_ratio(&self) -> f64

Gets the damping ratio of @self.

Returns

the damping ratio

pub fn mass(&self) -> f64

Gets the mass of @self.

Returns

the mass

pub fn stiffness(&self) -> f64

Gets the stiffness of @self.

Returns

the stiffness

Trait Implementations

impl Clone for SpringParams

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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

Performs copy-assignment from source.

impl Debug for SpringParams

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

Formats the value using the given formatter.

impl From<SpringParams> for Value

fn from(s: SpringParams) -> Self

Converts to this type from the input type.

impl HasParamSpec for SpringParams

type ParamSpec = ParamSpecBoxed

type SetValue = SpringParams

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, SpringParams>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SpringParams

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SpringParams

fn cmp(&self, other: &SpringParams) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SpringParams

fn eq(&self, other: &SpringParams) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SpringParams

fn partial_cmp(&self, other: &SpringParams) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SpringParams

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SpringParams

impl StructuralPartialEq for SpringParams