universum.studios.android.transition

Class Reveal

java.lang.Object

android.transition.Transition

android.transition.Visibility

universum.studios.android.transition.Reveal

All Implemented Interfaces:

Cloneable

public class Reveal
extends android.transition.Visibility

A Visibility transition implementation that tracks changes to the visibility of target views in the start and end scenes and reveals or conceals views in the scene. Visibility is determined by the View.setVisibility(int) state of the views.

A Reveal transition uses ViewAnimationUtils.createCircularReveal(View, int, int, float, float) to create a circular reveal/conceal animator that is used to animate its target views. A center coordinates of revealing/concealing circle can be specified via setCenterX(Float) and setCenterY(Float) or by using fractions via setCenterXFraction(float) and setCenterYFraction(float). If specifying a gravity for the center of the animating circle is enough, the desired gravity flags may be specified via setCenterGravity(Integer).

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

XML attributes

Reveal Attributes

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

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

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

android.transition.Transition.EpicenterCallback, android.transition.Transition.TransitionListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONCEAL Mode to indicate that Reveal transition should play conceal animation, that is to 'downscale' the animating circle of an animating view from its initial size to a smaller one.
static int	REVEAL Mode to indicate that Reveal transition should play reveal animation, that is to 'upscale' the animating circle of an animating view from its initial size to a larger one.

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
Reveal() Same as Reveal(int) with REVEAL mode.
Reveal(android.content.Context context, android.util.AttributeSet attrs) Creates a new instance of Reveal transition with animation property values set from the specified attrs.
Reveal(int mode) Creates a new instance of Reveal transition with the specified mode.

Method Summary

Modifier and Type	Method and Description
static float	calculateRadius(float width, float height) Calculates the radius of the specified width and height dimension for purpose of circular reveal animation.
static float	calculateRadius(android.view.View view) Same as calculateRadius(float, float) where width and height of the given view will be used for radius calculation.
static android.animation.Animator	createAnimator(android.view.View view, float startRadius, float endRadius) Same as createAnimator(View, int, int, float, float) where the center coordinates will be automatically resolved using the given view.
static android.animation.Animator	createAnimator(android.view.View view, int centerX, int centerY, float startRadius, float endRadius) Creates a new instance of circular reveal Animator for the specified view.
int	getAppearVisibility() Returns the visibility flag that will be set to a revealing view whenever this transition is requested to create an appear animator.
Integer	getCenterGravity() Returns the gravity flags that will be used to resolve center for animating circle of the reveal animation.
int	getCenterHorizontalOffset() Returns the offset for the center x coordinate for animating circle of the reveal animation.
int	getCenterVerticalOffset() Returns the offset for the center y coordinate for animating circle of the reveal animation.
Float	getCenterX() Returns the x coordinate of the center for animating circle of the reveal animation.
float	getCenterXFraction() Returns the fraction of the center x coordinate.
Float	getCenterY() Returns the y coordinate of the center for animating circle of the reveal animation.
float	getCenterYFraction() Returns the fraction of the center y coordinate.
int	getDisappearVisibility() Returns the visibility flag that will be set to a revealing view whenever this transition is requested to created a disappear animator.
Float	getEndRadius() Returns the end radius for animating circle of the reveal animation.
int	getEndVisibility() Returns the visibility flag that will be set to a revealing view whenever this transition ends.
int	getMode() Returns the reveal mode of this transition.
Float	getStartRadius() Returns the start radius for animating circle of the reveal animation.
int	getStartVisibility() Returns the visibility flag that will be set to a revealing view whenever this transition (its animation) starts.
android.animation.Animator	onAppear(android.view.ViewGroup sceneRoot, android.view.View view, android.transition.TransitionValues startValues, android.transition.TransitionValues endValues)
android.animation.Animator	onDisappear(android.view.ViewGroup sceneRoot, android.view.View view, android.transition.TransitionValues startValues, android.transition.TransitionValues endValues)
static float[]	resolveCenter(android.view.View view) Same as resolveCenter(View, float, float) with fraction 0.5 for booth center coordinates.
static float[]	resolveCenter(android.view.View view, float centerXFraction, float centerYFraction) Resolves the center of the specified view based on its current width and height according to the requested fractions.
static float[]	resolveCenterPosition(android.view.View view) Same as resolveCenterPosition(View, float, float) with fraction 0.5 for booth center coordinates.
static float[]	resolveCenterPosition(android.view.View view, float centerXFraction, float centerYFraction) Like resolveCenter(View, float, float) this method will resolve center of the specified view based on its current width and height but also takes into count its current x and y coordinate.
void	setAppearVisibility(int visibility) Sets a visibility flag that should be set to a revealing view whenever this transition has been requested to create an appear animator via onAppear(ViewGroup, View, TransitionValues, TransitionValues).
void	setCenterGravity(Integer gravity) Sets a gravity flags that should be used to resolve center for animating circle of the reveal animation.
void	setCenterHorizontalOffset(int offset) Sets an offset for the center x coordinate for animating circle of the reveal animation.
void	setCenterVerticalOffset(int offset) Sets an offset for the center y coordinate for animating circle of the reveal animation.
void	setCenterX(Float centerX) Sets a center x coordinate for animating circle of the reveal animation.
void	setCenterXFraction(float fractionX) Sets a fraction for the center x coordinate.
void	setCenterY(Float centerY) Sets a center y coordinate for animating circle of the reveal animation.
void	setCenterYFraction(float fractionY) Sets a fraction for the center y coordinate.
void	setDisappearVisibility(int visibility) Sets a visibility flag that should be set to a revealing view whenever this transition has been requested to create a disappear animator via onDisappear(ViewGroup, View, TransitionValues, TransitionValues).
void	setEndRadius(Float radius) Sets an end radius for animating circle of the reveal animation.
void	setEndVisibility(int visibility) Sets a visibility flag that should be set to a revealing view whenever this transition (its animation) ends.
void	setMode(int mode) Sets a mode in which should this transition run.
void	setStartRadius(Float radius) Sets a start radius for animating circle of the reveal animation.
void	setStartVisibility(int visibility) Sets a visibility flag that should be set to a revealing view whenever this transition starts.

