AnimationUtils.java

/*
 * Copyright 2018 Mauricio Colli <mauriciocolli@outlook.com>
 * AnimationUtils.java is part of NewPipe
 *
 * License: GPL-3.0+
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

package org.schabi.newpipe.util;

import android.animation.Animator;
import android.animation.AnimatorListenerAdapter;
import android.animation.ArgbEvaluator;
import android.animation.ValueAnimator;
import android.content.res.ColorStateList;
import android.util.Log;
import android.view.View;
import android.widget.TextView;

import androidx.annotation.ColorInt;
import androidx.annotation.FloatRange;
import androidx.core.view.ViewCompat;
import androidx.interpolator.view.animation.FastOutSlowInInterpolator;

import org.schabi.newpipe.MainActivity;

public final class AnimationUtils {
    private static final String TAG = "AnimationUtils";
    private static final boolean DEBUG = MainActivity.DEBUG;

    private AnimationUtils() { }

    public static void animateView(final View view, final boolean enterOrExit,
                                   final long duration) {
        animateView(view, Type.ALPHA, enterOrExit, duration, 0, null);
    }

    public static void animateView(final View view, final boolean enterOrExit,
                                   final long duration, final long delay) {
        animateView(view, Type.ALPHA, enterOrExit, duration, delay, null);
    }

    public static void animateView(final View view, final boolean enterOrExit, final long duration,
                                   final long delay, final Runnable execOnEnd) {
        animateView(view, Type.ALPHA, enterOrExit, duration, delay, execOnEnd);
    }

    public static void animateView(final View view, final Type animationType,
                                   final boolean enterOrExit, final long duration) {
        animateView(view, animationType, enterOrExit, duration, 0, null);
    }

    public static void animateView(final View view, final Type animationType,
                                   final boolean enterOrExit, final long duration,
                                   final long delay) {
        animateView(view, animationType, enterOrExit, duration, delay, null);
    }

    /**
     * Animate the view.
     *
     * @param view          view that will be animated
     * @param animationType {@link Type} of the animation
     * @param enterOrExit   true to enter, false to exit
     * @param duration      how long the animation will take, in milliseconds
     * @param delay         how long the animation will wait to start, in milliseconds
     * @param execOnEnd     runnable that will be executed when the animation ends
     */
    public static void animateView(final View view, final Type animationType,
                                   final boolean enterOrExit, final long duration,
                                   final long delay, final Runnable execOnEnd) {
        if (DEBUG) {
            String id;
            try {
                id = view.getResources().getResourceEntryName(view.getId());
            } catch (final Exception e) {
                id = view.getId() + "";
            }

            final String msg = String.format("%8s →  [%s:%s] [%s %s:%s] execOnEnd=%s", enterOrExit,
                    view.getClass().getSimpleName(), id, animationType, duration, delay, execOnEnd);
            Log.d(TAG, "animateView()" + msg);
        }

        if (view.getVisibility() == View.VISIBLE && enterOrExit) {
            if (DEBUG) {
                Log.d(TAG, "animateView() view was already visible > view = [" + view + "]");
            }
            view.animate().setListener(null).cancel();
            view.setVisibility(View.VISIBLE);
            view.setAlpha(1f);
            if (execOnEnd != null) {
                execOnEnd.run();
            }
            return;
        } else if ((view.getVisibility() == View.GONE || view.getVisibility() == View.INVISIBLE)
                && !enterOrExit) {
            if (DEBUG) {
                Log.d(TAG, "animateView() view was already gone > view = [" + view + "]");
            }
            view.animate().setListener(null).cancel();
            view.setVisibility(View.GONE);
            view.setAlpha(0f);
            if (execOnEnd != null) {
                execOnEnd.run();
            }
            return;
        }

        view.animate().setListener(null).cancel();
        view.setVisibility(View.VISIBLE);

        switch (animationType) {
            case ALPHA:
                animateAlpha(view, enterOrExit, duration, delay, execOnEnd);
                break;
            case SCALE_AND_ALPHA:
                animateScaleAndAlpha(view, enterOrExit, duration, delay, execOnEnd);
                break;
            case LIGHT_SCALE_AND_ALPHA:
                animateLightScaleAndAlpha(view, enterOrExit, duration, delay, execOnEnd);
                break;
            case SLIDE_AND_ALPHA:
                animateSlideAndAlpha(view, enterOrExit, duration, delay, execOnEnd);
                break;
            case LIGHT_SLIDE_AND_ALPHA:
                animateLightSlideAndAlpha(view, enterOrExit, duration, delay, execOnEnd);
                break;
        }
    }

    /**
     * Animate the background color of a view.
     *
     * @param view       the view to animate
     * @param duration   the duration of the animation
     * @param colorStart the background color to start with
     * @param colorEnd   the background color to end with
     */
    public static void animateBackgroundColor(final View view, final long duration,
                                              @ColorInt final int colorStart,
                                              @ColorInt final int colorEnd) {
        if (DEBUG) {
            Log.d(TAG, "animateBackgroundColor() called with: "
                    + "view = [" + view + "], duration = [" + duration + "], "
                    + "colorStart = [" + colorStart + "], colorEnd = [" + colorEnd + "]");
        }

        final int[][] empty = new int[][]{new int[0]};
        final ValueAnimator viewPropertyAnimator = ValueAnimator
                .ofObject(new ArgbEvaluator(), colorStart, colorEnd);
        viewPropertyAnimator.setInterpolator(new FastOutSlowInInterpolator());
        viewPropertyAnimator.setDuration(duration);
        viewPropertyAnimator.addUpdateListener(animation ->
                ViewCompat.setBackgroundTintList(view,
                        new ColorStateList(empty, new int[]{(int) animation.getAnimatedValue()})));
        viewPropertyAnimator.addListener(new AnimatorListenerAdapter() {
            @Override
            public void onAnimationEnd(final Animator animation) {
                ViewCompat.setBackgroundTintList(view,
                        new ColorStateList(empty, new int[]{colorEnd}));
            }

            @Override
            public void onAnimationCancel(final Animator animation) {
                onAnimationEnd(animation);
            }
        });
        viewPropertyAnimator.start();
    }

    /**
     * Animate the text color of any view that extends {@link TextView} (Buttons, EditText...).
     *
     * @param view       the text view to animate
     * @param duration   the duration of the animation
     * @param colorStart the text color to start with
     * @param colorEnd   the text color to end with
     */
    public static void animateTextColor(final TextView view, final long duration,
                                        @ColorInt final int colorStart,
                                        @ColorInt final int colorEnd) {
        if (DEBUG) {
            Log.d(TAG, "animateTextColor() called with: "
                    + "view = [" + view + "], duration = [" + duration + "], "
                    + "colorStart = [" + colorStart + "], colorEnd = [" + colorEnd + "]");
        }

        final ValueAnimator viewPropertyAnimator = ValueAnimator
                .ofObject(new ArgbEvaluator(), colorStart, colorEnd);
        viewPropertyAnimator.setInterpolator(new FastOutSlowInInterpolator());
        viewPropertyAnimator.setDuration(duration);
        viewPropertyAnimator.addUpdateListener(animation ->
                view.setTextColor((int) animation.getAnimatedValue()));
        viewPropertyAnimator.addListener(new AnimatorListenerAdapter() {
            @Override
            public void onAnimationEnd(final Animator animation) {
                view.setTextColor(colorEnd);
            }

            @Override
            public void onAnimationCancel(final Animator animation) {
                view.setTextColor(colorEnd);
            }
        });
        viewPropertyAnimator.start();
    }

    public static ValueAnimator animateHeight(final View view, final long duration,
                                              final int targetHeight) {
        final int height = view.getHeight();
        if (DEBUG) {
            Log.d(TAG, "animateHeight: duration = [" + duration + "], "
                    + "from " + height + " to → " + targetHeight + " in: " + view);
        }

        final ValueAnimator animator = ValueAnimator.ofFloat(height, targetHeight);
        animator.setInterpolator(new FastOutSlowInInterpolator());
        animator.setDuration(duration);
        animator.addUpdateListener(animation -> {
            final float value = (float) animation.getAnimatedValue();
            view.getLayoutParams().height = (int) value;
            view.requestLayout();
        });
        animator.addListener(new AnimatorListenerAdapter() {
            @Override
            public void onAnimationEnd(final Animator animation) {
                view.getLayoutParams().height = targetHeight;
                view.requestLayout();
            }

            @Override
            public void onAnimationCancel(final Animator animation) {
                view.getLayoutParams().height = targetHeight;
                view.requestLayout();
            }
        });
        animator.start();

        return animator;
    }

    public static void animateRotation(final View view, final long duration,
                                       final int targetRotation) {
        if (DEBUG) {
            Log.d(TAG, "animateRotation: duration = [" + duration + "], "
                    + "from " + view.getRotation() + " to → " + targetRotation + " in: " + view);
        }
        view.animate().setListener(null).cancel();

        view.animate()
                .rotation(targetRotation).setDuration(duration)
                .setInterpolator(new FastOutSlowInInterpolator())
                .setListener(new AnimatorListenerAdapter() {
                    @Override
                    public void onAnimationCancel(final Animator animation) {
                        view.setRotation(targetRotation);
                    }

                    @Override
                    public void onAnimationEnd(final Animator animation) {
                        view.setRotation(targetRotation);
                    }
                }).start();
    }

    private static void animateAlpha(final View view, final boolean enterOrExit,
                                     final long duration, final long delay,
                                     final Runnable execOnEnd) {
        if (enterOrExit) {
            view.animate().setInterpolator(new FastOutSlowInInterpolator()).alpha(1f)
                    .setDuration(duration).setStartDelay(delay)
                    .setListener(new AnimatorListenerAdapter() {
                @Override
                public void onAnimationEnd(final Animator animation) {
                    if (execOnEnd != null) {
                        execOnEnd.run();
                    }
                }
            }).start();
        } else {
            view.animate().setInterpolator(new FastOutSlowInInterpolator()).alpha(0f)
                    .setDuration(duration).setStartDelay(delay)
                    .setListener(new AnimatorListenerAdapter() {
                @Override
                public void onAnimationEnd(final Animator animation) {
                    view.setVisibility(View.GONE);
                    if (execOnEnd != null) {
                        execOnEnd.run();
                    }
                }
            }).start();
        }
    }

    /*//////////////////////////////////////////////////////////////////////////
    // Internals
    //////////////////////////////////////////////////////////////////////////*/

    private static void animateScaleAndAlpha(final View view, final boolean enterOrExit,
                                             final long duration, final long delay,
                                             final Runnable execOnEnd) {
        if (enterOrExit) {
            view.setScaleX(.8f);
            view.setScaleY(.8f);
            view.animate()
                    .setInterpolator(new FastOutSlowInInterpolator())
                    .alpha(1f).scaleX(1f).scaleY(1f)
                    .setDuration(duration).setStartDelay(delay)
                    .setListener(new AnimatorListenerAdapter() {
                @Override
                public void onAnimationEnd(final Animator animation) {
                    if (execOnEnd != null) {
                        execOnEnd.run();
                    }
                }
            }).start();
        } else {
            view.setScaleX(1f);
            view.setScaleY(1f);
            view.animate()
                    .setInterpolator(new FastOutSlowInInterpolator())
                    .alpha(0f).scaleX(.8f).scaleY(.8f)
                    .setDuration(duration).setStartDelay(delay)
                    .setListener(new AnimatorListenerAdapter() {
                @Override
                public void onAnimationEnd(final Animator animation) {
                    view.setVisibility(View.GONE);
                    if (execOnEnd != null) {
                        execOnEnd.run();
                    }
                }
            }).start();
        }
    }

    private static void animateLightScaleAndAlpha(final View view, final boolean enterOrExit,
                                                  final long duration, final long delay,
                                                  final Runnable execOnEnd) {
        if (enterOrExit) {
            view.setAlpha(.5f);
            view.setScaleX(.95f);
            view.setScaleY(.95f);
            view.animate()
                    .setInterpolator(new FastOutSlowInInterpolator())
                    .alpha(1f).scaleX(1f).scaleY(1f)
                    .setDuration(duration).setStartDelay(delay)
                    .setListener(new AnimatorListenerAdapter() {
                @Override
                public void onAnimationEnd(final Animator animation) {
                    if (execOnEnd != null) {
                        execOnEnd.run();
                    }
                }
            }).start();
        } else {
            view.setAlpha(1f);
            view.setScaleX(1f);
            view.setScaleY(1f);
            view.animate()
                    .setInterpolator(new FastOutSlowInInterpolator())
                    .alpha(0f).scaleX(.95f).scaleY(.95f)
                    .setDuration(duration).setStartDelay(delay)
                    .setListener(new AnimatorListenerAdapter() {
                @Override
                public void onAnimationEnd(final Animator animation) {
                    view.setVisibility(View.GONE);
                    if (execOnEnd != null) {
                        execOnEnd.run();
                    }
                }
            }).start();
        }
    }

    private static void animateSlideAndAlpha(final View view, final boolean enterOrExit,
                                             final long duration, final long delay,
                                             final Runnable execOnEnd) {
        if (enterOrExit) {
            view.setTranslationY(-view.getHeight());
            view.setAlpha(0f);
            view.animate()
                    .setInterpolator(new FastOutSlowInInterpolator()).alpha(1f).translationY(0)
                    .setDuration(duration).setStartDelay(delay)
                    .setListener(new AnimatorListenerAdapter() {
                @Override
                public void onAnimationEnd(final Animator animation) {
                    if (execOnEnd != null) {
                        execOnEnd.run();
                    }
                }
            }).start();
        } else {
            view.animate()
                    .setInterpolator(new FastOutSlowInInterpolator())
                    .alpha(0f).translationY(-view.getHeight())
                    .setDuration(duration).setStartDelay(delay)
                    .setListener(new AnimatorListenerAdapter() {
                @Override
                public void onAnimationEnd(final Animator animation) {
                    view.setVisibility(View.GONE);
                    if (execOnEnd != null) {
                        execOnEnd.run();
                    }
                }
            }).start();
        }
    }

    private static void animateLightSlideAndAlpha(final View view, final boolean enterOrExit,
                                                  final long duration, final long delay,
                                                  final Runnable execOnEnd) {
        if (enterOrExit) {
            view.setTranslationY(-view.getHeight() / 2.0f);
            view.setAlpha(0f);
            view.animate()
                    .setInterpolator(new FastOutSlowInInterpolator()).alpha(1f).translationY(0)
                    .setDuration(duration).setStartDelay(delay)
                    .setListener(new AnimatorListenerAdapter() {
                @Override
                public void onAnimationEnd(final Animator animation) {
                    if (execOnEnd != null) {
                        execOnEnd.run();
                    }
                }
            }).start();
        } else {
            view.animate().setInterpolator(new FastOutSlowInInterpolator())
                    .alpha(0f).translationY(-view.getHeight() / 2.0f)
                    .setDuration(duration).setStartDelay(delay)
                    .setListener(new AnimatorListenerAdapter() {
                @Override
                public void onAnimationEnd(final Animator animation) {
                    view.setVisibility(View.GONE);
                    if (execOnEnd != null) {
                        execOnEnd.run();
                    }
                }
            }).start();
        }
    }

    public static void slideUp(final View view, final long duration, final long delay,
                               @FloatRange(from = 0.0f, to = 1.0f)
                               final float translationPercent) {
        final int translationY = (int) (view.getResources().getDisplayMetrics().heightPixels
                * (translationPercent));

        view.animate().setListener(null).cancel();
        view.setAlpha(0f);
        view.setTranslationY(translationY);
        view.setVisibility(View.VISIBLE);
        view.animate()
                .alpha(1f)
                .translationY(0)
                .setStartDelay(delay)
                .setDuration(duration)
                .setInterpolator(new FastOutSlowInInterpolator())
                .start();
    }

    public enum Type {
        ALPHA,
        SCALE_AND_ALPHA, LIGHT_SCALE_AND_ALPHA,
        SLIDE_AND_ALPHA, LIGHT_SLIDE_AND_ALPHA
    }
}