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