blob: 64f77a2cc4ce71a24d3e88e0b272181893f37d88 [file] [log] [blame]
Jorim Jaggi21c39a72017-10-20 15:47:51 +02001/*
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 */
16
17package com.android.server.wm;
18
19import android.annotation.ColorInt;
20import android.graphics.Point;
21import android.view.SurfaceControl;
22import android.view.SurfaceControl.Transaction;
23import android.view.animation.Animation;
24
25import com.android.server.wm.SurfaceAnimator.OnAnimationFinishedCallback;
26
27/**
28 * Interface that describes an animation and bridges the animation start to the component
29 * responsible for running the animation.
30 */
31interface AnimationAdapter {
32
Jorim Jaggif5f9e122017-10-24 18:21:09 +020033 long STATUS_BAR_TRANSITION_DURATION = 120L;
34
Jorim Jaggi21c39a72017-10-20 15:47:51 +020035 /**
36 * @return Whether we should detach the wallpaper during the animation.
37 * @see Animation#setDetachWallpaper
38 */
39 boolean getDetachWallpaper();
40
41 /**
Jorim Jaggi82c17862018-02-21 17:50:18 +010042 * @return Whether we should show the wallpaper during the animation.
43 * @see Animation#getShowWallpaper()
44 */
45 boolean getShowWallpaper();
46
47 /**
Jorim Jaggi21c39a72017-10-20 15:47:51 +020048 * @return The background color behind the animation.
49 */
50 @ColorInt int getBackgroundColor();
51
52 /**
53 * Requests to start the animation.
54 *
55 * @param animationLeash The surface to run the animation on. See {@link SurfaceAnimator} for an
56 * overview of the mechanism. This surface needs to be released by the
57 * component running the animation after {@code finishCallback} has been
58 * invoked, or after the animation was cancelled.
59 * @param t The Transaction to apply the initial frame of the animation.
60 * @param finishCallback The callback to be invoked when the animation has finished.
61 */
62 void startAnimation(SurfaceControl animationLeash, Transaction t,
63 OnAnimationFinishedCallback finishCallback);
64
65 /**
66 * Called when the animation that was started with {@link #startAnimation} was cancelled by the
67 * window manager.
68 *
69 * @param animationLeash The leash passed to {@link #startAnimation}.
70 */
71 void onAnimationCancelled(SurfaceControl animationLeash);
72
73 /**
74 * @return The approximate duration of the animation, in milliseconds.
75 */
76 long getDurationHint();
Jorim Jaggif5f9e122017-10-24 18:21:09 +020077
78 /**
79 * If this animation is run as an app opening animation, this calculates the start time for all
80 * status bar transitions that happen as part of the app opening animation, which will be
81 * forwarded to SystemUI.
82 *
83 * @return the desired start time of the status bar transition, in uptime millis
84 */
85 long getStatusBarTransitionsStartTime();
Jorim Jaggi21c39a72017-10-20 15:47:51 +020086}