Show splash screen when entering VR from a deep-link

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_browser_interface.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_prompt_backplane.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/splash_screen_icon.h"
 #include "chrome/browser/android/vr_shell/ui_elements/transient_security_warning.h"
 #include "chrome/browser/android/vr_shell/ui_elements/transient_url_bar.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"
 
 namespace vr_shell {
 
@@ skipping 49 matching lines @@
 
 static constexpr float kTransientUrlBarDistance = 1.4;
 static constexpr float kTransientUrlBarWidth =
     kUrlBarWidthDMM * kTransientUrlBarDistance;
 static constexpr float kTransientUrlBarHeight =
     kUrlBarHeightDMM * kTransientUrlBarDistance;
 static constexpr float kTransientUrlBarVerticalOffset =
     -0.2 * kTransientUrlBarDistance;
 static constexpr int kTransientUrlBarTimeoutSeconds = 6;
 
+static constexpr float kSplashScreenDistance = 1;
+static constexpr float kSplashScreenIconDMM = 0.12;
+static constexpr float kSplashScreenIconHeight =
+    kSplashScreenIconDMM * kSplashScreenDistance;
+static constexpr float kSplashScreenIconWidth =
+    kSplashScreenIconDMM * kSplashScreenDistance;
+static constexpr float kSplashScreenIconVerticalOffset =
+    0.2 * kSplashScreenDistance;
+
 static constexpr float kCloseButtonDistance = 2.4;
 static constexpr float kCloseButtonHeight =
     kUrlBarHeightDMM * kCloseButtonDistance;
 static constexpr float kCloseButtonWidth =
     kUrlBarHeightDMM * kCloseButtonDistance;
 static constexpr float kCloseButtonFullscreenDistance = 2.9;
 static constexpr float kCloseButtonFullscreenHeight =
     kUrlBarHeightDMM * kCloseButtonDistance;
 static constexpr float kCloseButtonFullscreenWidth =
     kUrlBarHeightDMM * kCloseButtonDistance;
@@ skipping 13 matching lines @@
 
 // Tiny distance to offset textures that should appear in the same plane.
 static constexpr float kTextureOffset = 0.01;
 
 }  // namespace
 
 UiSceneManager::UiSceneManager(UiBrowserInterface* browser,
                                UiScene* scene,
                                bool in_cct,
                                bool in_web_vr,
-                               bool web_vr_autopresented)
+                               bool web_vr_autopresentation_expected)
     : browser_(browser),
       scene_(scene),
       in_cct_(in_cct),
       web_vr_mode_(in_web_vr),
-      web_vr_autopresented_(web_vr_autopresented),
+      web_vr_autopresentation_expected_(web_vr_autopresentation_expected),
       weak_ptr_factory_(this) {
+  CreateSplashScreen();
   CreateBackground();
   CreateContentQuad();
   CreateSecurityWarnings();
   CreateSystemIndicators();
   CreateUrlBar();
   CreateTransientUrlBar();
   CreateCloseButton();
   CreateScreenDimmer();
   CreateExitPrompt();
 
+  scene_->set_showing_splash_screen(web_vr_autopresentation_expected_);

[cjgrant, 2017/06/23 19:26:32]

Why is this not in ConfigureScene()?

[ymalik, 2017/06/25 20:27:14]

Done.

+
   ConfigureScene();
   ConfigureSecurityWarnings();
-  ConfigureTransientUrlBar();
 }
 
 UiSceneManager::~UiSceneManager() {}
 
 void UiSceneManager::CreateScreenDimmer() {
   std::unique_ptr<UiElement> element;
   element = base::MakeUnique<ScreenDimmer>();
   element->set_debug_id(kScreenDimmer);
   element->set_id(AllocateId());
   element->set_fill(vr_shell::Fill::NONE);
@@ skipping 120 matching lines @@
   element->set_translation({0.0, 0.0, -kTextureOffset});
   element->set_parent_id(main_content_->id());
   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::CreateSplashScreen() {
+  // Chrome icon.
+  std::unique_ptr<SplashScreenIcon> icon =
+      base::MakeUnique<SplashScreenIcon>(256);
+  icon->set_debug_id(kSplashScreenIcon);
+  icon->set_id(AllocateId());
+  icon->set_hit_testable(false);
+  icon->set_size({kSplashScreenIconWidth, kSplashScreenIconHeight, 1.0});
+  icon->set_translation(
+      {0, kSplashScreenIconVerticalOffset, -kSplashScreenDistance});
+  splash_screen_icon_ = icon.get();
+  scene_->AddUiElement(std::move(icon));
+}
+
 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(gfx::Quaternion(gfx::Vector3dF(1, 0, 0), -M_PI / 2));
@@ skipping 112 matching lines @@
   element->set_parent_id(exit_prompt_->id());
   exit_prompt_backplane_ = element.get();
   content_elements_.push_back(element.get());
   scene_->AddUiElement(std::move(element));
 }
 
 base::WeakPtr<UiSceneManager> UiSceneManager::GetWeakPtr() {
   return weak_ptr_factory_.GetWeakPtr();
 }
 
