universum.studios.android.transition

Class Scale

java.lang.Object

android.transition.Transition

android.transition.Visibility

universum.studios.android.transition.Scale

All Implemented Interfaces:

Cloneable

public class Scale
extends Visibility

A Visibility transition implementation that tracks changes to the visibility of target views in the start and end scenes and scales up or down views in the scene. Visibility is determined by both the View.setVisibility(int) state of the view as well as whether it is parented in the current view hierarchy. Disappearing Views are limited as described in Visibility.onDisappear(android.view.ViewGroup, TransitionValues, int, TransitionValues, int).

Scaling pivot for both X and Y axes, as concrete positions, may be specified via setPivotX(Float) and setPivotY(Float). In order too specify X and Y pivots as relative positions/fractions, setPivotXFraction(float) along with setPivotYFraction(float) may be used.

Scale transition can be described in a resource file by using the transition tag with class attribute set to universum.studios.android.transition.Scale, along with Xml attributes referenced below.

XML attributes

Scale Attributes

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Scale.ScaleMode Defines an annotation for determining set of allowed modes for Scale transition.

Nested classes/interfaces inherited from class android.transition.Transition

Transition.EpicenterCallback, Transition.TransitionListener

Field Summary

Fields

Modifier and Type	Field and Description
static TimeInterpolator	INTERPOLATOR Default interpolator attached to Animator created via createAnimator(View, float, float, float, float).
static float	MAX Maximum value for scale property
static float	MIN Minimum value for scale property.
static String	PROPERTY_SCALE_X Name of the view's property used to scale size of a specific view along its x axis.
static String	PROPERTY_SCALE_Y Name of the view's property used to scale size of a specific view along its y axis.

Fields inherited from class android.transition.Visibility

MODE_IN, MODE_OUT

Fields inherited from class android.transition.Transition

MATCH_ID, MATCH_INSTANCE, MATCH_ITEM_ID, MATCH_NAME

Constructor Summary

Constructors

Constructor and Description
Scale() Same as Scale(int) with both Visibility.MODE_IN and Visibility.MODE_OUT modes combined.
Scale(Context context, AttributeSet attrs) Creates a new instance of Scale transition with animation property values set from the specified attrs.
Scale(int mode) Creates a new instance of Scale transition with the specified mode.

Method Summary

Modifier and Type	Method and Description
void	captureStartValues(TransitionValues transitionValues)
static Animator	createAnimator(View view, float startScale, float endScale) Creates a new instance of Animator that animates both, scale X and scale Y, properties of the specified view.
static Animator	createAnimator(View view, float startScaleX, float startScaleY, float endScaleX, float endScaleY) Creates a new instance of Animator that animates both, scale X and scale Y, properties of the specified view.
Float	getPivotX() Returns the x coordinate for pivot of the scale animation.
float	getPivotXFraction() Returns the fraction of the pivot x coordinate.
Float	getPivotY() Returns the y coordinate for pivot of the scale animation.
float	getPivotYFraction() Returns the fraction of the pivot y coordinate.
Animator	onAppear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)
Animator	onDisappear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)
void	setPivotX(Float pivotX) Sets a pivot x coordinate for scale animation.
void	setPivotXFraction(float fractionX) Sets a fraction for the pivot x coordinate.
void	setPivotY(Float pivotY) Sets a pivot y coordinate for scale animation.
void	setPivotYFraction(float fractionY) Sets a fraction for the pivot y coordinate.

Methods inherited from class android.transition.Visibility

captureEndValues, createAnimator, getMode, getTransitionProperties, isTransitionRequired, isVisible, onAppear, onDisappear, setMode

Methods inherited from class android.transition.Transition

addListener, addTarget, addTarget, addTarget, addTarget, canRemoveViews, clone, excludeChildren, excludeChildren, excludeChildren, excludeTarget, excludeTarget, excludeTarget, excludeTarget, getDuration, getEpicenter, getEpicenterCallback, getInterpolator, getName, getPathMotion, getPropagation, getStartDelay, getTargetIds, getTargetNames, getTargets, getTargetTypes, getTransitionValues, removeListener, removeTarget, removeTarget, removeTarget, removeTarget, setDuration, setEpicenterCallback, setInterpolator, setMatchOrder, setPathMotion, setPropagation, setStartDelay, toString

Methods inherited from class java.lang.Object

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

Field Detail

MIN

public static final float MIN

Minimum value for scale property.

See Also:

Constant Field Values

MAX

public static final float MAX

Maximum value for scale property

See Also:

Constant Field Values

PROPERTY_SCALE_X

public static final String PROPERTY_SCALE_X

Name of the view's property used to scale size of a specific view along its x axis.

See Also:

Constant Field Values

PROPERTY_SCALE_Y

public static final String PROPERTY_SCALE_Y

Name of the view's property used to scale size of a specific view along its y axis.

See Also:

Constant Field Values

INTERPOLATOR

public static final TimeInterpolator INTERPOLATOR

Default interpolator attached to Animator created via createAnimator(View, float, float, float, float).

Constructor Detail

Scale

public Scale()

Same as Scale(int) with both Visibility.MODE_IN and Visibility.MODE_OUT modes combined.

