// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef ASH_DISPLAY_TOUCH_CALIBRATOR_VIEW_H_
#define ASH_DISPLAY_TOUCH_CALIBRATOR_VIEW_H_
#include <memory>
#include "ash/ash_export.h"
#include "base/memory/raw_ptr.h"
#include "cc/paint/paint_flags.h"
#include "ui/base/metadata/metadata_header_macros.h"
#include "ui/compositor/layer_animation_observer.h"
#include "ui/display/display.h"
#include "ui/gfx/animation/linear_animation.h"
#include "ui/views/animation/animation_delegate_views.h"
#include "ui/views/view.h"
#include "ui/views/widget/unique_widget_ptr.h"
namespace views {
class Label;
} // namespace views
namespace gfx {
class Animation;
} // namespace gfx
namespace ui {
class LayerAnimationSequence;
} // namespace ui
namespace ash {
class CircularThrobberView;
class HintBox;
// An overlay view used during touch calibration. This view is responsible for
// all animations and UX during touch calibration on all displays currently
// active on the device. The view on the display being calibrated is the primary
// touch calibration view.
// |TouchCalibratorView| acts as a state machine and has an API to toggle its
// state or get the current state.
class ASH_EXPORT TouchCalibratorView : public views::View,
public views::AnimationDelegateViews,
public ui::LayerAnimationObserver {
METADATA_HEADER(TouchCalibratorView, views::View)
public:
// Different states of |TouchCalibratorView| in order.
enum State {
UNKNOWN = 0,
BACKGROUND_FADING_IN, // Transition state where the background is fading
// in.
DISPLAY_POINT_1, // Static state where the touch point is at its first
// location.
ANIMATING_1_TO_2, // Transition state when the touch point is being moved
// from one location to another.
DISPLAY_POINT_2, // Static state where the touch point is at its second
// location.
ANIMATING_2_TO_3,
DISPLAY_POINT_3, // Static state where the touch point is at its third
// location.
ANIMATING_3_TO_4,
DISPLAY_POINT_4, // Static state where the touch point is at its final
// location.
ANIMATING_FINAL_MESSAGE, // Transition state when the calibration complete
// message is being transitioned into view.
CALIBRATION_COMPLETE, // Static state when the calibration complete message
// is displayed to the user.
BACKGROUND_FADING_OUT // Transition state where the background is fading
// out
};
// Only use this function to construct. This ensures a Widget is properly
// constructed and is set as the content view.
static views::UniqueWidgetPtr Create(const display::Display& target_display,
bool is_primary_view,
bool is_all_displays_calibration);
~TouchCalibratorView() override;
// views::View:
void OnPaint(gfx::Canvas* canvas) override;
void OnPaintBackground(gfx::Canvas* canvas) override;
// views::AnimationDelegateViews:
void AnimationEnded(const gfx::Animation* animation) override;
void AnimationProgressed(const gfx::Animation* animation) override;
void AnimationCanceled(const gfx::Animation* animation) override;
// ui::LayerAnimationObserver
void OnLayerAnimationStarted(ui::LayerAnimationSequence* sequence) override;
void OnLayerAnimationEnded(ui::LayerAnimationSequence* sequence) override;
void OnLayerAnimationAborted(ui::LayerAnimationSequence* sequence) override;
void OnLayerAnimationScheduled(ui::LayerAnimationSequence* sequence) override;
// Moves the touch calibrator view to its next state.
void AdvanceToNextState();
// Skips to the final state. Should be used to cancel calibration and hide all
// views from the screen with a smooth transition out animation.
void SkipToFinalState();
// Returns true if |location| is set by the end of this function call. If set,
// |location| will point to the center of the circle that the user sees during
// the touch calibration UX.
bool GetDisplayPointLocation(gfx::Point* location);
// Skips/cancels any ongoing animation to its end.
void SkipCurrentAnimation();
// Returns the current state of the view.
State state() { return state_; }
private:
TouchCalibratorView(const display::Display& target_display,
bool is_primary_view,
bool is_all_displays_calibration);
TouchCalibratorView(const TouchCalibratorView&) = delete;
TouchCalibratorView& operator=(const TouchCalibratorView&) = delete;
void InitViewContents(bool is_for_touchscreen_mapping);
// The target display on which this view is rendered on.
const display::Display display_;
// True if this view is on the display that is being calibrated.
bool is_primary_view_;
cc::PaintFlags flags_;
// Defines the bounds for the background animation.
gfx::RectF background_rect_;
// Text label indicating how to exit the touch calibration.
raw_ptr<views::Label> exit_label_ = nullptr;
// Text label indicating the significance of the touch point on screen.
raw_ptr<views::Label> tap_label_ = nullptr;
// Start and end opacity values used during the fade animation. This is set
// before the animation begins.
float start_opacity_value_ = 0.0f;
float end_opacity_value_ = 0.0f;
// Linear animation used for various aniations including fade-in, fade out,
// and view translation.
std::unique_ptr<gfx::LinearAnimation> animator_;
// View responsible for displaying the animated circular icon that the user
// touches to calibrate the screen.
raw_ptr<CircularThrobberView> throbber_circle_ = nullptr;
// A hint box displayed next to the first touch point to assist user with
// information about the next step.
raw_ptr<HintBox> hint_box_view_ = nullptr;
// Final view containing the calibration complete message along with an icon.
raw_ptr<views::View> completion_message_view_ = nullptr;
// View that contains the animated throbber circle and a text label informing
// the user to tap the circle to continue calibration.
raw_ptr<views::View> touch_point_view_ = nullptr;
State state_ = UNKNOWN;
};
} // namespace ash
#endif // ASH_DISPLAY_TOUCH_CALIBRATOR_VIEW_H_
Codebase Browser
chromium