Methods inherited from class android.transition.Visibility

captureEndValues, captureStartValues, createAnimator, getTransitionProperties, isTransitionRequired, isVisible, onAppear, onDisappear

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

REVEAL

public static final int REVEAL

Mode to indicate that Reveal transition should play reveal animation, that is to 'upscale' the animating circle of an animating view from its initial size to a larger one.

This mode can be used as well for appearing targets as for disappearing ones.

See Also:

Constant Field Values

CONCEAL

public static final int CONCEAL

Mode to indicate that Reveal transition should play conceal animation, that is to 'downscale' the animating circle of an animating view from its initial size to a smaller one.

This mode can be used as well for disappearing targets as for appearing ones.

See Also:

Constant Field Values

Constructor Detail

Reveal

public Reveal()

Same as Reveal(int) with REVEAL mode.

Reveal

public Reveal(int mode)

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

Parameters:

mode - One of REVEAL or CONCEAL.

Reveal

public Reveal(android.content.Context context,
              android.util.AttributeSet attrs)

Creates a new instance of Reveal 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 property values for the reveal animation.

Method Detail

calculateRadius

public static float calculateRadius(android.view.View view)

Same as calculateRadius(float, float) where width and height of the given view will be used for radius calculation.

Parameters:

view - The view of which radius to calculate.

Returns:

Calculated radius that may be used as end/start radius for the desired reveal animation.

calculateRadius

public static float calculateRadius(float width,
                                    float height)

Calculates the radius of the specified width and height dimension for purpose of circular reveal animation.

Parameters:

width - The width or horizontal distance from which to calculate radius.

height - The height or vertical distance from which to calculate radius.

Returns:

Calculated radius that may be used as end/start radius for the desired reveal animation.

resolveCenterPosition

public static float[] resolveCenterPosition(android.view.View view)

Same as resolveCenterPosition(View, float, float) with fraction 0.5 for booth center coordinates.

resolveCenterPosition

public static float[] resolveCenterPosition(android.view.View view,
                                            float centerXFraction,
                                            float centerYFraction)

