dali/internal/event/events/gesture-event.h

   1 #ifndef DALI_INTERNAL_EVENT_GESTURE_EVENT_H
   2 #define DALI_INTERNAL_EVENT_GESTURE_EVENT_H
   3
   4 /*
   5  * Copyright (c) 2022 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/integration-api/events/event.h>
  23 #include <dali/internal/event/events/gesture-impl.h>
  24 #include <dali/internal/event/render-tasks/render-task-impl.h>
  25
  26 namespace Dali
  27 {
  28 namespace Internal
  29 {
  30 /**
  31  * This is the abstract base structure for any gestures that the adaptor detects and wishes to send
  32  * to the Core.
  33  */
  34 struct GestureEvent
  35 {
  36   // Destruction
  37
  38   /**
  39    * Virtual destructor.
  40    */
  41   virtual ~GestureEvent();
  42
  43   // Data
  44
  45   /**
  46    * Gesture Type.
  47    */
  48   GestureType::Value gestureType;
  49
  50   /**
  51    * The state of the gesture.
  52    */
  53   GestureState state;
  54
  55   /**
  56    * The time the gesture took place.
  57    */
  58   uint32_t time;
  59
  60   /**
  61    * This is the value of which source the gesture was started with. (ex : mouse)
  62    */
  63   GestureSourceType sourceType;
  64
  65   /**
  66    * The data of the source type.
  67    */
  68   GestureSourceData sourceData;
  69
  70   /**
  71    * The render task used to generate this touch event.
  72    */
  73   RenderTaskPtr renderTask;
  74
  75
  76 protected: // Constructors only to be used by derived structures.
  77   /**
  78    * This constructor is only used by derived classes.
  79    * @param[in] gesture       The type of gesture event.
  80    * @param[in] gestureState  The state of the gesture event.
  81    */
  82   GestureEvent(GestureType::Value gesture, GestureState gestureState);
  83 };
  84
  85 } // namespace Internal
  86
  87 } // namespace Dali
  88
  89 #endif // DALI_INTERNAL_EVENT_GESTURE_EVENT_H