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/pinch-gesture/pinch-gesture-processor.h>
25 #include <dali/integration-api/debug.h>
26 #include <dali/integration-api/trace.h>
27 #include <dali/internal/event/common/scene-impl.h>
28 #include <dali/internal/event/events/gesture-requests.h>
29 #include <dali/internal/event/events/pinch-gesture/pinch-gesture-event.h>
30 #include <dali/internal/event/events/pinch-gesture/pinch-gesture-impl.h>
31 #include <dali/internal/event/events/pinch-gesture/pinch-gesture-recognizer.h>
32 #include <dali/internal/event/render-tasks/render-task-impl.h>
33 #include <dali/public-api/actors/actor.h>
34 #include <dali/public-api/events/pinch-gesture.h>
35 #include <dali/public-api/math/vector2.h>
43 DALI_INIT_TRACE_FILTER(gTraceFilter, DALI_TRACE_PERFORMANCE_MARKER, false);
44 const uint32_t MINIMUM_TOUCH_EVENTS_REQUIRED = 4u;
45 const uint32_t MINIMUM_TOUCH_EVENTS_REQUIRED_AFTER_START = 4u;
48 * Creates a PinchGesture and asks the specified detector to emit its detected signal.
49 * @param[in] actor The actor that has been pinched.
50 * @param[in] gestureDetectors The gesture detector container that should emit the signal.
51 * @param[in] pinchEvent The pinchEvent received from the adaptor.
52 * @param[in] localCenter Relative to the actor attached to the detector.
56 const GestureDetectorContainer& gestureDetectors,
57 const PinchGestureEvent& pinchEvent,
60 Internal::PinchGesturePtr pinch(new Internal::PinchGesture(pinchEvent.state));
61 pinch->SetTime(pinchEvent.time);
63 pinch->SetScale(pinchEvent.scale);
64 pinch->SetSpeed(pinchEvent.speed);
65 pinch->SetScreenCenterPoint(pinchEvent.centerPoint);
67 pinch->SetLocalCenterPoint(localCenter);
68 pinch->SetSourceType(pinchEvent.sourceType);
69 pinch->SetSourceData(pinchEvent.sourceData);
71 DALI_TRACE_BEGIN_WITH_MESSAGE_GENERATOR(gTraceFilter, "DALI_EMIT_PINCH_GESTURE_SIGNAL", [&](std::ostringstream& oss) {
72 oss << "[" << gestureDetectors.size() << "]";
75 Dali::Actor actorHandle(actor);
76 const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
77 for(GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter)
79 static_cast<PinchGestureDetector*>(*iter)->EmitPinchGestureSignal(actorHandle, Dali::PinchGesture(pinch.Get()));
82 DALI_TRACE_END_WITH_MESSAGE_GENERATOR(gTraceFilter, "DALI_EMIT_PINCH_GESTURE_SIGNAL", [&](std::ostringstream& oss) {
83 oss << "[" << gestureDetectors.size() << "]";
88 * Functor which checks whether the specified actor is attached to the gesture detector.
89 * It returns true if it is no longer attached. This can be used in remove_if functions.
91 struct IsNotAttachedFunctor
95 * @param[in] actor The actor to check whether it is attached.
97 IsNotAttachedFunctor(Actor* actor)
103 * Returns true if not attached, false if it is still attached.
104 * @param[in] detector The detector to check.
105 * @return true, if not attached, false otherwise.
107 bool operator()(const GestureDetector* detector) const
109 return !detector->IsAttached(*actorToCheck);
112 Actor* actorToCheck; ///< The actor to check whether it is attached or not.
115 } // unnamed namespace
117 PinchGestureProcessor::PinchGestureProcessor()
118 : GestureProcessor(GestureType::PINCH),
119 mPinchGestureDetectors(),
120 mCurrentPinchEmitters(),
121 mCurrentPinchEvent(nullptr),
122 mMinimumPinchDistance(-1.0f),
123 mMinimumTouchEvents(MINIMUM_TOUCH_EVENTS_REQUIRED),
124 mMinimumTouchEventsAfterStart(MINIMUM_TOUCH_EVENTS_REQUIRED_AFTER_START)
128 PinchGestureProcessor::~PinchGestureProcessor() = default;
130 void PinchGestureProcessor::SetMinimumPinchDistance(float value)
132 mMinimumPinchDistance = value;
134 if(mGestureRecognizer)
136 PinchGestureRecognizer* pinchRecognizer = dynamic_cast<PinchGestureRecognizer*>(mGestureRecognizer.Get());
139 pinchRecognizer->SetMinimumPinchDistance(value);
144 void PinchGestureProcessor::SetMinimumTouchEvents(uint32_t value)
146 if(value > 1u && mMinimumTouchEvents != value)
148 mMinimumTouchEvents = value;
150 if(mGestureRecognizer)
152 PinchGestureRecognizer* pinchRecognizer = dynamic_cast<PinchGestureRecognizer*>(mGestureRecognizer.Get());
155 pinchRecognizer->SetMinimumTouchEvents(value);
161 void PinchGestureProcessor::SetMinimumTouchEventsAfterStart(uint32_t value)
163 if(value > 1u && mMinimumTouchEventsAfterStart != value)
165 mMinimumTouchEventsAfterStart = value;
167 if(mGestureRecognizer)
169 PinchGestureRecognizer* pinchRecognizer = dynamic_cast<PinchGestureRecognizer*>(mGestureRecognizer.Get());
172 pinchRecognizer->SetMinimumTouchEventsAfterStart(value);
178 void PinchGestureProcessor::Process(Scene& scene, const PinchGestureEvent& pinchEvent)
180 DALI_TRACE_SCOPE(gTraceFilter, "DALI_PROCESS_PINCH_GESTURE");
181 switch(pinchEvent.state)
183 case GestureState::STARTED:
185 // The pinch gesture should only be sent to the gesture detector which first received it so that
186 // it can be told when the gesture ends as well.
188 mCurrentPinchEmitters.clear();
191 HitTestAlgorithm::Results hitTestResults;
194 hitTestResults.actor = Dali::Actor(GetFeededActor());
195 hitTestResults.renderTask = GetFeededRenderTask();
197 // Record the current render-task for Screen->Actor coordinate conversions
198 mCurrentRenderTask = hitTestResults.renderTask;
201 GetFeededActor()->ScreenToLocal(*mCurrentRenderTask.Get(), actorCoords.x, actorCoords.y, pinchEvent.centerPoint.x, pinchEvent.centerPoint.y);
202 hitTestResults.actorCoordinates = actorCoords;
204 // Set mCurrentPinchEvent to use inside overridden methods called from ProcessAndEmit()
205 mCurrentPinchEvent = &pinchEvent;
206 ProcessAndEmitActor(hitTestResults, GetFeededGestureDetector());
207 mCurrentPinchEvent = nullptr;
209 else if(HitTest(scene, pinchEvent.centerPoint, hitTestResults))
211 // Record the current render-task for Screen->Actor coordinate conversions
212 mCurrentRenderTask = hitTestResults.renderTask;
214 // Set mCurrentPinchEvent to use inside overridden methods called from ProcessAndEmit()
215 mCurrentPinchEvent = &pinchEvent;
216 ProcessAndEmit(hitTestResults);
217 mCurrentPinchEvent = nullptr;
222 case GestureState::CONTINUING:
223 case GestureState::FINISHED:
224 case GestureState::CANCELLED:
226 // Only send subsequent pinch gesture signals if we processed the pinch gesture when it started.
227 // Check if actor is still touchable.
229 Actor* currentGesturedActor = GetCurrentGesturedActor();
230 if(currentGesturedActor)
232 if(currentGesturedActor->IsHittable() && !mCurrentPinchEmitters.empty() && mCurrentRenderTask)
234 // Ensure actor is still attached to the emitters, if it is not then remove the emitter.
235 GestureDetectorContainer::iterator endIter = std::remove_if(mCurrentPinchEmitters.begin(), mCurrentPinchEmitters.end(), IsNotAttachedFunctor(currentGesturedActor));
236 mCurrentPinchEmitters.erase(endIter, mCurrentPinchEmitters.end());
237 if(GetFeededActor() && GetFeededGestureDetector())
239 mCurrentPinchEmitters.push_back(GetFeededGestureDetector());
242 if(!mCurrentPinchEmitters.empty())
245 RenderTask& renderTaskImpl(*mCurrentRenderTask.Get());
246 currentGesturedActor->ScreenToLocal(renderTaskImpl, actorCoords.x, actorCoords.y, pinchEvent.centerPoint.x, pinchEvent.centerPoint.y);
248 EmitPinchSignal(currentGesturedActor, mCurrentPinchEmitters, pinchEvent, actorCoords);
252 // If we have no current emitters then clear pinched actor as well.
256 // Clear current emitters if pinch gesture has ended or been cancelled.
257 if(pinchEvent.state == GestureState::FINISHED || pinchEvent.state == GestureState::CANCELLED)
259 mCurrentPinchEmitters.clear();
265 mCurrentPinchEmitters.clear();
272 case GestureState::CLEAR:
274 DALI_ABORT("Incorrect state received from Integration layer: CLEAR\n");
277 case GestureState::POSSIBLE:
279 DALI_ABORT("Incorrect state received from Integration layer: POSSIBLE\n");
285 void PinchGestureProcessor::AddGestureDetector(PinchGestureDetector* gestureDetector, Scene& scene)
287 bool createRecognizer(mPinchGestureDetectors.empty());
289 mPinchGestureDetectors.push_back(gestureDetector);
293 Size size = scene.GetSize();
294 mGestureRecognizer = new PinchGestureRecognizer(*this, Vector2(size.width, size.height), scene.GetDpi(), mMinimumPinchDistance, mMinimumTouchEvents, mMinimumTouchEventsAfterStart);
298 void PinchGestureProcessor::RemoveGestureDetector(PinchGestureDetector* gestureDetector)
300 if(!mCurrentPinchEmitters.empty())
302 // Check if the removed detector was one that is currently being pinched and remove it from emitters.
303 GestureDetectorContainer::iterator endIter = std::remove(mCurrentPinchEmitters.begin(), mCurrentPinchEmitters.end(), gestureDetector);
304 mCurrentPinchEmitters.erase(endIter, mCurrentPinchEmitters.end());
306 // If we no longer have any emitters, then we should clear mCurrentGesturedActor as well
307 if(mCurrentPinchEmitters.empty())
313 // Find the detector...
314 PinchGestureDetectorContainer::iterator endIter = std::remove(mPinchGestureDetectors.begin(), mPinchGestureDetectors.end(), gestureDetector);
315 DALI_ASSERT_DEBUG(endIter != mPinchGestureDetectors.end());
318 mPinchGestureDetectors.erase(endIter, mPinchGestureDetectors.end());
320 if(mPinchGestureDetectors.empty())
322 mGestureRecognizer = nullptr;
326 void PinchGestureProcessor::GestureDetectorUpdated(PinchGestureDetector* gestureDetector)
328 // Nothing to do as PinchGestureDetector does not have any specific parameters.
331 void PinchGestureProcessor::OnGesturedActorStageDisconnection()
333 mCurrentPinchEmitters.clear();
336 bool PinchGestureProcessor::CheckGestureDetector(GestureDetector* detector, Actor* actor)
338 // No special case required for pinch.
342 void PinchGestureProcessor::EmitGestureSignal(Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates)
344 DALI_ASSERT_DEBUG(mCurrentPinchEvent);
346 EmitPinchSignal(actor, gestureDetectors, *mCurrentPinchEvent, actorCoordinates);
350 mCurrentPinchEmitters = gestureDetectors;
355 } // namespace Internal