Updating trunk VERSION from 2139.0 to 2140.0
[chromium-blink-merge.git] / ui / events / gesture_detection / gesture_event_data_packet.h
blob9b115de9ca77b29c2210b4933cd9a78acbb69198
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_GESTURE_EVENT_DATA_PACKET_H_
6 #define UI_EVENTS_GESTURE_DETECTION_GESTURE_EVENT_DATA_PACKET_H_
8 #include "base/containers/stack_container.h"
9 #include "ui/events/gesture_detection/gesture_detection_export.h"
10 #include "ui/events/gesture_detection/gesture_event_data.h"
12 namespace ui {
14 class MotionEvent;
16 // Acts as a transport container for gestures created (directly or indirectly)
17 // by a touch event.
18 class GESTURE_DETECTION_EXPORT GestureEventDataPacket {
19 public:
20 enum GestureSource {
21 UNDEFINED = -1, // Used only for a default-constructed packet.
22 INVALID, // The source of the gesture was invalid.
23 TOUCH_SEQUENCE_START, // The start of a new gesture sequence.
24 TOUCH_SEQUENCE_END, // The end of a gesture sequence.
25 TOUCH_SEQUENCE_CANCEL, // The gesture sequence was cancelled.
26 TOUCH_START, // A touch down occured during a gesture sequence.
27 TOUCH_MOVE, // A touch move occured during a gesture sequence.
28 TOUCH_END, // A touch up occured during a gesture sequence.
29 TOUCH_TIMEOUT, // Timeout from an existing gesture sequence.
32 GestureEventDataPacket();
33 GestureEventDataPacket(const GestureEventDataPacket& other);
34 ~GestureEventDataPacket();
35 GestureEventDataPacket& operator=(const GestureEventDataPacket& other);
37 // Factory methods for creating a packet from a particular event.
38 static GestureEventDataPacket FromTouch(const ui::MotionEvent& touch);
39 static GestureEventDataPacket FromTouchTimeout(
40 const GestureEventData& gesture);
42 void Push(const GestureEventData& gesture);
44 const base::TimeTicks& timestamp() const { return timestamp_; }
45 const GestureEventData& gesture(size_t i) const { return gestures_[i]; }
46 size_t gesture_count() const { return gestures_->size(); }
47 GestureSource gesture_source() const { return gesture_source_; }
48 const gfx::PointF& touch_location() const { return touch_location_; }
49 const gfx::PointF& raw_touch_location() const { return raw_touch_location_; }
51 private:
52 GestureEventDataPacket(base::TimeTicks timestamp,
53 GestureSource source,
54 const gfx::PointF& touch_location,
55 const gfx::PointF& raw_touch_location);
57 enum { kTypicalMaxGesturesPerTouch = 5 };
58 base::TimeTicks timestamp_;
59 base::StackVector<GestureEventData, kTypicalMaxGesturesPerTouch> gestures_;
60 gfx::PointF touch_location_;
61 gfx::PointF raw_touch_location_;
62 GestureSource gesture_source_;
65 } // namespace ui
67 #endif // UI_EVENTS_GESTURE_DETECTION_GESTURE_EVENT_DATA_PACKET_H_