Support for Adaptive Handle Orientation

ui/touch_selection/touch_handle.cc

Index: ui/touch_selection/touch_handle.cc
diff --git a/ui/touch_selection/touch_handle.cc b/ui/touch_selection/touch_handle.cc
index e2faff1f382cf4b85ea2892dbb1f4e7965ed03ad..8c5f609b9dd02c16c69cae6141f1702b0f8498f9 100644
--- a/ui/touch_selection/touch_handle.cc
+++ b/ui/touch_selection/touch_handle.cc
@@ -63,9 +63,11 @@ static std::ostream& operator<<(std::ostream& os,
 
 // Responsible for rendering a selection or insertion handle for text editing.
 TouchHandle::TouchHandle(TouchHandleClient* client,
-                         TouchHandleOrientation orientation)
+                         TouchHandleOrientation orientation,
+                         const gfx::RectF viewport_rect)
     : drawable_(client->CreateDrawable()),
       client_(client),
+      viewport_rect_(viewport_rect),
       orientation_(orientation),
       deferred_orientation_(TouchHandleOrientation::UNDEFINED),
       alpha_(0.f),
@@ -73,12 +75,16 @@ TouchHandle::TouchHandle(TouchHandleClient* client,
       enabled_(true),
       is_visible_(false),
       is_dragging_(false),
-      is_drag_within_tap_region_(false) {
+      is_drag_within_tap_region_(false),
+      is_handle_layout_update_required_(false),
+      mirror_vertical_(false),
+      mirror_horizontal_(false) {
   DCHECK_NE(orientation, TouchHandleOrientation::UNDEFINED);
   drawable_->SetEnabled(enabled_);
-  drawable_->SetOrientation(orientation_);
+  drawable_->SetOrientation(orientation_, false, false);
+  drawable_->SetOrigin(focus_bottom_);
   drawable_->SetAlpha(alpha_);
-  drawable_->SetFocus(position_);
+  handle_horizontal_padding_ = drawable_->GetDrawableHorizontalPadding();
 }
 
 TouchHandle::~TouchHandle() {
@@ -103,8 +109,7 @@ void TouchHandle::SetVisible(bool visible, AnimationStyle animation_style) {
   is_visible_ = visible;
 
   // Handle repositioning may have been deferred while previously invisible.
-  if (visible)
-    drawable_->SetFocus(position_);
+  SetUpdateLayoutRequired();

[mfomitchev, 2015/08/06 14:33:02]

if (visible) ?

[AviD, 2015/08/09 13:55:41]

There is a visibility check in SetUpdateLayoutRequired().

287   if (!is_visible_ || !is_handle_layout_update_required_)
288       return;


I thought it would be redundant here.

Should I still add it?

[mfomitchev, 2015/08/10 13:23:45]

Yeah, I realize we check visibility in UpdateHandleLayout(). Personally I'd
still add the check here - just so that it is crystal clear what is happening in
this code without looking anywhere else.

I don't feel strongly about this though, so if you feel it would make code
harder to understand - feel free to leave it the way it is.

[AviD, 2015/08/10 14:16:10]

Added the visibility check here.

 
   bool animate = animation_style != ANIMATION_NONE;
   if (is_dragging_) {
@@ -118,16 +123,21 @@ void TouchHandle::SetVisible(bool visible, AnimationStyle animation_style) {
     EndFade();
 }
 
-void TouchHandle::SetPosition(const gfx::PointF& position) {
-  DCHECK(enabled_);
-  if (position_ == position)
+void TouchHandle::SetFocus(const gfx::PointF& top, const gfx::PointF& bottom) {
+  if (focus_top_ == top && focus_bottom_ == bottom)
     return;
-  position_ = position;
-  // Suppress repositioning a handle while invisible or fading out to prevent it
-  // from "ghosting" outside the visible bounds. The position will be pushed to
-  // the drawable when the handle regains visibility (see |SetVisible()|).
-  if (is_visible_)
-    drawable_->SetFocus(position_);
+
+  focus_top_ = top;
+  focus_bottom_ = bottom;
+  SetUpdateLayoutRequired();
+}
+
+void TouchHandle::SetViewportRect(const gfx::RectF viewport_rect) {
+  if (viewport_rect_ == viewport_rect)
+    return;
+
+  viewport_rect_ = viewport_rect;
+  SetUpdateLayoutRequired();
 }
 
 void TouchHandle::SetOrientation(TouchHandleOrientation orientation) {
@@ -142,7 +152,7 @@ void TouchHandle::SetOrientation(TouchHandleOrientation orientation) {
     return;
 
   orientation_ = orientation;
-  drawable_->SetOrientation(orientation);
+  SetUpdateLayoutRequired();
 }
 
 bool TouchHandle::WillHandleTouchEvent(const MotionEvent& event) {
@@ -167,7 +177,7 @@ bool TouchHandle::WillHandleTouchEvent(const MotionEvent& event) {
         return false;
       }
       touch_down_position_ = touch_point;
-      touch_drag_offset_ = position_ - touch_down_position_;
+      touch_drag_offset_ = focus_bottom_ - touch_down_position_;
       touch_down_time_ = event.GetEventTime();
       BeginDrag();
     } break;
@@ -214,8 +224,8 @@ bool TouchHandle::Animate(base::TimeTicks frame_time) {
 
   float time_u =
       1.f - (fade_end_time_ - frame_time).InMillisecondsF() / kFadeDurationMs;
-  float position_u =
-      (position_ - fade_start_position_).LengthSquared() / kFadeDistanceSquared;
+  float position_u = (focus_bottom_ - fade_start_position_).LengthSquared() /
+                     kFadeDistanceSquared;
   float u = std::max(time_u, position_u);
   SetAlpha(is_visible_ ? u : 1.f - u);
 
@@ -234,6 +244,91 @@ gfx::RectF TouchHandle::GetVisibleBounds() const {
   return drawable_->GetVisibleBounds();
 }
 
+gfx::PointF TouchHandle::GetHandleOrigin() const {
+  gfx::PointF position = mirror_vertical_ ? focus_top_ : focus_bottom_;

[mfomitchev, 2015/08/06 14:33:02]

Call this "focus" instead of position? IMO position is more ambiguous.

[AviD, 2015/08/09 13:55:41]

Done.

+  gfx::RectF drawable_bounds = drawable_->GetVisibleBounds();
+  float drawable_width = drawable_->GetVisibleBounds().width();
+
+  // Set the Focal offsets for the composited handle layer

[mfomitchev, 2015/08/06 14:33:02]

"focal offsets from origin"?

[AviD, 2015/08/09 13:55:41]

Done.

+  // based on the orientation
+  int focal_offset_x = 0;
+  int focal_offset_y = mirror_vertical_ ? drawable_bounds.height() : 0;
+  switch (orientation_) {
+    case ui::TouchHandleOrientation::LEFT:
+      focal_offset_x =
+          mirror_horizontal_
+              ? drawable_width * handle_horizontal_padding_
+              : drawable_width * (1.0f - handle_horizontal_padding_);
+      break;
+    case ui::TouchHandleOrientation::RIGHT:
+      focal_offset_x =
+          mirror_horizontal_
+              ? drawable_width * (1.0f - handle_horizontal_padding_)
+              : drawable_width * handle_horizontal_padding_;
+      break;
+    case ui::TouchHandleOrientation::CENTER:
+      focal_offset_x = drawable_width * 0.5f;
+      break;
+    case ui::TouchHandleOrientation::UNDEFINED:
+      NOTREACHED() << "Invalid touch handle orientation.";
+      break;
+  };
+
+  gfx::Vector2dF offset_from_origin_ =

[mfomitchev, 2015/08/06 14:33:02]

I'd just remove this variable and use the vector directly in the calc below. If
you decide to leave it, please remove the trailing underscore.

[AviD, 2015/08/09 13:55:41]

Done.

+      gfx::Vector2dF(focal_offset_x, focal_offset_y);
+
+  return position - offset_from_origin_;
+}
+
+void TouchHandle::UpdateHandleLayout() {
+  // Suppress repositioning a handle while invisible or fading out to prevent it
+  // from "ghosting" outside the visible bounds. The position will be pushed to
+  // the drawable when the handle regains visibility (see |SetVisible()|).
+  if (!is_visible_ || !is_handle_layout_update_required_)
+    return;
+
+  is_handle_layout_update_required_ = false;
+
+  // Update mirror values only when dragging has stopped to prevent unwanted
+  // inversion while dragging of handles
+  if (client_->IsEnabledAdaptiveHandleOrientation() && !is_dragging_) {
+    gfx::RectF handle_bounds = drawable_->GetVisibleBounds();
+    bool mirror_horizontal = false;
+    bool mirror_vertical = false;
+
+    const float handle_width =
+        handle_bounds.width() * (1.0 - handle_horizontal_padding_);
+    const float handle_height = handle_bounds.height();
+
+    const float bottom_y_unmirrored =
+        focus_bottom_.y() + handle_height + viewport_rect_.y();
+    const float top_y_mirrored =
+        focus_top_.y() - handle_height + viewport_rect_.y();
+
+    // In case the viewport height is small, like webview, avoid inversion.
+    if (bottom_y_unmirrored > viewport_rect_.bottom() &&
+        top_y_mirrored > viewport_rect_.y()) {
+      mirror_vertical = true;
+    }
+
+    if (orientation_ == TouchHandleOrientation::LEFT &&
+        focus_bottom_.x() - handle_width < viewport_rect_.x()) {
+      mirror_horizontal = true;
+    } else if (orientation_ == TouchHandleOrientation::RIGHT &&
+               focus_bottom_.x() + handle_width > viewport_rect_.right()) {
+      mirror_horizontal = true;
+    }
+
+    mirror_horizontal_ = mirror_horizontal;
+    mirror_vertical_ = mirror_vertical;
+  }
+
+  drawable_->SetOrientation(orientation_, mirror_vertical_, mirror_horizontal_);
+
+  gfx::PointF origin = GetHandleOrigin();
+  drawable_->SetOrigin(origin);
+}
+
 void TouchHandle::BeginDrag() {
   DCHECK(enabled_);
   if (is_dragging_)
@@ -241,7 +336,7 @@ void TouchHandle::BeginDrag() {
   EndFade();
   is_dragging_ = true;
   is_drag_within_tap_region_ = true;
-  client_->OnDragBegin(*this, position());
+  client_->OnDragBegin(*this, focus_bottom());
 }
 
 void TouchHandle::EndDrag() {
@@ -257,6 +352,9 @@ void TouchHandle::EndDrag() {
     TouchHandleOrientation deferred_orientation = deferred_orientation_;
     deferred_orientation_ = TouchHandleOrientation::UNDEFINED;
     SetOrientation(deferred_orientation);
+    // Handle layout may is deferred while the handle is dragged.
+    SetUpdateLayoutRequired();
+    UpdateHandleLayout();
   }
 
   if (animate_deferred_fade_) {
@@ -281,7 +379,7 @@ void TouchHandle::BeginFade() {
   fade_end_time_ = base::TimeTicks::Now() +
                    base::TimeDelta::FromMillisecondsD(
                        kFadeDurationMs * std::abs(target_alpha - alpha_));
-  fade_start_position_ = position_;
+  fade_start_position_ = focus_bottom_;
   client_->SetNeedsAnimate();
 }