mosaic-animation/org.unitedsoftware.mosaic.animation/SpringSpec

SpringSpec

@Immutable

class SpringSpec<T>(val dampingRatio: Float = Spring.DampingRatioNoBouncy, val stiffness: Float = Spring.StiffnessMedium, val visibilityThreshold: T? = null) : FiniteAnimationSpec<T>

Creates a SpringSpec that uses the given spring constants (i.e. dampingRatio and stiffness. The optional visibilityThreshold defines when the animation should be considered to be visually close enough to round off to its target.

Parameters

dampingRatio

damping ratio of the spring. org.unitedsoftware.mosaic.animation.Spring.DampingRatioNoBouncy by default.

stiffness

stiffness of the spring. org.unitedsoftware.mosaic.animation.Spring.StiffnessMedium by default.

visibilityThreshold

specifies the visibility threshold

Constructors

constructor(dampingRatio: Float = Spring.DampingRatioNoBouncy, stiffness: Float = Spring.StiffnessMedium, visibilityThreshold: T? = null)

Properties

val dampingRatio: Float

val stiffness: Float

visibilityThreshold

val visibilityThreshold: T?

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun <V : AnimationVector> vectorize(converter: TwoWayConverter<T, V>): VectorizedSpringSpec<V>

Creates a org.unitedsoftware.mosaic.animation.VectorizedAnimationSpec with the given org.unitedsoftware.mosaic.animation.TwoWayConverter.