2 * Copyright (c) 2021 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-recognizer.h>
24 #include <dali/devel-api/events/touch-point.h>
25 #include <dali/public-api/math/vector2.h>
27 #include <dali/integration-api/events/touch-event-integ.h>
28 #include <dali/integration-api/platform-abstraction.h>
29 #include <dali/internal/event/common/thread-local-storage.h>
30 #include <dali/internal/event/events/gesture-requests.h>
38 // TODO: Set these according to DPI
39 const float MAXIMUM_MOTION_ALLOWED = 60.0f;
41 } // unnamed namespace
43 LongPressGestureRecognizer::LongPressGestureRecognizer(Observer& observer, Vector2 screenSize, const LongPressGestureRequest& request, uint32_t minimumHoldingTime)
44 : GestureRecognizer(screenSize, GestureType::LONG_PRESS),
47 mMinimumTouchesRequired(request.minTouches),
48 mMaximumTouchesRequired(request.maxTouches),
51 mMinimumHoldingTime(minimumHoldingTime)
55 LongPressGestureRecognizer::~LongPressGestureRecognizer()
57 if(mTimerId != 0 && ThreadLocalStorage::Created())
59 Dali::Integration::PlatformAbstraction& platformAbstraction = ThreadLocalStorage::Get().GetPlatformAbstraction();
60 platformAbstraction.CancelTimer(mTimerId);
64 void LongPressGestureRecognizer::SendEvent(const Integration::TouchEvent& event)
66 unsigned int pointCount(event.GetPointCount());
67 Dali::Integration::PlatformAbstraction& platformAbstraction = ThreadLocalStorage::Get().GetPlatformAbstraction();
68 GestureRecognizerPtr ptr(this); // To keep us from being destroyed during the life-time of this method
72 // CLEAR: Wait till one point touches the screen before starting timer.
75 const Integration::Point& point = event.points[0];
77 if(point.GetState() == PointState::DOWN)
79 mTouchPositions.clear();
80 mTouchPositions[point.GetDeviceId()] = point.GetScreenPosition();
82 mTouchTime = event.time;
86 platformAbstraction.CancelTimer(mTimerId);
88 mTimerId = platformAbstraction.StartTimer(mMinimumHoldingTime, MakeCallback(this, &LongPressGestureRecognizer::TimerCallback));
90 // A long press gesture may be possible, tell Core about this and change state to TOUCHED.
92 EmitGesture(GestureState::POSSIBLE);
98 // TOUCHED: Monitor movement and addition/removal of points.
101 if(pointCount > mMaximumTouchesRequired)
103 // A long press did not occur, tell Core that it was cancelled and change state to FAILED.
104 EmitGesture(GestureState::CANCELLED);
105 mTouchPositions.clear();
106 platformAbstraction.CancelTimer(mTimerId);
114 for(Integration::PointContainerConstIterator iter = event.points.begin(), endIter = event.points.end();
115 iter != endIter && !endLoop;
118 switch(iter->GetState())
121 case PointState::DOWN:
123 mTouchPositions[iter->GetDeviceId()] = iter->GetScreenPosition();
129 case PointState::INTERRUPTED:
131 // System has interrupted us, long press is not possible, inform Core
132 EmitGesture(GestureState::CANCELLED);
133 mTouchPositions.clear();
134 platformAbstraction.CancelTimer(mTimerId);
136 mState = (pointCount == 1) ? CLEAR : FAILED; // Change state to CLEAR if only one point, FAILED otherwise.
141 case PointState::MOTION:
143 const Vector2 touchPosition(mTouchPositions[iter->GetDeviceId()] - iter->GetScreenPosition());
144 float distanceSquared = touchPosition.LengthSquared();
146 if(distanceSquared > (MAXIMUM_MOTION_ALLOWED * MAXIMUM_MOTION_ALLOWED))
148 // We have moved more than the allowable motion for a long press gesture. Inform Core and change state to FAILED.
149 EmitGesture(GestureState::CANCELLED);
150 platformAbstraction.CancelTimer(mTimerId);
158 case PointState::STATIONARY:
159 case PointState::LEAVE:
168 // FAILED/FINISHED: Monitor the touches, waiting for all touches to be released.
172 // eventually the final touch point will be removed, marking the end of this gesture.
175 PointState::Type primaryPointState = event.points[0].GetState();
177 if((primaryPointState == PointState::UP) || (primaryPointState == PointState::INTERRUPTED))
179 if(mState == FINISHED)
181 // When the last touch point is lifted, we should inform the Core that the Long press has finished.
182 EmitGesture(GestureState::FINISHED);
184 mTouchPositions.clear();
185 mState = CLEAR; // Reset state to clear when last touch point is lifted.
193 void LongPressGestureRecognizer::Update(const GestureRequest& request)
195 const LongPressGestureRequest& longPress = static_cast<const LongPressGestureRequest&>(request);
197 mMinimumTouchesRequired = longPress.minTouches;
198 mMaximumTouchesRequired = longPress.maxTouches;
201 void LongPressGestureRecognizer::SetMinimumHoldingTime(uint32_t time)
203 mMinimumHoldingTime = time;
206 bool LongPressGestureRecognizer::TimerCallback()
208 EmitGesture(GestureState::STARTED);
217 void LongPressGestureRecognizer::EmitGesture(GestureState state)
219 unsigned int touchPoints(static_cast<unsigned int>(mTouchPositions.size()));
221 // We should tell Core about the POSSIBLE and CANCELLED states regardless of whether we have satisfied long press requirements.
222 if((state == GestureState::POSSIBLE) ||
223 (state == GestureState::CANCELLED) ||
224 (touchPoints >= mMinimumTouchesRequired))
226 LongPressGestureEvent longPress(state);
227 longPress.numberOfTouches = touchPoints;
229 for(std::map<int, Vector2>::iterator iter = mTouchPositions.begin(), endIter = mTouchPositions.end();
233 longPress.point += iter->second;
235 longPress.point /= static_cast<float>(touchPoints);
237 longPress.time = mTouchTime;
238 if(state != GestureState::POSSIBLE)
240 longPress.time += mMinimumHoldingTime;
245 // Create another handle so the recognizer cannot be destroyed during process function
246 GestureRecognizerPtr recognizerHandle = this;
248 mObserver.Process(*mScene, longPress);
253 } // namespace Internal