motion_event.h revision a1401311d1ab56c4ed0a474bd38c108f75cb0cd9 
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.
4
5#ifndef UI_EVENTS_GESTURE_DETECTION_MOTION_EVENT_H_
6#define UI_EVENTS_GESTURE_DETECTION_MOTION_EVENT_H_
7
8#include "base/memory/scoped_ptr.h"
9#include "base/time/time.h"
10#include "ui/events/gesture_detection/gesture_detection_export.h"
11
12namespace ui {
13
14// Abstract class for a generic motion-related event, patterned after that
15// subset of Android's MotionEvent API used in gesture detection.
16class GESTURE_DETECTION_EXPORT MotionEvent {
17 public:
18  enum Action {
19    ACTION_DOWN,
20    ACTION_UP,
21    ACTION_MOVE,
22    ACTION_CANCEL,
23    ACTION_POINTER_DOWN,
24    ACTION_POINTER_UP,
25  };
26
27  // The implementer promises that |GetPointerId()| will never exceed this.
28  enum { MAX_POINTER_ID = 31 };
29
30  virtual ~MotionEvent() {}
31
32  virtual Action GetAction() const = 0;
33  virtual int GetActionIndex() const = 0;
34  virtual size_t GetPointerCount() const = 0;
35  virtual int GetPointerId(size_t pointer_index) const = 0;
36  virtual float GetX(size_t pointer_index) const = 0;
37  virtual float GetY(size_t pointer_index) const = 0;
38  virtual float GetTouchMajor(size_t pointer_index) const = 0;
39  virtual float GetPressure(size_t pointer_index) const = 0;
40  virtual base::TimeTicks GetEventTime() const = 0;
41
42  virtual size_t GetHistorySize() const = 0;
43  virtual base::TimeTicks GetHistoricalEventTime(
44      size_t historical_index) const = 0;
45  virtual float GetHistoricalTouchMajor(size_t pointer_index,
46                                        size_t historical_index) const = 0;
47  virtual float GetHistoricalX(size_t pointer_index,
48                               size_t historical_index) const = 0;
49  virtual float GetHistoricalY(size_t pointer_index,
50                               size_t historical_index) const = 0;
51
52  virtual scoped_ptr<MotionEvent> Clone() const = 0;
53  virtual scoped_ptr<MotionEvent> Cancel() const = 0;
54
55  // Utility accessor methods for convenience.
56  float GetX() const { return GetX(0); }
57  float GetY() const { return GetY(0); }
58  float GetRawX() const { return GetX(); }
59  float GetRawY() const { return GetY(); }
60  float GetTouchMajor() const { return GetTouchMajor(0); }
61  float GetPressure() const { return GetPressure(0); }
62};
63
64}  // namespace ui
65
66#endif  // UI_EVENTS_GESTURE_DETECTION_MOTION_EVENT_H_
67