Summary: Methods | Inherited Methods

ParallaxEffect

Kotlin |Java

public abstract class ParallaxEffect
extends Object

java.lang.Object
↳	androidx.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 ParallaxTarget.update(float).

App use Parallax.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.PropertyMarkerValue`s, 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.PropertyMarkerValue`s, 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

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public methods

public final void addTarget (ParallaxTarget target)

Add a ParallaxTarget to run parallax effect.

Parameters
`target`	`ParallaxTarget`: ParallaxTarget to add.

getPropertyRanges

public final List<PropertyMarkerValue> getPropertyRanges ()

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

Returns
`List<PropertyMarkerValue>`	A list of `Parallax.PropertyMarkerValue`s.

See also:

performMapping(Parallax)

getTargets

public final List<ParallaxTarget> getTargets ()

Returns the list of ParallaxTarget objects.

Returns
`List<ParallaxTarget>`	The list of `ParallaxTarget` objects.

public final void performMapping (Parallax source)

Perform mapping from Parallax to list of ParallaxTarget.

Parameters
`source`	`Parallax`

public final void removeTarget (ParallaxTarget target)

Remove a ParallaxTarget object from the list.

Parameters
`target`	`ParallaxTarget`: The `ParallaxTarget` object to be removed.

public final void setPropertyRanges (PropertyMarkerValue... markerValues)

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

Parameters
`markerValues`	`PropertyMarkerValue`: A list of `Parallax.PropertyMarkerValue`s.

See also:

performMapping(Parallax)

target

public final 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.

Parameters
`targetObject`	`T`: Target object for property.
`targetProperty`	`Property`: The target property that will receive values.

Returns
`ParallaxEffect`	This ParallaxEffect object, allowing calls to methods in this class to be chained.

See also:

ParallaxTarget.isDirectMapping()

target

public final ParallaxEffect target (Object targetObject, 
                PropertyValuesHolder values)

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

Parameters
`targetObject`	`Object`: Target object for PropertyValuesHolderTarget.
`values`	`PropertyValuesHolder`: PropertyValuesHolder for PropertyValuesHolderTarget.

Returns
`ParallaxEffect`	This ParallaxEffect object, allowing calls to methods in this class to be chained.

public final ParallaxEffect target (ParallaxTarget target)

Add a ParallaxTarget to run parallax effect.

Parameters
`target`	`ParallaxTarget`: ParallaxTarget to add.

Returns
`ParallaxEffect`	This ParallaxEffect object, allowing calls to methods in this class to be chained.