SpringParams

class SpringParams(**kwargs)

Constructors:

new(damping_ratio:float, mass:float, stiffness:float) -> Adw.SpringParams
new_full(damping:float, mass:float, stiffness:float) -> Adw.SpringParams

Constructors

class SpringParams

classmethod new(damping_ratio: float, mass: float, stiffness: float) → SpringParams

Creates a new AdwSpringParams 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.

new_full allows to pass a raw damping value instead.

Parameters:

• damping_ratio – the damping ratio of the spring

• mass – the mass of the spring

• stiffness – the stiffness of the spring

classmethod new_full(damping: float, mass: float, stiffness: float) → SpringParams

Creates a new AdwSpringParams from mass, stiffness and damping.

See new for a simplified constructor using damping ratio instead of damping.

Parameters:

• damping – the damping of the spring

• mass – the mass of the spring

• stiffness – the stiffness of the spring

Methods

class SpringParams

get_damping() → float

Gets the damping of self.

get_damping_ratio() → float

Gets the damping ratio of self.

get_mass() → float

Gets the mass of self.

get_stiffness() → float

Gets the stiffness of self.