dali/internal/event/events/pan-gesture-processor.cpp

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali/internal/event/events/pan-gesture-processor.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <algorithm>
  23
  24 // INTERNAL INCLUDES
  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>
  35
  36 namespace Dali
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 namespace // unnamed namespace
  43 {
  44
  45 const unsigned long MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY( 50u );
  46
  47 /**
  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.
  53  */
  54 struct IsNotAttachedAndOutsideTouchesRangeFunctor
  55 {
  56   /**
  57    * Constructor
  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.
  61    */
  62   IsNotAttachedAndOutsideTouchesRangeFunctor(Actor* actor, unsigned int touches, GestureDetectorContainer& outsideRangeEmitters)
  63   : actorToCheck(actor),
  64     numberOfTouches(touches),
  65     outsideTouchesRangeEmitters(outsideRangeEmitters)
  66   {
  67   }
  68
  69   /**
  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.
  75    */
  76   bool operator()(GestureDetector* detector) const
  77   {
  78     bool remove(!detector->IsAttached(*actorToCheck));
  79
  80     if (!remove)
  81     {
  82       PanGestureDetector* panDetector( static_cast< PanGestureDetector* >( detector ) );
  83
  84       // Ensure number of touch points is within the range of our emitter. If it isn't then remove
  85       // this emitter and add it to the outsideTouchesRangeEmitters container
  86       if ( (numberOfTouches < panDetector->GetMinimumTouchesRequired()) ||
  87            (numberOfTouches > panDetector->GetMaximumTouchesRequired()) )
  88       {
  89         remove = true;
  90         outsideTouchesRangeEmitters.push_back(detector);
  91       }
  92     }
  93
  94     return remove;
  95   }
  96
  97   Actor* actorToCheck; ///< The actor to check whether it is attached or not.
  98   unsigned int numberOfTouches; ///< The number of touches in the pan event.
  99   GestureDetectorContainer& outsideTouchesRangeEmitters; ///< Emitters that are outside of the range of current pan.
 100 };
 101
 102 } // unnamed namespace
 103
 104 PanGestureProcessor::PanGestureProcessor( Stage& stage, Integration::GestureManager& gestureManager )
 105 : GestureProcessor( Gesture::Pan ),
 106   mStage( stage ),
 107   mGestureManager( gestureManager ),
 108   mGestureDetectors(),
 109   mCurrentPanEmitters(),
 110   mCurrentRenderTask(),
 111   mPossiblePanPosition(),
 112   mMinTouchesRequired( 1 ),
 113   mMaxTouchesRequired( 1 ),
 114   mCurrentPanEvent( NULL ),
 115   mSceneObject( SceneGraph::PanGesture::New() ) // Create scene object to store pan information.
 116 {
 117   // Pass ownership to scene-graph
 118   AddGestureMessage( mStage.GetUpdateManager(), mSceneObject );
 119 }
 120
 121 PanGestureProcessor::~PanGestureProcessor()
 122 {
 123   if( Stage::IsInstalled() && ( mSceneObject != NULL ) )
 124   {
 125     RemoveGestureMessage( mStage.GetUpdateManager(), mSceneObject );
 126     mSceneObject = NULL; // mSceneObject is about to be destroyed
 127   }
 128 }
 129
 130 void PanGestureProcessor::Process( const Integration::PanGestureEvent& panEvent )
 131 {
 132   switch( panEvent.state )
 133   {
 134     case Gesture::Possible:
 135     {
 136       mCurrentPanEmitters.clear();
 137       ResetActor();
 138
 139       HitTestAlgorithm::Results hitTestResults;
 140       if( HitTest( mStage, panEvent.currentPosition, hitTestResults ) )
 141       {
 142         SetActor( &GetImplementation( hitTestResults.actor ) );
 143         mPossiblePanPosition = panEvent.currentPosition;
 144       }
 145
 146       break;
 147     }
 148
 149     case Gesture::Started:
 150     {
 151       if ( GetCurrentGesturedActor() )
 152       {
 153         // The pan gesture should only be sent to the gesture detector which first received it so that
 154         // it can be told when the gesture ends as well.
 155
 156         HitTestAlgorithm::Results hitTestResults;
 157         HitTest( mStage, mPossiblePanPosition, hitTestResults ); // Hit test original possible position...
 158
 159         if ( hitTestResults.actor && ( GetCurrentGesturedActor() == &GetImplementation( hitTestResults.actor ) ) )
 160         {
 161           // Record the current render-task for Screen->Actor coordinate conversions
 162           mCurrentRenderTask = hitTestResults.renderTask;
 163
 164           // Set mCurrentPanEvent to use inside overridden methods called in ProcessAndEmit()
 165           mCurrentPanEvent = &panEvent;
 166           ProcessAndEmit( hitTestResults );
 167           mCurrentPanEvent = NULL;
 168         }
 169         else
 170         {
 171           ResetActor();
 172           mCurrentPanEmitters.clear();
 173         }
 174       }
 175       break;
 176     }
 177
 178     case Gesture::Continuing:
 179     case Gesture::Finished:
 180     case Gesture::Cancelled:
 181     {
 182       // Only send subsequent pan gesture signals if we processed the pan gesture when it started.
 183       // Check if actor is still touchable.
 184
 185       Actor* currentGesturedActor = GetCurrentGesturedActor();
 186       if ( currentGesturedActor )
 187       {
 188         if ( currentGesturedActor->IsHittable() && !mCurrentPanEmitters.empty() && mCurrentRenderTask )
 189         {
 190           GestureDetectorContainer outsideTouchesRangeEmitters;
 191
 192           // Removes emitters that no longer have the actor attached
 193           // Also remove emitters whose touches are outside the range of the current pan event and add them to outsideTouchesRangeEmitters
 194           GestureDetectorContainer::iterator endIter = std::remove_if( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(),
 195                                                                        IsNotAttachedAndOutsideTouchesRangeFunctor(currentGesturedActor, panEvent.numberOfTouches, outsideTouchesRangeEmitters) );
 196           mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
 197
 198           Vector2 actorCoords;
 199
 200           if ( !outsideTouchesRangeEmitters.empty() || !mCurrentPanEmitters.empty() )
 201           {
 202             currentGesturedActor->ScreenToLocal( GetImplementation( mCurrentRenderTask ), actorCoords.x, actorCoords.y, panEvent.currentPosition.x, panEvent.currentPosition.y );
 203
 204             // EmitPanSignal checks whether we have a valid actor and whether the container we are passing in has emitters before it emits the pan.
 205             EmitPanSignal( currentGesturedActor, outsideTouchesRangeEmitters, panEvent, actorCoords, Gesture::Finished, mCurrentRenderTask);
 206             EmitPanSignal( currentGesturedActor, mCurrentPanEmitters, panEvent, actorCoords, panEvent.state, mCurrentRenderTask);
 207           }
 208
 209           if ( mCurrentPanEmitters.empty() )
 210           {
 211             // If we have no emitters attached then clear pan actor as well.
 212             ResetActor();
 213           }
 214
 215           // Clear current gesture detectors if pan gesture has ended or been cancelled.
 216           if ( ( panEvent.state == Gesture::Finished ) || ( panEvent.state == Gesture::Cancelled ) )
 217           {
 218             mCurrentPanEmitters.clear();
 219             ResetActor();
 220           }
 221         }
 222         else
 223         {
 224           mCurrentPanEmitters.clear();
 225           ResetActor();
 226         }
 227       }
 228       break;
 229     }
 230
 231     case Gesture::Clear:
 232     {
 233       DALI_ABORT( "Incorrect state received from Integration layer: Clear\n" );
 234       break;
 235     }
 236   }
 237 }
 238
 239 void PanGestureProcessor::AddGestureDetector( PanGestureDetector* gestureDetector )
 240 {
 241   bool firstRegistration(mGestureDetectors.empty());
 242
 243   mGestureDetectors.push_back(gestureDetector);
 244
 245   // Set the pan scene object on the gesture detector
 246   gestureDetector->SetSceneObject( mSceneObject );
 247
 248   if (firstRegistration)
 249   {
 250     mMinTouchesRequired = gestureDetector->GetMinimumTouchesRequired();
 251     mMaxTouchesRequired = gestureDetector->GetMaximumTouchesRequired();
 252
 253     Integration::PanGestureRequest request;
 254     request.minTouches = mMinTouchesRequired;
 255     request.maxTouches = mMaxTouchesRequired;
 256     mGestureManager.Register(request);
 257   }
 258   else
 259   {
 260     UpdateDetection();
 261   }
 262 }
 263
 264 void PanGestureProcessor::RemoveGestureDetector( PanGestureDetector* gestureDetector )
 265 {
 266   if (!mCurrentPanEmitters.empty())
 267   {
 268     // Check if the removed detector was one that is currently being panned and remove it from emitters.
 269     GestureDetectorContainer::iterator endIter = std::remove( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(), gestureDetector );
 270     mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
 271
 272     // If we no longer have any emitters, then we should clear mCurrentGesturedActor as well
 273     if ( mCurrentPanEmitters.empty() )
 274     {
 275       ResetActor();
 276     }
 277   }
 278
 279   // Find the detector...
 280   PanGestureDetectorContainer::iterator endIter = std::remove( mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector );
 281   DALI_ASSERT_DEBUG( endIter != mGestureDetectors.end() );
 282
 283   // ...and remove it
 284   mGestureDetectors.erase(endIter, mGestureDetectors.end());
 285
 286   if (mGestureDetectors.empty())
 287   {
 288     Integration::GestureRequest request(Gesture::Pan);
 289     mGestureManager.Unregister(request);
 290   }
 291   else
 292   {
 293     UpdateDetection();
 294   }
 295 }
 296
 297 void PanGestureProcessor::GestureDetectorUpdated( PanGestureDetector* gestureDetector )
 298 {
 299   DALI_ASSERT_DEBUG(find(mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector) != mGestureDetectors.end());
 300
 301   UpdateDetection();
 302 }
 303
 304 void PanGestureProcessor::SetPanGestureProperties( const PanGesture& pan )
 305 {
 306   // If we are currently processing a pan gesture then just ignore
 307   if ( mCurrentPanEmitters.empty() && mSceneObject )
 308   {
 309     // We update the scene object directly rather than sending a message.
 310     // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
 311     mSceneObject->AddGesture( pan );
 312   }
 313 }
 314
 315 void PanGestureProcessor::EnableProfiling()
 316 {
 317   mSceneObject->EnableProfiling();
 318 }
 319
 320 void PanGestureProcessor::SetPredictionMode(int mode)
 321 {
 322   if( (mode < 0)
 323       || (mode >= SceneGraph::PanGesture::NUM_PREDICTION_MODES) )
 324   {
 325     mode = SceneGraph::PanGesture::DEFAULT_PREDICTION_MODE;
 326   }
 327   SceneGraph::PanGesture::PredictionMode modeEnum = static_cast<SceneGraph::PanGesture::PredictionMode>(mode);
 328   mSceneObject->SetPredictionMode(modeEnum);
 329 }
 330
 331 void PanGestureProcessor::SetPredictionAmount(unsigned int amount)
 332 {
 333   mSceneObject->SetPredictionAmount(amount);
 334 }
 335
 336 void PanGestureProcessor::SetMaximumPredictionAmount(unsigned int amount)
 337 {
 338   mSceneObject->SetMaximumPredictionAmount(amount);
 339 }
 340
 341 void PanGestureProcessor::SetMinimumPredictionAmount(unsigned int amount)
 342 {
 343   mSceneObject->SetMinimumPredictionAmount(amount);
 344 }
 345
 346 void PanGestureProcessor::SetPredictionAmountAdjustment(unsigned int amount)
 347 {
 348   mSceneObject->SetPredictionAmountAdjustment(amount);
 349 }
 350
 351 void PanGestureProcessor::SetSmoothingMode(int mode)
 352 {
 353   if( (mode < 0)
 354       || (mode >= SceneGraph::PanGesture::NUM_SMOOTHING_MODES) )
 355   {
 356     mode = SceneGraph::PanGesture::DEFAULT_SMOOTHING_MODE;
 357   }
 358   SceneGraph::PanGesture::SmoothingMode modeEnum = static_cast<SceneGraph::PanGesture::SmoothingMode>(mode);
 359   mSceneObject->SetSmoothingMode(modeEnum);
 360 }
 361
 362 void PanGestureProcessor::SetSmoothingAmount(float amount)
 363 {
 364   mSceneObject->SetSmoothingAmount(amount);
 365 }
 366
 367 void PanGestureProcessor::UpdateDetection()
 368 {
 369   DALI_ASSERT_DEBUG(!mGestureDetectors.empty());
 370
 371   unsigned int minimumRequired = UINT_MAX;
 372   unsigned int maximumRequired = 0;
 373
 374   for ( PanGestureDetectorContainer::iterator iter = mGestureDetectors.begin(), endIter = mGestureDetectors.end(); iter != endIter; ++iter )
 375   {
 376     PanGestureDetector* detector(*iter);
 377
 378     if( detector )
 379     {
 380       unsigned int minimum = detector->GetMinimumTouchesRequired();
 381       if (minimum < minimumRequired)
 382       {
 383         minimumRequired = minimum;
 384       }
 385
 386       unsigned int maximum = detector->GetMaximumTouchesRequired();
 387       if (maximum > maximumRequired)
 388       {
 389         maximumRequired = maximum;
 390       }
 391     }
 392   }
 393
 394   if ( (minimumRequired != mMinTouchesRequired)||(maximumRequired != mMaxTouchesRequired) )
 395   {
 396     mMinTouchesRequired = minimumRequired;
 397     mMaxTouchesRequired = maximumRequired;
 398
 399     Integration::PanGestureRequest request;
 400     request.minTouches = mMinTouchesRequired;
 401     request.maxTouches = mMaxTouchesRequired;
 402     mGestureManager.Update(request);
 403   }
 404 }
 405
 406 void PanGestureProcessor::EmitPanSignal( Actor* actor,
 407                                          const GestureDetectorContainer& gestureDetectors,
 408                                          const Integration::PanGestureEvent& panEvent,
 409                                          Vector2 localCurrent,
 410                                          Gesture::State state,
 411                                          Dali::RenderTask renderTask )
 412 {
 413   if ( actor && !gestureDetectors.empty() )
 414   {
 415     PanGesture pan(state);
 416     pan.time = panEvent.time;
 417
 418     pan.numberOfTouches = panEvent.numberOfTouches;
 419     pan.screenPosition = panEvent.currentPosition;
 420     pan.position = localCurrent;
 421
 422     RenderTask& renderTaskImpl( GetImplementation( renderTask ) );
 423
 424     Vector2 localPrevious;
 425     actor->ScreenToLocal( renderTaskImpl, localPrevious.x, localPrevious.y, panEvent.previousPosition.x, panEvent.previousPosition.y );
 426
 427     pan.displacement = localCurrent - localPrevious;
 428     Vector2 previousPos( panEvent.previousPosition );
 429     if ( state == Gesture::Started )
 430     {
 431       previousPos = mPossiblePanPosition;
 432     }
 433
 434     pan.screenDisplacement = panEvent.currentPosition - previousPos;
 435
 436     // Avoid dividing by 0
 437     if ( panEvent.timeDelta > 0 )
 438     {
 439       pan.velocity.x = pan.displacement.x / panEvent.timeDelta;
 440       pan.velocity.y = pan.displacement.y / panEvent.timeDelta;
 441
 442       pan.screenVelocity.x = pan.screenDisplacement.x / panEvent.timeDelta;
 443       pan.screenVelocity.y = pan.screenDisplacement.y / panEvent.timeDelta;
 444     }
 445
 446     // When the gesture ends, we may incorrectly get a ZERO velocity (as we have lifted our finger without any movement)
 447     // so we should use the last recorded velocity instead in this scenario.
 448     if ( ( state == Gesture::Finished ) && ( pan.screenVelocity == Vector2::ZERO ) &&
 449          ( panEvent.timeDelta < MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY ) )
 450     {
 451       pan.velocity = mLastVelocity;
 452       pan.screenVelocity = mLastScreenVelocity;
 453     }
 454     else
 455     {
 456       // Store the current velocity for future iterations.
 457       mLastVelocity = pan.velocity;
 458       mLastScreenVelocity = pan.screenVelocity;
 459     }
 460
 461     if ( mSceneObject )
 462     {
 463       // We update the scene object directly rather than sending a message.
 464       // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
 465       mSceneObject->AddGesture( pan );
 466     }
 467
 468     Dali::Actor actorHandle( actor );
 469     const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
 470     for ( GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter )
 471     {
 472       static_cast< PanGestureDetector* >( *iter )->EmitPanGestureSignal( actorHandle, pan );
 473     }
 474   }
 475 }
 476
 477 void PanGestureProcessor::OnGesturedActorStageDisconnection()
 478 {
 479   mCurrentPanEmitters.clear();
 480 }
 481
 482 bool PanGestureProcessor::CheckGestureDetector( GestureDetector* detector, Actor* actor )
 483 {
 484   DALI_ASSERT_DEBUG( mCurrentPanEvent );
 485
 486   bool retVal( false );
 487   PanGestureDetector* panDetector( static_cast< PanGestureDetector* >( detector ) );
 488
 489   if ( ( mCurrentPanEvent->numberOfTouches >= panDetector->GetMinimumTouchesRequired() ) &&
 490        ( mCurrentPanEvent->numberOfTouches <= panDetector->GetMaximumTouchesRequired() ) )
 491   {
 492     // Check if the detector requires directional panning.
 493     if ( panDetector->RequiresDirectionalPan() && mCurrentRenderTask )
 494     {
 495       // It does, calculate the angle of the pan in local actor coordinates and ensures it fits
 496       // the detector's criteria.
 497       RenderTask& renderTaskImpl( GetImplementation( mCurrentRenderTask ) );
 498
 499       Vector2 startPosition, currentPosition;
 500       actor->ScreenToLocal( renderTaskImpl, startPosition.x,   startPosition.y,   mPossiblePanPosition.x,              mPossiblePanPosition.y );
 501       actor->ScreenToLocal( renderTaskImpl, currentPosition.x, currentPosition.y, mCurrentPanEvent->currentPosition.x, mCurrentPanEvent->currentPosition.y );
 502       Vector2 displacement( currentPosition - startPosition );
 503
 504       Radian angle( atan( displacement.y / displacement.x ) );
 505
 506       /////////////////////////////
 507       //            |            //
 508       //            |            //
 509       //   Q3 (-,-) | Q4 (+,-)   //
 510       //            |            //
 511       //    ----------------- +x //
 512       //            |            //
 513       //   Q2 (-,+) | Q1 (+,+)   //
 514       //            |            //
 515       //            |            //
 516       //           +y            //
 517       /////////////////////////////
 518       // Quadrant 1: As is
 519       // Quadrant 2: 180 degrees + angle
 520       // Quadrant 3: angle - 180 degrees
 521       // Quadrant 4: As is
 522       /////////////////////////////
 523
 524       if ( displacement.x < 0.0f )
 525       {
 526         if ( displacement.y >= 0.0f )
 527         {
 528           // Quadrant 2
 529           angle.radian += Math::PI;
 530         }
 531         else
 532         {
 533           // Quadrant 3
 534           angle.radian -= Math::PI;
 535         }
 536       }
 537
 538       if ( panDetector->CheckAngleAllowed( angle ) )
 539       {
 540         retVal = true;
 541       }
 542     }
 543     else
 544     {
 545       // Directional panning not required so we can use this actor and gesture detector.
 546       retVal = true;
 547     }
 548   }
 549   return retVal;
 550 }
 551
 552 void PanGestureProcessor::EmitGestureSignal( Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates )
 553 {
 554   DALI_ASSERT_DEBUG ( mCurrentPanEvent );
 555
 556   mCurrentPanEmitters.clear();
 557   ResetActor();
 558
 559   actor->ScreenToLocal( GetImplementation(mCurrentRenderTask), actorCoordinates.x, actorCoordinates.y, mCurrentPanEvent->currentPosition.x, mCurrentPanEvent->currentPosition.y );
 560
 561   EmitPanSignal( actor, gestureDetectors, *mCurrentPanEvent, actorCoordinates, mCurrentPanEvent->state, mCurrentRenderTask );
 562
 563   if ( actor->OnStage() )
 564   {
 565     mCurrentPanEmitters = gestureDetectors;
 566     SetActor( actor );
 567   }
 568 }
 569
 570 } // namespace Internal
 571
 572 } // namespace Dali