1f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)// Copyright 2013 The Chromium Authors. All rights reserved.
2f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
3f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)// found in the LICENSE file.
4f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
5f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)#include "cc/animation/scroll_offset_animation_curve.h"
6f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
7a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include <algorithm>
8a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include <cmath>
9a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)
10f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)#include "base/logging.h"
11f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)#include "cc/animation/timing_function.h"
12f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)#include "ui/gfx/animation/tween.h"
13f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
14a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)const double kDurationDivisor = 60.0;
15a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)
16f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)namespace cc {
17f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
185f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)namespace {
195f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
205f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)static float MaximumDimension(gfx::Vector2dF delta) {
215f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  return std::max(std::abs(delta.x()), std::abs(delta.y()));
225f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)}
235f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
245f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)static base::TimeDelta DurationFromDelta(gfx::Vector2dF delta) {
255f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // The duration of a scroll animation depends on the size of the scroll.
265f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // The exact relationship between the size and the duration isn't specified
275f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // by the CSSOM View smooth scroll spec and is instead left up to user agents
285f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // to decide. The calculation performed here will very likely be further
295f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // tweaked before the smooth scroll API ships.
305f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  return base::TimeDelta::FromMicroseconds(
315f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)      (std::sqrt(MaximumDimension(delta)) / kDurationDivisor) *
325f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)      base::Time::kMicrosecondsPerSecond);
335f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)}
345f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
355f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)static scoped_ptr<TimingFunction> EaseOutWithInitialVelocity(double velocity) {
365f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // Based on EaseInOutTimingFunction::Create with first control point rotated.
375f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  const double r2 = 0.42 * 0.42;
385f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  const double v2 = velocity * velocity;
395f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  const double x1 = std::sqrt(r2 / (v2 + 1));
405f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  const double y1 = std::sqrt(r2 * v2 / (v2 + 1));
415f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  return CubicBezierTimingFunction::Create(x1, y1, 0.58, 1)
425f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)      .PassAs<TimingFunction>();
435f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)}
445f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
455f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)}  // namespace
465f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
47f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)scoped_ptr<ScrollOffsetAnimationCurve> ScrollOffsetAnimationCurve::Create(
485d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    const gfx::Vector2dF& target_value,
49f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)    scoped_ptr<TimingFunction> timing_function) {
50f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)  return make_scoped_ptr(
51f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)      new ScrollOffsetAnimationCurve(target_value, timing_function.Pass()));
52f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)}
53f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
54f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)ScrollOffsetAnimationCurve::ScrollOffsetAnimationCurve(
555d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    const gfx::Vector2dF& target_value,
56f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)    scoped_ptr<TimingFunction> timing_function)
57cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)    : target_value_(target_value), timing_function_(timing_function.Pass()) {
58cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)}
59f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
60f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)ScrollOffsetAnimationCurve::~ScrollOffsetAnimationCurve() {}
61f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
625d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)void ScrollOffsetAnimationCurve::SetInitialValue(
635d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    const gfx::Vector2dF& initial_value) {
64a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)  initial_value_ = initial_value;
655f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  total_animation_duration_ = DurationFromDelta(target_value_ - initial_value_);
66a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)}
67a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)
68f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)gfx::Vector2dF ScrollOffsetAnimationCurve::GetValue(double t) const {
695f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  double duration = (total_animation_duration_ - last_retarget_).InSecondsF();
705f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  t -= last_retarget_.InSecondsF();
71cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)
72f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)  if (t <= 0)
73f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)    return initial_value_;
74f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
75cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)  if (t >= duration)
76f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)    return target_value_;
77f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
78cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)  double progress = (timing_function_->GetValue(t / duration));
79f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)  return gfx::Vector2dF(gfx::Tween::FloatValueBetween(
80f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)                            progress, initial_value_.x(), target_value_.x()),
81f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)                        gfx::Tween::FloatValueBetween(
82f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)                            progress, initial_value_.y(), target_value_.y()));
83f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)}
84f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
85f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)double ScrollOffsetAnimationCurve::Duration() const {
865f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  return total_animation_duration_.InSecondsF();
87f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)}
88f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
89f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)AnimationCurve::CurveType ScrollOffsetAnimationCurve::Type() const {
90f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)  return ScrollOffset;
91f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)}
92f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
93f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)scoped_ptr<AnimationCurve> ScrollOffsetAnimationCurve::Clone() const {
94f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)  scoped_ptr<TimingFunction> timing_function(
95f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)      static_cast<TimingFunction*>(timing_function_->Clone().release()));
96f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)  scoped_ptr<ScrollOffsetAnimationCurve> curve_clone =
97f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)      Create(target_value_, timing_function.Pass());
98a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)  curve_clone->initial_value_ = initial_value_;
995f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  curve_clone->total_animation_duration_ = total_animation_duration_;
1005f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  curve_clone->last_retarget_ = last_retarget_;
101f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)  return curve_clone.PassAs<AnimationCurve>();
102f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)}
103f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)
1045f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)void ScrollOffsetAnimationCurve::UpdateTarget(
1055f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)    double t,
1065f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)    const gfx::Vector2dF& new_target) {
1075f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  gfx::Vector2dF current_position = GetValue(t);
1085f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  gfx::Vector2dF old_delta = target_value_ - initial_value_;
1095f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  gfx::Vector2dF new_delta = new_target - current_position;
1105f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
1115f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  double old_duration =
1125f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)      (total_animation_duration_ - last_retarget_).InSecondsF();
1135f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  double new_duration = DurationFromDelta(new_delta).InSecondsF();
1145f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
1155f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  double old_velocity = timing_function_->Velocity(
1165f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)      (t - last_retarget_.InSecondsF()) / old_duration);
1175f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
1185f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // TimingFunction::Velocity gives the slope of the curve from 0 to 1.
1195f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // To match the "true" velocity in px/sec we must adjust this slope for
1205f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // differences in duration and scroll delta between old and new curves.
1215f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  double new_velocity =
1225f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)      old_velocity * (new_duration / old_duration) *
1235f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)      (MaximumDimension(old_delta) / MaximumDimension(new_delta));
1245f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
1255f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  initial_value_ = current_position;
1265f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  target_value_ = new_target;
1275f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  total_animation_duration_ = base::TimeDelta::FromSecondsD(t + new_duration);
1285f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  last_retarget_ = base::TimeDelta::FromSecondsD(t);
1295f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  timing_function_ = EaseOutWithInitialVelocity(new_velocity);
1305f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)}
1315f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
132f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)}  // namespace cc
133