blob: 58df9c8f64340278227694664efd7bf064f0e776 [file] [log] [blame]
Sunny Goyal4c7f2152017-10-17 17:17:16 -07001/*
2 * Copyright (C) 2017 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 */
16package com.android.launcher3;
17
Sunny Goyal210e1742019-10-17 12:05:38 -070018import static com.android.launcher3.anim.Interpolators.ACCEL_2;
Winson Chungf9935182020-10-23 09:26:44 -070019import static com.android.launcher3.logging.StatsLogManager.LAUNCHER_STATE_HOME;
Tony Wickhamc5d168d2021-03-25 09:28:19 -070020import static com.android.launcher3.logging.StatsLogManager.LAUNCHER_STATE_OVERVIEW;
Sunny Goyalab3963d2019-05-23 00:50:08 -070021import static com.android.launcher3.testing.TestProtocol.ALL_APPS_STATE_ORDINAL;
22import static com.android.launcher3.testing.TestProtocol.BACKGROUND_APP_STATE_ORDINAL;
Tony Wickham4fdba142019-11-04 16:23:51 -080023import static com.android.launcher3.testing.TestProtocol.HINT_STATE_ORDINAL;
Tony Wickhamc5d168d2021-03-25 09:28:19 -070024import static com.android.launcher3.testing.TestProtocol.HINT_STATE_TWO_BUTTON_ORDINAL;
Sunny Goyalab3963d2019-05-23 00:50:08 -070025import static com.android.launcher3.testing.TestProtocol.NORMAL_STATE_ORDINAL;
Zak Cohena39544d2020-04-27 16:26:55 -070026import static com.android.launcher3.testing.TestProtocol.OVERVIEW_MODAL_TASK_STATE_ORDINAL;
Vinit Nayakd987a822021-02-22 14:49:27 -080027import static com.android.launcher3.testing.TestProtocol.OVERVIEW_SPLIT_SELECT_ORDINAL;
Sunny Goyalab3963d2019-05-23 00:50:08 -070028import static com.android.launcher3.testing.TestProtocol.OVERVIEW_STATE_ORDINAL;
29import static com.android.launcher3.testing.TestProtocol.QUICK_SWITCH_STATE_ORDINAL;
30import static com.android.launcher3.testing.TestProtocol.SPRING_LOADED_STATE_ORDINAL;
Sunny Goyal0c723352017-12-12 12:02:29 -080031
Winson Chung8687bc22020-02-27 23:34:24 -080032import android.content.Context;
Sunny Goyal0c723352017-12-12 12:02:29 -080033import android.view.animation.Interpolator;
Sunny Goyalbe93f262017-10-20 17:05:27 -070034
Sunny Goyal35e7d382020-05-08 13:37:58 -070035import com.android.launcher3.statemanager.BaseState;
36import com.android.launcher3.statemanager.StateManager;
Tony Wickham4fdba142019-11-04 16:23:51 -080037import com.android.launcher3.states.HintState;
Sunny Goyalc99cb172017-10-19 16:15:09 -070038import com.android.launcher3.states.SpringLoadedState;
Tony Wickhamf844ee92020-05-27 15:41:32 -050039import com.android.launcher3.testing.TestProtocol;
Tonye06fef42019-03-22 15:44:28 -050040import com.android.launcher3.uioverrides.states.AllAppsState;
41import com.android.launcher3.uioverrides.states.OverviewState;
Sunny Goyal4c7f2152017-10-17 17:17:16 -070042
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070043import java.util.Arrays;
44
Sunny Goyal4c7f2152017-10-17 17:17:16 -070045/**
Sunny Goyalbe93f262017-10-20 17:05:27 -070046 * Base state for various states used for the Launcher
Sunny Goyal4c7f2152017-10-17 17:17:16 -070047 */
Sunny Goyal35e7d382020-05-08 13:37:58 -070048public abstract class LauncherState implements BaseState<LauncherState> {
Sunny Goyal4c7f2152017-10-17 17:17:16 -070049
Sunny Goyal7185dd62018-03-14 17:51:49 -070050 /**
51 * Set of elements indicating various workspace elements which change visibility across states
52 * Note that workspace is not included here as in that case, we animate individual pages
53 */
54 public static final int NONE = 0;
Tony Wickhambd6f05e2018-03-21 08:16:33 -070055 public static final int HOTSEAT_ICONS = 1 << 0;
Sunny Goyalc373e1c2021-03-09 17:27:53 -080056 public static final int ALL_APPS_CONTENT = 1 << 1;
57 public static final int VERTICAL_SWIPE_INDICATOR = 1 << 2;
58 public static final int OVERVIEW_ACTIONS = 1 << 3;
59 public static final int TASKBAR = 1 << 4;
60 public static final int CLEAR_ALL_BUTTON = 1 << 5;
61 public static final int WORKSPACE_PAGE_INDICATOR = 1 << 6;
62 public static final int SPLIT_PLACHOLDER_VIEW = 1 << 7;
Zak Cohen43a16152020-02-25 14:29:37 -080063
Sunny Goyal8f965462020-04-23 19:00:36 -070064 // Flag indicating workspace has multiple pages visible.
Sunny Goyal35e7d382020-05-08 13:37:58 -070065 public static final int FLAG_MULTI_PAGE = BaseState.getFlag(0);
Sunny Goyal8f965462020-04-23 19:00:36 -070066 // Flag indicating that workspace and its contents are not accessible
Sunny Goyal35e7d382020-05-08 13:37:58 -070067 public static final int FLAG_WORKSPACE_INACCESSIBLE = BaseState.getFlag(1);
Sunny Goyal8f965462020-04-23 19:00:36 -070068
Sunny Goyal8f965462020-04-23 19:00:36 -070069 // Flag indicating the state allows workspace icons to be dragged.
Sunny Goyal35e7d382020-05-08 13:37:58 -070070 public static final int FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED = BaseState.getFlag(2);
Sunny Goyal8f965462020-04-23 19:00:36 -070071 // Flag to indicate that workspace should draw page background
Sunny Goyal35e7d382020-05-08 13:37:58 -070072 public static final int FLAG_WORKSPACE_HAS_BACKGROUNDS = BaseState.getFlag(3);
Sunny Goyal8f965462020-04-23 19:00:36 -070073 // True if the back button should be hidden when in this state (assuming no floating views are
74 // open, launcher has window focus, etc).
Sunny Goyal35e7d382020-05-08 13:37:58 -070075 public static final int FLAG_HIDE_BACK_BUTTON = BaseState.getFlag(4);
Sunny Goyal8f965462020-04-23 19:00:36 -070076 // Flag to indicate if the state would have scrim over sysui region: statu sbar and nav bar
Sunny Goyal35e7d382020-05-08 13:37:58 -070077 public static final int FLAG_HAS_SYS_UI_SCRIM = BaseState.getFlag(5);
Sunny Goyal8f965462020-04-23 19:00:36 -070078 // Flag to inticate that all popups should be closed when this state is enabled.
Sunny Goyal35e7d382020-05-08 13:37:58 -070079 public static final int FLAG_CLOSE_POPUPS = BaseState.getFlag(6);
80 public static final int FLAG_OVERVIEW_UI = BaseState.getFlag(7);
Sunny Goyal8f965462020-04-23 19:00:36 -070081
Sunny Goyal6c6c2f42018-03-02 14:57:46 -080082
Sunny Goyalf2393f12020-04-01 20:13:12 -070083 public static final float NO_OFFSET = 0;
84 public static final float NO_SCALE = 1;
85
Sunny Goyal0c723352017-12-12 12:02:29 -080086 protected static final PageAlphaProvider DEFAULT_ALPHA_PROVIDER =
87 new PageAlphaProvider(ACCEL_2) {
88 @Override
89 public float getPageAlpha(int pageIndex) {
90 return 1;
91 }
92 };
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070093
Tony Wickhamc5d168d2021-03-25 09:28:19 -070094 private static final LauncherState[] sAllStates = new LauncherState[10];
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -070095
Sunny Goyal75c59ac2018-01-15 14:23:11 -080096 /**
97 * TODO: Create a separate class for NORMAL state.
98 */
vadimt6895e402019-02-15 16:42:14 -080099 public static final LauncherState NORMAL = new LauncherState(NORMAL_STATE_ORDINAL,
Winson Chungf9935182020-10-23 09:26:44 -0700100 LAUNCHER_STATE_HOME,
Sunny Goyal5d1873a2018-05-08 11:10:44 -0700101 FLAG_DISABLE_RESTORE | FLAG_WORKSPACE_ICONS_CAN_BE_DRAGGED | FLAG_HIDE_BACK_BUTTON |
Tony Wickhamc7203ad2020-02-03 18:36:06 -0800102 FLAG_HAS_SYS_UI_SCRIM) {
103 @Override
Sunny Goyal8f965462020-04-23 19:00:36 -0700104 public int getTransitionDuration(Context context) {
Tony Wickhamc7203ad2020-02-03 18:36:06 -0800105 // Arbitrary duration, when going to NORMAL we use the state we're coming from instead.
106 return 0;
107 }
108 };
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700109
Sunny Goyal7185dd62018-03-14 17:51:49 -0700110 /**
111 * Various Launcher states arranged in the increasing order of UI layers
112 */
vadimt2a648aa2019-02-14 17:47:11 -0800113 public static final LauncherState SPRING_LOADED = new SpringLoadedState(
114 SPRING_LOADED_STATE_ORDINAL);
vadimt2a648aa2019-02-14 17:47:11 -0800115 public static final LauncherState ALL_APPS = new AllAppsState(ALL_APPS_STATE_ORDINAL);
Tony Wickham4fdba142019-11-04 16:23:51 -0800116 public static final LauncherState HINT_STATE = new HintState(HINT_STATE_ORDINAL);
Tony Wickhamc5d168d2021-03-25 09:28:19 -0700117 public static final LauncherState HINT_STATE_TWO_BUTTON = new HintState(
118 HINT_STATE_TWO_BUTTON_ORDINAL, LAUNCHER_STATE_OVERVIEW);
Tony1787ee92019-03-20 12:38:35 -0500119
120 public static final LauncherState OVERVIEW = new OverviewState(OVERVIEW_STATE_ORDINAL);
Zak Cohena39544d2020-04-27 16:26:55 -0700121 public static final LauncherState OVERVIEW_MODAL_TASK = OverviewState.newModalTaskState(
122 OVERVIEW_MODAL_TASK_STATE_ORDINAL);
Tonye4c2e2b2019-03-25 10:23:39 -0500123 public static final LauncherState QUICK_SWITCH =
124 OverviewState.newSwitchState(QUICK_SWITCH_STATE_ORDINAL);
Tony1787ee92019-03-20 12:38:35 -0500125 public static final LauncherState BACKGROUND_APP =
126 OverviewState.newBackgroundState(BACKGROUND_APP_STATE_ORDINAL);
Vinit Nayakd987a822021-02-22 14:49:27 -0800127 public static final LauncherState OVERVIEW_SPLIT_SELECT =
128 OverviewState.newSplitSelectState(OVERVIEW_SPLIT_SELECT_ORDINAL);
Tony Wickham6becf7c2018-04-19 11:39:34 -0700129
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700130 public final int ordinal;
131
Sunny Goyalf9403d92017-10-18 10:55:56 -0700132 /**
Winson Chungf9935182020-10-23 09:26:44 -0700133 * Used for {@link com.android.launcher3.logging.StatsLogManager}
Sunny Goyalf9403d92017-10-18 10:55:56 -0700134 */
Winson Chungf9935182020-10-23 09:26:44 -0700135 public final int statsLogOrdinal;
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700136
Sunny Goyalf9403d92017-10-18 10:55:56 -0700137 /**
Sunny Goyal6c6c2f42018-03-02 14:57:46 -0800138 * True if the state has overview panel visible.
139 */
140 public final boolean overviewUi;
141
Sunny Goyal8f965462020-04-23 19:00:36 -0700142 private final int mFlags;
Sunny Goyal5d1873a2018-05-08 11:10:44 -0700143
Winson Chungf9935182020-10-23 09:26:44 -0700144 public LauncherState(int id, int statsLogOrdinal, int flags) {
145 this.statsLogOrdinal = statsLogOrdinal;
Sunny Goyal8f965462020-04-23 19:00:36 -0700146 this.mFlags = flags;
Sunny Goyal6c6c2f42018-03-02 14:57:46 -0800147 this.overviewUi = (flags & FLAG_OVERVIEW_UI) != 0;
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700148 this.ordinal = id;
149 sAllStates[id] = this;
150 }
151
Sunny Goyal8f965462020-04-23 19:00:36 -0700152 /**
153 * Returns if the state has the provided flag
154 */
Sunny Goyal35e7d382020-05-08 13:37:58 -0700155 @Override
Sunny Goyal8f965462020-04-23 19:00:36 -0700156 public final boolean hasFlag(int mask) {
157 return (mFlags & mask) != 0;
158 }
159
Sunny Goyalcd7c0aa2017-10-19 12:36:27 -0700160 public static LauncherState[] values() {
161 return Arrays.copyOf(sAllStates, sAllStates.length);
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700162 }
Sunny Goyalc99cb172017-10-19 16:15:09 -0700163
Tonybc234402019-03-19 13:30:25 -0500164 public ScaleAndTranslation getWorkspaceScaleAndTranslation(Launcher launcher) {
Sunny Goyalf2393f12020-04-01 20:13:12 -0700165 return new ScaleAndTranslation(NO_SCALE, NO_OFFSET, NO_OFFSET);
Sunny Goyalc99cb172017-10-19 16:15:09 -0700166 }
167
Tonybc234402019-03-19 13:30:25 -0500168 public ScaleAndTranslation getHotseatScaleAndTranslation(Launcher launcher) {
Tony Wickham57e489c2019-03-04 14:57:07 -0800169 // For most states, treat the hotseat as if it were part of the workspace.
170 return getWorkspaceScaleAndTranslation(launcher);
Tony4bb4b892019-03-03 15:32:12 -0800171 }
172
Sunny Goyalf2393f12020-04-01 20:13:12 -0700173 /**
174 * Returns an array of two elements.
Samuel Fufa2ea01e42020-12-02 13:48:18 -0600175 * The first specifies the scale for the overview
176 * The second is the factor ([0, 1], 0 => center-screen; 1 => offscreen) by which overview
177 * should be shifted horizontally.
Sunny Goyalf2393f12020-04-01 20:13:12 -0700178 */
179 public float[] getOverviewScaleAndOffset(Launcher launcher) {
180 return launcher.getNormalOverviewScaleAndOffset();
Tony3bb5e8e2018-03-14 12:05:00 +0000181 }
182
Tony Wickham02e9f1e2021-03-22 17:32:50 -0700183 public float getTaskbarScale(Launcher launcher) {
184 return launcher.getNormalTaskbarScale();
185 }
186
Tony Wickham81f81752021-04-07 11:06:40 -0700187 public float getTaskbarTranslationY(Launcher launcher) {
188 return -launcher.getHotseat().getTaskbarOffsetY();
189 }
190
Tony54068172019-05-12 13:24:51 -0500191 public float getOverviewFullscreenProgress() {
192 return 0;
193 }
194
Sunny Goyal7185dd62018-03-14 17:51:49 -0700195 public int getVisibleElements(Launcher launcher) {
Tony Wickham9ce3b252021-03-22 14:43:58 -0700196 return HOTSEAT_ICONS | WORKSPACE_PAGE_INDICATOR | VERTICAL_SWIPE_INDICATOR | TASKBAR;
Sunny Goyal7185dd62018-03-14 17:51:49 -0700197 }
198
Sunny Goyal228153d2018-01-04 15:35:22 -0800199 /**
Tony Wickhama29a0462021-03-02 12:28:25 -0800200 * A shorthand for checking getVisibleElements() & elements == elements.
201 * @return Whether all of the given elements are visible.
202 */
203 public boolean areElementsVisible(Launcher launcher, int elements) {
204 return (getVisibleElements(launcher) & elements) == elements;
205 }
206
207 /**
Sunny Goyal228153d2018-01-04 15:35:22 -0800208 * Fraction shift in the vertical translation UI and related properties
209 *
210 * @see com.android.launcher3.allapps.AllAppsTransitionController
211 */
212 public float getVerticalProgress(Launcher launcher) {
213 return 1f;
214 }
215
Sunny Goyalc82916f2021-04-06 13:03:54 -0700216 public float getWorkspaceBackgroundAlpha(Launcher launcher) {
Sunny Goyal927447e2018-05-04 13:19:29 -0700217 return 0;
218 }
219
Sunny Goyalc82916f2021-04-06 13:03:54 -0700220 public float getWorkspaceScrimAlpha(Launcher launcher) {
Tony Wickhamc0880512019-07-24 17:32:08 -0700221 return 0;
222 }
223
Winson Chung8687bc22020-02-27 23:34:24 -0800224 /**
Zak Cohena39544d2020-04-27 16:26:55 -0700225 * For this state, how modal should over view been shown. 0 modalness means all tasks drawn,
226 * 1 modalness means the current task is show on its own.
227 */
228 public float getOverviewModalness() {
229 return 0;
230 }
231
232 /**
Vinit Nayakd987a822021-02-22 14:49:27 -0800233 * For this state, how much additional vertical translation there should be for each of the
234 * child TaskViews.
235 */
236 public float getOverviewSecondaryTranslation(Launcher launcher) {
237 return 0;
238 }
239
240 /**
Lucas Dupin4918ed32020-03-17 17:11:32 -0700241 * The amount of blur and wallpaper zoom to apply to the background of either the app
242 * or Launcher surface in this state. Should be a number between 0 and 1, inclusive.
243 *
244 * 0 means completely zoomed in, without blurs. 1 is zoomed out, with blurs.
Winson Chung8687bc22020-02-27 23:34:24 -0800245 */
Winson Chungb330d6e2020-04-20 11:57:11 -0700246 public final float getDepth(Context context) {
Jon Miranda36d10152020-06-19 16:35:08 -0700247 return getDepth(context,
248 BaseDraggingActivity.fromContext(context).getDeviceProfile().isMultiWindowMode);
249 }
250
251 /**
252 * Returns the amount of blur and wallpaper zoom for this state with {@param isMultiWindowMode}.
Samuel Fufa2ea01e42020-12-02 13:48:18 -0600253 *
Jon Miranda36d10152020-06-19 16:35:08 -0700254 * @see #getDepth(Context).
255 */
256 public final float getDepth(Context context, boolean isMultiWindowMode) {
257 if (isMultiWindowMode) {
Winson Chungb330d6e2020-04-20 11:57:11 -0700258 return 0;
259 }
260 return getDepthUnchecked(context);
261 }
262
263 protected float getDepthUnchecked(Context context) {
Lucas Dupin4918ed32020-03-17 17:11:32 -0700264 return 0f;
Winson Chung8687bc22020-02-27 23:34:24 -0800265 }
266
Sunny Goyal3e3f44c2017-10-23 17:14:52 -0700267 public String getDescription(Launcher launcher) {
268 return launcher.getWorkspace().getCurrentPageDescription();
269 }
270
Sunny Goyalbc683e92017-12-06 10:25:07 -0800271 public PageAlphaProvider getWorkspacePageAlphaProvider(Launcher launcher) {
Jon Mirandae3832222020-07-06 15:38:38 -0700272 if ((this != NORMAL && this != HINT_STATE)
273 || !launcher.getDeviceProfile().shouldFadeAdjacentWorkspaceScreens()) {
Sunny Goyalbc683e92017-12-06 10:25:07 -0800274 return DEFAULT_ALPHA_PROVIDER;
275 }
Sunny Goyal228153d2018-01-04 15:35:22 -0800276 final int centerPage = launcher.getWorkspace().getNextPage();
Sunny Goyal0c723352017-12-12 12:02:29 -0800277 return new PageAlphaProvider(ACCEL_2) {
278 @Override
279 public float getPageAlpha(int pageIndex) {
Samuel Fufa2ea01e42020-12-02 13:48:18 -0600280 return pageIndex != centerPage ? 0 : 1f;
Sunny Goyal0c723352017-12-12 12:02:29 -0800281 }
282 };
Sunny Goyalbc683e92017-12-06 10:25:07 -0800283 }
284
Sunny Goyal35e7d382020-05-08 13:37:58 -0700285 @Override
Sunny Goyal49bcf342018-01-11 13:59:53 -0800286 public LauncherState getHistoryForState(LauncherState previousState) {
287 // No history is supported
288 return NORMAL;
289 }
290
Sunny Goyal35e7d382020-05-08 13:37:58 -0700291 @Override
292 public String toString() {
Tony Wickhamf844ee92020-05-27 15:41:32 -0500293 return TestProtocol.stateOrdinalToString(ordinal);
Sunny Goyal35e7d382020-05-08 13:37:58 -0700294 }
295
Sunny Goyale39690b2018-08-02 13:35:07 -0700296 public void onBackPressed(Launcher launcher) {
297 if (this != NORMAL) {
Sunny Goyal35e7d382020-05-08 13:37:58 -0700298 StateManager<LauncherState> lsm = launcher.getStateManager();
Sunny Goyale39690b2018-08-02 13:35:07 -0700299 LauncherState lastState = lsm.getLastState();
Sunny Goyale39690b2018-08-02 13:35:07 -0700300 lsm.goToState(lastState);
301 }
302 }
303
Sunny Goyal0c723352017-12-12 12:02:29 -0800304 public static abstract class PageAlphaProvider {
Sunny Goyalbc683e92017-12-06 10:25:07 -0800305
Sunny Goyal0c723352017-12-12 12:02:29 -0800306 public final Interpolator interpolator;
307
308 public PageAlphaProvider(Interpolator interpolator) {
309 this.interpolator = interpolator;
310 }
311
312 public abstract float getPageAlpha(int pageIndex);
Sunny Goyalbc683e92017-12-06 10:25:07 -0800313 }
Tonybc234402019-03-19 13:30:25 -0500314
315 public static class ScaleAndTranslation {
316 public float scale;
317 public float translationX;
318 public float translationY;
319
320 public ScaleAndTranslation(float scale, float translationX, float translationY) {
321 this.scale = scale;
322 this.translationX = translationX;
323 this.translationY = translationY;
324 }
325 }
Sunny Goyal4c7f2152017-10-17 17:17:16 -0700326}