1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef UI_EVENTS_GESTURE_DETECTION_MOTION_EVENT_H_
6 #define UI_EVENTS_GESTURE_DETECTION_MOTION_EVENT_H_
8 #include "base/memory/scoped_ptr.h"
9 #include "base/time/time.h"
10 #include "ui/events/gesture_detection/gesture_detection_export.h"
14 // Abstract class for a generic motion-related event, patterned after that
15 // subset of Android's MotionEvent API used in gesture detection.
16 class GESTURE_DETECTION_EXPORT MotionEvent {
36 BUTTON_PRIMARY = 1 << 0,
37 BUTTON_SECONDARY = 1 << 1,
38 BUTTON_TERTIARY = 1 << 2,
40 BUTTON_FORWARD = 1 << 4,
43 // The implementer promises that |GetPointerId()| will never exceed this.
44 enum { MAX_POINTER_ID = 31 };
46 virtual ~MotionEvent() {}
48 virtual int GetId() const = 0;
49 virtual Action GetAction() const = 0;
50 // Only valid if |GetAction()| returns ACTION_POINTER_UP or
51 // ACTION_POINTER_DOWN.
52 virtual int GetActionIndex() const = 0;
53 virtual size_t GetPointerCount() const = 0;
54 virtual int GetPointerId(size_t pointer_index) const = 0;
55 virtual float GetX(size_t pointer_index) const = 0;
56 virtual float GetY(size_t pointer_index) const = 0;
57 virtual float GetRawX(size_t pointer_index) const = 0;
58 virtual float GetRawY(size_t pointer_index) const = 0;
59 virtual float GetTouchMajor(size_t pointer_index) const = 0;
60 virtual float GetPressure(size_t pointer_index) const = 0;
61 virtual ToolType GetToolType(size_t pointer_index) const = 0;
62 virtual int GetButtonState() const = 0;
63 virtual base::TimeTicks GetEventTime() const = 0;
65 // Optional historical data, default implementation provides an empty history.
66 virtual size_t GetHistorySize() const;
67 virtual base::TimeTicks GetHistoricalEventTime(size_t historical_index) const;
68 virtual float GetHistoricalTouchMajor(size_t pointer_index,
69 size_t historical_index) const;
70 virtual float GetHistoricalX(size_t pointer_index,
71 size_t historical_index) const;
72 virtual float GetHistoricalY(size_t pointer_index,
73 size_t historical_index) const;
75 virtual scoped_ptr<MotionEvent> Clone() const = 0;
76 virtual scoped_ptr<MotionEvent> Cancel() const = 0;
78 // Utility accessor methods for convenience.
79 float GetX() const { return GetX(0); }
80 float GetY() const { return GetY(0); }
81 float GetRawX() const { return GetRawX(0); }
82 float GetRawY() const { return GetRawY(0); }
83 float GetRawOffsetX() const { return GetRawX() - GetX(); }
84 float GetRawOffsetY() const { return GetRawY() - GetY(); }
85 float GetTouchMajor() const { return GetTouchMajor(0); }
86 float GetPressure() const { return GetPressure(0); }
87 ToolType GetToolType() const { return GetToolType(0); }
89 // O(N) search of pointers (use sparingly!). Returns -1 if |id| nonexistent.
90 int FindPointerIndexOfId(int id) const;
93 GESTURE_DETECTION_EXPORT bool operator==(const MotionEvent& lhs,
94 const MotionEvent& rhs);
95 GESTURE_DETECTION_EXPORT bool operator!=(const MotionEvent& lhs,
96 const MotionEvent& rhs);
100 #endif // UI_EVENTS_GESTURE_DETECTION_MOTION_EVENT_H_