SidePropagation

Kotlin |Java

open class SidePropagation : VisibilityPropagation

kotlin.Any
↳	android.transition.TransitionPropagation
	↳	android.transition.VisibilityPropagation
		↳	android.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
`SidePropagation()`

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

From class VisibilityPropagation

`Unit`	`captureValues(values: TransitionValues!)`
`Array<String!>!`	`getPropagationProperties()`
`Int`	`getViewVisibility(values: TransitionValues!)` Returns `android.view.View#getVisibility()` for the View at the time the values were captured.
`Int`	`getViewX(values: TransitionValues!)` Returns the View's center x coordinate, relative to the screen, at the time the values were captured.
`Int`	`getViewY(values: TransitionValues!)` Returns the View's center y coordinate, relative to the screen, at the time the values were captured.

From class TransitionPropagation

Long

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

Called by Transition to alter the Animator start delay. All start delays will be adjusted such that the minimum becomes zero.

Public constructors

SidePropagation

SidePropagation()

Public methods

getStartDelay

Added in API level 21

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

Parameters
`sceneRoot`	ViewGroup!: The root of the View hierarchy running the transition.
`transition`	Transition!: The transition that created the Animator
`startValues`	TransitionValues!: The values for a specific target in the start scene.
`endValues`	TransitionValues!: The values for the target in the end scene.

Return
`Long`	A start delay to use with the Animator created by `transition`. The delay will be offset by the minimum delay of all `TransitionPropagation`s used in the Transition so that the smallest delay will be 0. Returned values may be negative.

setPropagationSpeed

Added in API level 21

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

Added in API level 21

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`. Value is `android.view.Gravity#LEFT`, `android.view.Gravity#TOP`, `android.view.Gravity#RIGHT`, `android.view.Gravity#BOTTOM`, `android.view.Gravity#START`, or `android.view.Gravity#END`