home_screen_presenter.cc

// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "ash/home_screen/home_screen_presenter.h"

#include <string>
#include <utility>

#include "ash/home_screen/home_screen_controller.h"
#include "ash/home_screen/home_screen_delegate.h"
#include "ash/public/cpp/ash_features.h"
#include "ash/wm/window_util.h"
#include "base/bind.h"
#include "base/bind_helpers.h"
#include "base/check.h"
#include "base/optional.h"
#include "base/time/time.h"
#include "ui/aura/window.h"
#include "ui/compositor/layer.h"
#include "ui/compositor/layer_animation_element.h"
#include "ui/compositor/layer_animator.h"
#include "ui/compositor/scoped_layer_animation_settings.h"
#include "ui/gfx/animation/tween.h"

namespace ash {
namespace {

// The y offset for home screen animation when overview mode toggles using slide
// animation.
constexpr int kOverviewSlideAnimationYOffset = 100;

// The duration in milliseconds for home screen animation when overview mode
// toggles using fade animation.
constexpr base::TimeDelta kOverviewSlideAnimationDuration =
    base::TimeDelta::FromMilliseconds(250);

// The target scale to which (or from which) the home screen will animate when
// overview is being shown (or hidden) using fade transitions while home screen
// is shown.
constexpr float kOverviewFadeAnimationScale = 0.92f;

// The home screen animation duration for transitions that accompany overview
// fading transitions.
constexpr base::TimeDelta kOverviewFadeAnimationDuration =
    base::TimeDelta::FromMilliseconds(350);

base::TimeDelta GetAnimationDurationForTransition(
    HomeScreenPresenter::TransitionType transition) {
  switch (transition) {
    case HomeScreenPresenter::TransitionType::kSlideHomeIn:
    case HomeScreenPresenter::TransitionType::kSlideHomeOut:
      return kOverviewSlideAnimationDuration;
    case HomeScreenPresenter::TransitionType::kScaleHomeIn:
    case HomeScreenPresenter::TransitionType::kScaleHomeOut:
      return kOverviewFadeAnimationDuration;
  }
}

HomeScreenPresenter::TransitionType GetOppositeTransition(
    HomeScreenPresenter::TransitionType transition) {
  switch (transition) {
    case HomeScreenPresenter::TransitionType::kSlideHomeIn:
      return HomeScreenPresenter::TransitionType::kSlideHomeOut;
    case HomeScreenPresenter::TransitionType::kSlideHomeOut:
      return HomeScreenPresenter::TransitionType::kSlideHomeIn;
    case HomeScreenPresenter::TransitionType::kScaleHomeIn:
      return HomeScreenPresenter::TransitionType::kScaleHomeOut;
    case HomeScreenPresenter::TransitionType::kScaleHomeOut:
      return HomeScreenPresenter::TransitionType::kScaleHomeIn;
  }
}

HomeScreenDelegate::AnimationTrigger GetAnimationTrigger(
    HomeScreenPresenter::TransitionType transition) {
  return (transition == HomeScreenPresenter::TransitionType::kSlideHomeIn ||
          transition == HomeScreenPresenter::TransitionType::kSlideHomeOut)
             ? HomeScreenDelegate::AnimationTrigger::kOverviewModeSlide
             : HomeScreenDelegate::AnimationTrigger::kOverviewModeFade;
}

bool IsShowingHomeTransition(HomeScreenPresenter::TransitionType transition) {
  return transition == HomeScreenPresenter::TransitionType::kSlideHomeIn ||
         transition == HomeScreenPresenter::TransitionType::kScaleHomeIn;
}

void UpdateOverviewSettings(base::TimeDelta duration,
                            ui::ScopedLayerAnimationSettings* settings) {
  settings->SetTransitionDuration(duration);
  settings->SetTweenType(gfx::Tween::FAST_OUT_SLOW_IN);
  settings->SetPreemptionStrategy(
      ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET);
}

}  // namespace

HomeScreenPresenter::HomeScreenPresenter(HomeScreenController* controller)
    : controller_(controller) {
  DCHECK(controller);
}

HomeScreenPresenter::~HomeScreenPresenter() = default;

void HomeScreenPresenter::ScheduleOverviewModeAnimation(
    TransitionType transition,
    bool animate) {
  // If animating, set the source parameters first.
  if (animate) {
    // Force the home view into the expected initial state without animation,
    // except when transitioning out from home screen. Gesture handling for the
    // gesture to move to overview can update the scale before triggering
    // transition to overview - undoing these changes here would make the UI
    // jump during the transition.
    if (transition != TransitionType::kScaleHomeOut) {
      SetFinalHomeTransformForTransition(GetOppositeTransition(transition),
                                         base::TimeDelta());
    }
  }

  // Hide all transient child windows in the app list (e.g. uninstall dialog)
  // before starting the overview mode transition, and restore them when
  // reshowing the app list.
  aura::Window* app_list_window =
      controller_->delegate()->GetHomeScreenWindow();
  if (app_list_window) {
    const bool showing_home = IsShowingHomeTransition(transition);
    for (auto* child : wm::GetTransientChildren(app_list_window)) {
      if (showing_home)
        child->Show();
      else
        child->Hide();
    }
  }

  SetFinalHomeTransformForTransition(
      transition, animate ? GetAnimationDurationForTransition(transition)
                          : base::TimeDelta());
}

void HomeScreenPresenter::SetFinalHomeTransformForTransition(
    TransitionType transition,
    base::TimeDelta animation_duration) {
  HomeScreenDelegate::UpdateAnimationSettingsCallback
      animation_settings_updater =
          !animation_duration.is_zero()
              ? base::BindRepeating(&UpdateOverviewSettings,
                                    animation_duration)
              : base::NullCallback();

  base::Optional<HomeScreenDelegate::AnimationInfo> animation_info =
      !animation_duration.is_zero()
          ? base::make_optional<HomeScreenDelegate::AnimationInfo>(
                GetAnimationTrigger(transition),
                IsShowingHomeTransition(transition))
          : base::nullopt;

  switch (transition) {
    case TransitionType::kSlideHomeIn:
      controller_->delegate()->UpdateYPositionAndOpacityForHomeLauncher(
          0 /*y_position_in_screen*/, 1.0 /*opacity*/,
          std::move(animation_info), animation_settings_updater);
      break;
    case TransitionType::kSlideHomeOut:
      controller_->delegate()->UpdateYPositionAndOpacityForHomeLauncher(
          kOverviewSlideAnimationYOffset /*y_position_in_screen*/,
          0.0 /*opacity*/, std::move(animation_info),
          animation_settings_updater);
      break;
    case TransitionType::kScaleHomeIn:
      controller_->delegate()->UpdateScaleAndOpacityForHomeLauncher(
          1.0 /*scale*/, 1.0 /*opacity*/, std::move(animation_info),
          animation_settings_updater);
      break;
    case TransitionType::kScaleHomeOut:
      controller_->delegate()->UpdateScaleAndOpacityForHomeLauncher(
          kOverviewFadeAnimationScale /*scale*/, 0.0 /*opacity*/,
          std::move(animation_info), animation_settings_updater);
      break;
  }
}

}  // namespace ash