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

   1 #ifndef DALI_INTERNAL_ACTOR_GESTURE_DATA_H
   2 #define DALI_INTERNAL_ACTOR_GESTURE_DATA_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/internal/event/events/gesture-detector-impl.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Internal
  28 {
  29
  30 /**
  31  * Holds gesture specific data for an Actor
  32  */
  33 class ActorGestureData
  34 {
  35 public:
  36
  37   /**
  38    * Constructor
  39    */
  40   ActorGestureData();
  41
  42   /**
  43    * Non-virtual Destructor
  44    */
  45   ~ActorGestureData();
  46
  47   /**
  48    * Adds a gesture detector to the data so that the owning actor is aware that it requires this
  49    * type of gesture.
  50    * @param[in] detector The detector being added.
  51    * @note A raw pointer to the detector is stored, so the detector MUST remove itself when it is
  52    * destroyed using RemoveGestureDetector()
  53    */
  54   void AddGestureDetector( GestureDetector& detector );
  55
  56   /**
  57    * Removes a previously added gesture detector from the data. If no more gesture detectors of
  58    * this type are registered then the actor owning this data will no longer be hit-tested for that
  59    * gesture.
  60    * @param[in] detector The detector to remove.
  61    */
  62   void RemoveGestureDetector( GestureDetector& detector );
  63
  64   /**
  65    * Queries whether the actor requires the gesture type.
  66    * @param[in] type The gesture type.
  67    * @return true if the gesture is required, false otherwise.
  68    */
  69   inline bool IsGestureRequred( Gesture::Type type ) const
  70   {
  71     return type & gesturesRequired;
  72   }
  73
  74   /**
  75    * Retrieve a reference to the detectors for the given type.
  76    * @param[in] type The container type required
  77    * @pre Ensure IsGestureRequired() is used to check if the container is actually available.
  78    */
  79   GestureDetectorContainer& GetGestureDetectorContainer( Gesture::Type type );
  80
  81 private:
  82
  83   /**
  84    * Helper to retrieve the appropriate container type.
  85    * @param[in] type The container type required.
  86    */
  87   inline GestureDetectorContainer*& GetContainerPtr( Gesture::Type type );
  88
  89 private:
  90
  91   Gesture::Type gesturesRequired; ///< Stores which gestures are required
  92
  93   GestureDetectorContainer* panDetectors;       ///< Pointer to a container of pan-detectors
  94   GestureDetectorContainer* pinchDetectors;     ///< Pointer to a container of pinch-detectors
  95   GestureDetectorContainer* longPressDetectors; ///< Pointer to a container of long-press-detectors
  96   GestureDetectorContainer* tapDetectors;       ///< Pointer to a container of tap-detectors
  97   GestureDetectorContainer* rotationDetectors;  ///< Pointer to a container of tap-detectors
  98 };
  99
 100 } // namespace Internal
 101
 102 } // namespace Dali
 103
 104 #endif // DALI_INTERNAL_ACTOR_GESTURE_DATA_H
 105