2 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali/internal/event/events/long-press-gesture/long-press-gesture-processor.h>
25 #include <dali/integration-api/debug.h>
26 #include <dali/integration-api/trace.h>
27 #include <dali/internal/event/actors/actor-impl.h>
28 #include <dali/internal/event/common/scene-impl.h>
29 #include <dali/internal/event/events/gesture-requests.h>
30 #include <dali/internal/event/events/long-press-gesture/long-press-gesture-event.h>
31 #include <dali/internal/event/events/long-press-gesture/long-press-gesture-impl.h>
32 #include <dali/internal/event/events/long-press-gesture/long-press-gesture-recognizer.h>
33 #include <dali/internal/event/render-tasks/render-task-impl.h>
34 #include <dali/public-api/actors/actor.h>
35 #include <dali/public-api/common/dali-common.h>
43 DALI_INIT_TRACE_FILTER(gTraceFilter, DALI_TRACE_PERFORMANCE_MARKER, false);
44 const unsigned long DEFAULT_MINIMUM_HOLDING_TIME = 500u;
47 * Creates a LongPressGesture and asks the specified detector to emit its detected signal.
48 * @param[in] actor The actor on which the long press gesture has occurred.
49 * @param[in] gestureDetectors A reference to gesture detectors that should emit the signal.
50 * @param[in] longPressEvent The longPressEvent received from the adaptor.
51 * @param[in] localPoint Relative to the actor attached to the detector.
53 void EmitLongPressSignal(
55 const GestureDetectorContainer& gestureDetectors,
56 const LongPressGestureEvent& longPressEvent,
59 Internal::LongPressGesturePtr longPress(new Internal::LongPressGesture(longPressEvent.state));
60 longPress->SetTime(longPressEvent.time);
61 longPress->SetNumberOfTouches(longPressEvent.numberOfTouches);
62 longPress->SetScreenPoint(longPressEvent.point);
63 longPress->SetLocalPoint(localPoint);
64 longPress->SetSourceType(longPressEvent.sourceType);
65 longPress->SetSourceData(longPressEvent.sourceData);
67 DALI_TRACE_BEGIN_WITH_MESSAGE_GENERATOR(gTraceFilter, "DALI_EMIT_LONG_PRESS_GESTURE_SIGNAL", [&](std::ostringstream& oss) {
68 oss << "[" << gestureDetectors.size() << "]";
71 Dali::Actor actorHandle(actor);
72 const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
73 for(GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter)
75 static_cast<LongPressGestureDetector*>(*iter)->EmitLongPressGestureSignal(actorHandle, Dali::LongPressGesture(longPress.Get()));
78 DALI_TRACE_END_WITH_MESSAGE_GENERATOR(gTraceFilter, "DALI_EMIT_LONG_PRESS_GESTURE_SIGNAL", [&](std::ostringstream& oss) {
79 oss << "[" << gestureDetectors.size() << "]";
84 * Functor which checks whether the specified actor is attached to the gesture detector.
85 * It returns true if it is no longer attached. This can be used in remove_if functions.
87 struct IsNotAttachedFunctor
91 * @param[in] actor The actor to check whether it is attached.
93 IsNotAttachedFunctor(Actor* actor)
99 * Returns true if not attached, false if it is still attached.
100 * @param[in] detector The detector to check.
101 * @return true, if not attached, false otherwise.
103 bool operator()(const GestureDetector* detector) const
105 return !detector->IsAttached(*actorToCheck);
108 Actor* actorToCheck; ///< The actor to check whether it is attached or not.
111 } // unnamed namespace
113 LongPressGestureProcessor::LongPressGestureProcessor()
114 : GestureProcessor(GestureType::LONG_PRESS),
115 mLongPressGestureDetectors(),
117 mCurrentRenderTask(),
118 mMinTouchesRequired(1),
119 mMaxTouchesRequired(1),
120 mCurrentLongPressEvent(nullptr),
121 mMinimumHoldingTime(DEFAULT_MINIMUM_HOLDING_TIME)
125 LongPressGestureProcessor::~LongPressGestureProcessor() = default;
127 void LongPressGestureProcessor::Process(Scene& scene, const LongPressGestureEvent& longPressEvent)
129 DALI_TRACE_SCOPE(gTraceFilter, "DALI_PROCESS_LONG_PRESS_GESTURE");
130 switch(longPressEvent.state)
132 case GestureState::POSSIBLE:
134 mCurrentEmitters.clear();
137 HitTestAlgorithm::Results hitTestResults;
138 if(HitTest(scene, longPressEvent.point, hitTestResults))
140 SetActor(&GetImplementation(hitTestResults.actor));
145 case GestureState::STARTED:
147 Actor* currentGesturedActor = GetCurrentGesturedActor();
148 if(currentGesturedActor)
150 HitTestAlgorithm::Results hitTestResults;
151 HitTest(scene, longPressEvent.point, hitTestResults);
153 if(hitTestResults.actor && (currentGesturedActor == &GetImplementation(hitTestResults.actor)))
155 // Record the current render-task for Screen->Actor coordinate conversions
156 mCurrentRenderTask = hitTestResults.renderTask;
158 // Set mCurrentLongPressEvent to use inside overridden methods called from ProcessAndEmit()
159 mCurrentLongPressEvent = &longPressEvent;
160 ProcessAndEmit(hitTestResults);
161 mCurrentLongPressEvent = nullptr;
165 mCurrentEmitters.clear();
172 case GestureState::FINISHED:
174 // The gesture should only be sent to the gesture detector which first received it so that it
175 // can be told when the gesture ends as well.
177 // Only send subsequent long press gesture signals if we processed the gesture when it started.
178 // Check if actor is still touchable.
180 Actor* currentGesturedActor = GetCurrentGesturedActor();
181 if(currentGesturedActor)
183 if(currentGesturedActor->IsHittable() && !mCurrentEmitters.empty() && mCurrentRenderTask)
185 // Ensure actor is still attached to the emitters, if it is not then remove the emitter.
186 GestureDetectorContainer::iterator endIter = std::remove_if(mCurrentEmitters.begin(), mCurrentEmitters.end(), IsNotAttachedFunctor(currentGesturedActor));
187 mCurrentEmitters.erase(endIter, mCurrentEmitters.end());
189 if(!mCurrentEmitters.empty())
192 RenderTask& renderTaskImpl = *mCurrentRenderTask.Get();
193 currentGesturedActor->ScreenToLocal(renderTaskImpl, actorCoords.x, actorCoords.y, longPressEvent.point.x, longPressEvent.point.y);
195 EmitLongPressSignal(currentGesturedActor, mCurrentEmitters, longPressEvent, actorCoords);
199 // Clear current emitters and emitted actor
200 mCurrentEmitters.clear();
206 case GestureState::CANCELLED:
208 mCurrentEmitters.clear();
213 case GestureState::CONTINUING:
215 DALI_ABORT("Incorrect state received from Integration layer: CONTINUING\n");
219 case GestureState::CLEAR:
221 DALI_ABORT("Incorrect state received from Integration layer: CLEAR\n");
227 void LongPressGestureProcessor::AddGestureDetector(LongPressGestureDetector* gestureDetector, Scene& scene)
229 bool firstRegistration(mLongPressGestureDetectors.empty());
231 mLongPressGestureDetectors.push_back(gestureDetector);
233 if(firstRegistration)
235 mMinTouchesRequired = gestureDetector->GetMinimumTouchesRequired();
236 mMaxTouchesRequired = gestureDetector->GetMaximumTouchesRequired();
238 LongPressGestureRequest request;
239 request.minTouches = mMinTouchesRequired;
240 request.maxTouches = mMaxTouchesRequired;
242 Size size = scene.GetSize();
244 mGestureRecognizer = new LongPressGestureRecognizer(*this, Vector2(size.width, size.height), static_cast<const LongPressGestureRequest&>(request), mMinimumHoldingTime);
252 void LongPressGestureProcessor::RemoveGestureDetector(LongPressGestureDetector* gestureDetector)
255 LongPressGestureDetectorContainer::iterator endIter = std::remove(mLongPressGestureDetectors.begin(), mLongPressGestureDetectors.end(), gestureDetector);
256 DALI_ASSERT_DEBUG(endIter != mLongPressGestureDetectors.end());
259 mLongPressGestureDetectors.erase(endIter, mLongPressGestureDetectors.end());
261 if(mLongPressGestureDetectors.empty())
263 mGestureRecognizer = nullptr;
271 void LongPressGestureProcessor::GestureDetectorUpdated(LongPressGestureDetector* gestureDetector)
273 DALI_ASSERT_DEBUG(find(mLongPressGestureDetectors.begin(), mLongPressGestureDetectors.end(), gestureDetector) != mLongPressGestureDetectors.end());
278 void LongPressGestureProcessor::SetMinimumHoldingTime(uint32_t time)
280 if(time > 0u && mMinimumHoldingTime != time)
282 mMinimumHoldingTime = time;
284 if(mGestureRecognizer)
286 LongPressGestureRecognizer* longPressRecognizer = dynamic_cast<LongPressGestureRecognizer*>(mGestureRecognizer.Get());
287 if(longPressRecognizer)
289 longPressRecognizer->SetMinimumHoldingTime(time);
295 uint32_t LongPressGestureProcessor::GetMinimumHoldingTime() const
297 return mMinimumHoldingTime;
300 void LongPressGestureProcessor::UpdateDetection()
302 DALI_ASSERT_DEBUG(!mLongPressGestureDetectors.empty());
304 unsigned int minimumRequired = UINT_MAX;
305 unsigned int maximumRequired = 0;
307 for(LongPressGestureDetectorContainer::iterator iter = mLongPressGestureDetectors.begin(), endIter = mLongPressGestureDetectors.end(); iter != endIter; ++iter)
309 LongPressGestureDetector* current(*iter);
313 unsigned int minimum = current->GetMinimumTouchesRequired();
314 if(minimum < minimumRequired)
316 minimumRequired = minimum;
319 unsigned int maximum = current->GetMaximumTouchesRequired();
320 if(maximum > maximumRequired)
322 maximumRequired = maximum;
327 if((minimumRequired != mMinTouchesRequired) || (maximumRequired != mMaxTouchesRequired))
329 mMinTouchesRequired = minimumRequired;
330 mMaxTouchesRequired = maximumRequired;
332 LongPressGestureRequest request;
333 request.minTouches = mMinTouchesRequired;
334 request.maxTouches = mMaxTouchesRequired;
335 mGestureRecognizer->Update(request);
339 void LongPressGestureProcessor::OnGesturedActorStageDisconnection()
341 mCurrentEmitters.clear();
344 bool LongPressGestureProcessor::CheckGestureDetector(GestureDetector* detector, Actor* actor)
346 DALI_ASSERT_DEBUG(mCurrentLongPressEvent);
350 ret = detector->CheckGestureDetector(mCurrentLongPressEvent, actor, mCurrentRenderTask);
355 void LongPressGestureProcessor::EmitGestureSignal(Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates)
357 DALI_ASSERT_DEBUG(mCurrentLongPressEvent);
359 mCurrentEmitters.clear();
362 EmitLongPressSignal(actor, gestureDetectors, *mCurrentLongPressEvent, actorCoordinates);
366 mCurrentEmitters = gestureDetectors;
371 } // namespace Internal