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

   1 #ifndef DALI_INTERNAL_GESTURE_DETECTOR_H
   2 #define DALI_INTERNAL_GESTURE_DETECTOR_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/actors/actor-impl.h>
  23 #include <dali/public-api/common/dali-common.h>
  24 #include <dali/public-api/common/vector-wrapper.h>
  25 #include <dali/public-api/events/gesture-detector.h>
  26 #include <dali/public-api/events/gesture.h>
  27 #include <dali/public-api/signals/slot-delegate.h>
  28
  29 namespace Dali
  30 {
  31 namespace Integration
  32 {
  33 struct GestureEvent;
  34 }
  35
  36 namespace Internal
  37 {
  38 class GestureDetector;
  39 class GestureEventProcessor;
  40
  41 using GestureDetectorPtr            = IntrusivePtr<GestureDetector>;
  42 using GestureDetectorContainer      = std::vector<GestureDetector*>;
  43 using GestureDetectorActorContainer = std::vector<Actor*>;
  44
  45 /**
  46  * This is a type trait that should be used by deriving gesture detectors for their container type.
  47  */
  48 template<typename Detector>
  49 struct DerivedGestureDetectorContainer
  50 {
  51   using type = std::vector<Detector*>;
  52 };
  53
  54 /**
  55  * @copydoc Dali::GestureDetector
  56  */
  57 class GestureDetector : public Object, public Object::Observer
  58 {
  59 public:
  60   /**
  61    * @copydoc Dali::GestureDetector::Attach()
  62    */
  63   void Attach(Actor& actor);
  64
  65   /**
  66    * @copydoc Dali::GestureDetector::Detach()
  67    */
  68   void Detach(Actor& actor);
  69
  70   /**
  71    * @copydoc Dali::GestureDetector::DetachAll()
  72    */
  73   void DetachAll();
  74
  75   /**
  76    * @copydoc Dali::GestureDetector::GetAttachedActorCount() const
  77    */
  78   size_t GetAttachedActorCount() const;
  79
  80   /**
  81    * @copydoc Dali::GestureDetector::GetAttachedActor() const
  82    */
  83   Dali::Actor GetAttachedActor(size_t index) const;
  84
  85   /**
  86    * @copydoc Dali::GestureDetector::FeedTouch()
  87    */
  88   bool FeedTouch(Dali::Actor& actor, Dali::TouchEvent& touch);
  89
  90   /**
  91    * Returns a const reference to the container of attached actor pointers.
  92    * @return A const reference to the attached internal actors.
  93    */
  94   const GestureDetectorActorContainer& GetAttachedActorPointers() const
  95   {
  96     return mAttachedActors;
  97   }
  98
  99   /**
 100    * Retrieves the type of GestureDetector
 101    * @return The GestureDetector Type
 102    */
 103   GestureType::Value GetType() const
 104   {
 105     return mType;
 106   }
 107
 108   /**
 109    * Checks if the specified actor is still attached or pending attachment.
 110    * @param[in]  actor  The actor to check.
 111    * @return true, if the actor is attached or pending, false otherwise.
 112    */
 113   bool IsAttached(Actor& actor) const;
 114
 115 protected: // Creation & Destruction
 116   /**
 117    * Construct a new GestureDetector.
 118    * @param type the type of gesture
 119    * @param pointer to the scene object, nullptr if none
 120    * by default GestureDetectors don't have our own scene object
 121    */
 122   GestureDetector(GestureType::Value type, const SceneGraph::PropertyOwner* sceneObject = nullptr);
 123
 124   /**
 125    * A reference counted object may only be deleted by calling Unreference()
 126    */
 127   ~GestureDetector() override;
 128
 129 private:
 130   // Undefined
 131   GestureDetector()                       = delete;
 132   GestureDetector(const GestureDetector&) = delete;
 133   GestureDetector& operator=(const GestureDetector& rhs) = delete;
 134
 135   /**
 136    * @copydoc Dali::Internal::Object::Observer::SceneObjectAdded()
 137    */
 138   void SceneObjectAdded(Object& object) override;
 139
 140   /**
 141    * @copydoc Dali::Internal::Object::Observer::SceneObjectAdded()
 142    */
 143   void SceneObjectRemoved(Object& object) override
 144   {
 145   }
 146
 147   /**
 148    * @copydoc Dali::Internal::Object::Observer::ObjectDestroyed()
 149    */
 150   void ObjectDestroyed(Object& object) override;
 151
 152   /**
 153    * For use in derived classes, called after an actor is attached.
 154    * @param[in]  actor  The actor that is being attached.
 155    */
 156   virtual void OnActorAttach(Actor& actor) = 0;
 157
 158   /**
 159    * For use in derived classes, called after an actor is detached.
 160    * @param[in] actor The actor that is being detached.
 161    */
 162   virtual void OnActorDetach(Actor& actor) = 0;
 163
 164   /**
 165    * For use in derived classes, called when an attached actor is destroyed.
 166    * @param[in] object The object (Actor's base class) that has been destroyed.
 167    * @note Derived classes should not call any Actor specific APIs in this method as the Actor's
 168    *       destructor would have already been called.
 169    */
 170   virtual void OnActorDestroyed(Object& object) = 0;
 171
 172 protected:
 173   GestureType::Value            mType;                  ///< The gesture detector will detect this type of gesture.
 174   GestureDetectorActorContainer mAttachedActors;        ///< Object::Observer is used to provide weak-pointer behaviour
 175   GestureDetectorActorContainer mPendingAttachActors;   ///< Object::Observer is used to provide weak-pointer behaviour
 176   GestureEventProcessor&        mGestureEventProcessor; ///< A reference to the gesture event processor.
 177 };
 178
 179 } // namespace Internal
 180
 181 // Helpers for public-api forwarding methods
 182
 183 inline Internal::GestureDetector& GetImplementation(Dali::GestureDetector& detector)
 184 {
 185   DALI_ASSERT_ALWAYS(detector && "GestureDetector handle is empty");
 186
 187   BaseObject& handle = detector.GetBaseObject();
 188
 189   return static_cast<Internal::GestureDetector&>(handle);
 190 }
 191
 192 inline const Internal::GestureDetector& GetImplementation(const Dali::GestureDetector& detector)
 193 {
 194   DALI_ASSERT_ALWAYS(detector && "GestureDetector handle is empty");
 195
 196   const BaseObject& handle = detector.GetBaseObject();
 197
 198   return static_cast<const Internal::GestureDetector&>(handle);
 199 }
 200
 201 } // namespace Dali
 202
 203 #endif // DALI_INTERNAL_GESTURE_DETECTOR_H