OLD | NEW |
---|---|
1 // Copyright 2016 The Chromium Authors. All rights reserved. | 1 // Copyright 2016 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef ASH_LASER_LASER_POINTER_POINTS_H_ | 5 #ifndef ASH_LASER_LASER_POINTER_POINTS_H_ |
6 #define ASH_LASER_LASER_POINTER_POINTS_H_ | 6 #define ASH_LASER_LASER_POINTER_POINTS_H_ |
7 | 7 |
8 #include <deque> | 8 #include <deque> |
9 #include <memory> | 9 #include <memory> |
10 | 10 |
11 #include "ash/ash_export.h" | 11 #include "ash/ash_export.h" |
12 #include "base/time/time.h" | 12 #include "base/time/time.h" |
13 #include "ui/gfx/geometry/point.h" | 13 #include "ui/gfx/geometry/point.h" |
14 #include "ui/gfx/geometry/rect.h" | 14 #include "ui/gfx/geometry/rect.h" |
15 | 15 |
16 namespace ash { | 16 namespace ash { |
17 | 17 |
18 // LaserPointerPoints is a helper class used for displaying the palette tool | 18 // LaserPointerPoints is a helper class used for displaying the palette tool |
19 // laser pointer. It keeps track of the points needed to render the laser | 19 // laser pointer. It keeps track of the points needed to render the laser |
20 // pointer and its tail. | 20 // pointer and its tail. |
21 class ASH_EXPORT LaserPointerPoints { | 21 class ASH_EXPORT LaserPointerPoints { |
22 public: | 22 public: |
23 // Struct to describe each point. | 23 // Struct to describe each point. |
24 struct LaserPoint { | 24 struct LaserPoint { |
25 gfx::Point location; | 25 gfx::Point location; |
26 base::Time creation_time; | 26 base::Time creation_time; |
jdufault
2016/10/04 22:04:13
Why does the point store its creation_time? age ca
sammiequon
2016/10/05 17:42:23
Done.
| |
27 // age is a value between [0,1] where 0 means the point was just added and 1 | |
28 // means that the point is just about to be removed. | |
29 double age; | |
27 }; | 30 }; |
28 | 31 |
29 // Constructor with a parameter to choose the fade out time of the points in | 32 // Constructor with a parameter to choose the fade out time of the points in |
30 // the collection. | 33 // the collection. |
31 explicit LaserPointerPoints(base::TimeDelta life_duration); | 34 explicit LaserPointerPoints(base::TimeDelta life_duration); |
32 ~LaserPointerPoints(); | 35 ~LaserPointerPoints(); |
33 | 36 |
34 // Adds a point. Automatically clears points that are too old. | 37 // Adds a point. Automatically clears points that are too old. |
35 void AddPoint(const gfx::Point& point); | 38 void AddPoint(const gfx::Point& point); |
39 // Updates the collection latest time. Automatically clears points that are | |
40 // too old. | |
41 void MoveForwardToCurrentTime(); | |
42 void MoveForwardToTime(const base::Time& new_latest_time); | |
36 // Removes all points. | 43 // Removes all points. |
37 void Clear(); | 44 void Clear(); |
38 // Gets the bounding box of the points. | 45 // Gets the bounding box of the points. |
39 gfx::Rect GetBoundingBox(); | 46 gfx::Rect GetBoundingBox(); |
40 // Returns the oldest point in the collection. | 47 // Returns the oldest point in the collection. |
41 LaserPoint GetOldest() const; | 48 LaserPoint GetOldest() const; |
42 // Returns the newest point in the collection. | 49 // Returns the newest point in the collection. |
43 LaserPoint GetNewest() const; | 50 LaserPoint GetNewest() const; |
44 // Returns the number of points in the collection. | 51 // Returns the number of points in the collection. |
45 int GetNumberOfPoints() const; | 52 int GetNumberOfPoints() const; |
46 // Whether there are any points or not. | 53 // Whether there are any points or not. |
47 bool IsEmpty() const; | 54 bool IsEmpty() const; |
48 // Expose the collection so callers can work with the points. | 55 // Expose the collection so callers can work with the points. |
49 const std::deque<LaserPoint>& laser_points(); | 56 const std::deque<LaserPoint>& laser_points(); |
50 | 57 |
51 private: | 58 private: |
52 friend class LaserPointerPointsTestApi; | 59 friend class LaserPointerPointsTestApi; |
53 | 60 |
54 void ClearOldPoints(); | 61 void ClearOldPoints(); |
62 void UpdateAges(); | |
55 | 63 |
56 base::TimeDelta life_duration_; | 64 base::TimeDelta life_duration_; |
57 std::deque<LaserPoint> points_; | 65 std::deque<LaserPoint> points_; |
66 // The latest time of the collection of points. This gets updated when new | |
67 // points are added or when MoveForwardInTime is called. | |
68 base::Time collection_latest_time_; | |
58 | 69 |
59 DISALLOW_COPY_AND_ASSIGN(LaserPointerPoints); | 70 DISALLOW_COPY_AND_ASSIGN(LaserPointerPoints); |
60 }; | 71 }; |
61 | 72 |
62 } // namespace ash | 73 } // namespace ash |
63 | 74 |
64 #endif // ASH_LASER_LASER_POINTER_POINTS_H_ | 75 #endif // ASH_LASER_LASER_POINTER_POINTS_H_ |
OLD | NEW |