added in version 25.4.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
Summary: Methods | Inherited Methods | [Expand All]

ParallaxEffect

public abstract class ParallaxEffect
extends Object

java.lang.Object
   ↳ android.support.v17.leanback.widget.ParallaxEffect

ParallaxEffect class drives changes in ParallaxTarget in response to changes in variables defined in Parallax.

ParallaxEffect has a list of Parallax.PropertyMarkerValues which represents the range of values that source variables can take. The main function is performMapping(Parallax) which computes a fraction between 0 and 1 based on the current values of variables in Parallax. As the parallax effect goes on, the fraction increases from 0 at beginning to 1 at the end. Then the fraction is passed on to update(float).

App use addEffect(PropertyMarkerValue) to create a ParallaxEffect.

Summary

Public methods

final void addTarget(ParallaxTarget target)

Add a ParallaxTarget to run parallax effect.

final List<PropertyMarkerValue> getPropertyRanges()

Returns the list of Parallax.PropertyMarkerValues, which represents the range of values that source variables can take.

final List<ParallaxTarget> getTargets()

Returns the list of ParallaxTarget objects.

final void performMapping(Parallax source)

Perform mapping from Parallax to list of ParallaxTarget.

final void removeTarget(ParallaxTarget target)

Remove a ParallaxTarget object from the list.

final void setPropertyRanges(PropertyMarkerValue... markerValues)

Sets the list of Parallax.PropertyMarkerValues, which represents the range of values that source variables can take.

final <T, V extends Number> ParallaxEffect target(T targetObject, Property<T, V> targetProperty)

Creates a ParallaxTarget using direct mapping from source property into target property, the new ParallaxTarget will be added to its list of targets.

final ParallaxEffect target(Object targetObject, PropertyValuesHolder values)

Creates a ParallaxTarget from PropertyValuesHolder and adds it to the list of targets.

final ParallaxEffect target(ParallaxTarget target)

Add a ParallaxTarget to run parallax effect.

Inherited methods

From class java.lang.Object

Public methods