Scale

public Scale(int mode)

Creates a new instance of Scale transition with the specified mode.

Parameters:

mode - One of Visibility.MODE_IN or Visibility.MODE_OUT or theirs combination.

Scale

public Scale(@NonNull
             Context context,
             @Nullable
             AttributeSet attrs)

Creates a new instance of Scale transition with animation property values set from the specified attrs.

Parameters:

context - Context used to obtain values from the specified attrs.

attrs - Set of attributes from which to obtain animation property values for the scale animation.

Method Detail

createAnimator

@Nullable
public static Animator createAnimator(@NonNull
                                                View view,
                                                float startScale,
                                                float endScale)

Creates a new instance of Animator that animates both, scale X and scale Y, properties of the specified view.

The returned animator will also have the default INTERPOLATOR attached.

Parameters:

view - The view for which to create the requested animator.

startScale - Scale from which to start the animation along X and Y axis.

endScale - Scale at which should the animation end along X and Y axis.

Returns:

Animator that will play scale animation for the specified view according to the specified parameters when started or null if the start and end scale values are the same.

See Also:

createAnimator(View, float, float, float, float)

createAnimator

@Nullable
public static Animator createAnimator(@NonNull
                                                View view,
                                                float startScaleX,
                                                float startScaleY,
                                                float endScaleX,
                                                float endScaleY)

Creates a new instance of Animator that animates both, scale X and scale Y, properties of the specified view.

The returned animator will also have the default INTERPOLATOR attached.

Parameters:

view - The view for which to create the requested animator.

startScaleX - Scale from which to start the animation along X axis.

startScaleY - Scale from which to start the animation along Y axis.

endScaleX - Scale at which should the animation end along X axis.

endScaleY - Scale at which should the animation end along Y axis.

Returns:

Animator that will play scale animation for the specified view according to the specified parameters when started or null if the start and end scale values are the same or the target view is already detached from window.

setPivotX

public void setPivotX(@Nullable
                      Float pivotX)

Sets a pivot x coordinate for scale animation.

Default value: null

Parameters:

pivotX - The desired pivot x coordinate in pixels. May be null to use pivot fraction specified via setPivotXFraction(float) instead.

See Also:

getPivotX(), setPivotXFraction(float), setPivotY(Float), android:transformPivotX

getPivotX

@Nullable
public Float getPivotX()

Returns the x coordinate for pivot of the scale animation.

Returns:

Pivot in pixels or null if no pivot has been specified.

See Also:

setPivotX(Float)

setPivotY

public void setPivotY(@Nullable
                      Float pivotY)

Sets a pivot y coordinate for scale animation.

Default value: null

Parameters:

pivotY - The desired pivot y coordinate in pixels. May be null to use pivot fraction specified via setPivotYFraction(float) instead.

See Also:

getPivotY(), setPivotYFraction(float), setPivotX(Float), android:transformPivotY

getPivotY

@Nullable
public Float getPivotY()

Returns the y coordinate for pivot of the scale animation.

Returns:

Pivot in pixels or null if no pivot has been specified.

See Also:

setPivotY(Float)

setPivotXFraction

public void setPivotXFraction(float fractionX)

Sets a fraction for the pivot x coordinate. This fraction will be used to resolve pivot x coordinate of an animating view depending on its current width if such value has not been specified via setPivotX(Float).

Default value: 0.5

Parameters:

fractionX - The desired fraction from the [0.0, 1.0] range.

See Also:

getPivotYFraction(), setPivotXFraction(float), setPivotX(Float), android:pivotX

getPivotXFraction

public float getPivotXFraction()

Returns the fraction of the pivot x coordinate.

Returns:

Fraction from the [0.0, 1.0] range.

See Also:

setPivotXFraction(float)

setPivotYFraction

public void setPivotYFraction(float fractionY)

Sets a fraction for the pivot y coordinate. This fraction will be used to resolve pivot y coordinate of an animating view depending on its current height if such value has not been specified via setPivotY(Float).

Default value: 0.5

Parameters:

fractionY - The desired fraction from the [0.0, 1.0] range.

See Also:

getPivotXFraction(), setPivotYFraction(float), setPivotY(Float), android:pivotY

getPivotYFraction

public float getPivotYFraction()

Returns the fraction of the pivot y coordinate.

Returns:

Fraction from the [0.0, 1.0] range.

See Also:

setPivotYFraction(float)

captureStartValues

public void captureStartValues(@NonNull
                               TransitionValues transitionValues)

Overrides:

captureStartValues in class Visibility

onAppear

@Nullable
public Animator onAppear(@NonNull
                                   ViewGroup sceneRoot,
                                   @NonNull
                                   View view,
                                   @Nullable
                                   TransitionValues startValues,
                                   @Nullable
                                   TransitionValues endValues)

Overrides:

onAppear in class Visibility

onDisappear

@Nullable
public Animator onDisappear(@NonNull
                                      ViewGroup sceneRoot,
                                      @NonNull
                                      View view,
                                      @Nullable
                                      TransitionValues startValues,
                                      @Nullable
                                      TransitionValues endValues)

Overrides:

onDisappear in class Visibility