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

chrome/android/java/src/org/chromium/chrome/browser/compositor/bottombar/contextualsearch/ContextualSearchPanelBase.java

Index: chrome/android/java/src/org/chromium/chrome/browser/compositor/bottombar/contextualsearch/ContextualSearchPanelBase.java
diff --git a/chrome/android/java/src/org/chromium/chrome/browser/compositor/bottombar/contextualsearch/ContextualSearchPanelBase.java b/chrome/android/java/src/org/chromium/chrome/browser/compositor/bottombar/contextualsearch/ContextualSearchPanelBase.java
index d08874dbf6936e08edc6cdfe4a8ecb26cbb26151..4fbc5ac4e945f83cc96162af6fd08ec12d1e1510 100644
--- a/chrome/android/java/src/org/chromium/chrome/browser/compositor/bottombar/contextualsearch/ContextualSearchPanelBase.java
+++ b/chrome/android/java/src/org/chromium/chrome/browser/compositor/bottombar/contextualsearch/ContextualSearchPanelBase.java
@@ -760,6 +760,85 @@ abstract class ContextualSearchPanelBase extends ContextualSearchPanelStateHandl
     }
 
     // --------------------------------------------------------------------------------------------
+    // Search provider icon states
+    // --------------------------------------------------------------------------------------------
+
+    // TODO(twellington): tweak these values once we have the final sprite sheets.
+    protected static final int SEARCH_PROVIDER_ICON_FIRST_SPRITE_FRAME = 40;

[pedro (no code reviews), 2015/09/11 22:49:42]

I would prefer not hardcoding the initial and final frame, because ideally we
would not have extra unused sprites in the grid, which means the first and last
frames would be the first and last available frames, respectively.

[Theresa, 2015/09/14 19:48:24]

The last frame still needs to be hard coded. The sprite sheet we have is a grid
with a few blank frames on the end. We can reliably use 0 for the first frame,
so I dropped that constant.

+    protected static final int SEARCH_PROVIDER_ICON_LAST_SPRITE_FRAME = 67;
+    private static final int SEARCH_PROVIDER_ICON_SPRITES_PER_ROW = 10;

[pedro (no code reviews), 2015/09/11 22:49:42]

Instead of hardcoding the number of sprites per row and column, can we deduct
those values from the size of a single sprite and the size of the sprite grid?

[Theresa, 2015/09/14 19:48:24]

Done.

+    private static final int SEARCH_PROVIDER_ICON_SPRITE_ROWS = 7;
+
+    private boolean mIsSearchProviderIconVisible;
+    private boolean mShouldAnimateSearchProviderIcon;
+    private int mSearchProviderIconSpriteFrame;
+
+    /**
+     * @return Whether the search provider icon is visible.
+     */
+    public boolean isSearchProviderIconVisible() {
+        return mIsSearchProviderIconVisible;
+    }
+
+    /**
+     * @param isSearchProviderIconVisible Whether the search provider icon should be visible.
+     */
+    public void setIsSearchProviderIconVisible(boolean isSearchProviderIconVisible) {
+        mIsSearchProviderIconVisible = isSearchProviderIconVisible;
+    }
+
+    /**
+     * @return Whether the search provider icon should be animated.
+     */
+    public boolean shouldAnimateSearchProviderIcon() {
+        return mShouldAnimateSearchProviderIcon;
+    }
+
+    /**
+     * @param shouldAnimateSearchProviderIcon Whether the search provider icon should be animated.
+     */
+    public void setShouldAnimateSearchProviderIcon(boolean shouldAnimateSearchProviderIcon) {
+        if (shouldAnimateSearchProviderIcon) {
+            // The search provider icon should be hidden until the animation starts.
+            setIsSearchProviderIconVisible(false);
+        } else {
+            setSearchProviderIconSpriteFrame(SEARCH_PROVIDER_ICON_LAST_SPRITE_FRAME);
+            setIsSearchProviderIconVisible(true);
+        }
+        mShouldAnimateSearchProviderIcon = shouldAnimateSearchProviderIcon;
+    }
+
+    /**
+     * @return The number of sprites in each row of the search provider icon sprite sheet.
+     */
+    public int getSearchProviderIconSpritesPerRow() {
+        return SEARCH_PROVIDER_ICON_SPRITES_PER_ROW;
+    }
+
+    /**
+     * @return The number of rows in the search provider icon sprite sheet.
+     */
+    public int getSearchProviderIconSpriteRows() {
+        return SEARCH_PROVIDER_ICON_SPRITE_ROWS;
+    }
+
+    /**
+     * @return The sprite frame to display in the search provider icon sprite sheet. Sprites are
+     *         numbered starting at 0.
+     */
+    public int getSearchProviderIconSpriteFrame() {
+        return mSearchProviderIconSpriteFrame;
+    }
+
+    /**
+     * @param spriteFrame The sprite frame to display in the search provider icon sprite sheet.
+     *                    Sprites are numbered starting at 0.
+     */
+    public void setSearchProviderIconSpriteFrame(int spriteFrame) {

[pedro (no code reviews), 2015/09/11 22:49:42]

As stated in the comment on the ContextualSearchPanelAnimation() file, I think
we should name this setSearchProviderIconAnimationCompletion(float percentage).

The idea is that the animation code should only care about completion (a number
between 0 and 1).

The ContextualSearchPanelBase class, on the other hand, knows how to render the
details of things, so it should take the completion and deduct which frame to
render based on a series of factors.

We should only hardcode the size of the sprite, say 32dp. Then, with this
information, and the completion percentage, we are able to tell which frame to
render.

Instead of hardcoding how many rows and columns are there, we can find that by
comparing the sprite size with the grid size. We can also calculate the total
number of frames using the same logic.

Then, finally, we would pass to the native code (contextual_search_layer.cc)
which exact frame to render, because this is the part of the code that render
things but does not know the logic behind it (this class only "follow orders").

[Theresa, 2015/09/14 19:48:24]

I changed this to a percentage and am passing the sprite frame and size of the
sprite to contextual_search_layer.cc. That class still uses the size to
calculate which part of the sprite sheet to show. That makes sense to me,
because contextual_search_layer.cc is already using width/height to calculate
placement, but I could also pass the x/y pairs that determine which part of the
sprite sheet to draw from ContextualSearchPanelBase instead of calculating on
the native side if that's preferable.

+        mSearchProviderIconSpriteFrame = spriteFrame;
+    }
+
+    // --------------------------------------------------------------------------------------------
     // Promo states
     // --------------------------------------------------------------------------------------------