1 /* 2 * Copyright (C) 2020 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package com.android.launcher3.states; 17 18 import android.view.animation.Interpolator; 19 20 import androidx.annotation.IntDef; 21 22 import java.lang.annotation.Retention; 23 import java.lang.annotation.RetentionPolicy; 24 25 /** 26 * Utility class for building animator set 27 */ 28 public class StateAnimationConfig { 29 30 @IntDef(flag = true, value = { 31 SKIP_ALL_ANIMATIONS, 32 SKIP_OVERVIEW, 33 SKIP_DEPTH_CONTROLLER, 34 SKIP_SCRIM, 35 }) 36 @Retention(RetentionPolicy.SOURCE) 37 public @interface AnimationFlags {} 38 public static final int SKIP_ALL_ANIMATIONS = 1 << 0; 39 public static final int SKIP_OVERVIEW = 1 << 1; 40 public static final int SKIP_DEPTH_CONTROLLER = 1 << 2; 41 public static final int SKIP_SCRIM = 1 << 3; 42 43 public long duration; 44 public boolean userControlled; 45 public @AnimationFlags int animFlags = 0; 46 47 48 // Various types of animation state transition 49 @IntDef(value = { 50 ANIM_VERTICAL_PROGRESS, 51 ANIM_WORKSPACE_SCALE, 52 ANIM_WORKSPACE_TRANSLATE, 53 ANIM_WORKSPACE_FADE, 54 ANIM_HOTSEAT_SCALE, 55 ANIM_HOTSEAT_TRANSLATE, 56 ANIM_HOTSEAT_FADE, 57 ANIM_OVERVIEW_SCALE, 58 ANIM_OVERVIEW_TRANSLATE_X, 59 ANIM_OVERVIEW_TRANSLATE_Y, 60 ANIM_OVERVIEW_FADE, 61 ANIM_ALL_APPS_FADE, 62 ANIM_SCRIM_FADE, 63 ANIM_OVERVIEW_MODAL, 64 ANIM_DEPTH, 65 ANIM_OVERVIEW_ACTIONS_FADE, 66 ANIM_WORKSPACE_PAGE_TRANSLATE_X, 67 ANIM_OVERVIEW_SPLIT_SELECT_FLOATING_TASK_TRANSLATE_OFFSCREEN, 68 ANIM_OVERVIEW_SPLIT_SELECT_INSTRUCTIONS_FADE 69 }) 70 @Retention(RetentionPolicy.SOURCE) 71 public @interface AnimType {} 72 public static final int ANIM_VERTICAL_PROGRESS = 0; 73 public static final int ANIM_WORKSPACE_SCALE = 1; 74 public static final int ANIM_WORKSPACE_TRANSLATE = 2; 75 public static final int ANIM_WORKSPACE_FADE = 3; 76 public static final int ANIM_HOTSEAT_SCALE = 4; 77 public static final int ANIM_HOTSEAT_TRANSLATE = 5; 78 public static final int ANIM_HOTSEAT_FADE = 16; 79 public static final int ANIM_OVERVIEW_SCALE = 6; 80 public static final int ANIM_OVERVIEW_TRANSLATE_X = 7; 81 public static final int ANIM_OVERVIEW_TRANSLATE_Y = 8; 82 public static final int ANIM_OVERVIEW_FADE = 9; 83 public static final int ANIM_ALL_APPS_FADE = 10; 84 public static final int ANIM_SCRIM_FADE = 11; 85 public static final int ANIM_OVERVIEW_MODAL = 12; 86 public static final int ANIM_DEPTH = 13; 87 public static final int ANIM_OVERVIEW_ACTIONS_FADE = 14; 88 public static final int ANIM_WORKSPACE_PAGE_TRANSLATE_X = 15; 89 public static final int ANIM_OVERVIEW_SPLIT_SELECT_FLOATING_TASK_TRANSLATE_OFFSCREEN = 17; 90 public static final int ANIM_OVERVIEW_SPLIT_SELECT_INSTRUCTIONS_FADE = 18; 91 92 private static final int ANIM_TYPES_COUNT = 19; 93 94 protected final Interpolator[] mInterpolators = new Interpolator[ANIM_TYPES_COUNT]; 95 StateAnimationConfig()96 public StateAnimationConfig() { } 97 98 /** 99 * Copies the config to target 100 */ copyTo(StateAnimationConfig target)101 public void copyTo(StateAnimationConfig target) { 102 target.duration = duration; 103 target.animFlags = animFlags; 104 target.userControlled = userControlled; 105 for (int i = 0; i < ANIM_TYPES_COUNT; i++) { 106 target.mInterpolators[i] = mInterpolators[i]; 107 } 108 } 109 110 /** 111 * Returns the interpolator set for animId or fallback if nothing is set 112 * 113 * @see #setInterpolator(int, Interpolator) 114 */ getInterpolator(@nimType int animId, Interpolator fallback)115 public Interpolator getInterpolator(@AnimType int animId, Interpolator fallback) { 116 return mInterpolators[animId] == null ? fallback : mInterpolators[animId]; 117 } 118 119 /** 120 * Sets an interpolator for a given animation type 121 */ setInterpolator(@nimType int animId, Interpolator interpolator)122 public void setInterpolator(@AnimType int animId, Interpolator interpolator) { 123 mInterpolators[animId] = interpolator; 124 } 125 126 /** 127 * Returns true if the config and any of the provided component flags 128 */ hasAnimationFlag(@nimationFlags int a)129 public boolean hasAnimationFlag(@AnimationFlags int a) { 130 return (animFlags & a) != 0; 131 } 132 } 133