2 * Copyright (c) 2014 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-processor.h>
25 #include <dali/public-api/actors/actor.h>
26 #include <dali/public-api/common/dali-common.h>
27 #include <dali/public-api/events/pan-gesture.h>
28 #include <dali/public-api/math/vector2.h>
29 #include <dali/integration-api/events/pan-gesture-event.h>
30 #include <dali/integration-api/gesture-manager.h>
31 #include <dali/integration-api/debug.h>
32 #include <dali/internal/event/common/stage-impl.h>
33 #include <dali/internal/event/render-tasks/render-task-impl.h>
34 #include <dali/internal/update/gestures/scene-graph-pan-gesture.h>
42 namespace // unnamed namespace
45 const unsigned long MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY( 50u );
48 * Functor which checks whether the specified actor is attached to the gesture detector.
49 * If the actor is attached, it also checks whether the number of touches of the current pan event
50 * are within the range of that expected by the detector.
51 * It returns true if it is no longer attached or the touches are out of range.
52 * This can be used in remove_if functions.
54 struct IsNotAttachedAndOutsideTouchesRangeFunctor
58 * @param[in] actor The actor to check whether it is attached.
59 * @param[in] touches The number of touches in the current pan event.
60 * @param[in] outsideRangeEmitters Reference to container where emitters outside of the touches range should be added.
62 IsNotAttachedAndOutsideTouchesRangeFunctor(Actor* actor, unsigned int touches, PanGestureDetectorContainer& outsideRangeEmitters)
63 : actorToCheck(actor),
64 numberOfTouches(touches),
65 outsideTouchesRangeEmitters(outsideRangeEmitters)
70 * Returns true if not attached, false if it is still attached.
71 * Additionally, checks if the number of touches has changed and stops sending the pan to a particular
72 * detector if it exceeds the range of that detector.
73 * @param[in] detector The detector to check.
74 * @return true, if not attached, false otherwise.
76 bool operator()(PanGestureDetector* detector) const
78 bool remove(!detector->IsAttached(*actorToCheck));
82 // Ensure number of touch points is within the range of our emitter. If it isn't then remove
83 // this emitter and add it to the outsideTouchesRangeEmitters container
84 if ( (numberOfTouches < detector->GetMinimumTouchesRequired()) ||
85 (numberOfTouches > detector->GetMaximumTouchesRequired()) )
88 outsideTouchesRangeEmitters.push_back(detector);
95 Actor* actorToCheck; ///< The actor to check whether it is attached or not.
96 unsigned int numberOfTouches; ///< The number of touches in the pan event.
97 PanGestureDetectorContainer& outsideTouchesRangeEmitters; ///< Emitters that are outside of the range of current pan.
100 } // unnamed namespace
102 struct PanGestureProcessor::PanEventFunctor : public GestureProcessor::Functor
106 * @param[in] panEvent The current gesture event.
107 * @param[in] processor Reference to the processor.
109 PanEventFunctor( const Integration::PanGestureEvent& panEvent, PanGestureProcessor& processor )
110 : panEvent( panEvent ),
111 processor( processor )
116 * Check if the detector meets the current gesture event parameters.
118 virtual bool operator() ( GestureDetector* detector, Actor* actor )
120 bool retVal( false );
122 PanGestureDetector* panDetector( static_cast< PanGestureDetector* >( detector ) );
124 if ( ( panEvent.numberOfTouches >= panDetector->GetMinimumTouchesRequired() ) &&
125 ( panEvent.numberOfTouches <= panDetector->GetMaximumTouchesRequired() ) )
127 // Check if the detector requires directional panning.
128 if ( panDetector->RequiresDirectionalPan() && processor.mCurrentRenderTask )
130 // It does, calculate the angle of the pan in local actor coordinates and ensures it fits
131 // the detector's criteria.
132 RenderTask& renderTaskImpl( GetImplementation( processor.mCurrentRenderTask ) );
134 Vector2 startPosition, currentPosition;
135 actor->ScreenToLocal( renderTaskImpl, startPosition.x, startPosition.y, processor.mPossiblePanPosition.x, processor.mPossiblePanPosition.y );
136 actor->ScreenToLocal( renderTaskImpl, currentPosition.x, currentPosition.y, panEvent.currentPosition.x, panEvent.currentPosition.y );
137 Vector2 displacement( currentPosition - startPosition );
139 Radian angle( atan( displacement.y / displacement.x ) );
141 /////////////////////////////
144 // Q3 (-,-) | Q4 (+,-) //
146 // ----------------- +x //
148 // Q2 (-,+) | Q1 (+,+) //
152 /////////////////////////////
154 // Quadrant 2: 180 degrees + angle
155 // Quadrant 3: angle - 180 degrees
157 /////////////////////////////
159 if ( displacement.x < 0.0f )
161 if ( displacement.y >= 0.0f )
173 if ( panDetector->CheckAngleAllowed( angle ) )
180 // Directional panning not required so we can use this actor and gesture detector.
189 * Gestured actor and gesture detectors that meet the gesture's parameters found, emit and save required information.
191 virtual void operator() ( Dali::Actor actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates )
193 PanGestureDetectorContainer derivedContainer;
194 DownCastContainer<PanGestureDetector>( gestureDetectors, derivedContainer );
196 processor.mCurrentPanEmitters.clear();
197 processor.ResetActor();
199 Actor* actorImpl( &GetImplementation( actor ) );
200 actorImpl->ScreenToLocal( GetImplementation(processor.mCurrentRenderTask), actorCoordinates.x, actorCoordinates.y, panEvent.currentPosition.x, panEvent.currentPosition.y );
202 processor.EmitPanSignal( actor, derivedContainer, panEvent, actorCoordinates, panEvent.state, processor.mCurrentRenderTask );
204 if ( actorImpl->OnStage() )
206 processor.mCurrentPanEmitters = derivedContainer;
207 processor.SetActor( actor );
211 const Integration::PanGestureEvent& panEvent;
212 PanGestureProcessor& processor;
215 PanGestureProcessor::PanGestureProcessor( Stage& stage, Integration::GestureManager& gestureManager )
216 : GestureProcessor( Gesture::Pan ),
218 mGestureManager( gestureManager ),
220 mCurrentPanEmitters(),
221 mCurrentRenderTask(),
222 mPossiblePanPosition(),
223 mMinTouchesRequired( 1 ),
224 mMaxTouchesRequired( 1 ),
225 mSceneObject( SceneGraph::PanGesture::New() ) // Create scene object to store pan information.
227 // Pass ownership to scene-graph
228 AddGestureMessage( mStage.GetUpdateManager(), mSceneObject );
231 PanGestureProcessor::~PanGestureProcessor()
233 if( Stage::IsInstalled() && ( mSceneObject != NULL ) )
235 RemoveGestureMessage( mStage.GetUpdateManager(), mSceneObject );
236 mSceneObject = NULL; // mSceneObject is about to be destroyed
240 void PanGestureProcessor::Process( const Integration::PanGestureEvent& panEvent )
242 switch( panEvent.state )
244 case Gesture::Possible:
246 mCurrentPanEmitters.clear();
249 HitTestAlgorithm::Results hitTestResults;
250 if( HitTest( mStage, panEvent.currentPosition, hitTestResults ) )
252 SetActor( hitTestResults.actor );
253 mPossiblePanPosition = panEvent.currentPosition;
259 case Gesture::Started:
261 if ( GetCurrentGesturedActor() )
263 // The pan gesture should only be sent to the gesture detector which first received it so that
264 // it can be told when the gesture ends as well.
266 HitTestAlgorithm::Results hitTestResults;
267 HitTest( mStage, mPossiblePanPosition, hitTestResults ); // Hit test original possible position...
269 if ( hitTestResults.actor && ( GetCurrentGesturedActor() == &GetImplementation( hitTestResults.actor ) ) )
271 // Record the current render-task for Screen->Actor coordinate conversions
272 mCurrentRenderTask = hitTestResults.renderTask;
274 PanEventFunctor functor( panEvent, *this );
275 GestureDetectorContainer gestureDetectors;
276 UpCastContainer<PanGestureDetector>( mGestureDetectors, gestureDetectors );
277 ProcessAndEmit( hitTestResults, gestureDetectors, functor );
282 mCurrentPanEmitters.clear();
288 case Gesture::Continuing:
289 case Gesture::Finished:
290 case Gesture::Cancelled:
292 // Only send subsequent pan gesture signals if we processed the pan gesture when it started.
293 // Check if actor is still touchable.
295 Actor* currentGesturedActor = GetCurrentGesturedActor();
296 if ( currentGesturedActor )
298 if ( currentGesturedActor->IsHittable() && !mCurrentPanEmitters.empty() && mCurrentRenderTask )
300 PanGestureDetectorContainer outsideTouchesRangeEmitters;
302 // Removes emitters that no longer have the actor attached
303 // Also remove emitters whose touches are outside the range of the current pan event and add them to outsideTouchesRangeEmitters
304 PanGestureDetectorContainer::iterator endIter = std::remove_if( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(),
305 IsNotAttachedAndOutsideTouchesRangeFunctor(currentGesturedActor, panEvent.numberOfTouches, outsideTouchesRangeEmitters) );
306 mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
310 if ( !outsideTouchesRangeEmitters.empty() || !mCurrentPanEmitters.empty() )
312 currentGesturedActor->ScreenToLocal( GetImplementation( mCurrentRenderTask ), actorCoords.x, actorCoords.y, panEvent.currentPosition.x, panEvent.currentPosition.y );
314 // EmitPanSignal checks whether we have a valid actor and whether the container we are passing in has emitters before it emits the pan.
315 EmitPanSignal(Dali::Actor(currentGesturedActor), outsideTouchesRangeEmitters, panEvent, actorCoords, Gesture::Finished, mCurrentRenderTask);
316 EmitPanSignal(Dali::Actor(currentGesturedActor), mCurrentPanEmitters, panEvent, actorCoords, panEvent.state, mCurrentRenderTask);
319 if ( mCurrentPanEmitters.empty() )
321 // If we have no emitters attached then clear pan actor as well.
325 // Clear current gesture detectors if pan gesture has ended or been cancelled.
326 if ( ( panEvent.state == Gesture::Finished ) || ( panEvent.state == Gesture::Cancelled ) )
328 mCurrentPanEmitters.clear();
334 mCurrentPanEmitters.clear();
342 DALI_ASSERT_ALWAYS( false && "Incorrect state received from Integration layer: Clear\n" );
347 void PanGestureProcessor::AddGestureDetector( PanGestureDetector* gestureDetector )
349 bool firstRegistration(mGestureDetectors.empty());
351 mGestureDetectors.push_back(gestureDetector);
353 // Set the pan scene object on the gesture detector
354 gestureDetector->SetSceneObject( mSceneObject );
356 if (firstRegistration)
358 mMinTouchesRequired = gestureDetector->GetMinimumTouchesRequired();
359 mMaxTouchesRequired = gestureDetector->GetMaximumTouchesRequired();
361 Integration::PanGestureRequest request;
362 request.minTouches = mMinTouchesRequired;
363 request.maxTouches = mMaxTouchesRequired;
364 mGestureManager.Register(request);
372 void PanGestureProcessor::RemoveGestureDetector( PanGestureDetector* gestureDetector )
374 if (!mCurrentPanEmitters.empty())
376 // Check if the removed detector was one that is currently being panned and remove it from emitters.
377 PanGestureDetectorContainer::iterator endIter = std::remove( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(), gestureDetector );
378 mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
380 // If we no longer have any emitters, then we should clear mCurrentGesturedActor as well
381 if ( mCurrentPanEmitters.empty() )
387 // Find the detector...
388 PanGestureDetectorContainer::iterator endIter = std::remove( mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector );
389 DALI_ASSERT_DEBUG( endIter != mGestureDetectors.end() );
392 mGestureDetectors.erase(endIter, mGestureDetectors.end());
394 if (mGestureDetectors.empty())
396 Integration::GestureRequest request(Gesture::Pan);
397 mGestureManager.Unregister(request);
405 void PanGestureProcessor::GestureDetectorUpdated( PanGestureDetector* gestureDetector )
407 DALI_ASSERT_DEBUG(find(mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector) != mGestureDetectors.end());
412 void PanGestureProcessor::SetPanGestureProperties( const PanGesture& pan )
414 // If we are currently processing a pan gesture then just ignore
415 if ( mCurrentPanEmitters.empty() && mSceneObject )
417 // We update the scene object directly rather than sending a message.
418 // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
419 mSceneObject->AddGesture( pan );
423 void PanGestureProcessor::EnableProfiling()
425 mSceneObject->EnableProfiling();
428 void PanGestureProcessor::SetPredictionMode(int mode)
431 || (mode >= SceneGraph::PanGesture::NUM_PREDICTION_MODES) )
433 mode = SceneGraph::PanGesture::DEFAULT_PREDICTION_MODE;
435 SceneGraph::PanGesture::PredictionMode modeEnum = static_cast<SceneGraph::PanGesture::PredictionMode>(mode);
436 mSceneObject->SetPredictionMode(modeEnum);
439 void PanGestureProcessor::SetPredictionAmount(unsigned int amount)
441 mSceneObject->SetPredictionAmount(amount);
444 void PanGestureProcessor::UpdateDetection()
446 DALI_ASSERT_DEBUG(!mGestureDetectors.empty());
448 unsigned int minimumRequired = UINT_MAX;
449 unsigned int maximumRequired = 0;
451 for ( PanGestureDetectorContainer::iterator iter = mGestureDetectors.begin(), endIter = mGestureDetectors.end(); iter != endIter; ++iter )
453 PanGestureDetector* detector(*iter);
455 unsigned int minimum = detector->GetMinimumTouchesRequired();
456 if (minimum < minimumRequired)
458 minimumRequired = minimum;
461 unsigned int maximum = detector->GetMaximumTouchesRequired();
462 if (maximum > maximumRequired)
464 maximumRequired = maximum;
468 if ( (minimumRequired != mMinTouchesRequired)||(maximumRequired != mMaxTouchesRequired) )
470 mMinTouchesRequired = minimumRequired;
471 mMaxTouchesRequired = maximumRequired;
473 Integration::PanGestureRequest request;
474 request.minTouches = mMinTouchesRequired;
475 request.maxTouches = mMaxTouchesRequired;
476 mGestureManager.Update(request);
480 void PanGestureProcessor::EmitPanSignal( Dali::Actor actorHandle,
481 PanGestureDetectorContainer& gestureDetectors,
482 const Integration::PanGestureEvent& panEvent,
483 Vector2 localCurrent,
484 Gesture::State state,
485 Dali::RenderTask renderTask )
487 if ( actorHandle && !gestureDetectors.empty() )
489 Actor& actor = GetImplementation(actorHandle);
491 PanGesture pan(state);
492 pan.time = panEvent.time;
494 pan.numberOfTouches = panEvent.numberOfTouches;
495 pan.screenPosition = panEvent.currentPosition;
496 pan.position = localCurrent;
498 RenderTask& renderTaskImpl( GetImplementation( renderTask ) );
500 Vector2 localPrevious;
501 actor.ScreenToLocal( renderTaskImpl, localPrevious.x, localPrevious.y, panEvent.previousPosition.x, panEvent.previousPosition.y );
503 pan.displacement = localCurrent - localPrevious;
504 Vector2 previousPos( panEvent.previousPosition );
505 if ( state == Gesture::Started )
507 previousPos = mPossiblePanPosition;
510 pan.screenDisplacement = panEvent.currentPosition - previousPos;
512 pan.velocity.x = pan.displacement.x / panEvent.timeDelta;
513 pan.velocity.y = pan.displacement.y / panEvent.timeDelta;
515 pan.screenVelocity.x = pan.screenDisplacement.x / panEvent.timeDelta;
516 pan.screenVelocity.y = pan.screenDisplacement.y / panEvent.timeDelta;
518 // When the gesture ends, we may incorrectly get a ZERO velocity (as we have lifted our finger without any movement)
519 // so we should use the last recorded velocity instead in this scenario.
520 if ( ( state == Gesture::Finished ) && ( pan.screenVelocity == Vector2::ZERO ) &&
521 ( panEvent.timeDelta < MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY ) )
523 pan.velocity = mLastVelocity;
524 pan.screenVelocity = mLastScreenVelocity;
528 // Store the current velocity for future iterations.
529 mLastVelocity = pan.velocity;
530 mLastScreenVelocity = pan.screenVelocity;
535 // We update the scene object directly rather than sending a message.
536 // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
537 mSceneObject->AddGesture( pan );
540 for ( PanGestureDetectorContainer::iterator iter = gestureDetectors.begin(), endIter = gestureDetectors.end(); iter != endIter; ++iter )
542 (*iter)->EmitPanGestureSignal(actorHandle, pan);
547 void PanGestureProcessor::OnGesturedActorStageDisconnection()
549 mCurrentPanEmitters.clear();
552 } // namespace Internal