Like resolveCenter(View, float, float) this method will resolve center of the specified view based on its current width and height but also takes into count its current x and y coordinate.

Parameters:

view - The view of which center position to resolve.

centerXFraction - Fraction to resolve x coordinate of the center. Should be from the [0.0, 1.0] range.

centerYFraction - Fraction to resolve y coordinate of the center. Should be from the [0.0, 1.0] range.

Returns:

An array with center coordinates: centerX[0], centerY[1].

resolveCenter

public static float[] resolveCenter(android.view.View view)

Same as resolveCenter(View, float, float) with fraction 0.5 for booth center coordinates.

resolveCenter

public static float[] resolveCenter(android.view.View view,
                                    float centerXFraction,
                                    float centerYFraction)

Resolves the center of the specified view based on its current width and height according to the requested fractions.

Parameters:

view - The view of which center to resolve.

centerXFraction - Fraction to resolve x coordinate of the center. Should be from the [0.0, 1.0] range.

centerYFraction - Fraction to resolve y coordinate of the center. Should be from the [0.0, 1.0] range.

Returns:

An array with center coordinates: centerX[0], centerY[1].

createAnimator

public static android.animation.Animator createAnimator(android.view.View view,
                                                        float startRadius,
                                                        float endRadius)

Same as createAnimator(View, int, int, float, float) where the center coordinates will be automatically resolved using the given view.

See Also:

resolveCenterPosition(View)

createAnimator

public static android.animation.Animator createAnimator(android.view.View view,
                                                        int centerX,
                                                        int centerY,
                                                        float startRadius,
                                                        float endRadius)

Creates a new instance of circular reveal Animator for the specified view.

Parameters:

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

centerX - X coordinate of a center from where should the reveal animation start.

centerY - Y coordinate of a center from where should the reveal animation start.

startRadius - Radius of the specified view at the start of the reveal animation.

endRadius - Radius of the specified view at the end of the reveal animation.

Returns:

Animator that will play circular reveal animation for the specified view according to the specified parameters when started.

See Also:

ViewAnimationUtils.createCircularReveal(View, int, int, float, float)

setMode

public final void setMode(int mode)

Sets a mode in which should this transition run.

Default value: REVEAL

Overrides:

setMode in class android.transition.Visibility

Parameters:

mode - The desired mode. One of REVEAL or CONCEAL.

See Also:

getMode()

getMode

public final int getMode()

Returns the reveal mode of this transition.

Overrides:

getMode in class android.transition.Visibility

Returns:

One of REVEAL or CONCEAL.

setStartRadius

public void setStartRadius(Float radius)

Sets a start radius for animating circle of the reveal animation. Based on the current reveal mode, this radius should be either smaller than the end radius specified via setEndRadius(Float) or grater one otherwise there will be nothing to reveal/conceal.

Parameters:

radius - The desired radius in pixels. May be null to use the default approach to compute start radius based on the reveal mode.

See Also:

ui:uiStartRadius, getStartRadius(), setEndRadius(Float)

getStartRadius

public Float getStartRadius()

Returns the start radius for animating circle of the reveal animation.

Returns:

Start radius in pixels or null if this radius will be calculated based on the reveal mode.

See Also:

setStartRadius(Float)

setEndRadius

public void setEndRadius(Float radius)

Sets an end radius for animating circle of the reveal animation. Based on the current reveal mode, this radius should be either greater than the start radius specified via setStartRadius(Float) or smaller one otherwise there will be nothing to reveal/conceal.

Parameters:

radius - The desired radius in pixels. May be null to use the default approach to compute end radius based on the reveal mode.

See Also:

ui:uiEndRadius, getEndRadius(), setStartRadius(Float)

getEndRadius

public Float getEndRadius()

Returns the end radius for animating circle of the reveal animation.

Returns:

End radius in pixels or null if this radius will be calculated based on the reveal mode.

See Also:

setEndRadius(Float)

setStartVisibility

public void setStartVisibility(int visibility)

Sets a visibility flag that should be set to a revealing view whenever this transition starts.

Default value: VISIBLE

Parameters:

visibility - One of View.VISIBLE, View.INVISIBLE or View.GONE.

See Also:

