2 * Copyright (c) 2019 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/pan-gesture/pan-gesture-processor.h>
21 #if defined(DEBUG_ENABLED)
29 #include <dali/public-api/actors/actor.h>
30 #include <dali/public-api/common/dali-common.h>
31 #include <dali/public-api/events/pan-gesture.h>
32 #include <dali/public-api/math/vector2.h>
33 #include <dali/internal/event/events/pan-gesture/pan-gesture-event.h>
34 #include <dali/integration-api/debug.h>
35 #include <dali/internal/event/common/scene-impl.h>
36 #include <dali/internal/event/render-tasks/render-task-impl.h>
37 #include <dali/internal/update/gestures/scene-graph-pan-gesture.h>
38 #include <dali/internal/event/events/multi-point-event-util.h>
39 #include <dali/internal/event/events/pan-gesture/pan-gesture-recognizer.h>
40 #include <dali/internal/event/events/gesture-requests.h>
48 namespace // unnamed namespace
51 #if defined(DEBUG_ENABLED)
52 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_PAN_PROCESSOR" );
54 const char * GESTURE_STATES[ 6 ] =
64 #endif // defined(DEBUG_ENABLED)
66 const unsigned long MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY( 50u );
69 * Functor which checks whether the specified actor is attached to the gesture detector.
70 * If the actor is attached, it also checks whether the number of touches of the current pan event
71 * are within the range of that expected by the detector.
72 * It returns true if it is no longer attached or the touches are out of range.
73 * This can be used in remove_if functions.
75 struct IsNotAttachedAndOutsideTouchesRangeFunctor
79 * @param[in] actor The actor to check whether it is attached.
80 * @param[in] touches The number of touches in the current pan event.
81 * @param[in] outsideRangeEmitters Reference to container where emitters outside of the touches range should be added.
83 IsNotAttachedAndOutsideTouchesRangeFunctor(Actor* actor, unsigned int touches, GestureDetectorContainer& outsideRangeEmitters)
84 : actorToCheck(actor),
85 numberOfTouches(touches),
86 outsideTouchesRangeEmitters(outsideRangeEmitters)
91 * Returns true if not attached, false if it is still attached.
92 * Additionally, checks if the number of touches has changed and stops sending the pan to a particular
93 * detector if it exceeds the range of that detector.
94 * @param[in] detector The detector to check.
95 * @return true, if not attached, false otherwise.
97 bool operator()(GestureDetector* detector) const
99 bool remove(!detector->IsAttached(*actorToCheck));
103 PanGestureDetector* panDetector( static_cast< PanGestureDetector* >( detector ) );
105 // Ensure number of touch points is within the range of our emitter. If it isn't then remove
106 // this emitter and add it to the outsideTouchesRangeEmitters container
107 if ( (numberOfTouches < panDetector->GetMinimumTouchesRequired()) ||
108 (numberOfTouches > panDetector->GetMaximumTouchesRequired()) )
111 outsideTouchesRangeEmitters.push_back(detector);
118 Actor* actorToCheck; ///< The actor to check whether it is attached or not.
119 unsigned int numberOfTouches; ///< The number of touches in the pan event.
120 GestureDetectorContainer& outsideTouchesRangeEmitters; ///< Emitters that are outside of the range of current pan.
123 } // unnamed namespace
125 PanGestureProcessor::PanGestureProcessor( SceneGraph::UpdateManager& updateManager )
126 : GestureProcessor( Gesture::Pan ),
127 mPanGestureDetectors(),
128 mCurrentPanEmitters(),
129 mCurrentRenderTask(),
130 mPossiblePanPosition(),
131 mMinTouchesRequired( 1 ),
132 mMaxTouchesRequired( 1 ),
133 mCurrentPanEvent( nullptr ),
134 mSceneObject( SceneGraph::PanGesture::New() ) // Create scene object to store pan information.
136 // Pass ownership to scene-graph; scene object lives for the lifecycle of UpdateManager
137 updateManager.SetPanGestureProcessor( mSceneObject );
140 PanGestureProcessor::~PanGestureProcessor()
142 mSceneObject = nullptr; // mSceneObject is owned and destroyed by update manager (there is only one of these for now)
145 void PanGestureProcessor::Process( Scene& scene, const PanGestureEvent& panEvent )
147 #if defined(DEBUG_ENABLED)
148 DALI_LOG_TRACE_METHOD( gLogFilter );
150 DALI_LOG_INFO( gLogFilter, Debug::General, " Pan Event\n");
151 DALI_LOG_INFO( gLogFilter, Debug::General, " State: %s Touches: %d Time: %d TimeDelta: %d\n",
152 GESTURE_STATES[panEvent.state], panEvent.numberOfTouches, panEvent.time, panEvent.timeDelta);
153 DALI_LOG_INFO( gLogFilter, Debug::General, " Positions: Current: (%.0f, %.0f), Previous: (%.0f, %.0f)\n",
154 panEvent.currentPosition.x, panEvent.currentPosition.y, panEvent.previousPosition.x, panEvent.previousPosition.y);
157 switch( panEvent.state )
159 case Gesture::Possible:
161 mCurrentPanEmitters.clear();
164 // It's only possible on touch-down, which is the position we want to hit-test against when the pan actually starts
165 mPossiblePanPosition = panEvent.currentPosition;
169 case Gesture::Started:
171 // Requires a core update
174 if ( GetCurrentGesturedActor() )
176 // The pan gesture should only be sent to the gesture detector which first received it so that
177 // it can be told when the gesture ends as well.
179 HitTestAlgorithm::Results hitTestResults;
180 HitTest( scene, mPossiblePanPosition, hitTestResults ); // Hit test original possible position...
182 if ( hitTestResults.actor )
184 // Record the current render-task for Screen->Actor coordinate conversions
185 mCurrentRenderTask = hitTestResults.renderTask;
187 // Set mCurrentPanEvent to use inside overridden methods called in ProcessAndEmit()
188 mCurrentPanEvent = &panEvent;
189 ProcessAndEmit( hitTestResults );
190 mCurrentPanEvent = nullptr;
195 mCurrentPanEmitters.clear();
201 case Gesture::Continuing:
203 // Requires a core update
206 // No break, Fallthrough
207 case Gesture::Finished:
208 case Gesture::Cancelled:
210 // Only send subsequent pan gesture signals if we processed the pan gesture when it started.
211 // Check if actor is still touchable.
213 Actor* currentGesturedActor = GetCurrentGesturedActor();
214 if ( currentGesturedActor )
216 if ( currentGesturedActor->IsHittable() && !mCurrentPanEmitters.empty() && mCurrentRenderTask )
218 GestureDetectorContainer outsideTouchesRangeEmitters;
220 // Removes emitters that no longer have the actor attached
221 // Also remove emitters whose touches are outside the range of the current pan event and add them to outsideTouchesRangeEmitters
222 GestureDetectorContainer::iterator endIter = std::remove_if( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(),
223 IsNotAttachedAndOutsideTouchesRangeFunctor(currentGesturedActor, panEvent.numberOfTouches, outsideTouchesRangeEmitters) );
224 mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
228 if ( !outsideTouchesRangeEmitters.empty() || !mCurrentPanEmitters.empty() )
230 currentGesturedActor->ScreenToLocal( *mCurrentRenderTask.Get(), actorCoords.x, actorCoords.y, panEvent.currentPosition.x, panEvent.currentPosition.y );
232 // EmitPanSignal checks whether we have a valid actor and whether the container we are passing in has emitters before it emits the pan.
233 EmitPanSignal( currentGesturedActor, outsideTouchesRangeEmitters, panEvent, actorCoords, Gesture::Finished, mCurrentRenderTask);
234 EmitPanSignal( currentGesturedActor, mCurrentPanEmitters, panEvent, actorCoords, panEvent.state, mCurrentRenderTask);
237 if ( mCurrentPanEmitters.empty() )
239 // If we have no emitters attached then clear pan actor as well.
243 // Clear current gesture detectors if pan gesture has ended or been cancelled.
244 if ( ( panEvent.state == Gesture::Finished ) || ( panEvent.state == Gesture::Cancelled ) )
246 mCurrentPanEmitters.clear();
252 mCurrentPanEmitters.clear();
261 DALI_ABORT( "Incorrect state received from Integration layer: Clear\n" );
267 void PanGestureProcessor::AddGestureDetector( PanGestureDetector* gestureDetector, Scene& scene, int32_t minDistance, int32_t minPanEvents )
269 bool firstRegistration(mPanGestureDetectors.empty());
271 mPanGestureDetectors.push_back(gestureDetector);
273 if (firstRegistration)
275 mMinTouchesRequired = gestureDetector->GetMinimumTouchesRequired();
276 mMaxTouchesRequired = gestureDetector->GetMaximumTouchesRequired();
278 PanGestureRequest request;
279 request.minTouches = mMinTouchesRequired;
280 request.maxTouches = mMaxTouchesRequired;
282 Size size = scene.GetSize();
283 mGestureRecognizer = new PanGestureRecognizer(*this, Vector2(size.width, size.height), static_cast<const PanGestureRequest&>(request), minDistance, minPanEvents);
291 void PanGestureProcessor::RemoveGestureDetector( PanGestureDetector* gestureDetector )
293 if (!mCurrentPanEmitters.empty())
295 // Check if the removed detector was one that is currently being panned and remove it from emitters.
296 GestureDetectorContainer::iterator endIter = std::remove( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(), gestureDetector );
297 mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
299 // If we no longer have any emitters, then we should clear mCurrentGesturedActor as well
300 if ( mCurrentPanEmitters.empty() )
306 // Find the detector...
307 PanGestureDetectorContainer::iterator endIter = std::remove( mPanGestureDetectors.begin(), mPanGestureDetectors.end(), gestureDetector );
308 DALI_ASSERT_DEBUG( endIter != mPanGestureDetectors.end() );
311 mPanGestureDetectors.erase(endIter, mPanGestureDetectors.end());
313 if (mPanGestureDetectors.empty())
315 mGestureRecognizer.Detach();
323 void PanGestureProcessor::GestureDetectorUpdated( PanGestureDetector* gestureDetector )
325 DALI_ASSERT_DEBUG(find(mPanGestureDetectors.begin(), mPanGestureDetectors.end(), gestureDetector) != mPanGestureDetectors.end());
330 bool PanGestureProcessor::SetPanGestureProperties( const PanGesture& pan )
332 // If we are currently processing a pan gesture then just ignore
333 if ( mCurrentPanEmitters.empty() && mSceneObject )
335 // We update the scene object directly rather than sending a message.
336 // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
337 mSceneObject->AddGesture( pan );
339 if( Gesture::Started == pan.state || Gesture::Continuing == pan.state )
348 void PanGestureProcessor::EnableProfiling()
350 mSceneObject->EnableProfiling();
353 void PanGestureProcessor::SetPredictionMode(int mode)
356 || (mode >= SceneGraph::PanGesture::NUM_PREDICTION_MODES) )
358 mode = SceneGraph::PanGesture::DEFAULT_PREDICTION_MODE;
360 SceneGraph::PanGesture::PredictionMode modeEnum = static_cast<SceneGraph::PanGesture::PredictionMode>(mode);
361 mSceneObject->SetPredictionMode(modeEnum);
364 void PanGestureProcessor::SetPredictionAmount(unsigned int amount)
366 mSceneObject->SetPredictionAmount(amount);
369 void PanGestureProcessor::SetMaximumPredictionAmount(unsigned int amount)
371 mSceneObject->SetMaximumPredictionAmount(amount);
374 void PanGestureProcessor::SetMinimumPredictionAmount(unsigned int amount)
376 mSceneObject->SetMinimumPredictionAmount(amount);
379 void PanGestureProcessor::SetPredictionAmountAdjustment(unsigned int amount)
381 mSceneObject->SetPredictionAmountAdjustment(amount);
384 void PanGestureProcessor::SetSmoothingMode(int mode)
387 || (mode >= SceneGraph::PanGesture::NUM_SMOOTHING_MODES) )
389 mode = SceneGraph::PanGesture::DEFAULT_SMOOTHING_MODE;
391 SceneGraph::PanGesture::SmoothingMode modeEnum = static_cast<SceneGraph::PanGesture::SmoothingMode>(mode);
392 mSceneObject->SetSmoothingMode(modeEnum);
395 void PanGestureProcessor::SetSmoothingAmount(float amount)
397 mSceneObject->SetSmoothingAmount(amount);
400 void PanGestureProcessor::SetUseActualTimes( bool value )
402 mSceneObject->SetUseActualTimes( value );
405 void PanGestureProcessor::SetInterpolationTimeRange( int value )
407 mSceneObject->SetInterpolationTimeRange( value );
410 void PanGestureProcessor::SetScalarOnlyPredictionEnabled( bool value )
412 mSceneObject->SetScalarOnlyPredictionEnabled( value );
415 void PanGestureProcessor::SetTwoPointPredictionEnabled( bool value )
417 mSceneObject->SetTwoPointPredictionEnabled( value );
420 void PanGestureProcessor::SetTwoPointInterpolatePastTime( int value )
422 mSceneObject->SetTwoPointInterpolatePastTime( value );
425 void PanGestureProcessor::SetTwoPointVelocityBias( float value )
427 mSceneObject->SetTwoPointVelocityBias( value );
430 void PanGestureProcessor::SetTwoPointAccelerationBias( float value )
432 mSceneObject->SetTwoPointAccelerationBias( value );
435 void PanGestureProcessor::SetMultitapSmoothingRange( int value )
437 mSceneObject->SetMultitapSmoothingRange( value );
440 const SceneGraph::PanGesture& PanGestureProcessor::GetSceneObject() const
442 return *mSceneObject;
445 void PanGestureProcessor::UpdateDetection()
447 DALI_ASSERT_DEBUG(!mPanGestureDetectors.empty());
449 unsigned int minimumRequired = UINT_MAX;
450 unsigned int maximumRequired = 0;
452 for ( PanGestureDetectorContainer::iterator iter = mPanGestureDetectors.begin(), endIter = mPanGestureDetectors.end(); iter != endIter; ++iter )
454 PanGestureDetector* detector(*iter);
458 unsigned int minimum = detector->GetMinimumTouchesRequired();
459 if (minimum < minimumRequired)
461 minimumRequired = minimum;
464 unsigned int maximum = detector->GetMaximumTouchesRequired();
465 if (maximum > maximumRequired)
467 maximumRequired = maximum;
472 if ( (minimumRequired != mMinTouchesRequired)||(maximumRequired != mMaxTouchesRequired) )
474 mMinTouchesRequired = minimumRequired;
475 mMaxTouchesRequired = maximumRequired;
477 PanGestureRequest request;
478 request.minTouches = mMinTouchesRequired;
479 request.maxTouches = mMaxTouchesRequired;
480 mGestureRecognizer->Update(request);
484 void PanGestureProcessor::EmitPanSignal( Actor* actor,
485 const GestureDetectorContainer& gestureDetectors,
486 const PanGestureEvent& panEvent,
487 Vector2 localCurrent,
488 Gesture::State state,
489 RenderTaskPtr renderTask )
491 if ( actor && !gestureDetectors.empty() )
493 PanGesture pan(state);
494 pan.time = panEvent.time;
496 pan.numberOfTouches = panEvent.numberOfTouches;
497 pan.screenPosition = panEvent.currentPosition;
498 pan.position = localCurrent;
500 RenderTask& renderTaskImpl( *renderTask.Get() );
502 Vector2 localPrevious;
503 actor->ScreenToLocal( renderTaskImpl, localPrevious.x, localPrevious.y, panEvent.previousPosition.x, panEvent.previousPosition.y );
505 pan.displacement = localCurrent - localPrevious;
506 Vector2 previousPos( panEvent.previousPosition );
507 if ( state == Gesture::Started )
509 previousPos = mPossiblePanPosition;
512 pan.screenDisplacement = panEvent.currentPosition - previousPos;
514 // Avoid dividing by 0
515 if ( panEvent.timeDelta > 0 )
517 pan.velocity.x = pan.displacement.x / static_cast<float>( panEvent.timeDelta );
518 pan.velocity.y = pan.displacement.y / static_cast<float>( panEvent.timeDelta );
520 pan.screenVelocity.x = pan.screenDisplacement.x / static_cast<float>( panEvent.timeDelta );
521 pan.screenVelocity.y = pan.screenDisplacement.y / static_cast<float>( panEvent.timeDelta );
524 // When the gesture ends, we may incorrectly get a ZERO velocity (as we have lifted our finger without any movement)
525 // so we should use the last recorded velocity instead in this scenario.
526 if ( ( state == Gesture::Finished ) && ( pan.screenVelocity == Vector2::ZERO ) &&
527 ( panEvent.timeDelta < MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY ) )
529 pan.velocity = mLastVelocity;
530 pan.screenVelocity = mLastScreenVelocity;
534 // Store the current velocity for future iterations.
535 mLastVelocity = pan.velocity;
536 mLastScreenVelocity = pan.screenVelocity;
541 // We update the scene object directly rather than sending a message.
542 // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
543 mSceneObject->AddGesture( pan );
546 Dali::Actor actorHandle( actor );
548 const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
549 for ( GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter )
551 static_cast< PanGestureDetector* >( *iter )->EmitPanGestureSignal( actorHandle, pan );
556 void PanGestureProcessor::OnGesturedActorStageDisconnection()
558 mCurrentPanEmitters.clear();
561 bool PanGestureProcessor::CheckGestureDetector( GestureDetector* detector, Actor* actor )
563 DALI_ASSERT_DEBUG( mCurrentPanEvent );
565 bool retVal( false );
566 PanGestureDetector* panDetector( static_cast< PanGestureDetector* >( detector ) );
568 if ( ( mCurrentPanEvent->numberOfTouches >= panDetector->GetMinimumTouchesRequired() ) &&
569 ( mCurrentPanEvent->numberOfTouches <= panDetector->GetMaximumTouchesRequired() ) )
571 // Check if the detector requires directional panning.
572 if ( panDetector->RequiresDirectionalPan() && mCurrentRenderTask )
574 // It does, calculate the angle of the pan in local actor coordinates and ensures it fits
575 // the detector's criteria.
576 RenderTask& renderTaskImpl = *mCurrentRenderTask.Get();
578 Vector2 startPosition, currentPosition;
579 actor->ScreenToLocal( renderTaskImpl, startPosition.x, startPosition.y, mPossiblePanPosition.x, mPossiblePanPosition.y );
580 actor->ScreenToLocal( renderTaskImpl, currentPosition.x, currentPosition.y, mCurrentPanEvent->currentPosition.x, mCurrentPanEvent->currentPosition.y );
581 Vector2 displacement( currentPosition - startPosition );
583 Radian angle( atanf( displacement.y / displacement.x ) );
585 /////////////////////////////
588 // Q3 (-,-) | Q4 (+,-) //
590 // ----------------- +x //
592 // Q2 (-,+) | Q1 (+,+) //
596 /////////////////////////////
598 // Quadrant 2: 180 degrees + angle
599 // Quadrant 3: angle - 180 degrees
601 /////////////////////////////
603 if ( displacement.x < 0.0f )
605 if ( displacement.y >= 0.0f )
608 angle.radian += Math::PI;
613 angle.radian -= Math::PI;
617 if ( panDetector->CheckAngleAllowed( angle ) )
624 // Directional panning not required so we can use this actor and gesture detector.
631 void PanGestureProcessor::EmitGestureSignal( Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates )
633 DALI_ASSERT_DEBUG ( mCurrentPanEvent );
635 mCurrentPanEmitters.clear();
638 actor->ScreenToLocal( *mCurrentRenderTask.Get(), actorCoordinates.x, actorCoordinates.y, mCurrentPanEvent->currentPosition.x, mCurrentPanEvent->currentPosition.y );
640 EmitPanSignal( actor, gestureDetectors, *mCurrentPanEvent, actorCoordinates, mCurrentPanEvent->state, mCurrentRenderTask );
642 if ( actor->OnStage() )
644 mCurrentPanEmitters = gestureDetectors;
649 } // namespace Internal