Implement pinch-zoom scaling for main-frame scrollbars and pinch-zoom overlay scrollbars.

cc/layer_tree_host.cc

 // Copyright 2011 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 "cc/layer_tree_host.h"
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/debug/trace_event.h"
 #include "base/message_loop.h"
 #include "base/stl_util.h"
 #include "base/string_number_conversions.h"
 #include "cc/animation_registrar.h"
 #include "cc/heads_up_display_layer.h"
 #include "cc/heads_up_display_layer_impl.h"
 #include "cc/layer.h"
 #include "cc/layer_animation_controller.h"
 #include "cc/layer_iterator.h"
 #include "cc/layer_tree_host_client.h"
 #include "cc/layer_tree_host_common.h"
 #include "cc/layer_tree_host_impl.h"
 #include "cc/layer_tree_impl.h"
 #include "cc/math_util.h"
 #include "cc/occlusion_tracker.h"
 #include "cc/overdraw_metrics.h"
+#include "cc/pinch_zoom_scrollbar.h"
+#include "cc/pinch_zoom_scrollbar_geometry.h"
+#include "cc/pinch_zoom_scrollbar_painter.h"
 #include "cc/prioritized_resource_manager.h"
+#include "cc/scrollbar_layer.h"
 #include "cc/single_thread_proxy.h"
 #include "cc/switches.h"
 #include "cc/thread.h"
 #include "cc/thread_proxy.h"
 #include "cc/top_controls_manager.h"
 #include "cc/tree_synchronizer.h"
 
 namespace {
 static int numLayerTreeInstances;
 }
@@ skipping 284 matching lines @@
     hostImpl->setDeviceScaleFactor(deviceScaleFactor());
     hostImpl->setDebugState(m_debugState);
 
     DCHECK(!syncTree->ViewportSizeInvalid());
 
     if (newImplTreeHasNoEvictedResources) {
         if (syncTree->ContentsTexturesPurged())
             syncTree->ResetContentsTexturesPurged();
     }
 
+    syncTree->SetPinchZoomHorizontalLayerId(
+        m_pinchZoomScrollbarHorizontal ? m_pinchZoomScrollbarHorizontal->id() : 0);

[jamesr, 2013/02/26 20:48:46]

we use -1 as an invalid id most of the time

[wjmaclean, 2013/03/01 15:30:32]

Fixed.

+    syncTree->SetPinchZoomVerticalLayerId(
+        m_pinchZoomScrollbarVertical ? m_pinchZoomScrollbarVertical->id() : 0);
+
     if (!m_settings.implSidePainting) {
         // If we're not in impl-side painting, the tree is immediately
         // considered active.
         syncTree->DidBecomeActive();
     }
 
     if (m_debugState.continuousPainting)
         hostImpl->savePaintTime(m_renderingStats.totalPaintTime, commitNumber());
 
     m_commitNumber++;
 }
 
