[vr] Clicking on the security icon should prompt the user to bail out of VR

chrome/browser/android/vr_shell/ui_scene_manager.cc

 // Copyright 2017 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/vr_shell/ui_scene_manager.h"
 
 #include "base/callback.h"
 #include "base/memory/ptr_util.h"
 #include "chrome/browser/android/vr_shell/textures/close_button_texture.h"
 #include "chrome/browser/android/vr_shell/textures/ui_texture.h"
 #include "chrome/browser/android/vr_shell/ui_elements/audio_capture_indicator.h"
 #include "chrome/browser/android/vr_shell/ui_elements/button.h"
+#include "chrome/browser/android/vr_shell/ui_elements/exit_prompt.h"
 #include "chrome/browser/android/vr_shell/ui_elements/exit_warning.h"
 #include "chrome/browser/android/vr_shell/ui_elements/loading_indicator.h"
 #include "chrome/browser/android/vr_shell/ui_elements/permanent_security_warning.h"
 #include "chrome/browser/android/vr_shell/ui_elements/screen_capture_indicator.h"
 #include "chrome/browser/android/vr_shell/ui_elements/screen_dimmer.h"
 #include "chrome/browser/android/vr_shell/ui_elements/transient_security_warning.h"
 #include "chrome/browser/android/vr_shell/ui_elements/ui_element.h"
 #include "chrome/browser/android/vr_shell/ui_elements/ui_element_debug_id.h"
 #include "chrome/browser/android/vr_shell/ui_elements/url_bar.h"
 #include "chrome/browser/android/vr_shell/ui_elements/video_capture_indicator.h"
 #include "chrome/browser/android/vr_shell/ui_scene.h"
 #include "chrome/browser/android/vr_shell/vr_browser_interface.h"
 
 namespace vr_shell {
 
 namespace {
 
 static constexpr int kWarningTimeoutSeconds = 30;
 static constexpr float kWarningDistance = 0.7;
 static constexpr float kWarningAngleRadians = 16.3 * M_PI / 180.0;
 static constexpr float kPermanentWarningHeight = 0.070f;
 static constexpr float kPermanentWarningWidth = 0.224f;
 static constexpr float kTransientWarningHeight = 0.160;
 static constexpr float kTransientWarningWidth = 0.512;
 
+static constexpr float kExitPromptDistance = 2.5;
+static constexpr float kExitPromptWidth = 0.672 * kExitPromptDistance;
+static constexpr float kExitPromptHeight = 0.2 * kExitPromptDistance;
+static constexpr float kExitPromptVerticalOffset = -0.1 * kExitPromptDistance;
+
 static constexpr float kExitWarningDistance = 0.6;
 static constexpr float kExitWarningHeight = 0.160;
 static constexpr float kExitWarningWidth = 0.512;
 
 static constexpr float kContentDistance = 2.5;
 static constexpr float kContentWidth = 0.96 * kContentDistance;
 static constexpr float kContentHeight = 0.64 * kContentDistance;
 static constexpr float kContentVerticalOffset = -0.1 * kContentDistance;
 static constexpr float kBackplaneSize = 1000.0;
 static constexpr float kBackgroundDistanceMultiplier = 1.414;
@@ skipping 98 matching lines @@
   element->set_id(AllocateId());
   element->set_fill(vr_shell::Fill::NONE);
   element->set_size({kExitWarningWidth, kExitWarningHeight, 1});
   element->set_scale({kExitWarningDistance, kExitWarningDistance, 1});
   element->set_translation({0, 0, -kExitWarningDistance});
   element->set_visible(false);
   element->set_hit_testable(false);
   element->set_lock_to_fov(true);
   exit_warning_ = element.get();
   scene_->AddUiElement(std::move(element));
+
+  element = base::MakeUnique<ExitPrompt>(
+      512,
+      base::Bind(&UiSceneManager::OnExitPromptPrimaryButtonClicked,
+                 base::Unretained(this)),
+      base::Bind(&UiSceneManager::OnExitPromptSecondaryButtonClicked,
+                 base::Unretained(this)));
+  element->set_debug_id(kExitPrompt);
+  element->set_id(AllocateId());
+  element->set_fill(vr_shell::Fill::NONE);
+  element->set_size({kExitPromptWidth, kExitPromptHeight, 1});
+  element->set_translation(
+      {0, kExitPromptVerticalOffset, -kExitPromptDistance});
+  element->set_visible(false);
+  exit_prompt_ = element.get();
+  scene_->AddUiElement(std::move(element));
 }
 
 void UiSceneManager::CreateSystemIndicators() {
   std::unique_ptr<UiElement> element;
 
   // TODO(acondor): Make constants for sizes and positions once the UX for the
   // indicators is defined.
   element = base::MakeUnique<AudioCaptureIndicator>(512);
   element->set_debug_id(kAudioCaptureIndicator);
   element->set_id(AllocateId());
@@ skipping 38 matching lines @@
 
   // Place an invisible but hittable plane behind the content quad, to keep the
   // reticle roughly planar with the content if near content.
   element = base::MakeUnique<UiElement>();
   element->set_debug_id(kBackplane);
   element->set_id(AllocateId());
   element->set_fill(vr_shell::Fill::NONE);
   element->set_size({kBackplaneSize, kBackplaneSize, 1.0});
   element->set_translation({0.0, 0.0, -kTextureOffset});
   element->set_parent_id(main_content_->id());
+  main_content_backplane_ = element.get();
   content_elements_.push_back(element.get());
   scene_->AddUiElement(std::move(element));
 
   // Limit reticle distance to a sphere based on content distance.
   scene_->SetBackgroundDistance(main_content_->translation().z() *
                                 -kBackgroundDistanceMultiplier);
 }
 
 void UiSceneManager::CreateBackground() {
   std::unique_ptr<UiElement> element;
 
   // Floor.
   element = base::MakeUnique<UiElement>();
   element->set_debug_id(kFloor);
   element->set_id(AllocateId());
   element->set_size({kSceneSize, kSceneSize, 1.0});
   element->set_translation({0.0, -kSceneHeight / 2, 0.0});
   element->set_rotation({1.0, 0.0, 0.0, -M_PI / 2.0});
   element->set_fill(vr_shell::Fill::GRID_GRADIENT);
   element->set_draw_phase(0);
   element->set_gridline_count(kFloorGridlineCount);
   floor_ = element.get();
-  content_elements_.push_back(element.get());
+  background_elements_.push_back(element.get());

[amp, 2017/06/02 20:37:01]

This is going to confuse the unit tests for transitions.

[ymalik, 2017/06/04 04:08:56]

I ran all the vr unit tests and they seem to pass. Which test in particular are
you talking about?

[amp, 2017/06/05 16:44:57]

Sorry, ignore this.  I was misremembering an older version of the tests (the
same one where I made the internals accessible) where the tests used 
content_elements_ to verify what is visible.  I momentarily forgot that we
transitioned to declaring explicitly what elements should be visible.

   scene_->AddUiElement(std::move(element));
 
   // Ceiling.
   element = base::MakeUnique<UiElement>();
   element->set_debug_id(kCeiling);
   element->set_id(AllocateId());
   element->set_size({kSceneSize, kSceneSize, 1.0});
   element->set_translation({0.0, kSceneHeight / 2, 0.0});
   element->set_rotation({1.0, 0.0, 0.0, M_PI / 2});
   element->set_fill(vr_shell::Fill::OPAQUE_GRADIENT);
   element->set_draw_phase(0);
   ceiling_ = element.get();
-  content_elements_.push_back(element.get());
+  background_elements_.push_back(element.get());
   scene_->AddUiElement(std::move(element));
 
   UpdateBackgroundColor();
 }
 
 void UiSceneManager::CreateUrlBar() {
   // TODO(cjgrant): Incorporate final size and position.
   auto url_bar = base::MakeUnique<UrlBar>(
       512,
+      base::Bind(&UiSceneManager::OnBackButtonClicked, base::Unretained(this)),
+      base::Bind(&UiSceneManager::OnSecurityIconClicked,
+                 base::Unretained(this)),
       base::Bind(&UiSceneManager::OnUnsupportedMode, base::Unretained(this)));
   url_bar->set_debug_id(kUrlBar);
   url_bar->set_id(AllocateId());
   url_bar->set_translation({0, kUrlBarVerticalOffset, -kUrlBarDistance});
   url_bar->set_size({kUrlBarWidth, kUrlBarHeight, 1});
-  url_bar->SetBackButtonCallback(
-      base::Bind(&UiSceneManager::OnBackButtonClicked, base::Unretained(this)));
   url_bar_ = url_bar.get();
   control_elements_.push_back(url_bar.get());
   scene_->AddUiElement(std::move(url_bar));
 
   auto indicator = base::MakeUnique<LoadingIndicator>(256);
   indicator->set_debug_id(kLoadingIndicator);
   indicator->set_id(AllocateId());
   indicator->set_translation({0, 0, kLoadingIndicatorOffset});
   indicator->set_size({kLoadingIndicatorWidth, kLoadingIndicatorHeight, 1});
   indicator->set_parent_id(url_bar_->id());
@@ skipping 28 matching lines @@
   web_vr_mode_ = web_vr;
   ConfigureScene();
   ConfigureSecurityWarnings();
   audio_capture_indicator_->set_visible(!web_vr && audio_capturing_);
   video_capture_indicator_->set_visible(!web_vr && video_capturing_);
   screen_capture_indicator_->set_visible(!web_vr && screen_capturing_);
 }
 
 void UiSceneManager::ConfigureScene() {
   exit_warning_->SetEnabled(scene_->is_exiting());
+  exit_prompt_->SetEnabled(scene_->is_prompting_to_exit());
   screen_dimmer_->SetEnabled(scene_->is_exiting());
 
   // Controls (URL bar, loading progress, etc).
   bool controls_visible = !web_vr_mode_ && !fullscreen_;
   for (UiElement* element : control_elements_) {
-    element->SetEnabled(controls_visible);
+    element->SetEnabled(controls_visible && !scene_->is_prompting_to_exit());
   }
 
   // Content elements.
   for (UiElement* element : content_elements_) {
+    // We don't want to show the content elements when the exit prompt is
+    // visible. The only content element visible in this case is the invisible
+    // backplane that we add right behind the content rect so that the rectile

[cjgrant, 2017/06/02 04:16:36]

s/rectile/reticle/

[ymalik, 2017/06/02 21:14:31]

Done.

+    // doesn't jump when it transitions between the content rect (and the exit
+    // prompt in this case) and the background.
+    bool disabled_for_exit_prompt =
+        element != main_content_backplane_ && scene_->is_prompting_to_exit();
+    element->SetEnabled(!web_vr_mode_ && !disabled_for_exit_prompt);
+  }
+
+  // Background elements.
+  for (UiElement* element : background_elements_) {
     element->SetEnabled(!web_vr_mode_);
   }
 
   // Update content quad parameters depending on fullscreen.
   // TODO(http://crbug.com/642937): Animate fullscreen transitions.
   if (fullscreen_) {
     main_content_->set_translation(
         {0, kFullscreenVerticalOffset, -kFullscreenDistance});
     main_content_->set_size({kFullscreenWidth, kFullscreenHeight, 1});
   } else {
@@ skipping 76 matching lines @@
 }
 
 void UiSceneManager::OnSecurityWarningTimer() {
   transient_security_warning_->set_visible(false);
 }
 
 void UiSceneManager::OnBackButtonClicked() {
   browser_->NavigateBack();
 }
 
+void UiSceneManager::OnSecurityIconClicked() {
+  if (scene_->is_prompting_to_exit())
+    return;
+  scene_->set_is_prompting_to_exit(true);

[cjgrant, 2017/06/02 04:16:36]

I need to look at this tomorrow, but I don't get why the scene should have any
notion of prompting.  Conceptually it's a batch of elements for GL to draw. 
Seems odd...

[ymalik, 2017/06/04 04:08:56]

The prompt is a part of the scene so it should know when something is visible?
Not sure. We also do the same for ExitWarning.

+  ConfigureScene();
+}
+
+void UiSceneManager::OnExitPromptPrimaryButtonClicked() {
+  if (!scene_->is_prompting_to_exit())
+    return;
+  scene_->set_is_prompting_to_exit(false);
+  ConfigureScene();
+}
+
+void UiSceneManager::OnExitPromptSecondaryButtonClicked() {
+  OnUnsupportedMode(UiUnsupportedMode::kUnhandledPageInfo);
+}
+
 void UiSceneManager::SetURL(const GURL& gurl) {
   url_bar_->SetURL(gurl);
 }
 
 void UiSceneManager::SetSecurityLevel(security_state::SecurityLevel level) {
   url_bar_->SetSecurityLevel(level);
 }
 
 void UiSceneManager::SetLoading(bool loading) {
   loading_indicator_->SetLoading(loading);
@@ skipping 33 matching lines @@
   if (fullscreen_)
     return ColorScheme::kModeFullscreen;
   return ColorScheme::kModeNormal;
 }
 
 const ColorScheme& UiSceneManager::color_scheme() const {
   return ColorScheme::GetColorScheme(mode());
 }
 
 }  // namespace vr_shell