Vectorize download shelf progress indicators

chrome/browser/download/download_shelf.cc

 // Copyright (c) 2012 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.
 
 #define _USE_MATH_DEFINES  // For VC++ to get M_PI. This has to be first.
 
 #include "chrome/browser/download/download_shelf.h"
 
 #include <cmath>
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/location.h"
 #include "base/single_thread_task_runner.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/thread_task_runner_handle.h"
+#include "base/time/time.h"
 #include "chrome/browser/download/download_item_model.h"
 #include "chrome/browser/download/download_service.h"
 #include "chrome/browser/download/download_service_factory.h"
 #include "chrome/browser/download/download_started_animation.h"
 #include "chrome/browser/platform_util.h"
 #include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/themes/theme_properties.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/tabs/tab_strip_model.h"
 #include "chrome/grit/locale_settings.h"
 #include "content/public/browser/browser_context.h"
 #include "content/public/browser/download_item.h"
 #include "content/public/browser/download_manager.h"
 #include "content/public/browser/web_contents.h"
 #include "grit/theme_resources.h"
+#include "third_party/skia/include/core/SkPaint.h"
+#include "third_party/skia/include/core/SkPath.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/resource/resource_bundle.h"
+#include "ui/base/theme_provider.h"
 #include "ui/gfx/animation/animation.h"
 #include "ui/gfx/canvas.h"
