[Contextual Search] Add support for crushed sprites and animate the search provider icon

chrome/browser/android/compositor/layer/contextual_search_layer.cc

 // Copyright 2014 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 "chrome/browser/android/compositor/layer/contextual_search_layer.h"
 
 #include "cc/layers/layer.h"
 #include "cc/layers/nine_patch_layer.h"
 #include "cc/layers/solid_color_layer.h"
 #include "cc/layers/ui_resource_layer.h"
 #include "cc/resources/scoped_ui_resource.h"
+#include "chrome/browser/android/compositor/layer/crushed_sprite_layer.h"
 #include "content/public/browser/android/compositor.h"
 #include "content/public/browser/android/content_view_core.h"
 #include "third_party/skia/include/core/SkColor.h"
+#include "ui/android/resources/crushed_sprite_resource.h"
 #include "ui/android/resources/resource_manager.h"
 #include "ui/base/l10n/l10n_util_android.h"
 #include "ui/gfx/color_utils.h"
 
 namespace {
 
 const SkColor kSearchBackgroundColor = SkColorSetRGB(0xee, 0xee, 0xee);
 const SkColor kSearchBarBackgroundColor = SkColorSetRGB(0xff, 0xff, 0xff);
 const SkColor kSearchBarBorderColor = SkColorSetRGB(0xf1, 0xf1, 0xf1);
 const SkColor kPeekPromoRippleBackgroundColor = SkColorSetRGB(0x42, 0x85, 0xF4);
@@ skipping 11 matching lines @@
 scoped_refptr<ContextualSearchLayer> ContextualSearchLayer::Create(
     ui::ResourceManager* resource_manager) {
   return make_scoped_refptr(new ContextualSearchLayer(resource_manager));
 }
 
 void ContextualSearchLayer::SetProperties(
     int panel_shadow_resource_id,
     int search_context_resource_id,
     int search_term_resource_id,
     int search_bar_shadow_resource_id,
-    int search_provider_icon_resource_id,
+    int panel_icon_resource_id,
     int arrow_up_resource_id,
     int close_icon_resource_id,
     int progress_bar_background_resource_id,
     int progress_bar_resource_id,
     int search_promo_resource_id,
     int peek_promo_ripple_resource_id,
     int peek_promo_text_resource_id,
+    int search_provider_icon_sprite_bitmap_resource_id,
+    int search_provider_icon_sprite_metadata_resource_id,
     content::ContentViewCore* content_view_core,
     bool search_promo_visible,
     float search_promo_height,
     float search_promo_opacity,
     bool search_peek_promo_visible,
     float search_peek_promo_height,
     float search_peek_promo_padding,
     float search_peek_promo_ripple_width,
     float search_peek_promo_ripple_opacity,
     float search_peek_promo_text_opacity,
     float search_panel_x,
     float search_panel_y,
     float search_panel_width,
     float search_panel_height,
     float search_bar_margin_side,
     float search_bar_height,
     float search_context_opacity,
     float search_term_opacity,
     bool search_bar_border_visible,
     float search_bar_border_height,
     bool search_bar_shadow_visible,
     float search_bar_shadow_opacity,
+    bool search_provider_icon_sprite_visible,
+    float search_provider_icon_sprite_completion_percentage,
+    float search_provider_icon_sprite_size,
     float arrow_icon_opacity,
     float arrow_icon_rotation,
     float close_icon_opacity,
     bool progress_bar_visible,
     float progress_bar_height,
     float progress_bar_opacity,
     int progress_bar_completion) {
   // Grabs the dynamic Search Bar Text resource.
   ui::ResourceManager::Resource* search_context_resource =
       resource_manager_->GetResource(ui::ANDROID_RESOURCE_TYPE_DYNAMIC,
                                      search_context_resource_id);
   ui::ResourceManager::Resource* search_term_resource =
       resource_manager_->GetResource(ui::ANDROID_RESOURCE_TYPE_DYNAMIC,
                                      search_term_resource_id);
 
   // Grabs required static resources.
   ui::ResourceManager::Resource* panel_shadow_resource =
       resource_manager_->GetResource(ui::ANDROID_RESOURCE_TYPE_STATIC,
                                      panel_shadow_resource_id);
-  ui::ResourceManager::Resource* search_provider_icon_resource =
-      resource_manager_->GetResource(ui::ANDROID_RESOURCE_TYPE_STATIC,
-                                     search_provider_icon_resource_id);
 
   DCHECK(panel_shadow_resource);
-  DCHECK(search_provider_icon_resource);
 
   // Round values to avoid pixel gap between layers.
   search_bar_height = floor(search_bar_height);
 
   float search_bar_top = search_peek_promo_height;
   float search_bar_bottom = search_bar_top + search_bar_height;
 
   bool is_rtl = l10n_util::IsLayoutRtl();
 
+  // If |panel_icon_resource_id| != 0, the static resource associated with that
+  // id will be displayed. If |panel_icon_resource_id| == 0, then the
+  // search provider icon sprite will be shown instead.
+  bool should_use_static_icon = panel_icon_resource_id != 0;
+
   // ---------------------------------------------------------------------------
   // Panel Shadow
   // ---------------------------------------------------------------------------
   gfx::Size shadow_res_size = panel_shadow_resource->size;
   gfx::Rect shadow_res_padding = panel_shadow_resource->padding;
   gfx::Size shadow_bounds(
       search_panel_width + shadow_res_size.width()
           - shadow_res_padding.size().width(),
       search_panel_height + shadow_res_size.height()
           - shadow_res_padding.size().height());
@@ skipping 32 matching lines @@
 
     // Apply a blend based on the ripple opacity. The resulting color will
     // be an interpolation between the background color of the Search Bar and
     // a lighter shade of the background color of the Ripple. The range of
     // the alpha value used in the blend will be:
     // [0.f, kPeekPromoBackgroundMaximumAlphaBlend]
     peek_promo_container_->SetBackgroundColor(
         color_utils::AlphaBlend(kPeekPromoRippleBackgroundColor,
                                 kSearchBarBackgroundColor,
                                 kPeekPromoBackgroundMaximumAlphaBlend *
-                                    search_peek_promo_ripple_opacity
-                                ));
+                                    search_peek_promo_ripple_opacity));
 
     // -----------------------------------------------------------------
     // Peek Promo Ripple
     // -----------------------------------------------------------------
     gfx::Size peek_promo_ripple_size(
         search_peek_promo_ripple_width, search_peek_promo_height);
     gfx::Rect peek_promo_ripple_border(
         peek_promo_ripple_resource->Border(peek_promo_ripple_size));
 
     // Add padding so the ripple will occupy the whole width at 100%.