ui:uiStartVisibility, getStartVisibility()

getStartVisibility

public int getStartVisibility()

Returns the visibility flag that will be set to a revealing view whenever this transition (its animation) starts.

Returns:

One of View.VISIBLE, View.INVISIBLE or View.GONE.

See Also:

setStartVisibility(int)

setEndVisibility

public void setEndVisibility(int visibility)

Sets a visibility flag that should be set to a revealing view whenever this transition (its animation) ends.

Default value: VISIBLE

Parameters:

visibility - One of View.VISIBLE, View.INVISIBLE or View.GONE.

See Also:

ui:uiEndVisibility, getEndVisibility()

getEndVisibility

public int getEndVisibility()

Returns the visibility flag that will be set to a revealing view whenever this transition ends.

Returns:

One of View.VISIBLE, View.INVISIBLE or View.GONE.

See Also:

setEndVisibility(int)

setAppearVisibility

public void setAppearVisibility(int visibility)

Sets a visibility flag that should be set to a revealing view whenever this transition has been requested to create an appear animator via onAppear(ViewGroup, View, TransitionValues, TransitionValues).

Default value: VISIBLE

Parameters:

visibility - One of View.VISIBLE, View.INVISIBLE or View.GONE.

See Also:

ui:uiAppearVisibility, getAppearVisibility()

getAppearVisibility

public int getAppearVisibility()

Returns the visibility flag that will be set to a revealing view whenever this transition is requested to create an appear animator.

Returns:

One of View.VISIBLE, View.INVISIBLE or View.GONE.

See Also:

setAppearVisibility(int)

setDisappearVisibility

public void setDisappearVisibility(int visibility)

Sets a visibility flag that should be set to a revealing view whenever this transition has been requested to create a disappear animator via onDisappear(ViewGroup, View, TransitionValues, TransitionValues).

Default value: VISIBLE

Parameters:

visibility - One of View.VISIBLE, View.INVISIBLE or View.GONE.

See Also:

ui:uiDisappearVisibility, getDisappearVisibility()

getDisappearVisibility

public int getDisappearVisibility()

Returns the visibility flag that will be set to a revealing view whenever this transition is requested to created a disappear animator.

Returns:

One of View.VISIBLE, View.INVISIBLE or View.GONE.

See Also:

setDisappearVisibility(int)

setCenterGravity

public void setCenterGravity(Integer gravity)

Sets a gravity flags that should be used to resolve center for animating circle of the reveal animation.

Sometimes the gravity is not enough to specify exact center coordinates for the reveal animation. In such case you can move the center coordinates calculated by the requested gravity by specifying horizontal and vertical offset via setCenterHorizontalOffset(int) and setCenterVerticalOffset(int).

Default value: null

Parameters:

gravity - One of Gravity.CENTER, Gravity.CENTER_VERTICAL, Gravity.CENTER_HORIZONTAL, Gravity.TOP, Gravity.BOTTOM, Gravity.START, Gravity.END or theirs combination. May be null to use either specified exact center coordinates or the specified fractions to calculate such coordinates.

See Also:

ui:uiCenterGravity, getCenterGravity(), setCenterX(Float), setCenterY(Float), setCenterXFraction(float), setCenterYFraction(float)

getCenterGravity

public Integer getCenterGravity()

Returns the gravity flags that will be used to resolve center for animating circle of the reveal animation.

Returns:

One of Gravity.CENTER, Gravity.CENTER_VERTICAL, Gravity.CENTER_HORIZONTAL, Gravity.TOP, Gravity.BOTTOM, Gravity.START, Gravity.END or theirs combination or null if no gravity has been specified so either center coordinates specified via setCenterX(Float) and setCenterY(Float) will be used or calculated using the current center fraction values.

See Also:

setCenterGravity(Integer)

setCenterHorizontalOffset

public void setCenterHorizontalOffset(int offset)

Sets an offset for the center x coordinate for animating circle of the reveal animation.

Default value: 0

Parameters:

offset - The desired offset in pixels. If negative the center x coordinate will be moved the the left, if positive it will be moved to the right, otherwise remains unchanged.

See Also:

