1 #ifndef DALI_INTERNAL_LONG_PRESS_GESTURE_EVENT_PROCESSOR_H
2 #define DALI_INTERNAL_LONG_PRESS_GESTURE_EVENT_PROCESSOR_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/internal/event/events/gesture-processor.h>
23 #include <dali/internal/event/events/long-press-gesture/long-press-gesture-detector-impl.h>
24 #include <dali/internal/event/render-tasks/render-task-impl.h>
34 struct LongPressGestureEvent;
37 * Long Press Gesture Event Processing:
39 * When we receive a long press gesture event, we do the following:
40 * - Find the actor that requires a long-press at the long press position.
41 * - Emit the gesture if the event satisfies the detector conditions.
43 class LongPressGestureProcessor : public GestureProcessor, public RecognizerObserver<LongPressGestureEvent>
47 * Create a long press gesture processor.
49 LongPressGestureProcessor();
52 * Non-virtual destructor; LongPressGestureProcessor is not a base class
54 ~LongPressGestureProcessor() override;
56 public: // To be called by GestureEventProcessor
58 * This method is called whenever a long press gesture event occurs.
59 * @param[in] scene The scene the long press gesture event occurs in.
60 * @param[in] longPressEvent The event that has occurred.
62 void Process(Scene& scene, const LongPressGestureEvent& longPressEvent) override;
65 * Adds a gesture detector to this gesture processor.
66 * If this is the first gesture detector being added, then this method registers the required
67 * gesture with the adaptor.
68 * @param[in] gestureDetector The gesture detector being added.
69 * @param[in] scene The scene the long press gesture event occurs in.
71 void AddGestureDetector(LongPressGestureDetector* gestureDetector, Scene& scene);
74 * Removes the specified gesture detector from this gesture processor. If, after removing this
75 * gesture detector, there are no more gesture detectors registered, then this method unregisters
76 * the gesture from the adaptor.
77 * @param[in] gestureDetector The gesture detector being removed.
79 void RemoveGestureDetector(LongPressGestureDetector* gestureDetector);
82 * This method updates the gesture detection parameters.
83 * @param[in] gestureDetector The gesture detector that has been updated.
85 void GestureDetectorUpdated(LongPressGestureDetector* gestureDetector);
88 * @brief This method sets the minimum holding time required to be recognized as a long press gesture
90 * @param[in] value The time value in milliseconds
92 void SetMinimumHoldingTime(uint32_t time);
95 * @return The minimum holding time required to be recognized as a long press gesture in milliseconds
97 uint32_t GetMinimumHoldingTime() const;
101 LongPressGestureProcessor(const LongPressGestureProcessor&);
102 LongPressGestureProcessor& operator=(const LongPressGestureProcessor& rhs);
106 * Iterates through our GestureDetectors and determines if we need to ask the adaptor to update
107 * its detection policy. If it does, it sends the appropriate gesture update request to adaptor.
109 void UpdateDetection();
111 // GestureProcessor overrides
114 * @copydoc GestureProcessor::OnGesturedActorStageDisconnection()
116 void OnGesturedActorStageDisconnection() override;
119 * @copydoc GestureProcessor::CheckGestureDetector()
121 bool CheckGestureDetector(GestureDetector* detector, Actor* actor) override;
124 * @copydoc GestureProcessor::EmitGestureSignal()
126 void EmitGestureSignal(Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates) override;
129 LongPressGestureDetectorContainer mLongPressGestureDetectors;
131 GestureDetectorContainer mCurrentEmitters;
132 RenderTaskPtr mCurrentRenderTask;
134 uint32_t mMinTouchesRequired;
135 uint32_t mMaxTouchesRequired;
137 const LongPressGestureEvent* mCurrentLongPressEvent; ///< Pointer to current longPressEvent, used when calling ProcessAndEmit()
139 uint32_t mMinimumHoldingTime;
142 } // namespace Internal
146 #endif // DALI_INTERNAL_LONG_PRESS_GESTURE_EVENT_PROCESSOR_H