-#include "ui/gfx/image/image_skia.h"
 
 using content::DownloadItem;
 
 namespace {
 
 // Delay before we show a transient download.
 const int64 kDownloadShowDelayInSeconds = 2;
 
 // Get the opacity based on |animation_progress|, with values in [0.0, 1.0].
 // Range of return value is [0, 255].
@@ skipping 13 matching lines @@
 DownloadShelf::DownloadShelf()
     : should_show_on_unhide_(false),
       is_hidden_(false),
       weak_ptr_factory_(this) {
 }
 
 DownloadShelf::~DownloadShelf() {}
 
 // Download progress painting --------------------------------------------------
 
-// Common images used for download progress animations. We load them once the
-// first time we do a progress paint, then reuse them as they are always the
-// same.
-gfx::ImageSkia* g_foreground_16 = NULL;
-gfx::ImageSkia* g_background_16 = NULL;
-
 // static
 void DownloadShelf::PaintDownloadProgress(
     gfx::Canvas* canvas,
-    const BoundsAdjusterCallback& rtl_mirror,
-    int origin_x,
-    int origin_y,
-    int start_angle,
+    const ui::ThemeProvider& theme_provider,
+    const base::TimeTicks& progress_start_time,
     int percent_done) {
-  // Load up our common images.
-  if (!g_background_16) {
-    ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
-    g_foreground_16 = rb.GetImageSkiaNamed(IDR_DOWNLOAD_PROGRESS_FOREGROUND_16);
-    g_background_16 = rb.GetImageSkiaNamed(IDR_DOWNLOAD_PROGRESS_BACKGROUND_16);
-    DCHECK_EQ(g_foreground_16->width(), g_background_16->width());
-    DCHECK_EQ(g_foreground_16->height(), g_background_16->height());
+  // Draw background (light blue circle).
+  SkPaint bg_paint;
+  bg_paint.setStyle(SkPaint::kFill_Style);
+  SkColor indicator_color =
+      theme_provider.GetColor(ThemeProperties::COLOR_THROBBER_SPINNING);

[Peter Kasting, 2015/07/16 00:52:17]

Seems like maybe we should rename this color constant, though I don't know if
there's a good name ("indicator stroke color"?).

[Evan Stade, 2015/07/16 02:16:44]

let me know if you think of a name you'd prefer. COLOR_PROGRESS_INDICATOR seems
the most accurate but I'm ambivalent about it.

+  bg_paint.setColor(SkColorSetA(indicator_color, 0x33));
+  bg_paint.setAntiAlias(true);
+  SkPath bg;
+  bg.addCircle(20, 20, 13);

[Peter Kasting, 2015/07/16 00:52:17]

Looking at all this code, it still seems like either the circle radius should be
12.5 instead of 13, or the progress arc rect should have w/h 26 instead of 25. 
Otherwise, the rect used inside SkPath::addCircle() doesn't match the rect used
for addArc() below.  I would guess the circle radius is what needs changing
rather than the progress arc rect, as if the arc rect changes that also suggests
that the "progress icon size" constant is wrong.

If we can bring these into alignment, then we can replace all the numbers here,
below, and in the "progress icon size" constant with just:

kProgressIndicatorRadius = 13;  // Or 12.5
kProgressIndicatorPadding = 7;

Then everything else can just be computed by adding those together and
multiplying by 2 where necessary.

[Evan Stade, 2015/07/16 02:16:44]

constants tweaked

+  canvas->DrawPath(bg, bg_paint);
+
+  // Calculate progress.
+  SkScalar sweep_angle = 0.f;
+  // Start at 12 o'clock.
+  SkScalar start_pos = SkIntToScalar(270);
+  if (percent_done < 0) {
+    // For unknown size downloads, draw a 50 degree sweep that moves at
+    // 0.08 degrees per millisecond.
+    sweep_angle = 50.f;
+    start_pos += static_cast<SkScalar>(
+        (base::TimeTicks::Now() - progress_start_time).InMilliseconds() * 0.08);
+  } else if (percent_done > 0) {
+    sweep_angle = static_cast<SkScalar>(360 * percent_done / 100.0);
   }
 
-  // We start by storing the bounds of the images so that it is easy to mirror
-  // the bounds if the UI layout is RTL.
-  gfx::Rect bounds(origin_x, origin_y, g_background_16->width(),
-                   g_background_16->height());
-
-  // Mirror the positions if necessary.
-  rtl_mirror.Run(&bounds);
-
-  // Draw the background progress image.
-  canvas->DrawImageInt(*g_background_16, bounds.x(), bounds.y());
-
-  // Layer the foreground progress image in an arc proportional to the download
-  // progress. The arc grows clockwise, starting in the midnight position, as
-  // the download progresses. However, if the download does not have known total
-  // size (the server didn't give us one), then we just spin an arc around until
-  // we're done.
-  float sweep_angle = 0.0;
-  float start_pos = static_cast<float>(kStartAngleDegrees);
-  if (percent_done < 0) {
-    sweep_angle = kUnknownAngleDegrees;
-    start_pos = static_cast<float>(start_angle);
-  } else if (percent_done > 0) {
-    sweep_angle = static_cast<float>(kMaxDegrees / 100.0 * percent_done);
-  }
-
-  // Set up an arc clipping region for the foreground image. Don't bother using
-  // a clipping region if it would round to 360 (really 0) degrees, since that
-  // would eliminate the foreground completely and be quite confusing (it would
-  // look like 0% complete when it should be almost 100%).
-  canvas->Save();
-  if (sweep_angle < static_cast<float>(kMaxDegrees - 1)) {
-    SkRect oval;
-    oval.set(SkIntToScalar(bounds.x()), SkIntToScalar(bounds.y()),
-             SkIntToScalar(bounds.x() + DownloadShelf::kSmallProgressIconSize),
-             SkIntToScalar(bounds.y() + DownloadShelf::kSmallProgressIconSize));
-    SkPath path;
-    path.arcTo(oval,
-               SkFloatToScalar(start_pos),
-               SkFloatToScalar(sweep_angle), false);
-    path.lineTo(
-        SkIntToScalar(bounds.x() + DownloadShelf::kSmallProgressIconSize / 2),
-        SkIntToScalar(bounds.y() + DownloadShelf::kSmallProgressIconSize / 2));
-
-    // gfx::Canvas::ClipPath does not provide for anti-aliasing.
-    canvas->sk_canvas()->clipPath(path, SkRegion::kIntersect_Op, true);
-  }
-
-  canvas->DrawImageInt(*g_foreground_16, bounds.x(), bounds.y());
-  canvas->Restore();
+  // Draw progress.
+  SkPath progress;
+  progress.addArc(SkRect::MakeXYWH(7, 7, 25, 25), start_pos, sweep_angle);
+  SkPaint progress_paint;
+  progress_paint.setColor(indicator_color);
+  progress_paint.setStyle(SkPaint::kStroke_Style);
+  progress_paint.setStrokeWidth(1.7f);
+  progress_paint.setAntiAlias(true);
+  canvas->DrawPath(progress, progress_paint);
 }
 
 // static
 void DownloadShelf::PaintDownloadComplete(
     gfx::Canvas* canvas,
-    const BoundsAdjusterCallback& rtl_mirror,
-    int origin_x,
-    int origin_y,
+    const ui::ThemeProvider& theme_provider,
     double animation_progress) {
-  // Load up our common images.
-  if (!g_foreground_16) {
-    ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
-    g_foreground_16 = rb.GetImageSkiaNamed(IDR_DOWNLOAD_PROGRESS_FOREGROUND_16);
-  }
-
-  gfx::Rect complete_bounds(origin_x, origin_y, g_foreground_16->width(),
-                            g_foreground_16->height());
-  // Mirror the positions if necessary.
-  rtl_mirror.Run(&complete_bounds);
-
   // Start at full opacity, then loop back and forth five times before ending
   // at zero opacity.
-  canvas->DrawImageInt(*g_foreground_16, complete_bounds.x(),
-                       complete_bounds.y(), GetOpacity(animation_progress));
+  canvas->sk_canvas()->saveLayerAlpha(nullptr, GetOpacity(animation_progress));
+  PaintDownloadProgress(canvas, theme_provider, base::TimeTicks(), 100);
+  canvas->sk_canvas()->restore();
 }
 
 // static
 void DownloadShelf::PaintDownloadInterrupted(
     gfx::Canvas* canvas,
-    const BoundsAdjusterCallback& rtl_mirror,
-    int origin_x,
-    int origin_y,
+    const ui::ThemeProvider& theme_provider,
     double animation_progress) {
   // Start at zero opacity, then loop back and forth five times before ending
   // at full opacity.
-  PaintDownloadComplete(canvas, rtl_mirror, origin_x, origin_y,
-                        1.0 - animation_progress);
+  PaintDownloadComplete(canvas, theme_provider, 1.0 - animation_progress);
 }
 
 void DownloadShelf::AddDownload(DownloadItem* download) {
   DCHECK(download);
   if (DownloadItemModel(download).ShouldRemoveFromShelfWhenComplete()) {
     // If we are going to remove the download from the shelf upon completion,
     // wait a few seconds to see if it completes quickly. If it's a small
     // download, then the user won't have time to interact with it.
     base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
         FROM_HERE,
@@ skipping 86 matching lines @@
   content::DownloadManager* download_manager = GetDownloadManager();
   if (!download_manager)
     return;
 
   DownloadItem* download = download_manager->GetDownload(download_id);
   if (!download)
     return;
 
   ShowDownload(download);
 }