SidePropagation

open class SidePropagation : VisibilityPropagation
kotlin.Any
   ↳ androidx.transition.TransitionPropagation
   ↳ androidx.transition.VisibilityPropagation
   ↳ androidx.transition.SidePropagation

A TransitionPropagation that propagates based on the distance to the side and, orthogonally, the distance to epicenter. If the transitioning View is visible in the start of the transition, then it will transition sooner when closer to the side and later when farther. If the view is not visible in the start of the transition, then it will transition later when closer to the side and sooner when farther from the edge. This is the default TransitionPropagation used with android.transition.Slide.

Summary

Public constructors

A TransitionPropagation that propagates based on the distance to the side and, orthogonally, the distance to epicenter.

Public methods

open Long
getStartDelay(sceneRoot: ViewGroup!, transition: Transition!, startValues: TransitionValues!, endValues: TransitionValues!)

open Unit
setPropagationSpeed(propagationSpeed: Float)

Sets the speed at which transition propagation happens, relative to the duration of the Transition.

open Unit
setSide(side: Int)

Sets the side that is used to calculate the transition propagation.

Inherited functions

Public constructors

<init>

SidePropagation()

A TransitionPropagation that propagates based on the distance to the side and, orthogonally, the distance to epicenter. If the transitioning View is visible in the start of the transition, then it will transition sooner when closer to the side and later when farther. If the view is not visible in the start of the transition, then it will transition later when closer to the side and sooner when farther from the edge. This is the default TransitionPropagation used with android.transition.Slide.

Public methods

getStartDelay

open fun getStartDelay(sceneRoot: ViewGroup!, transition: Transition!, startValues: TransitionValues!, endValues: TransitionValues!): Long

setPropagationSpeed

open fun setPropagationSpeed(propagationSpeed: Float): Unit

Sets the speed at which transition propagation happens, relative to the duration of the Transition. A propagationSpeed of 1 means that a View centered at the side set in setSide(int) and View centered at the opposite edge will have a difference in start delay of approximately the duration of the Transition. A speed of 2 means the start delay difference will be approximately half of the duration of the transition. A value of 0 is illegal, but negative values will invert the propagation.

Parameters
propagationSpeed Float: The speed at which propagation occurs, relative to the duration of the transition. A speed of 4 means it works 4 times as fast as the duration of the transition. May not be 0.

setSide

open fun setSide(side: Int): Unit

Sets the side that is used to calculate the transition propagation. If the transitioning View is visible in the start of the transition, then it will transition sooner when closer to the side and later when farther. If the view is not visible in the start of the transition, then it will transition later when closer to the side and sooner when farther from the edge. The default is Gravity#BOTTOM.

Parameters
side Int: The side that is used to calculate the transition propagation. Must be one of Gravity#LEFT, Gravity#TOP, Gravity#RIGHT, Gravity#BOTTOM, Gravity#START, or Gravity#END.