Google is committed to advancing racial equity for Black communities. See how.

RippleEffectFactory

interface RippleEffectFactory
androidx.ui.material.ripple.RippleEffectFactory

An encapsulation of an RippleEffect constructor used by ripple and RippleTheme.

Will be used as a theme parameter in RippleTheme.factory

Summary

Public methods

abstract RippleEffect
create(size: PxSize, startPosition: PxPosition, density: Density, radius: Dp?, clipped: Boolean, clock: AnimationClockObservable, onAnimationFinished: (RippleEffect) -> Unit)

The factory method.

Public methods

create

abstract fun create(
    size: PxSize,
    startPosition: PxPosition,
    density: Density,
    radius: Dp?,
    clipped: Boolean,
    clock: AnimationClockObservable,
    onAnimationFinished: (RippleEffect) -> Unit
): RippleEffect

The factory method.

Subclasses should override this method to return a new instance of an RippleEffect.

Parameters
size: PxSize The size of the target layout.
startPosition: PxPosition The position the animation will start from.
density: Density The Density object to convert the dimensions.
radius: Dp? Effects grow up to this size.
clipped: Boolean If true the effect should be clipped by the target layout bounds.
clock: AnimationClockObservable The animation clock observable that will drive this ripple effect
onAnimationFinished: (RippleEffect) -> Unit Call when the effect animation has been finished.