use modern construct 'override' in the derive class.
[platform/core/uifw/dali-core.git] / dali / internal / event / events / rotation-gesture / rotation-gesture-event.h
1 #ifndef DALI_INTERNAL_EVENT_ROTATION_GESTURE_EVENT_H
2 #define DALI_INTERNAL_EVENT_ROTATION_GESTURE_EVENT_H
3
4 /*
5  * Copyright (c) 2020 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/public-api/math/radian.h>
23 #include <dali/public-api/math/vector2.h>
24 #include <dali/internal/event/events/gesture-event.h>
25
26 namespace Dali
27 {
28
29 namespace Internal
30 {
31
32 /**
33  * When a rotation gesture is detected, this structure holds information regarding the gesture.
34  *
35  * A ROTATION Gesture event should be in one of four states:
36  * - STARTED:    If a rotation is detected.
37  * - CONTINUING: If after a rotation is detected, it continues.
38  * - FINISHED:   If after a rotation, the user lifts their finger(s).
39  * - CANCELLED:  If there is a system interruption.
40  */
41 struct RotationGestureEvent : public GestureEvent
42 {
43   // Construction & Destruction
44
45   /**
46    * Default Constructor
47    * @param[in]  state  The state of the gesture
48    */
49   RotationGestureEvent( GestureState state )
50   : GestureEvent( GestureType::ROTATION, state )
51   {
52   }
53
54   /**
55    * Virtual destructor
56    */
57   ~RotationGestureEvent() override = default;
58
59   // Data
60
61   /**
62    * @copydoc Dali::RotationGesture::rotation
63    */
64   Radian rotation;
65
66   /**
67    * @copydoc Dali::RotationGesture::screenCenterPoint
68    */
69   Vector2 centerPoint;
70 };
71
72 } // namespace Integration
73
74 } // namespace Dali
75
76 #endif // DALI_INTERNAL_EVENT_ROTATION_GESTURE_EVENT_H