Gesture event refactor
[platform/core/uifw/dali-core.git] / dali / internal / event / events / pinch-gesture-event.h
1 #ifndef DALI_INTERNAL_EVENT_PINCH_GESTURE_EVENT_H
2 #define DALI_INTERNAL_EVENT_PINCH_GESTURE_EVENT_H
3
4 /*
5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // INTERNAL INCLUDES
22 #include <dali/internal/event/events/gesture-event.h>
23 #include <dali/public-api/math/vector2.h>
24
25 namespace Dali
26 {
27
28 namespace Internal
29 {
30
31 /**
32  * If the adaptor detects a pinch gesture, then it should create an instance of this structure and
33  * send it to the Core.
34  *
35  * A Pinch Gesture event should be in one of four states:
36  * - Started:    If a pinch is detected.
37  * - Continuing: If after a pinch is detected, it continues.
38  * - Finished:   If after a pinch, the user lifts their finger(s).
39  * - Cancelled:  If there is a system interruption.
40  */
41 struct PinchGestureEvent : public GestureEvent
42 {
43   // Construction & Destruction
44
45   /**
46    * Default Constructor
47    * @param[in]  state  The state of the gesture
48    */
49   PinchGestureEvent(Gesture::State state);
50
51   /**
52    * Virtual destructor
53    */
54   virtual ~PinchGestureEvent();
55
56   // Data
57
58   /**
59    * @copydoc Dali::PinchGesture::scale
60    */
61   float scale;
62
63   /**
64    * @copydoc Dali::PinchGesture::speed
65    */
66   float speed;
67
68   /**
69    * The center point between the two touch points of the last touch event in the series of touch motion
70    * event producing this gesture.
71    */
72   Vector2 centerPoint;
73 };
74
75 } // namespace Integration
76
77 } // namespace Dali
78
79 #endif // DALI_INTERNAL_EVENT_PINCH_GESTURE_EVENT_H