-void UiSceneManager::SetWebVrMode(bool web_vr, bool auto_presented) {
+void UiSceneManager::SetWebVrMode(bool web_vr) {
   if (web_vr_mode_ == web_vr)
     return;
   web_vr_mode_ = web_vr;
-  web_vr_autopresented_ = auto_presented;
+  scene_->set_showing_splash_screen(false);
+
   ConfigureScene();
   ConfigureSecurityWarnings();
   ConfigureTransientUrlBar();
   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_);
+  web_vr_autopresentation_expected_ = false;
 }
 
 void UiSceneManager::ConfigureScene() {
-  exit_warning_->SetEnabled(scene_->is_exiting());
-  screen_dimmer_->SetEnabled(scene_->is_exiting());
+  splash_screen_icon_->SetEnabled(!web_vr_mode_ &&
+                                  scene_->showing_splash_screen());
+
+  bool browsing_mode = !web_vr_mode_ && !scene_->showing_splash_screen();
+  // Exit warning.

[cjgrant, 2017/06/23 19:26:32]

New-line before // Exit warning, as others below?

[ymalik, 2017/06/25 20:27:14]

Done.

+  exit_warning_->SetEnabled(scene_->is_exiting() && browsing_mode);
+  screen_dimmer_->SetEnabled(scene_->is_exiting() && browsing_mode);

[cjgrant, 2017/06/23 19:26:33]

Why are these changing to not show in WebVR?

[ymalik, 2017/06/25 20:27:14]

You're right. this shouldn't be the case. We can be exiting when in WebVR
because we show the transient url bar now.

 
   // Controls (URL bar, loading progress, etc).
-  bool controls_visible = !web_vr_mode_ && !fullscreen_;
+  bool controls_visible = browsing_mode && !fullscreen_;
   for (UiElement* element : control_elements_) {
     element->SetEnabled(controls_visible && !scene_->is_prompting_to_exit());
   }
 
   // Close button is a special control element that needs to be hidden when in
   // WebVR, but it needs to be visible when in cct or fullscreen.
-  close_button_->SetEnabled(!web_vr_mode_ && (fullscreen_ || in_cct_));
+  close_button_->SetEnabled(browsing_mode && (fullscreen_ || in_cct_));
 
   // Content elements.
   for (UiElement* element : content_elements_) {
-    element->SetEnabled(!web_vr_mode_ && !scene_->is_prompting_to_exit());
+    element->SetEnabled(browsing_mode && !scene_->is_prompting_to_exit());
   }
 
   // Background elements.
   for (UiElement* element : background_elements_) {
-    element->SetEnabled(!web_vr_mode_);
+    element->SetEnabled(browsing_mode);
   }
 
   // Exit prompt.
-  bool showExitPrompt = !web_vr_mode_ && scene_->is_prompting_to_exit();
+  bool showExitPrompt = browsing_mode && scene_->is_prompting_to_exit();
   exit_prompt_->SetEnabled(showExitPrompt);
   exit_prompt_backplane_->SetEnabled(showExitPrompt);
 
   // 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});
 
@@ skipping 24 matching lines @@
 void UiSceneManager::UpdateBackgroundColor() {
   // TODO(vollick): it would be nice if ceiling, floor and the grid were
   // UiElement subclasses and could respond to the OnSetMode signal.
   ceiling_->set_center_color(color_scheme().ceiling);
   ceiling_->set_edge_color(color_scheme().world_background);
   floor_->set_center_color(color_scheme().floor);
   floor_->set_edge_color(color_scheme().world_background);
   floor_->set_grid_color(color_scheme().floor_grid);
 }
 
+void UiSceneManager::SetSplashScreenIcon(const SkBitmap& bitmap) {
+  splash_screen_icon_->SetSplashScreenIcon(bitmap);

[cjgrant, 2017/06/23 19:26:32]

SetSplashScreenBitmap() for clarity?  As is you're setting an icon on an icon.

[ymalik, 2017/06/25 20:27:14]

The "icon" here refers to the actual logo. SplashScreenBitmap is a bit ambiguous
since the loading indicator (to come) can also have a bitmap. SetBitmap or
SetSplashScreenIconBitmap seems fine. Changed to latter. 

+  ConfigureScene();
+}
+
 void UiSceneManager::SetAudioCapturingIndicator(bool enabled) {
   audio_capturing_ = enabled;
   audio_capture_indicator_->set_visible(enabled && !web_vr_mode_);
 }
 
 void UiSceneManager::SetVideoCapturingIndicator(bool enabled) {
   video_capturing_ = enabled;
   video_capture_indicator_->set_visible(enabled && !web_vr_mode_);
 }
 
@@ skipping 41 matching lines @@
   } else {
     security_warning_timer_.Stop();
   }
 }
 
 void UiSceneManager::OnSecurityWarningTimer() {
   transient_security_warning_->set_visible(false);
 }
 
 void UiSceneManager::ConfigureTransientUrlBar() {
-  bool enabled = web_vr_mode_ && web_vr_autopresented_;
+  bool enabled = web_vr_mode_ && web_vr_autopresentation_expected_;
   transient_url_bar_->set_visible(enabled);
   if (enabled) {
     transient_url_bar_timer_.Start(
         FROM_HERE, base::TimeDelta::FromSeconds(kTransientUrlBarTimeoutSeconds),
         this, &UiSceneManager::OnTransientUrlBarTimer);
   } else {
     transient_url_bar_timer_.Stop();
   }
 }
 
@@ skipping 92 matching lines @@
   if (fullscreen_)
     return ColorScheme::kModeFullscreen;
   return ColorScheme::kModeNormal;
 }
 
 const ColorScheme& UiSceneManager::color_scheme() const {
   return ColorScheme::GetColorScheme(mode());
 }
 
 }  // namespace vr_shell