Package com.pranavpandey.android.dynamic.support.motion

Class DynamicMotion

java.lang.Object

com.pranavpandey.android.dynamic.support.motion.DynamicMotion

public class DynamicMotion
extends Object

Helper class to perform various animations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	DynamicMotion.Duration	Constant values for the animation duration.
static @interface	DynamicMotion.Value	Constant values for the view properties.

Method Summary

Modifier and Type	Method	Description
void	beginDelayedTransition(ViewGroup sceneRoot)	Use TransitionManager to begin delayed transition according to the motion duration.
void	beginDelayedTransition(ViewGroup sceneRoot, Transition transition)	Use TransitionManager to begin delayed transition according to the motion duration.
AnimatorSet	floatWithAlpha(View target, long startDelay, Property<View,Float> property, float from, float to, float alphaFrom, float alphaTo)	Returns an animator set with view property and alpha animators.
AnimatorSet	floatWithAlpha(View target, Property<View,Float> property, float from, float to, float alphaFrom, float alphaTo)	Returns an animator set with view property and alpha animators.
long	getDuration()	Get the current motion duration.
static DynamicMotion	getInstance()	Retrieves the singleton instance of DynamicMotion.
boolean	isMotion()	Checks whether the motion is enabled.
DynamicMotion	setDuration()	Sets the default motion duration.
DynamicMotion	setDuration(long duration)	Sets the motion duration.
DynamicMotion	setMotion(boolean motion)	Sets the motion, either enable or disable.
<T> T	withDuration(T transition)	Returns the transition with the default duration.
<T> T	withDuration(T transition, long duration)	Returns the transition with the specified duration.
<T> T	withInterpolator(T transition, Interpolator interpolator)	Returns the transition with the specified interpolator.
<T> T	withStartDelay(T transition)	Returns the transition with the default start delay.
<T> T	withStartDelay(T transition, long startDelay)	Returns the transition with the specified start delay.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInstance

@NonNull
public static DynamicMotion getInstance()

Retrieves the singleton instance of DynamicMotion.

Must be called before accessing the public methods.

Returns:

The singleton instance of DynamicMotion.

isMotion

public boolean isMotion()

Checks whether the motion is enabled.

Returns:

true if the motion is enabled.

setMotion

@NonNull
public DynamicMotion setMotion(boolean motion)

Sets the motion, either enable or disable.

Parameters:

motion - true to enable the motion.

Returns:

The DynamicMotion object to allow for chaining of calls to set methods.

getDuration

public long getDuration()

Get the current motion duration.

Returns:

The current motion duration.

setDuration

@NonNull
public DynamicMotion setDuration(long duration)

Sets the motion duration.

Parameters:

duration - The motion duration to be set.

Use 0 or DynamicMotion.Duration.NO to disable all the motion.

Returns:

The DynamicMotion object to allow for chaining of calls to set methods.

setDuration

@NonNull
public DynamicMotion setDuration()

Sets the default motion duration.

Returns:

The DynamicMotion object to allow for chaining of calls to set methods.

See Also:

• setDuration(long)
• DynamicMotion.Duration.DEFAULT

floatWithAlpha

@NonNull
public AnimatorSet floatWithAlpha(@Nullable
 View target,
 long startDelay,
 @NonNull
 Property<View,Float> property,
 float from,
 float to,
 @FloatRange(from=0.0,to=1.0)
 float alphaFrom,
 @FloatRange(from=0.0,to=1.0)
 float alphaTo)

Returns an animator set with view property and alpha animators.

Parameters:

target - The target view to be animated.

startDelay - The start delay for the animation.

property - The view property to be animated.

from - The initial value fo the view property.

to - The final value of the view property.

alphaFrom - The initial value of the view alpha.

alphaTo - The final value of the view alpha.

Returns:

The animator set with view property and alpha animators.

See Also:

• ObjectAnimator
• View.ROTATION
• View.ROTATION_X
• View.ROTATION_Y
• View.SCALE_X
• View.SCALE_Y
• View.TRANSLATION_X
• View.TRANSLATION_Y
• View.TRANSLATION_Z
• View.X
• View.Y
• View.Z
• View.Z
• View.ALPHA

floatWithAlpha

@NonNull
public AnimatorSet floatWithAlpha(@Nullable
 View target,
 @NonNull
 Property<View,Float> property,
 float from,
 float to,
 @FloatRange(from=0.0,to=1.0)
 float alphaFrom,
 @FloatRange(from=0.0,to=1.0)
 float alphaTo)

Returns an animator set with view property and alpha animators.

Parameters:

target - The target view to be animated.

property - The view property to be animated.

from - The initial value fo the view property.

to - The final value of the view property.

alphaFrom - The initial value of the view alpha.

alphaTo - The final value of the view alpha.

Returns:

The animator set with view property and alpha animators.

See Also:

• floatWithAlpha(View, long, Property, float, float, float, float)
• ObjectAnimator
• View.ROTATION
• View.ROTATION_X
• View.ROTATION_Y
• View.SCALE_X
• View.SCALE_Y
• View.TRANSLATION_X
• View.TRANSLATION_Y
• View.TRANSLATION_Z
• View.X
• View.Y
• View.Z
• View.Z
• View.ALPHA

withDuration

@Nullable
public <T> T withDuration(@Nullable
 T transition,
 long duration)

Returns the transition with the specified duration.

Type Parameters:

T - The type of the transition.

Parameters:

transition - The transition to used.

duration - The duration to be set.

Returns:

The transition with the specified duration.

withDuration

@Nullable
public <T> T withDuration(@Nullable
 T transition)

Returns the transition with the default duration.

Type Parameters:

T - The type of the transition.

Parameters:

transition - The transition to used.

Returns:

The transition with the default duration.

See Also:

• withDuration(Object, long)
• DynamicMotion.Duration

withStartDelay

@Nullable
public <T> T withStartDelay(@Nullable
 T transition,
 long startDelay)

Returns the transition with the specified start delay.

Type Parameters:

T - The type of the transition.

Parameters:

transition - The transition to used.

startDelay - The start delay to be set.

Returns:

The transition with the specified start delay.

withStartDelay

@Nullable
public <T> T withStartDelay(@Nullable
 T transition)

Returns the transition with the default start delay.

Type Parameters:

T - The type of the transition.

Parameters:

transition - The transition to used.

Returns:

The transition with the DynamicMotion.Duration.SHORTER delay.

See Also:

• withStartDelay(Object, long)
• DynamicMotion.Duration.SHORTER

withInterpolator

@Nullable
public <T> T withInterpolator(@Nullable
 T transition,
 @Nullable
 Interpolator interpolator)

Returns the transition with the specified interpolator.

Type Parameters:

T - The type of the transition.

Parameters:

transition - The transition to used.

interpolator - The interpolator to be set.

Returns:

The transition with the specified interpolator.

beginDelayedTransition

public void beginDelayedTransition(@Nullable
 ViewGroup sceneRoot,
 @Nullable
 Transition transition)

Use TransitionManager to begin delayed transition according to the motion duration.

Parameters:

sceneRoot - The scene root to be used.

transition - The transition to be used.

See Also:

• TransitionManager.beginDelayedTransition(ViewGroup, androidx.transition.Transition)

beginDelayedTransition

public void beginDelayedTransition(@Nullable
 ViewGroup sceneRoot)

Use TransitionManager to begin delayed transition according to the motion duration.

Parameters:

sceneRoot - The scene root to be used.

See Also:

• AutoTransition
• beginDelayedTransition(ViewGroup, androidx.transition.Transition)