SidePropagation

public class SidePropagation extends VisibilityPropagation

java.lang.Object
   ↳ 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

Public methods
long
getStartDelay(
    @NonNull ViewGroup sceneRoot,
    @NonNull Transition transition,
    @Nullable TransitionValues startValues,
    @Nullable TransitionValues endValues
)

Called by Transition to alter the Animator start delay.
void
setPropagationSpeed(float propagationSpeed)

Sets the speed at which transition propagation happens, relative to the duration of the Transition.
void
setSide(int side)

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

Inherited methods
From androidx.transition.VisibilityPropagation
void

Captures the values in the start or end scene for the properties that this transition propagation monitors.
@Nullable String[]

Returns the set of property names stored in the TransitionValues object passed into captureValues that this transition propagation cares about for the purposes of preventing duplicate capturing of property values.
int

Returns getVisibility for the View at the time the values were captured.
int

Returns the View's center x coordinate, relative to the screen, at the time the values were captured.
int

Returns the View's center y coordinate, relative to the screen, at the time the values were captured.

Public constructors

SidePropagation

Added in 1.0.0
public SidePropagation()

Public methods

getStartDelay

Added in 1.6.0-alpha01
public long getStartDelay(
    @NonNull ViewGroup sceneRoot,
    @NonNull Transition transition,
    @Nullable TransitionValues startValues,
    @Nullable TransitionValues endValues
)

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

Parameters
@NonNull ViewGroup sceneRoot

The root of the View hierarchy running the transition.
@NonNull Transition transition

The transition that created the Animator
@Nullable TransitionValues startValues

The values for a specific target in the start scene.
@Nullable TransitionValues endValues

The values for the target in the end scene.
Returns
long

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

setPropagationSpeed

Added in 1.0.0
public void setPropagationSpeed(float propagationSpeed)

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 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
float propagationSpeed

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 1.0.0
public void setSide(int side)

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 BOTTOM.

Parameters
int side

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