2 * Copyright (c) 2020 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/pan-gesture/pan-gesture-impl.h>
41 #include <dali/internal/event/events/gesture-requests.h>
49 namespace // unnamed namespace
52 #if defined(DEBUG_ENABLED)
53 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_PAN_PROCESSOR" );
55 const char * GESTURE_STATES[ 6 ] =
65 #endif // defined(DEBUG_ENABLED)
67 const unsigned long MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY( 50u );
70 * Functor which checks whether the specified actor is attached to the gesture detector.
71 * If the actor is attached, it also checks whether the number of touches of the current pan event
72 * are within the range of that expected by the detector.
73 * It returns true if it is no longer attached or the touches are out of range.
74 * This can be used in remove_if functions.
76 struct IsNotAttachedAndOutsideTouchesRangeFunctor
80 * @param[in] actor The actor to check whether it is attached.
81 * @param[in] touches The number of touches in the current pan event.
82 * @param[in] outsideRangeEmitters Reference to container where emitters outside of the touches range should be added.
84 IsNotAttachedAndOutsideTouchesRangeFunctor(Actor* actor, unsigned int touches, GestureDetectorContainer& outsideRangeEmitters)
85 : actorToCheck(actor),
86 numberOfTouches(touches),
87 outsideTouchesRangeEmitters(outsideRangeEmitters)
92 * Returns true if not attached, false if it is still attached.
93 * Additionally, checks if the number of touches has changed and stops sending the pan to a particular
94 * detector if it exceeds the range of that detector.
95 * @param[in] detector The detector to check.
96 * @return true, if not attached, false otherwise.
98 bool operator()(GestureDetector* detector) const
100 bool remove(!detector->IsAttached(*actorToCheck));
104 PanGestureDetector* panDetector( static_cast< PanGestureDetector* >( detector ) );
106 // Ensure number of touch points is within the range of our emitter. If it isn't then remove
107 // this emitter and add it to the outsideTouchesRangeEmitters container
108 if ( (numberOfTouches < panDetector->GetMinimumTouchesRequired()) ||
109 (numberOfTouches > panDetector->GetMaximumTouchesRequired()) )
112 outsideTouchesRangeEmitters.push_back(detector);
119 Actor* actorToCheck; ///< The actor to check whether it is attached or not.
120 unsigned int numberOfTouches; ///< The number of touches in the pan event.
121 GestureDetectorContainer& outsideTouchesRangeEmitters; ///< Emitters that are outside of the range of current pan.
124 } // unnamed namespace
126 PanGestureProcessor::PanGestureProcessor( SceneGraph::UpdateManager& updateManager )
127 : GestureProcessor( GestureType::PAN ),
128 mPanGestureDetectors(),
129 mCurrentPanEmitters(),
130 mCurrentRenderTask(),
131 mPossiblePanPosition(),
132 mMinTouchesRequired( 1 ),
133 mMaxTouchesRequired( 1 ),
134 mCurrentPanEvent( nullptr ),
135 mSceneObject( SceneGraph::PanGesture::New() ) // Create scene object to store pan information.
137 // Pass ownership to scene-graph; scene object lives for the lifecycle of UpdateManager
138 updateManager.SetPanGestureProcessor( mSceneObject );
141 PanGestureProcessor::~PanGestureProcessor()
143 mSceneObject = nullptr; // mSceneObject is owned and destroyed by update manager (there is only one of these for now)
146 void PanGestureProcessor::Process( Scene& scene, const PanGestureEvent& panEvent )
148 #if defined(DEBUG_ENABLED)
149 DALI_LOG_TRACE_METHOD( gLogFilter );
151 DALI_LOG_INFO( gLogFilter, Debug::General, " Pan Event\n");
152 DALI_LOG_INFO( gLogFilter, Debug::General, " State: %s Touches: %d Time: %d TimeDelta: %d\n",
153 GESTURE_STATES[static_cast<uint8_t>(panEvent.state)], panEvent.numberOfTouches, panEvent.time, panEvent.timeDelta);
154 DALI_LOG_INFO( gLogFilter, Debug::General, " Positions: Current: (%.0f, %.0f), Previous: (%.0f, %.0f)\n",
155 panEvent.currentPosition.x, panEvent.currentPosition.y, panEvent.previousPosition.x, panEvent.previousPosition.y);
158 switch( panEvent.state )
160 case GestureState::POSSIBLE:
162 mCurrentPanEmitters.clear();
165 HitTestAlgorithm::Results hitTestResults;
166 if( HitTest( scene, panEvent.currentPosition, hitTestResults ) )
168 SetActor( &GetImplementation( hitTestResults.actor ) );
169 mPossiblePanPosition = panEvent.currentPosition;
174 case GestureState::STARTED:
176 // Requires a core update
179 // The pan gesture should only be sent to the gesture detector which first received it so that
180 // it can be told when the gesture ends as well.
182 HitTestAlgorithm::Results hitTestResults;
183 HitTest( scene, panEvent.previousPosition, hitTestResults ); // Hit Test previous position
185 if ( hitTestResults.actor )
187 // If the current hit actor is different from the one we touched down on then set accordingly & update initial pan position
188 if( &GetImplementation( hitTestResults.actor ) != GetCurrentGesturedActor() )
190 mPossiblePanPosition = panEvent.previousPosition;
191 SetActor( &GetImplementation( hitTestResults.actor ) );
194 // Record the current render-task for Screen->Actor coordinate conversions
195 mCurrentRenderTask = hitTestResults.renderTask;
197 // Set mCurrentPanEvent to use inside overridden methods called in ProcessAndEmit()
198 mCurrentPanEvent = &panEvent;
199 ProcessAndEmit( hitTestResults );
200 mCurrentPanEvent = nullptr;
205 mCurrentPanEmitters.clear();
210 case GestureState::CONTINUING:
212 // Requires a core update
218 case GestureState::FINISHED:
219 case GestureState::CANCELLED:
221 // Only send subsequent pan gesture signals if we processed the pan gesture when it started.
222 // Check if actor is still touchable.
224 Actor* currentGesturedActor = GetCurrentGesturedActor();
225 if ( currentGesturedActor )
227 if ( currentGesturedActor->IsHittable() && !mCurrentPanEmitters.empty() && mCurrentRenderTask )
229 GestureDetectorContainer outsideTouchesRangeEmitters;
231 // Removes emitters that no longer have the actor attached
232 // Also remove emitters whose touches are outside the range of the current pan event and add them to outsideTouchesRangeEmitters
233 GestureDetectorContainer::iterator endIter = std::remove_if( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(),
234 IsNotAttachedAndOutsideTouchesRangeFunctor(currentGesturedActor, panEvent.numberOfTouches, outsideTouchesRangeEmitters) );
235 mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
239 if ( !outsideTouchesRangeEmitters.empty() || !mCurrentPanEmitters.empty() )
241 currentGesturedActor->ScreenToLocal( *mCurrentRenderTask.Get(), actorCoords.x, actorCoords.y, panEvent.currentPosition.x, panEvent.currentPosition.y );
243 // EmitPanSignal checks whether we have a valid actor and whether the container we are passing in has emitters before it emits the pan.
244 EmitPanSignal( currentGesturedActor, outsideTouchesRangeEmitters, panEvent, actorCoords, GestureState::FINISHED, mCurrentRenderTask);
245 EmitPanSignal( currentGesturedActor, mCurrentPanEmitters, panEvent, actorCoords, panEvent.state, mCurrentRenderTask);
248 if ( mCurrentPanEmitters.empty() )
250 // If we have no emitters attached then clear pan actor as well.
254 // Clear current gesture detectors if pan gesture has ended or been cancelled.
255 if ( ( panEvent.state == GestureState::FINISHED ) || ( panEvent.state == GestureState::CANCELLED ) )
257 mCurrentPanEmitters.clear();
263 mCurrentPanEmitters.clear();
270 case GestureState::CLEAR:
272 DALI_ABORT( "Incorrect state received from Integration layer: CLEAR\n" );
278 void PanGestureProcessor::AddGestureDetector( PanGestureDetector* gestureDetector, Scene& scene, int32_t minDistance, int32_t minPanEvents )
280 bool firstRegistration(mPanGestureDetectors.empty());
282 mPanGestureDetectors.push_back(gestureDetector);
284 if (firstRegistration)
286 mMinTouchesRequired = gestureDetector->GetMinimumTouchesRequired();
287 mMaxTouchesRequired = gestureDetector->GetMaximumTouchesRequired();
289 PanGestureRequest request;
290 request.minTouches = mMinTouchesRequired;
291 request.maxTouches = mMaxTouchesRequired;
293 Size size = scene.GetSize();
294 mGestureRecognizer = new PanGestureRecognizer(*this, Vector2(size.width, size.height), static_cast<const PanGestureRequest&>(request), minDistance, minPanEvents);
302 void PanGestureProcessor::RemoveGestureDetector( PanGestureDetector* gestureDetector )
304 if (!mCurrentPanEmitters.empty())
306 // Check if the removed detector was one that is currently being panned and remove it from emitters.
307 GestureDetectorContainer::iterator endIter = std::remove( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(), gestureDetector );
308 mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
310 // If we no longer have any emitters, then we should clear mCurrentGesturedActor as well
311 if ( mCurrentPanEmitters.empty() )
317 // Find the detector...
318 PanGestureDetectorContainer::iterator endIter = std::remove( mPanGestureDetectors.begin(), mPanGestureDetectors.end(), gestureDetector );
319 DALI_ASSERT_DEBUG( endIter != mPanGestureDetectors.end() );
322 mPanGestureDetectors.erase(endIter, mPanGestureDetectors.end());
324 if (mPanGestureDetectors.empty())
326 mGestureRecognizer = nullptr;
334 void PanGestureProcessor::GestureDetectorUpdated( PanGestureDetector* gestureDetector )
336 DALI_ASSERT_DEBUG(find(mPanGestureDetectors.begin(), mPanGestureDetectors.end(), gestureDetector) != mPanGestureDetectors.end());
341 bool PanGestureProcessor::SetPanGestureProperties( const Dali::PanGesture& pan )
343 // If we are currently processing a pan gesture then just ignore
344 if ( mCurrentPanEmitters.empty() && mSceneObject )
346 const PanGesture& panImpl( GetImplementation(pan) );
348 // We update the scene object directly rather than sending a message.
349 // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
350 mSceneObject->AddGesture( panImpl );
352 if( GestureState::STARTED == panImpl.GetState() || GestureState::CONTINUING == panImpl.GetState() )
361 void PanGestureProcessor::EnableProfiling()
363 mSceneObject->EnableProfiling();
366 void PanGestureProcessor::SetPredictionMode(int mode)
369 || (mode >= SceneGraph::PanGesture::NUM_PREDICTION_MODES) )
371 mode = SceneGraph::PanGesture::DEFAULT_PREDICTION_MODE;
373 SceneGraph::PanGesture::PredictionMode modeEnum = static_cast<SceneGraph::PanGesture::PredictionMode>(mode);
374 mSceneObject->SetPredictionMode(modeEnum);
377 void PanGestureProcessor::SetPredictionAmount(unsigned int amount)
379 mSceneObject->SetPredictionAmount(amount);
382 void PanGestureProcessor::SetMaximumPredictionAmount(unsigned int amount)
384 mSceneObject->SetMaximumPredictionAmount(amount);
387 void PanGestureProcessor::SetMinimumPredictionAmount(unsigned int amount)
389 mSceneObject->SetMinimumPredictionAmount(amount);
392 void PanGestureProcessor::SetPredictionAmountAdjustment(unsigned int amount)
394 mSceneObject->SetPredictionAmountAdjustment(amount);
397 void PanGestureProcessor::SetSmoothingMode(int mode)
400 || (mode >= SceneGraph::PanGesture::NUM_SMOOTHING_MODES) )
402 mode = SceneGraph::PanGesture::DEFAULT_SMOOTHING_MODE;
404 SceneGraph::PanGesture::SmoothingMode modeEnum = static_cast<SceneGraph::PanGesture::SmoothingMode>(mode);
405 mSceneObject->SetSmoothingMode(modeEnum);
408 void PanGestureProcessor::SetSmoothingAmount(float amount)
410 mSceneObject->SetSmoothingAmount(amount);
413 void PanGestureProcessor::SetUseActualTimes( bool value )
415 mSceneObject->SetUseActualTimes( value );
418 void PanGestureProcessor::SetInterpolationTimeRange( int value )
420 mSceneObject->SetInterpolationTimeRange( value );
423 void PanGestureProcessor::SetScalarOnlyPredictionEnabled( bool value )
425 mSceneObject->SetScalarOnlyPredictionEnabled( value );
428 void PanGestureProcessor::SetTwoPointPredictionEnabled( bool value )
430 mSceneObject->SetTwoPointPredictionEnabled( value );
433 void PanGestureProcessor::SetTwoPointInterpolatePastTime( int value )
435 mSceneObject->SetTwoPointInterpolatePastTime( value );
438 void PanGestureProcessor::SetTwoPointVelocityBias( float value )
440 mSceneObject->SetTwoPointVelocityBias( value );
443 void PanGestureProcessor::SetTwoPointAccelerationBias( float value )
445 mSceneObject->SetTwoPointAccelerationBias( value );
448 void PanGestureProcessor::SetMultitapSmoothingRange( int value )
450 mSceneObject->SetMultitapSmoothingRange( value );
453 const SceneGraph::PanGesture& PanGestureProcessor::GetSceneObject() const
455 return *mSceneObject;
458 void PanGestureProcessor::UpdateDetection()
460 DALI_ASSERT_DEBUG(!mPanGestureDetectors.empty());
462 unsigned int minimumRequired = UINT_MAX;
463 unsigned int maximumRequired = 0;
465 for ( PanGestureDetectorContainer::iterator iter = mPanGestureDetectors.begin(), endIter = mPanGestureDetectors.end(); iter != endIter; ++iter )
467 PanGestureDetector* detector(*iter);
471 unsigned int minimum = detector->GetMinimumTouchesRequired();
472 if (minimum < minimumRequired)
474 minimumRequired = minimum;
477 unsigned int maximum = detector->GetMaximumTouchesRequired();
478 if (maximum > maximumRequired)
480 maximumRequired = maximum;
485 if ( (minimumRequired != mMinTouchesRequired)||(maximumRequired != mMaxTouchesRequired) )
487 mMinTouchesRequired = minimumRequired;
488 mMaxTouchesRequired = maximumRequired;
490 PanGestureRequest request;
491 request.minTouches = mMinTouchesRequired;
492 request.maxTouches = mMaxTouchesRequired;
493 mGestureRecognizer->Update(request);
497 void PanGestureProcessor::EmitPanSignal( Actor* actor,
498 const GestureDetectorContainer& gestureDetectors,
499 const PanGestureEvent& panEvent,
500 Vector2 localCurrent,
502 RenderTaskPtr renderTask )
504 if ( actor && !gestureDetectors.empty() )
506 Internal::PanGesturePtr pan( new Internal::PanGesture(state ) );
508 pan->SetTime( panEvent.time );
510 pan->SetNumberOfTouches( panEvent.numberOfTouches );
511 pan->SetScreenPosition( panEvent.currentPosition );
512 pan->SetPosition( localCurrent );
514 RenderTask& renderTaskImpl( *renderTask.Get() );
516 Vector2 localPrevious;
517 actor->ScreenToLocal( renderTaskImpl, localPrevious.x, localPrevious.y, panEvent.previousPosition.x, panEvent.previousPosition.y );
519 pan->SetDisplacement( localCurrent - localPrevious );
520 Vector2 previousPos( panEvent.previousPosition );
521 if ( state == GestureState::STARTED )
523 previousPos = mPossiblePanPosition;
526 pan->SetScreenDisplacement( panEvent.currentPosition - previousPos );
528 // Avoid dividing by 0
529 if ( panEvent.timeDelta > 0 )
532 velocity.x = pan->GetDisplacement().x / static_cast<float>( panEvent.timeDelta );
533 velocity.y = pan->GetDisplacement().y / static_cast<float>( panEvent.timeDelta );
534 pan->SetVelocity( velocity );
536 Vector2 screenVelocity;
537 screenVelocity.x = pan->GetScreenDisplacement().x / static_cast<float>( panEvent.timeDelta );
538 screenVelocity.y = pan->GetScreenDisplacement().y / static_cast<float>( panEvent.timeDelta );
539 pan->SetScreenVelocity( screenVelocity );
542 // When the gesture ends, we may incorrectly get a ZERO velocity (as we have lifted our finger without any movement)
543 // so we should use the last recorded velocity instead in this scenario.
544 if ( ( state == GestureState::FINISHED ) && ( pan->GetScreenVelocity() == Vector2::ZERO ) &&
545 ( panEvent.timeDelta < MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY ) )
547 pan->SetVelocity( mLastVelocity );
548 pan->SetScreenVelocity( mLastScreenVelocity );
552 // Store the current velocity for future iterations.
553 mLastVelocity = pan->GetVelocity();
554 mLastScreenVelocity = pan->GetScreenVelocity();
559 // We update the scene object directly rather than sending a message.
560 // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
561 mSceneObject->AddGesture( *pan.Get() );
564 Dali::Actor actorHandle( actor );
566 const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
567 for ( GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter )
569 static_cast< PanGestureDetector* >( *iter )->EmitPanGestureSignal( actorHandle, Dali::PanGesture( pan.Get() ) );
574 void PanGestureProcessor::OnGesturedActorStageDisconnection()
576 mCurrentPanEmitters.clear();
579 bool PanGestureProcessor::CheckGestureDetector( GestureDetector* detector, Actor* actor )
581 DALI_ASSERT_DEBUG( mCurrentPanEvent );
583 bool retVal( false );
584 PanGestureDetector* panDetector( static_cast< PanGestureDetector* >( detector ) );
586 if ( ( mCurrentPanEvent->numberOfTouches >= panDetector->GetMinimumTouchesRequired() ) &&
587 ( mCurrentPanEvent->numberOfTouches <= panDetector->GetMaximumTouchesRequired() ) )
589 // Check if the detector requires directional panning.
590 if ( panDetector->RequiresDirectionalPan() && mCurrentRenderTask )
592 // It does, calculate the angle of the pan in local actor coordinates and ensures it fits
593 // the detector's criteria.
594 RenderTask& renderTaskImpl = *mCurrentRenderTask.Get();
596 Vector2 startPosition, currentPosition;
597 actor->ScreenToLocal( renderTaskImpl, startPosition.x, startPosition.y, mPossiblePanPosition.x, mPossiblePanPosition.y );
598 actor->ScreenToLocal( renderTaskImpl, currentPosition.x, currentPosition.y, mCurrentPanEvent->currentPosition.x, mCurrentPanEvent->currentPosition.y );
599 Vector2 displacement( currentPosition - startPosition );
601 Radian angle( atanf( displacement.y / displacement.x ) );
603 /////////////////////////////
606 // Q3 (-,-) | Q4 (+,-) //
608 // ----------------- +x //
610 // Q2 (-,+) | Q1 (+,+) //
614 /////////////////////////////
616 // Quadrant 2: 180 degrees + angle
617 // Quadrant 3: angle - 180 degrees
619 /////////////////////////////
621 if ( displacement.x < 0.0f )
623 if ( displacement.y >= 0.0f )
626 angle.radian += Math::PI;
631 angle.radian -= Math::PI;
635 if ( panDetector->CheckAngleAllowed( angle ) )
642 // Directional panning not required so we can use this actor and gesture detector.
649 void PanGestureProcessor::EmitGestureSignal( Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates )
651 DALI_ASSERT_DEBUG ( mCurrentPanEvent );
653 mCurrentPanEmitters.clear();
656 actor->ScreenToLocal( *mCurrentRenderTask.Get(), actorCoordinates.x, actorCoordinates.y, mCurrentPanEvent->currentPosition.x, mCurrentPanEvent->currentPosition.y );
658 EmitPanSignal( actor, gestureDetectors, *mCurrentPanEvent, actorCoordinates, mCurrentPanEvent->state, mCurrentRenderTask );
660 if ( actor->OnScene() )
662 mCurrentPanEmitters = gestureDetectors;
667 } // namespace Internal