+void LayerTreeHost::setPinchZoomScrollbarPropertiesIfNeeded()
+{
+    if (!m_pinchZoomScrollbarHorizontal || !m_pinchZoomScrollbarVertical)
+        return;
+
+    gfx::Size size = layoutViewportSize();
+    int trackWidth = PinchZoomScrollbar::kTrackWidth;
+    Layer* rootScrollLayer = this->rootScrollLayer();

[jamesr, 2013/02/26 20:48:46]

I can't find any uses of this local in this function

[wjmaclean, 2013/03/01 15:30:32]

Ooops, deleted this, but must have inadvertently restored it in the editor.

+
+    m_pinchZoomScrollbarHorizontal->setBounds(gfx::Size(size.width() - trackWidth, trackWidth));
+    m_pinchZoomScrollbarHorizontal->setPosition(gfx::PointF(0, size.height() - trackWidth));
+    m_pinchZoomScrollbarHorizontal->setIsDrawable(true);
+    m_pinchZoomScrollbarHorizontal->setOpacity(0.5);
+    m_pinchZoomScrollbarHorizontal->setNeedsDisplay();

[jamesr, 2013/02/26 20:48:46]

Most of these properties are the same every time, can't you just set them once
at initialization and have that be it?  The only thing that can change is the
bounds/position.  You should set these only when the layout viewport size
changes, not every commit

[wjmaclean, 2013/03/01 15:30:32]

Fixed.

+
+    m_pinchZoomScrollbarVertical->setBounds(gfx::Size(10, size.height() - 10));

[jamesr, 2013/02/26 20:48:46]

What are these "10"s for?  Are they supposed to be trackWidth or some other
magical value?  If the latter, please put them in a constant with a descriptive
name

[wjmaclean, 2013/03/01 15:30:32]

Fixed.

Trackwidth. I had them set correctly for horizontal, but missed them here.

+    m_pinchZoomScrollbarVertical->setPosition(gfx::PointF(size.width() - 10, 0));
+    m_pinchZoomScrollbarVertical->setIsDrawable(true);
+    m_pinchZoomScrollbarVertical->setOpacity(0.5);
+    m_pinchZoomScrollbarVertical->setNeedsDisplay();
+}
+
+static ScrollbarLayer* findScrollLayerScrollbar(Layer* layer, int targetScrollLayerId)
+{
+    if (layer->toScrollbarLayer()) {
+        int scrollLayerId = layer->toScrollbarLayer()->scrollLayerId();
+        if (scrollLayerId == targetScrollLayerId)
+            return layer->toScrollbarLayer();
+    }
+
+    const Layer::LayerList& children = layer->children();
+    for (size_t childIndex = 0; childIndex < children.size(); ++childIndex) {
+        ScrollbarLayer* result =
+            findScrollLayerScrollbar(children[childIndex].get(), targetScrollLayerId);
+        if (result)
+            return result;
+    }
+
+    return 0;
+}
+
+bool LayerTreeHost::rootScrollLayerUsesOverlayScrollbars() const

[jamesr, 2013/02/26 20:48:46]

This function doesn't seem helpful.  The decision over whether to use pinch zoom
scrollbars or not should be up to the embedder, they can set this however they
like.

[wjmaclean, 2013/03/01 15:30:32]

Done.