ui:uiCenterHorizontalOffset, getCenterHorizontalOffset(), setCenterVerticalOffset(int)

getCenterHorizontalOffset

public int getCenterHorizontalOffset()

Returns the offset for the center x coordinate for animating circle of the reveal animation.

Returns:

Horizontal offset in pixels.

See Also:

setCenterHorizontalOffset(int)

setCenterVerticalOffset

public void setCenterVerticalOffset(int offset)

Sets an offset for the center y coordinate for animating circle of the reveal animation.

Default value: 0

Parameters:

offset - The desired offset in pixels. If negative the center y coordinate will be moved the the top, if positive it will be moved to the bottom, otherwise remains unchanged.

See Also:

ui:uiCenterVerticalOffset, getCenterVerticalOffset(), setCenterHorizontalOffset(int)

getCenterVerticalOffset

public int getCenterVerticalOffset()

Returns the offset for the center y coordinate for animating circle of the reveal animation.

Returns:

Vertical offset in pixels.

See Also:

setCenterVerticalOffset(int)

setCenterX

public void setCenterX(Float centerX)

Sets a center x coordinate for animating circle of the reveal animation.

Default value: null

Parameters:

centerX - The desired center x coordinate in pixels. May be null to use center x fraction specified via setCenterXFraction(float) instead.

See Also:

getCenterX(), setCenterXFraction(float), setCenterY(Float)

getCenterX

public Float getCenterX()

Returns the x coordinate of the center for animating circle of the reveal animation.

Returns:

X coordinate of the center for animating circle in pixels or null if no coordinate has been specified so the fraction will be used to calculate this center coordinate.

See Also:

setCenterX(Float)

setCenterY

public void setCenterY(Float centerY)

Sets a center y coordinate for animating circle of the reveal animation.

Default value: null

Parameters:

centerY - The desired center y coordinate in pixels. May be null to use center y fraction specified via setCenterYFraction(float) instead.

See Also:

getCenterY(), setCenterYFraction(float), setCenterX(Float)

getCenterY

public Float getCenterY()

Returns the y coordinate of the center for animating circle of the reveal animation.

Returns:

Y coordinate of the center for animating circle in pixels or null if no coordinate has been specified so the fraction will be used to calculate this center coordinate.

See Also:

setCenterY(Float)

setCenterXFraction

public void setCenterXFraction(float fractionX)

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

Sometimes the fraction is not enough to specify exact center coordinate for the reveal animation. In such case you can move the center coordinates calculated by the requested fractions by specifying horizontal and vertical offset via setCenterHorizontalOffset(int) and setCenterVerticalOffset(int).

Default value: 0.5

Parameters:

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

See Also:

android:centerX, getCenterXFraction(), setCenterYFraction(float), setCenterX(Float)

getCenterXFraction

public float getCenterXFraction()

Returns the fraction of the center x coordinate.

Returns:

Fraction from the [0.0, 1.0] range.

See Also:

setCenterXFraction(float)

setCenterYFraction

public void setCenterYFraction(float fractionY)

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

Sometimes the fraction is not enough to specify exact center coordinate for the reveal animation. In such case you can move the center coordinates calculated by the requested fractions by specifying horizontal and vertical offset via setCenterHorizontalOffset(int) and setCenterVerticalOffset(int).

Default value: 0.5

Parameters:

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

See Also:

android:centerY, getCenterYFraction(), setCenterXFraction(float), setCenterY(Float)

getCenterYFraction

public float getCenterYFraction()

Returns the fraction of the center y coordinate.

Returns:

Fraction from the [0.0, 1.0] range.

See Also:

setCenterYFraction(float)

onAppear

public android.animation.Animator onAppear(android.view.ViewGroup sceneRoot,
                                           android.view.View view,
                                           android.transition.TransitionValues startValues,
                                           android.transition.TransitionValues endValues)

Overrides:

onAppear in class android.transition.Visibility

onDisappear

public android.animation.Animator onDisappear(android.view.ViewGroup sceneRoot,
                                              android.view.View view,
                                              android.transition.TransitionValues startValues,
                                              android.transition.TransitionValues endValues)

Overrides:

onDisappear in class android.transition.Visibility