@@ skipping 74 matching lines @@
         search_bar_top +
         search_bar_height / 2 -
         search_term_resource->size.height() / 2;
     search_term_->SetUIResourceId(search_term_resource->ui_resource->id());
     search_term_->SetBounds(search_term_resource->size);
     search_term_->SetPosition(gfx::PointF(0.f, search_bar_padding_top));
     search_term_->SetOpacity(search_term_opacity);
   }
 
   // ---------------------------------------------------------------------------
-  // Search Provider Icon
+  // Panel Icon (Static)
   // ---------------------------------------------------------------------------
-  // Positions the Search Provider Icon at the start of the Search Bar.
-  float search_provider_icon_left;
-  if (is_rtl) {
-    search_provider_icon_left = search_panel_width -
-        search_provider_icon_resource->size.width() - search_bar_margin_side;
+  if (should_use_static_icon) {
+    if (panel_icon_->parent() != layer_) {
+      layer_->AddChild(panel_icon_);
+    }
+    ui::ResourceManager::Resource* panel_icon_resource =
+        resource_manager_->GetResource(ui::ANDROID_RESOURCE_TYPE_STATIC,
+                                       panel_icon_resource_id);
+    DCHECK(panel_icon_resource);
+
+    // Positions the Icon at the start of the Search Bar.
+    float search_provider_icon_left;
+    if (is_rtl) {
+      search_provider_icon_left = search_panel_width -
+          panel_icon_resource->size.width() - search_bar_margin_side;
+    } else {
+      search_provider_icon_left = search_bar_margin_side;
+    }
+
+    // Centers the Icon vertically in the Search Bar.
+    float search_provider_icon_top = search_bar_top +
+        search_bar_height / 2 -
+        panel_icon_resource->size.height() / 2;
+
+    panel_icon_->SetUIResourceId(
+        panel_icon_resource->ui_resource->id());
+    panel_icon_->SetBounds(panel_icon_resource->size);
+    panel_icon_->SetPosition(
+        gfx::PointF(search_provider_icon_left, search_provider_icon_top));
   } else {
-    search_provider_icon_left = search_bar_margin_side;
+    if (panel_icon_.get() && panel_icon_->parent()) {

[pedro (no code reviews), 2015/10/29 17:01:42]

Since we are assuming that only one type of icon will be used, I think we can
remove this part that removes the static icon from the parent. This way, when
the icon sprite is used we won't have to unnecessarily execute this on every
frame.

[Theresa, 2015/10/29 17:44:09]

Done.

+      panel_icon_->RemoveFromParent();
+    }
   }
 
-  // Centers the Search Provider Icon vertically in the Search Bar.
-  float search_provider_icon_top = search_bar_top +
-      search_bar_height / 2 -
-      search_provider_icon_resource->size.height() / 2;
+  // ---------------------------------------------------------------------------
+  // Search Provider Icon Sprite (Animated)
+  // ---------------------------------------------------------------------------
+  if (!should_use_static_icon) {
+    if (search_provider_icon_sprite_visible) {
+      if (search_provider_icon_sprite_->layer()->parent() != layer_) {
+        layer_->AddChild(search_provider_icon_sprite_->layer());
+      }
 
-  search_provider_icon_->SetUIResourceId(
-      search_provider_icon_resource->ui_resource->id());
-  search_provider_icon_->SetBounds(search_provider_icon_resource->size);
-  search_provider_icon_->SetPosition(
-      gfx::PointF(search_provider_icon_left, search_provider_icon_top));
+      search_provider_icon_sprite_->DrawSpriteFrame(
+          resource_manager_,
+          search_provider_icon_sprite_bitmap_resource_id,
+          search_provider_icon_sprite_metadata_resource_id,
+          search_provider_icon_sprite_completion_percentage);
+
+      // Positions the Search Provider Icon at the start of the Search Bar.
+      float icon_x;
+      if (is_rtl) {
+        icon_x = search_panel_width - search_provider_icon_sprite_size -
+            search_bar_margin_side;
+      } else {
+        icon_x = search_bar_margin_side;
+      }
+
+      // Centers the Search Provider Icon vertically in the Search Bar.
+      float icon_y = search_bar_top + search_bar_height / 2
+          - search_provider_icon_sprite_size / 2;
+      search_provider_icon_sprite_->layer()->SetPosition(
+          gfx::PointF(icon_x, icon_y));
+
+      // Scales the layer to the correct size.
+      search_provider_icon_sprite_->layer()->SetBounds(
+          gfx::Size(search_provider_icon_sprite_size,
+                    search_provider_icon_sprite_size));
+
+    } else {
+      if (search_provider_icon_sprite_->layer().get() &&
+          search_provider_icon_sprite_->layer()->parent()) {
+        search_provider_icon_sprite_->layer()->RemoveFromParent();
+      }
+    }
+  }
 
   // ---------------------------------------------------------------------------
   // Arrow Icon
   // ---------------------------------------------------------------------------
   // Grabs the Search Arrow Icon resource.
   ui::ResourceManager::Resource* arrow_icon_resource =
       resource_manager_->GetResource(ui::ANDROID_RESOURCE_TYPE_STATIC,
                                      arrow_up_resource_id);
 
   // Positions the icon at the end of the Search Bar.
@@ skipping 222 matching lines @@
       panel_shadow_(
           cc::NinePatchLayer::Create(content::Compositor::LayerSettings())),
       search_bar_background_(
           cc::SolidColorLayer::Create(content::Compositor::LayerSettings())),
       search_context_(
           cc::UIResourceLayer::Create(content::Compositor::LayerSettings())),
       search_term_(
           cc::UIResourceLayer::Create(content::Compositor::LayerSettings())),
       search_bar_shadow_(
           cc::UIResourceLayer::Create(content::Compositor::LayerSettings())),
-      search_provider_icon_(
+      panel_icon_(
           cc::UIResourceLayer::Create(content::Compositor::LayerSettings())),
+      search_provider_icon_sprite_(CrushedSpriteLayer::Create()),
       arrow_icon_(
           cc::UIResourceLayer::Create(content::Compositor::LayerSettings())),
       close_icon_(
           cc::UIResourceLayer::Create(content::Compositor::LayerSettings())),
       content_view_container_(
           cc::Layer::Create(content::Compositor::LayerSettings())),
       search_bar_border_(
           cc::SolidColorLayer::Create(content::Compositor::LayerSettings())),
       progress_bar_(
           cc::NinePatchLayer::Create(content::Compositor::LayerSettings())),
@@ skipping 30 matching lines @@
   search_bar_background_->SetIsDrawable(true);
   search_bar_background_->SetBackgroundColor(kSearchBarBackgroundColor);
   layer_->AddChild(search_bar_background_);
 
   // Search Bar Text
   search_context_->SetIsDrawable(true);
   layer_->AddChild(search_context_);
   search_term_->SetIsDrawable(true);
   layer_->AddChild(search_term_);
 
-  // Search Provider Icon
-  search_provider_icon_->SetIsDrawable(true);
-  layer_->AddChild(search_provider_icon_);
+  // Panel Icon
+  panel_icon_->SetIsDrawable(true);
 
   // Arrow Icon
   arrow_icon_->SetIsDrawable(true);
   layer_->AddChild(arrow_icon_);
 
   // Close Icon
   close_icon_->SetIsDrawable(true);
   layer_->AddChild(close_icon_);
 
   // Search Opt Out Promo
@@ skipping 22 matching lines @@
 
 ContextualSearchLayer::~ContextualSearchLayer() {
 }
 
 scoped_refptr<cc::Layer> ContextualSearchLayer::layer() {
   return layer_;
 }
 
 }  //  namespace android
 }  //  namespace chrome