+{
+    // Use OS-specific defaults for the case where no rootLayer scrollbar is found.
+#if defined(OS_ANDROID)
+    bool usesOverlay = true;
+#else
+    bool usesOverlay = false;
+#endif
+
+    Layer* rootScrollLayer = this->rootScrollLayer();
+    if (!rootScrollLayer)
+        return usesOverlay;
+
+    ScrollbarLayer* rootScrollLayerScrollbar = findScrollLayerScrollbar(m_rootLayer.get(), rootScrollLayer->id());
+
+    if (rootScrollLayerScrollbar)
+        return rootScrollLayerScrollbar->isOverlay();
+    else
+        return usesOverlay;
+}
+
 void LayerTreeHost::willCommit()
 {
     m_client->willCommit();
 
     if (m_debugState.showHudInfo()) {
         if (!m_hudLayer)
             m_hudLayer = HeadsUpDisplayLayer::create();
 
         if (m_rootLayer && !m_hudLayer->parent())
             m_rootLayer->addChild(m_hudLayer);
     } else if (m_hudLayer) {
         m_hudLayer->removeFromParent();
         m_hudLayer = 0;
     }
+
+    // Setup pinch-zoom scrollbars if required.
+    if (rootScrollLayer() && !rootScrollLayerUsesOverlayScrollbars()) {

[jamesr, 2013/02/26 20:48:46]

This should check a setting to determine whether to make pinch zoom scrollbars
or not

[wjmaclean, 2013/03/01 15:30:32]

Done.

+        bool needsPropertiesUpdated = false;
+
+        if (!m_pinchZoomScrollbarHorizontal) {

[jamesr, 2013/02/26 20:48:46]

This is way too much code to add to ::willCommit() and the horizontal and
vertical cases are nearly identical.  Please refactor into a helper function or
two.

[wjmaclean, 2013/03/01 15:30:32]

Done.

+            m_pinchZoomScrollbarHorizontal = ScrollbarLayer::create(
+                make_scoped_ptr(
+                    new PinchZoomScrollbar(
+                        WebKit::WebScrollbar::Horizontal, this)).PassAs<WebKit::WebScrollbar>(),
+                make_scoped_ptr(new PinchZoomScrollbarPainter).PassAs<ScrollbarThemePainter>(),
+                make_scoped_ptr(new WebKit::PinchZoomScrollbarGeometry).PassAs<WebKit::WebScrollbarThemeGeometry>(),
+                0);
+            needsPropertiesUpdated = true;
+        }
+
+        DCHECK(m_pinchZoomScrollbarHorizontal);
+        if (!m_pinchZoomScrollbarHorizontal->parent())
+            m_rootLayer->addChild(m_pinchZoomScrollbarHorizontal);
+
+        if (!m_pinchZoomScrollbarVertical) {
+            m_pinchZoomScrollbarVertical = ScrollbarLayer::create(
+                make_scoped_ptr(
+                    new PinchZoomScrollbar(
+                        WebKit::WebScrollbar::Vertical, this)).PassAs<WebKit::WebScrollbar>(),
+                make_scoped_ptr(new PinchZoomScrollbarPainter).PassAs<ScrollbarThemePainter>(),
+                make_scoped_ptr(new WebKit::PinchZoomScrollbarGeometry).PassAs<WebKit::WebScrollbarThemeGeometry>(),
+                0);
+            needsPropertiesUpdated = true;
+        }
+
+        DCHECK(m_pinchZoomScrollbarVertical);
+        if (!m_pinchZoomScrollbarVertical->parent())
+            m_rootLayer->addChild(m_pinchZoomScrollbarVertical);
+
+        if (needsPropertiesUpdated)
+            setPinchZoomScrollbarPropertiesIfNeeded();
+    }
 }
 
 void LayerTreeHost::commitComplete()
 {
     m_client->didCommit();
 }
 
 scoped_ptr<OutputSurface> LayerTreeHost::createOutputSurface()
 {
     return m_client->createOutputSurface();
@@ skipping 126 matching lines @@
 }
 
 void LayerTreeHost::setViewportSize(const gfx::Size& layoutViewportSize, const gfx::Size& deviceViewportSize)
 {
     if (layoutViewportSize == m_layoutViewportSize && deviceViewportSize == m_deviceViewportSize)
         return;
 
     m_layoutViewportSize = layoutViewportSize;
     m_deviceViewportSize = deviceViewportSize;
 
+    setPinchZoomScrollbarPropertiesIfNeeded();
     setNeedsCommit();
 }
 
 void LayerTreeHost::setPageScaleFactorAndLimits(float pageScaleFactor, float minPageScaleFactor, float maxPageScaleFactor)
 {
     if (pageScaleFactor == m_pageScaleFactor && minPageScaleFactor == m_minPageScaleFactor && maxPageScaleFactor == m_maxPageScaleFactor)
         return;
 
     m_pageScaleFactor = pageScaleFactor;
     m_minPageScaleFactor = minPageScaleFactor;
@@ skipping 73 matching lines @@
 
     for (size_t i = 0; i < layer->children().size(); ++i) {
         Layer* found = findFirstScrollableLayer(layer->children()[i].get());
         if (found)
             return found;
     }
 
     return 0;
 }
 
+Layer* LayerTreeHost::rootScrollLayer() const

[jamesr, 2013/02/26 20:48:46]

I think this function can completely go away

[wjmaclean, 2013/03/01 15:30:32]

It's still used by PinchZoomScrollbar.

+{
+    return findFirstScrollableLayer(m_rootLayer.get());
+}
+
 void LayerTreeHost::updateLayers(Layer* rootLayer, ResourceUpdateQueue& queue)
 {
     TRACE_EVENT0("cc", "LayerTreeHost::updateLayers");
 
     LayerList updateList;
 
     {
         Layer* rootScroll = findFirstScrollableLayer(rootLayer);
         if (rootScroll)
             rootScroll->setImplTransform(m_implTransform);
@@ skipping 288 matching lines @@
     for (size_t childIndex = 0; childIndex < layer->children().size(); ++childIndex)
         setAnimationEventsRecursive(events, layer->children()[childIndex].get(), wallClockTime);
 }
 
 skia::RefPtr<SkPicture> LayerTreeHost::capturePicture()
 {
     return m_proxy->capturePicture();
 }
 
 }  // namespace cc