dali-toolkit/internal/controls/scrollable/scroll-view/scroll-view-impl.cpp

   1 /*
   2  * Copyright (c) 2015 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-toolkit/internal/controls/scrollable/scroll-view/scroll-view-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <cstring> // for strcmp
  23 #include <dali/public-api/animation/constraints.h>
  24 #include <dali/public-api/common/stage.h>
  25 #include <dali/public-api/events/wheel-event.h>
  26 #include <dali/public-api/events/touch-event.h>
  27 #include <dali/public-api/object/type-registry.h>
  28 #include <dali/devel-api/object/type-registry-helper.h>
  29 #include <dali/integration-api/debug.h>
  30
  31 // INTERNAL INCLUDES
  32 #include <dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h>
  33 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h>
  34 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h>
  35 #include <dali-toolkit/internal/controls/scrollable/scroll-view/scroll-overshoot-indicator-impl.h>
  36 #include <dali-toolkit/internal/controls/scrollable/scroll-view/scroll-view-effect-impl.h>
  37
  38 //#define ENABLED_SCROLL_STATE_LOGGING
  39
  40 #ifdef ENABLED_SCROLL_STATE_LOGGING
  41 #define DALI_LOG_SCROLL_STATE(format, args...) Dali::Integration::Log::LogMessage(Dali::Integration::Log::DebugInfo, "%s:%d " format "\n", __PRETTY_FUNCTION__, __LINE__, ## args)
  42 #else
  43 #define DALI_LOG_SCROLL_STATE(format, args...)
  44 #endif
  45
  46 // TODO: Change to two class system:
  47 // 1. DraggableActor (is an actor which can be dragged anywhere, can be set to range using the ruler)
  48 // 2. ScrollView (contains a draggable actor that can a) be dragged in the negative X, and Y domain, b) has a hitArea for touches)
  49 // TODO: external components (page and status overlays).
  50 // TODO: Orientation.
  51 // TODO: upgrade Vector2/3 to support returning Unit vectors, normals, & cross product (dot product is already provided)
  52
  53 using namespace Dali;
  54
  55 namespace
  56 {
  57 const float DEFAULT_SLOW_SNAP_ANIMATION_DURATION(0.5f);             ///< Default Drag-Release animation time.
  58 const float DEFAULT_FAST_SNAP_ANIMATION_DURATION(0.25f);            ///< Default Drag-Flick animation time.
  59 const float DEFAULT_SNAP_OVERSHOOT_DURATION(0.5f);                  ///< Default Overshoot snapping animation time.
  60 const float DEFAULT_MAX_OVERSHOOT(100.0f);                          ///< Default maximum allowed overshoot in pixels
  61
  62 const float DEFAULT_AXIS_AUTO_LOCK_GRADIENT(0.36f);                 ///< Default Axis-AutoLock gradient threshold. default is 0.36:1 (20 degrees)
  63 const float DEFAULT_FRICTION_COEFFICIENT(1.0f);                     ///< Default Friction Co-efficient. (in stage diagonals per second)
  64 const float DEFAULT_FLICK_SPEED_COEFFICIENT(1.0f);                  ///< Default Flick speed coefficient (multiples input touch velocity)
  65 const float DEFAULT_MAX_FLICK_SPEED(3.0f);                          ///< Default Maximum flick speed. (in stage diagonals per second)
  66
  67 const Vector2 DEFAULT_MIN_FLICK_DISTANCE(30.0f, 30.0f);              ///< minimum distance for pan before flick allowed
  68 const float DEFAULT_MIN_FLICK_SPEED_THRESHOLD(500.0f);              ///< Minimum pan speed required for flick in pixels/s
  69 const float FREE_FLICK_SPEED_THRESHOLD = 200.0f;                    ///< Free-Flick threshold in pixels/ms
  70 const float AUTOLOCK_AXIS_MINIMUM_DISTANCE2 = 100.0f;               ///< Auto-lock axis after minimum distance squared.
  71 const float FLICK_ORTHO_ANGLE_RANGE = 75.0f;                        ///< degrees. (if >45, then supports diagonal flicking)
  72 const Vector2 DEFAULT_WHEEL_SCROLL_DISTANCE_STEP_PROPORTION = Vector2(0.17f, 0.1f); ///< The step of horizontal scroll distance in the proportion of stage size for each wheel event received.
  73 const unsigned long MINIMUM_TIME_BETWEEN_DOWN_AND_UP_FOR_RESET( 150u );
  74 const float TOUCH_DOWN_TIMER_INTERVAL = 100.0f;
  75 const float DEFAULT_SCROLL_UPDATE_DISTANCE( 30.0f );                ///< Default distance to travel in pixels for scroll update signal
  76
  77 const std::string INTERNAL_MAX_POSITION_PROPERTY_NAME( "internalMaxPosition" );
  78
  79 // Helpers ////////////////////////////////////////////////////////////////////////////////////////
  80
  81 /**
  82  * Find the vector (distance) from (a) to (b)
  83  * in domain (start) to (end)
  84  * (\ / start)               (\ / end)
  85  *   |-a                 b<----|
  86  *
  87  * @note assumes both (a) and (b) are already with the domain
  88  * (start) to (end)
  89  *
  90  * @param[in] a the current point
  91  * @param[in] b the target point
  92  * @param[in] start the start of the domain
  93  * @param[in] end the end of the domain
  94  * @param[in] bias whether to only take the right direction or the left direction,
  95  * or the shortest direction.
  96  * @return the shortest direction and distance
  97  */
  98 float VectorInDomain(float a, float b, float start, float end, Dali::Toolkit::DirectionBias bias)
  99 {
 100   if(bias == Dali::Toolkit::DirectionBiasNone)
 101   {
 102     return ShortestDistanceInDomain( a, b, start, end );
 103   }
 104   //  (a-start + end-b)
 105   float size = end-start;
 106   float vect = b-a;
 107
 108   if(vect > 0)
 109   {
 110     // +ve vector
 111     if(bias == Dali::Toolkit::DirectionBiasRight) // going right, take the vector.
 112     {
 113       return vect;
 114     }
 115     else
 116     {
 117       float aRight = a+size;
 118       return b-aRight;
 119     }
 120   }
 121   else
 122   {
 123     // -ve vector
 124     if(bias == Dali::Toolkit::DirectionBiasLeft) // going left, take the vector.
 125     {
 126       return vect;
 127     }
 128     else
 129     {
 130       float aLeft = a-size;
 131       return b-aLeft;
 132     }
 133   }
 134 }
 135
 136 /**
 137  * Returns the position of the anchor within actor
 138  *
 139  * @param actor The Actor
 140  * @param anchor The Anchor point of interest.
 141  * @return The position of the Anchor
 142  */
 143 Vector3 GetPositionOfAnchor(Actor &actor, const Vector3 &anchor)
 144 {
 145   Vector3 childPosition = actor.GetCurrentPosition();
 146   Vector3 childAnchor = - actor.GetCurrentAnchorPoint() + anchor;
 147   Vector3 childSize = actor.GetCurrentSize();
 148
 149   return childPosition + childAnchor * childSize;
 150 }
 151
 152 // AlphaFunctions /////////////////////////////////////////////////////////////////////////////////
 153
 154 float FinalDefaultAlphaFunction(float offset)
 155 {
 156   return offset * 0.5f;
 157 }
 158
 159 /**
 160  * ConstantDecelerationAlphaFunction
 161  * Newtoninan distance for constant deceleration
 162  * v = 1 - t, s = t - 1/2 t^2
 163  * when t = 0, s = 0.0 (min distance)
 164  * when t = 1, s = 0.5 (max distance)
 165  * progress = s / (max-min) = 2t - t^2
 166  *
 167  * @param[in] offset The input progress
 168  * @return The output progress
 169  */
 170 float ConstantDecelerationAlphaFunction(float progress)
 171 {
 172   return progress * 2.0f - progress * progress;
 173 }
 174
 175 // Internal Constraints ///////////////////////////////////////////////////////////////////////////
 176
 177 /**
 178  * Internal Relative position Constraint
 179  * Generates the relative position value of the scroll view
 180  * based on the absolute position, and it's relation to the
 181  * scroll domain. This is a value from 0.0f to 1.0f in each
 182  * scroll position axis.
 183  */
 184 void InternalRelativePositionConstraint( Vector2& relativePosition, const PropertyInputContainer& inputs)
 185 {
 186   Vector2 position = -inputs[0]->GetVector2();
 187   const Vector2& min = inputs[1]->GetVector2();
 188   const Vector2& max = inputs[2]->GetVector2();
 189   const Vector3& size = inputs[3]->GetVector3();
 190
 191   position.x = WrapInDomain(position.x, min.x, max.x);
 192   position.y = WrapInDomain(position.y, min.y, max.y);
 193
 194   Vector2 domainSize = (max - min) - size.GetVectorXY();
 195
 196   relativePosition.x = domainSize.x > Math::MACHINE_EPSILON_1 ? fabsf((position.x - min.x) / domainSize.x) : 0.0f;
 197   relativePosition.y = domainSize.y > Math::MACHINE_EPSILON_1 ? fabsf((position.y - min.y) / domainSize.y) : 0.0f;
 198 }
 199
 200 /**
 201  * Internal scroll domain Constraint
 202  * Generates the scroll domain of the scroll view.
 203  */
 204 void InternalScrollDomainConstraint( Vector2& scrollDomain, const PropertyInputContainer& inputs)
 205 {
 206   const Vector2& min = inputs[0]->GetVector2();
 207   const Vector2& max = inputs[1]->GetVector2();
 208   const Vector3& size = inputs[2]->GetVector3();
 209
 210   scrollDomain = (max - min) - size.GetVectorXY();
 211 }
 212
 213 /**
 214  * Internal maximum scroll position Constraint
 215  * Generates the maximum scroll position of the scroll view.
 216  */
 217 void InternalPrePositionMaxConstraint( Vector2& scrollMax, const PropertyInputContainer& inputs)
 218 {
 219   const Vector2& max = inputs[0]->GetVector2();
 220   const Vector3& size = inputs[1]->GetVector3();
 221
 222   scrollMax = max - size.GetVectorXY();
 223 }
 224
 225 } // unnamed namespace
 226
 227 namespace Dali
 228 {
 229
 230 namespace Toolkit
 231 {
 232
 233 namespace Internal
 234 {
 235
 236 namespace
 237 {
 238
 239 BaseHandle Create()
 240 {
 241   return Toolkit::ScrollView::New();
 242 }
 243
 244 // Setup properties, signals and actions using the type-registry.
 245 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ScrollView, Toolkit::Scrollable, Create )
 246
 247 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollView, "wrapEnabled",                BOOLEAN,   WRAP_ENABLED                )
 248 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollView, "panningEnabled",             BOOLEAN,   PANNING_ENABLED             )
 249 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollView, "axisAutoLockEnabled",        BOOLEAN,   AXIS_AUTO_LOCK_ENABLED      )
 250 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollView, "wheelScrollDistanceStep",    VECTOR2,   WHEEL_SCROLL_DISTANCE_STEP  )
 251
 252 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "scrollPosition",  VECTOR2, SCROLL_POSITION)
 253 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "scrollPrePosition",   VECTOR2, SCROLL_PRE_POSITION)
 254 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, ScrollView, "scrollPrePositionX",    SCROLL_PRE_POSITION_X, SCROLL_PRE_POSITION, 0)
 255 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, ScrollView, "scrollPrePositionY",    SCROLL_PRE_POSITION_Y, SCROLL_PRE_POSITION, 1)
 256 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "scrollPrePositionMax",    VECTOR2, SCROLL_PRE_POSITION_MAX)
 257 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, ScrollView, "scrollPrePositionMaxX",     SCROLL_PRE_POSITION_MAX_X, SCROLL_PRE_POSITION_MAX, 0)
 258 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, ScrollView, "scrollPrePositionMaxY",     SCROLL_PRE_POSITION_MAX_Y, SCROLL_PRE_POSITION_MAX, 1)
 259 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "overshootX",  FLOAT, OVERSHOOT_X)
 260 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "overshootY",  FLOAT, OVERSHOOT_Y)
 261 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "scrollFinal",  VECTOR2, SCROLL_FINAL)
 262 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, ScrollView, "scrollFinalX",   SCROLL_FINAL_X, SCROLL_FINAL,0)
 263 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, ScrollView, "scrollFinalY",   SCROLL_FINAL_Y, SCROLL_FINAL,1)
 264 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "wrap", BOOLEAN, WRAP)
 265 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "panning", BOOLEAN, PANNING)
 266 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "scrolling", BOOLEAN, SCROLLING)
 267 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "scrollDomainSize",   VECTOR2, SCROLL_DOMAIN_SIZE)
 268 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, ScrollView, "scrollDomainSizeX",    SCROLL_DOMAIN_SIZE_X, SCROLL_DOMAIN_SIZE, 0)
 269 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, ScrollView, "scrollDomainSizeY",    SCROLL_DOMAIN_SIZE_Y, SCROLL_DOMAIN_SIZE, 1)
 270 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "scrollDomainOffset",   VECTOR2, SCROLL_DOMAIN_OFFSET)
 271 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "scrollPositionDelta",   VECTOR2, SCROLL_POSITION_DELTA)
 272 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, ScrollView, "startPagePosition",   VECTOR3, START_PAGE_POSITION)
 273
 274 DALI_SIGNAL_REGISTRATION( Toolkit, ScrollView, "valueChanged",  SIGNAL_SNAP_STARTED )
 275
 276 DALI_TYPE_REGISTRATION_END()
 277
 278 /**
 279  * Returns whether to lock scrolling to a particular axis
 280  *
 281  * @param[in] panDelta Distance panned since gesture started
 282  * @param[in] currentLockAxis The current lock axis value
 283  * @param[in] lockGradient How quickly to lock to a particular axis
 284  *
 285  * @return The new axis lock state
 286  */
 287 ScrollView::LockAxis GetLockAxis(const Vector2& panDelta, ScrollView::LockAxis currentLockAxis, float lockGradient)
 288 {
 289   if(panDelta.LengthSquared() > AUTOLOCK_AXIS_MINIMUM_DISTANCE2 &&
 290       currentLockAxis == ScrollView::LockPossible)
 291   {
 292     float dx = fabsf(panDelta.x);
 293     float dy = fabsf(panDelta.y);
 294     if(dx * lockGradient >= dy)
 295     {
 296       // 0.36:1 gradient to the horizontal (deviate < 20 degrees)
 297       currentLockAxis = ScrollView::LockVertical;
 298     }
 299     else if(dy * lockGradient > dx)
 300     {
 301       // 0.36:1 gradient to the vertical (deviate < 20 degrees)
 302       currentLockAxis = ScrollView::LockHorizontal;
 303     }
 304     else
 305     {
 306       currentLockAxis = ScrollView::LockNone;
 307     }
 308   }
 309   return currentLockAxis;
 310 }
 311
 312 /**
 313  * Internal Pre-Position Property Constraint.
 314  *
 315  * Generates position property based on current position + gesture displacement.
 316  * Or generates position property based on positionX/Y.
 317  * Note: This is the position prior to any clamping at scroll boundaries.
 318  */
 319 struct InternalPrePositionConstraint
 320 {
 321   InternalPrePositionConstraint( const Vector2& initialPanPosition,
 322                                  const Vector2& initialPanMask,
 323                                  bool axisAutoLock,
 324                                  float axisAutoLockGradient,
 325                                  ScrollView::LockAxis initialLockAxis,
 326                                  const Vector2& maxOvershoot,
 327                                  const RulerPtr& rulerX, const RulerPtr& rulerY )
 328   : mLocalStart( initialPanPosition ),
 329     mInitialPanMask( initialPanMask ),
 330     mMaxOvershoot( maxOvershoot ),
 331     mAxisAutoLockGradient( axisAutoLockGradient ),
 332     mLockAxis( initialLockAxis ),
 333     mAxisAutoLock( axisAutoLock ),
 334     mWasPanning( false )
 335   {
 336     const RulerDomain& rulerDomainX = rulerX->GetDomain();
 337     const RulerDomain& rulerDomainY = rulerY->GetDomain();
 338     mDomainMin = Vector2( rulerDomainX.min, -rulerDomainY.min );
 339     mDomainMax = Vector2( -rulerDomainX.max, -rulerDomainY.max );
 340     mClampX = rulerDomainX.enabled;
 341     mClampY = rulerDomainY.enabled;
 342     mFixedRulerX = rulerX->GetType() == Ruler::Fixed;
 343     mFixedRulerY = rulerY->GetType() == Ruler::Fixed;
 344   }
 345
 346   void operator()( Vector2& scrollPostPosition, const PropertyInputContainer& inputs )
 347   {
 348     const Vector2& panPosition = inputs[0]->GetVector2();
 349     const bool& inGesture = inputs[1]->GetBoolean();
 350
 351     // First check if we are within a gesture.
 352     // The ScrollView may have received a start gesture from ::OnPan()
 353     // while the finish gesture is received now in this constraint.
 354     // This gesture must then be rejected as the value will be "old".
 355     // Typically the last value from the end of the last gesture.
 356     // If we are rejecting the gesture, we simply don't modify the constraint target.
 357     if( inGesture )
 358     {
 359       if( !mWasPanning )
 360       {
 361         mPrePosition = scrollPostPosition;
 362         mStartPosition = mPrePosition;
 363         mCurrentPanMask = mInitialPanMask;
 364         mWasPanning = true;
 365       }
 366
 367       // Calculate Deltas...
 368       const Vector2& currentPosition = panPosition;
 369       Vector2 panDelta( currentPosition - mLocalStart );
 370
 371       // Axis Auto Lock - locks the panning to the horizontal or vertical axis if the pan
 372       // appears mostly horizontal or mostly vertical respectively...
 373       if( mAxisAutoLock )
 374       {
 375         mLockAxis = GetLockAxis( panDelta, mLockAxis, mAxisAutoLockGradient );
 376         if( mLockAxis == ScrollView::LockVertical )
 377         {
 378           mCurrentPanMask.y = 0.0f;
 379         }
 380         else if( mLockAxis == ScrollView::LockHorizontal )
 381         {
 382           mCurrentPanMask.x = 0.0f;
 383         }
 384       }
 385
 386       // Restrict deltas based on ruler enable/disable and axis-lock state...
 387       panDelta *= mCurrentPanMask;
 388
 389       // Perform Position transform based on input deltas...
 390       scrollPostPosition = mPrePosition;
 391       scrollPostPosition += panDelta;
 392
 393       // if no wrapping then clamp preposition to maximum overshoot amount
 394       const Vector3& size = inputs[2]->GetVector3();
 395       if( mClampX )
 396       {
 397         float newXPosition = Clamp( scrollPostPosition.x, ( mDomainMax.x + size.x ) - mMaxOvershoot.x, mDomainMin.x + mMaxOvershoot.x );
 398         if( (newXPosition < scrollPostPosition.x - Math::MACHINE_EPSILON_1)
 399           || (newXPosition > scrollPostPosition.x + Math::MACHINE_EPSILON_1) )
 400         {
 401           mPrePosition.x = newXPosition;
 402           mLocalStart.x = panPosition.x;
 403         }
 404         scrollPostPosition.x = newXPosition;
 405       }
 406       if( mClampY )
 407       {
 408         float newYPosition = Clamp( scrollPostPosition.y, ( mDomainMax.y + size.y ) - mMaxOvershoot.y, mDomainMin.y + mMaxOvershoot.y );
 409         if( ( newYPosition < scrollPostPosition.y - Math::MACHINE_EPSILON_1 )
 410           || ( newYPosition > scrollPostPosition.y + Math::MACHINE_EPSILON_1 ) )
 411         {
 412           mPrePosition.y = newYPosition;
 413           mLocalStart.y = panPosition.y;
 414         }
 415         scrollPostPosition.y = newYPosition;
 416       }
 417
 418       // If we are using a fixed ruler in a particular axis, limit the maximum pages scrolled on that axis.
 419       if( mFixedRulerX || mFixedRulerY )
 420       {
 421         // Here we limit the maximum amount that can be moved from the starting position of the gesture to one page.
 422         // We do this only if we have a fixed ruler (on that axis) and the mode is enabled.
 423         // Note: 1.0f is subtracted to keep the value within one page size (otherwise we stray on to the page after).
 424         // Note: A further 1.0f is subtracted to handle a compensation that happens later within the flick handling code in SnapWithVelocity().
 425         //       When a flick is completed, an adjustment of 1.0f is sometimes made to allow for the scenario where:
 426         //       A flick finishes before the update thread has advanced the scroll position past the previous snap point.
 427         Vector2 pageSizeLimit( size.x - ( 1.0f + 1.0f ), size.y - ( 1.0f - 1.0f ) );
 428         Vector2 minPosition( mStartPosition.x - pageSizeLimit.x, mStartPosition.y - pageSizeLimit.y );
 429         Vector2 maxPosition( mStartPosition.x + pageSizeLimit.x, mStartPosition.y + pageSizeLimit.y );
 430
 431         if( mFixedRulerX )
 432         {
 433           scrollPostPosition.x = Clamp( scrollPostPosition.x, minPosition.x, maxPosition.x );
 434         }
 435         if( mFixedRulerY )
 436         {
 437           scrollPostPosition.y = Clamp( scrollPostPosition.y, minPosition.y, maxPosition.y );
 438         }
 439       }
 440     }
 441   }
 442
 443   Vector2 mPrePosition;
 444   Vector2 mLocalStart;
 445   Vector2 mStartPosition;               ///< The start position of the gesture - used to limit scroll amount (not modified by clamping).
 446   Vector2 mInitialPanMask;              ///< Initial pan mask (based on ruler settings).
 447   Vector2 mCurrentPanMask;              ///< Current pan mask that can be altered by axis lock mode.
 448   Vector2 mDomainMin;
 449   Vector2 mDomainMax;
 450   Vector2 mMaxOvershoot;
 451
 452   float mAxisAutoLockGradient;          ///< Set by ScrollView
 453   ScrollView::LockAxis mLockAxis;
 454
 455   bool mAxisAutoLock:1;                 ///< Set by ScrollView
 456   bool mWasPanning:1;
 457   bool mClampX:1;
 458   bool mClampY:1;
 459   bool mFixedRulerX:1;
 460   bool mFixedRulerY:1;
 461 };
 462
 463 /**
 464  * Internal Position Property Constraint.
 465  *
 466  * Generates position property based on pre-position
 467  * Note: This is the position after clamping.
 468  * (uses result of InternalPrePositionConstraint)
 469  */
 470 struct InternalPositionConstraint
 471 {
 472   InternalPositionConstraint(const RulerDomain& domainX, const RulerDomain& domainY, bool wrap)
 473   : mDomainMin( -domainX.min, -domainY.min ),
 474     mDomainMax( -domainX.max, -domainY.max ),
 475     mClampX( domainX.enabled ),
 476     mClampY( domainY.enabled ),
 477     mWrap( wrap )
 478   {
 479   }
 480
 481   void operator()( Vector2& position, const PropertyInputContainer& inputs )
 482   {
 483     position = inputs[0]->GetVector2();
 484     const Vector2& size = inputs[3]->GetVector3().GetVectorXY();
 485     const Vector2& min = inputs[1]->GetVector2();
 486     const Vector2& max = inputs[2]->GetVector2();
 487
 488     if( mWrap )
 489     {
 490       position.x = -WrapInDomain(-position.x, min.x, max.x);
 491       position.y = -WrapInDomain(-position.y, min.y, max.y);
 492     }
 493     else
 494     {
 495       // clamp post position to domain
 496       position.x = mClampX ? Clamp(position.x, mDomainMax.x + size.x, mDomainMin.x ) : position.x;
 497       position.y = mClampY ? Clamp(position.y, mDomainMax.y + size.y, mDomainMin.y ) : position.y;
 498     }
 499   }
 500
 501   Vector2 mDomainMin;
 502   Vector2 mDomainMax;
 503   bool mClampX;
 504   bool mClampY;
 505   bool mWrap;
 506
 507 };
 508
 509 /**
 510  * This constraint updates the X overshoot property using the difference
 511  * SCROLL_PRE_POSITION.x and SCROLL_POSITION.x, returning a relative value between 0.0f and 1.0f
 512  */
 513 struct OvershootXConstraint
 514 {
 515   OvershootXConstraint(float maxOvershoot) : mMaxOvershoot(maxOvershoot) {}
 516
 517   void operator()( float& current, const PropertyInputContainer& inputs )
 518   {
 519     if( inputs[2]->GetBoolean() )
 520     {
 521       const Vector2& scrollPrePosition = inputs[0]->GetVector2();
 522       const Vector2& scrollPostPosition = inputs[1]->GetVector2();
 523       float newOvershoot = scrollPrePosition.x - scrollPostPosition.x;
 524       current = (newOvershoot > 0.0f ? std::min(newOvershoot, mMaxOvershoot) : std::max(newOvershoot, -mMaxOvershoot)) / mMaxOvershoot;
 525     }
 526     else
 527     {
 528       current = 0.0f;
 529     }
 530   }
 531
 532   float mMaxOvershoot;
 533 };
 534
 535 /**
 536  * This constraint updates the Y overshoot property using the difference
 537  * SCROLL_PRE_POSITION.y and SCROLL_POSITION.y, returning a relative value between 0.0f and 1.0f
 538  */
 539 struct OvershootYConstraint
 540 {
 541   OvershootYConstraint(float maxOvershoot) : mMaxOvershoot(maxOvershoot) {}
 542
 543   void operator()( float& current, const PropertyInputContainer& inputs )
 544   {
 545     if( inputs[2]->GetBoolean() )
 546     {
 547       const Vector2& scrollPrePosition = inputs[0]->GetVector2();
 548       const Vector2& scrollPostPosition = inputs[1]->GetVector2();
 549       float newOvershoot = scrollPrePosition.y - scrollPostPosition.y;
 550       current = (newOvershoot > 0.0f ? std::min(newOvershoot, mMaxOvershoot) : std::max(newOvershoot, -mMaxOvershoot)) / mMaxOvershoot;
 551     }
 552     else
 553     {
 554       current = 0.0f;
 555     }
 556   }
 557
 558   float mMaxOvershoot;
 559 };
 560
 561 /**
 562  * Internal Position-Delta Property Constraint.
 563  *
 564  * Generates position-delta property based on scroll-position + scroll-offset properties.
 565  */
 566 void InternalPositionDeltaConstraint( Vector2& current, const PropertyInputContainer& inputs )
 567 {
 568   const Vector2& scrollPosition = inputs[0]->GetVector2();
 569   const Vector2& scrollOffset = inputs[1]->GetVector2();
 570
 571   current = scrollPosition + scrollOffset;
 572 }
 573
 574 /**
 575  * Internal Final Position Constraint
 576  * The position of content is:
 577  * of scroll-position + f(scroll-overshoot)
 578  * where f(...) function defines how overshoot
 579  * should affect final-position.
 580  */
 581 struct InternalFinalConstraint
 582 {
 583   InternalFinalConstraint(AlphaFunctionPrototype functionX,
 584                           AlphaFunctionPrototype functionY)
 585   : mFunctionX(functionX),
 586     mFunctionY(functionY)
 587   {
 588   }
 589
 590   void operator()( Vector2& current, const PropertyInputContainer& inputs )
 591   {
 592     const float& overshootx = inputs[1]->GetFloat();
 593     const float& overshooty = inputs[2]->GetFloat();
 594     Vector2 offset( mFunctionX(overshootx),
 595                     mFunctionY(overshooty) );
 596
 597     current = inputs[0]->GetVector2() - offset;
 598   }
 599
 600   AlphaFunctionPrototype mFunctionX;
 601   AlphaFunctionPrototype mFunctionY;
 602 };
 603
 604 }
 605
 606
 607 ///////////////////////////////////////////////////////////////////////////////////////////////////
 608 // ScrollView
 609 ///////////////////////////////////////////////////////////////////////////////////////////////////
 610
 611 Dali::Toolkit::ScrollView ScrollView::New()
 612 {
 613   // Create the implementation
 614   ScrollViewPtr scrollView(new ScrollView());
 615
 616   // Pass ownership to CustomActor via derived handle
 617   Dali::Toolkit::ScrollView handle(*scrollView);
 618
 619   // Second-phase init of the implementation
 620   // This can only be done after the CustomActor connection has been made...
 621   scrollView->Initialize();
 622
 623   return handle;
 624 }
 625
 626 ScrollView::ScrollView()
 627 : ScrollBase( ControlBehaviour( REQUIRES_WHEEL_EVENTS ) ),   // Enable size negotiation
 628   mTouchDownTime(0u),
 629   mGestureStackDepth(0),
 630   mScrollStateFlags(0),
 631   mLockAxis(LockPossible),
 632   mScrollUpdateDistance(DEFAULT_SCROLL_UPDATE_DISTANCE),
 633   mMaxOvershoot(DEFAULT_MAX_OVERSHOOT, DEFAULT_MAX_OVERSHOOT),
 634   mUserMaxOvershoot(DEFAULT_MAX_OVERSHOOT, DEFAULT_MAX_OVERSHOOT),
 635   mSnapOvershootDuration(DEFAULT_SNAP_OVERSHOOT_DURATION),
 636   mSnapOvershootAlphaFunction(AlphaFunction::EASE_OUT),
 637   mSnapDuration(DEFAULT_SLOW_SNAP_ANIMATION_DURATION),
 638   mSnapAlphaFunction(AlphaFunction::EASE_OUT),
 639   mMinFlickDistance(DEFAULT_MIN_FLICK_DISTANCE),
 640   mFlickSpeedThreshold(DEFAULT_MIN_FLICK_SPEED_THRESHOLD),
 641   mFlickDuration(DEFAULT_FAST_SNAP_ANIMATION_DURATION),
 642   mFlickAlphaFunction(AlphaFunction::EASE_OUT),
 643   mAxisAutoLockGradient(DEFAULT_AXIS_AUTO_LOCK_GRADIENT),
 644   mFrictionCoefficient(DEFAULT_FRICTION_COEFFICIENT),
 645   mFlickSpeedCoefficient(DEFAULT_FLICK_SPEED_COEFFICIENT),
 646   mMaxFlickSpeed(DEFAULT_MAX_FLICK_SPEED),
 647   mWheelScrollDistanceStep(Vector2::ZERO),
 648   mInAccessibilityPan(false),
 649   mScrolling(false),
 650   mScrollInterrupted(false),
 651   mPanning(false),
 652   mSensitive(true),
 653   mTouchDownTimeoutReached(false),
 654   mActorAutoSnapEnabled(false),
 655   mAutoResizeContainerEnabled(false),
 656   mWrapMode(false),
 657   mAxisAutoLock(false),
 658   mAlterChild(false),
 659   mDefaultMaxOvershoot(true),
 660   mCanScrollHorizontal(true),
 661   mCanScrollVertical(true)
 662 {
 663 }
 664
 665 void ScrollView::OnInitialize()
 666 {
 667   Actor self = Self();
 668
 669   // Internal Actor, used to hide actors from enumerations.
 670   // Also actors added to Internal actor appear as overlays e.g. ScrollBar components.
 671   mInternalActor = Actor::New();
 672   self.Add(mInternalActor);
 673
 674   mInternalActor.SetParentOrigin(ParentOrigin::CENTER);
 675   mInternalActor.SetAnchorPoint(AnchorPoint::CENTER);
 676   mInternalActor.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
 677
 678   mAlterChild = true;
 679
 680   mScrollPostPosition = mScrollPrePosition = Vector2::ZERO;
 681
 682   mWheelScrollDistanceStep = Stage::GetCurrent().GetSize() * DEFAULT_WHEEL_SCROLL_DISTANCE_STEP_PROPORTION;
 683
 684   mGestureStackDepth = 0;
 685
 686   EnableGestureDetection( Gesture::Type( Gesture::Pan ) );
 687
 688   // By default we'll allow the user to freely drag the scroll view,
 689   // while disabling the other rulers.
 690   RulerPtr ruler = new DefaultRuler();
 691   mRulerX = ruler;
 692   mRulerY = ruler;
 693
 694   self.SetProperty(Toolkit::Scrollable::Property::CAN_SCROLL_VERTICAL, mCanScrollVertical);
 695   self.SetProperty(Toolkit::Scrollable::Property::CAN_SCROLL_HORIZONTAL, mCanScrollHorizontal);
 696
 697   UpdatePropertyDomain();
 698   SetInternalConstraints();
 699 }
 700
 701 void ScrollView::OnStageConnection( int depth )
 702 {
 703   ScrollBase::OnStageConnection( depth );
 704
 705   DALI_LOG_SCROLL_STATE("[0x%X]", this);
 706
 707   if ( mSensitive )
 708   {
 709     SetScrollSensitive( false );
 710     SetScrollSensitive( true );
 711   }
 712   if(IsOvershootEnabled())
 713   {
 714     // try and make sure property notifications are set
 715     EnableScrollOvershoot(true);
 716   }
 717 }
 718
 719 void ScrollView::OnStageDisconnection()
 720 {
 721   DALI_LOG_SCROLL_STATE("[0x%X]", this);
 722
 723   StopAnimation();
 724
 725   ScrollBase::OnStageDisconnection();
 726 }
 727
 728 ScrollView::~ScrollView()
 729 {
 730   DALI_LOG_SCROLL_STATE("[0x%X]", this);
 731 }
 732
 733 AlphaFunction ScrollView::GetScrollSnapAlphaFunction() const
 734 {
 735   return mSnapAlphaFunction;
 736 }
 737
 738 void ScrollView::SetScrollSnapAlphaFunction(AlphaFunction alpha)
 739 {
 740   mSnapAlphaFunction = alpha;
 741 }
 742
 743 AlphaFunction ScrollView::GetScrollFlickAlphaFunction() const
 744 {
 745   return mFlickAlphaFunction;
 746 }
 747
 748 void ScrollView::SetScrollFlickAlphaFunction(AlphaFunction alpha)
 749 {
 750   mFlickAlphaFunction = alpha;
 751 }
 752
 753 float ScrollView::GetScrollSnapDuration() const
 754 {
 755   return mSnapDuration;
 756 }
 757
 758 void ScrollView::SetScrollSnapDuration(float time)
 759 {
 760   mSnapDuration = time;
 761 }
 762
 763 float ScrollView::GetScrollFlickDuration() const
 764 {
 765   return mFlickDuration;
 766 }
 767
 768 void ScrollView::SetScrollFlickDuration(float time)
 769 {
 770   mFlickDuration = time;
 771 }
 772
 773 void ScrollView::ApplyEffect(Toolkit::ScrollViewEffect effect)
 774 {
 775   Dali::Toolkit::ScrollView self = Dali::Toolkit::ScrollView::DownCast(Self());
 776
 777   // Assertion check to ensure effect doesn't already exist in this scrollview
 778   bool effectAlreadyExistsInScrollView(false);
 779   for (ScrollViewEffectIter iter = mEffects.begin(); iter != mEffects.end(); ++iter)
 780   {
 781     if(*iter==effect)
 782     {
 783       effectAlreadyExistsInScrollView = true;
 784       break;
 785     }
 786   }
 787
 788   DALI_ASSERT_ALWAYS(!effectAlreadyExistsInScrollView);
 789
 790   // add effect to effects list
 791   mEffects.push_back(effect);
 792
 793   // invoke Attachment request to ScrollView first
 794   GetImpl(effect).Attach(self);
 795 }
 796
 797 void ScrollView::RemoveEffect(Toolkit::ScrollViewEffect effect)
 798 {
 799   Dali::Toolkit::ScrollView self = Dali::Toolkit::ScrollView::DownCast(Self());
 800
 801   // remove effect from effects list
 802   bool effectExistedInScrollView(false);
 803   for (ScrollViewEffectIter iter = mEffects.begin(); iter != mEffects.end(); ++iter)
 804   {
 805     if(*iter==effect)
 806     {
 807       mEffects.erase(iter);
 808       effectExistedInScrollView = true;
 809       break;
 810     }
 811   }
 812
 813   // Assertion check to ensure effect existed.
 814   DALI_ASSERT_ALWAYS(effectExistedInScrollView);
 815
 816   // invoke Detachment request to ScrollView last
 817   GetImpl(effect).Detach(self);
 818 }
 819
 820 void ScrollView::RemoveAllEffects()
 821 {
 822   Dali::Toolkit::ScrollView self = Dali::Toolkit::ScrollView::DownCast(Self());
 823
 824   for (ScrollViewEffectIter effectIter = mEffects.begin(); effectIter != mEffects.end(); ++effectIter)
 825   {
 826     Toolkit::ScrollViewEffect effect = *effectIter;
 827
 828     // invoke Detachment request to ScrollView last
 829     GetImpl(effect).Detach(self);
 830   }
 831
 832   mEffects.clear();
 833 }
 834
 835 void ScrollView::ApplyConstraintToChildren(Constraint constraint)
 836 {
 837   ApplyConstraintToBoundActors(constraint);
 838 }
 839
 840 void ScrollView::RemoveConstraintsFromChildren()
 841 {
 842   RemoveConstraintsFromBoundActors();
 843 }
 844
 845 const RulerPtr ScrollView::GetRulerX() const
 846 {
 847   return mRulerX;
 848 }
 849
 850 const RulerPtr ScrollView::GetRulerY() const
 851 {
 852   return mRulerY;
 853 }
 854
 855 void ScrollView::SetRulerX(RulerPtr ruler)
 856 {
 857   mRulerX = ruler;
 858
 859   UpdatePropertyDomain();
 860   UpdateMainInternalConstraint();
 861 }
 862
 863 void ScrollView::SetRulerY(RulerPtr ruler)
 864 {
 865   mRulerY = ruler;
 866
 867   UpdatePropertyDomain();
 868   UpdateMainInternalConstraint();
 869 }
 870
 871 void ScrollView::UpdatePropertyDomain()
 872 {
 873   Actor self = Self();
 874   Vector3 size = self.GetTargetSize();
 875   Vector2 min = mMinScroll;
 876   Vector2 max = mMaxScroll;
 877   bool scrollPositionChanged = false;
 878   bool domainChanged = false;
 879
 880   bool canScrollVertical = false;
 881   bool canScrollHorizontal = false;
 882   UpdateLocalScrollProperties();
 883   if(mRulerX->IsEnabled())
 884   {
 885     const Toolkit::RulerDomain& rulerDomain = mRulerX->GetDomain();
 886     if( fabsf(min.x - rulerDomain.min) > Math::MACHINE_EPSILON_100
 887         || fabsf(max.x - rulerDomain.max) > Math::MACHINE_EPSILON_100 )
 888     {
 889       domainChanged = true;
 890       min.x = rulerDomain.min;
 891       max.x = rulerDomain.max;
 892
 893       // make sure new scroll value is within new domain
 894       if( mScrollPrePosition.x < min.x
 895           || mScrollPrePosition.x > max.x )
 896       {
 897         scrollPositionChanged = true;
 898         mScrollPrePosition.x = Clamp(mScrollPrePosition.x, -(max.x - size.x), -min.x);
 899       }
 900     }
 901     if( (fabsf(rulerDomain.max - rulerDomain.min) - size.x) > Math::MACHINE_EPSILON_100 )
 902     {
 903       canScrollHorizontal = true;
 904     }
 905   }
 906   else if( fabs(min.x) > Math::MACHINE_EPSILON_100
 907            || fabs(max.x) > Math::MACHINE_EPSILON_100 )
 908   {
 909     // need to reset to 0
 910     domainChanged = true;
 911     min.x = 0.0f;
 912     max.x = 0.0f;
 913     canScrollHorizontal = false;
 914   }
 915
 916   if(mRulerY->IsEnabled())
 917   {
 918     const Toolkit::RulerDomain& rulerDomain = mRulerY->GetDomain();
 919     if( fabsf(min.y - rulerDomain.min) > Math::MACHINE_EPSILON_100
 920         || fabsf(max.y - rulerDomain.max) > Math::MACHINE_EPSILON_100 )
 921     {
 922       domainChanged = true;
 923       min.y = rulerDomain.min;
 924       max.y = rulerDomain.max;
 925
 926       // make sure new scroll value is within new domain
 927       if( mScrollPrePosition.y < min.y
 928           || mScrollPrePosition.y > max.y )
 929       {
 930         scrollPositionChanged = true;
 931         mScrollPrePosition.y = Clamp(mScrollPrePosition.y, -(max.y - size.y), -min.y);
 932       }
 933     }
 934     if( (fabsf(rulerDomain.max - rulerDomain.min) - size.y) > Math::MACHINE_EPSILON_100 )
 935     {
 936       canScrollVertical = true;
 937     }
 938   }
 939   else if( fabs(min.y) > Math::MACHINE_EPSILON_100
 940            || fabs(max.y) > Math::MACHINE_EPSILON_100 )
 941   {
 942     // need to reset to 0
 943     domainChanged = true;
 944     min.y = 0.0f;
 945     max.y = 0.0f;
 946     canScrollVertical = false;
 947   }
 948
 949   // avoid setting properties if possible, otherwise this will cause an entire update as well as triggering constraints using each property we update
 950   if( mCanScrollVertical != canScrollVertical )
 951   {
 952     mCanScrollVertical = canScrollVertical;
 953     self.SetProperty(Toolkit::Scrollable::Property::CAN_SCROLL_VERTICAL, canScrollVertical);
 954   }
 955   if( mCanScrollHorizontal != canScrollHorizontal )
 956   {
 957     mCanScrollHorizontal = canScrollHorizontal;
 958     self.SetProperty(Toolkit::Scrollable::Property::CAN_SCROLL_HORIZONTAL, canScrollHorizontal);
 959   }
 960   if( scrollPositionChanged )
 961   {
 962     DALI_LOG_SCROLL_STATE("[0x%X] Domain Changed, setting SCROLL_PRE_POSITION To[%.2f, %.2f]", this, mScrollPrePosition.x, mScrollPrePosition.y );
 963     self.SetProperty(Toolkit::ScrollView::Property::SCROLL_PRE_POSITION, mScrollPrePosition);
 964   }
 965   if( domainChanged )
 966   {
 967     mMinScroll = min;
 968     mMaxScroll = max;
 969     self.SetProperty(Toolkit::Scrollable::Property::SCROLL_POSITION_MIN, mMinScroll );
 970     self.SetProperty(Toolkit::Scrollable::Property::SCROLL_POSITION_MAX, mMaxScroll );
 971   }
 972 }
 973
 974 bool ScrollView::GetScrollSensitive()
 975 {
 976   return mSensitive;
 977 }
 978
 979 void ScrollView::SetScrollSensitive(bool sensitive)
 980 {
 981   Actor self = Self();
 982   PanGestureDetector panGesture( GetPanGestureDetector() );
 983
 984   DALI_LOG_SCROLL_STATE("[0x%X] sensitive: before:[%d] setting[%d]", this, int(mSensitive), int(sensitive));
 985
 986   if((!mSensitive) && (sensitive))
 987   {
 988     mSensitive = sensitive;
 989     panGesture.Attach(self);
 990   }
 991   else if((mSensitive) && (!sensitive))
 992   {
 993     DALI_LOG_SCROLL_STATE("[0x%X] BEFORE: panning:[%d]", this, int(mPanning));
 994
 995     // while the scroll view is panning, the state needs to be reset.
 996     if ( mPanning )
 997     {
 998       PanGesture cancelGesture( Gesture::Cancelled );
 999       OnPan( cancelGesture );
1000     }
1001
1002     panGesture.Detach(self);
1003     mSensitive = sensitive;
1004
1005     mGestureStackDepth = 0;
1006     DALI_LOG_SCROLL_STATE("[0x%X] AFTER: panning:[%d]", this, int(mPanning));
1007   }
1008 }
1009
1010 void ScrollView::SetMaxOvershoot(float overshootX, float overshootY)
1011 {
1012   mMaxOvershoot.x = overshootX;
1013   mMaxOvershoot.y = overshootY;
1014   mUserMaxOvershoot = mMaxOvershoot;
1015   mDefaultMaxOvershoot = false;
1016   UpdateMainInternalConstraint();
1017 }
1018
1019 void ScrollView::SetSnapOvershootAlphaFunction(AlphaFunction alpha)
1020 {
1021   mSnapOvershootAlphaFunction = alpha;
1022 }
1023
1024 float ScrollView::GetSnapOvershootDuration()
1025 {
1026   return mSnapOvershootDuration;
1027 }
1028
1029 void ScrollView::SetSnapOvershootDuration(float duration)
1030 {
1031   mSnapOvershootDuration = duration;
1032 }
1033
1034 bool ScrollView::GetActorAutoSnap()
1035 {
1036   return mActorAutoSnapEnabled;
1037 }
1038
1039 void ScrollView::SetActorAutoSnap(bool enable)
1040 {
1041   mActorAutoSnapEnabled = enable;
1042 }
1043
1044 void ScrollView::SetAutoResize(bool enable)
1045 {
1046   mAutoResizeContainerEnabled = enable;
1047   // TODO: This needs a lot of issues to be addressed before working.
1048 }
1049
1050 bool ScrollView::GetWrapMode() const
1051 {
1052   return mWrapMode;
1053 }
1054
1055 void ScrollView::SetWrapMode(bool enable)
1056 {
1057   mWrapMode = enable;
1058   Self().SetProperty(Toolkit::ScrollView::Property::WRAP, enable);
1059 }
1060
1061 int ScrollView::GetScrollUpdateDistance() const
1062 {
1063   return mScrollUpdateDistance;
1064 }
1065
1066 void ScrollView::SetScrollUpdateDistance(int distance)
1067 {
1068   mScrollUpdateDistance = distance;
1069 }
1070
1071 bool ScrollView::GetAxisAutoLock() const
1072 {
1073   return mAxisAutoLock;
1074 }
1075
1076 void ScrollView::SetAxisAutoLock(bool enable)
1077 {
1078   mAxisAutoLock = enable;
1079   UpdateMainInternalConstraint();
1080 }
1081
1082 float ScrollView::GetAxisAutoLockGradient() const
1083 {
1084   return mAxisAutoLockGradient;
1085 }
1086
1087 void ScrollView::SetAxisAutoLockGradient(float gradient)
1088 {
1089   DALI_ASSERT_DEBUG( gradient >= 0.0f && gradient <= 1.0f );
1090   mAxisAutoLockGradient = gradient;
1091   UpdateMainInternalConstraint();
1092 }
1093
1094 float ScrollView::GetFrictionCoefficient() const
1095 {
1096   return mFrictionCoefficient;
1097 }
1098
1099 void ScrollView::SetFrictionCoefficient(float friction)
1100 {
1101   DALI_ASSERT_DEBUG( friction > 0.0f );
1102   mFrictionCoefficient = friction;
1103 }
1104
1105 float ScrollView::GetFlickSpeedCoefficient() const
1106 {
1107   return mFlickSpeedCoefficient;
1108 }
1109
1110 void ScrollView::SetFlickSpeedCoefficient(float speed)
1111 {
1112   mFlickSpeedCoefficient = speed;
1113 }
1114
1115 Vector2 ScrollView::GetMinimumDistanceForFlick() const
1116 {
1117   return mMinFlickDistance;
1118 }
1119
1120 void ScrollView::SetMinimumDistanceForFlick( const Vector2& distance )
1121 {
1122   mMinFlickDistance = distance;
1123 }
1124
1125 float ScrollView::GetMinimumSpeedForFlick() const
1126 {
1127   return mFlickSpeedThreshold;
1128 }
1129
1130 void ScrollView::SetMinimumSpeedForFlick( float speed )
1131 {
1132   mFlickSpeedThreshold = speed;
1133 }
1134
1135 float ScrollView::GetMaxFlickSpeed() const
1136 {
1137   return mMaxFlickSpeed;
1138 }
1139
1140 void ScrollView::SetMaxFlickSpeed(float speed)
1141 {
1142   mMaxFlickSpeed = speed;
1143 }
1144
1145 void ScrollView::SetWheelScrollDistanceStep(Vector2 step)
1146 {
1147   mWheelScrollDistanceStep = step;
1148 }
1149
1150 Vector2 ScrollView::GetWheelScrollDistanceStep() const
1151 {
1152   return mWheelScrollDistanceStep;
1153 }
1154
1155 unsigned int ScrollView::GetCurrentPage() const
1156 {
1157   // in case animation is currently taking place.
1158   Vector2 position = GetPropertyPosition();
1159
1160   Actor self = Self();
1161   unsigned int page = 0;
1162   unsigned int pagesPerVolume = 1;
1163   unsigned int volume = 0;
1164
1165   // if rulerX is enabled, then get page count (columns)
1166   page = mRulerX->GetPageFromPosition(-position.x, mWrapMode);
1167   volume = mRulerY->GetPageFromPosition(-position.y, mWrapMode);
1168   pagesPerVolume = mRulerX->GetTotalPages();
1169
1170   return volume * pagesPerVolume + page;
1171 }
1172
1173 Vector2 ScrollView::GetCurrentScrollPosition() const
1174 {
1175   return -GetPropertyPosition();
1176 }
1177
1178 Vector2 ScrollView::GetDomainSize() const
1179 {
1180   Vector3 size = Self().GetCurrentSize();
1181
1182   const RulerDomain& xDomain = GetRulerX()->GetDomain();
1183   const RulerDomain& yDomain = GetRulerY()->GetDomain();
1184
1185   Vector2 domainSize;
1186   domainSize.x = xDomain.max - xDomain.min - size.x;
1187   domainSize.y = yDomain.max - yDomain.min - size.y;
1188   return domainSize;
1189 }
1190
1191 void ScrollView::TransformTo(const Vector2& position,
1192                              DirectionBias horizontalBias, DirectionBias verticalBias)
1193 {
1194   TransformTo(position, mSnapDuration, mSnapAlphaFunction, horizontalBias, verticalBias);
1195 }
1196
1197 void ScrollView::TransformTo(const Vector2& position, float duration, AlphaFunction alpha,
1198                              DirectionBias horizontalBias, DirectionBias verticalBias)
1199 {
1200   // If this is called while the timer is running, then cancel it
1201   StopTouchDownTimer();
1202
1203   Actor self( Self() );
1204
1205   // Guard against destruction during signal emission
1206   // Note that Emit() methods are called indirectly e.g. from within ScrollView::AnimateTo()
1207   Toolkit::ScrollView handle( GetOwner() );
1208
1209   DALI_LOG_SCROLL_STATE("[0x%X] pos[%.2f,%.2f], duration[%.2f] bias[%d, %d]",
1210     this, position.x, position.y, duration, int(horizontalBias), int(verticalBias));
1211
1212   Vector2 currentScrollPosition = GetCurrentScrollPosition();
1213   self.SetProperty( Toolkit::ScrollView::Property::START_PAGE_POSITION, Vector3(currentScrollPosition) );
1214
1215   if( mScrolling ) // are we interrupting a current scroll?
1216   {
1217     // set mScrolling to false, in case user has code that interrogates mScrolling Getter() in complete.
1218     mScrolling = false;
1219     DALI_LOG_SCROLL_STATE("[0x%X] mScrollCompletedSignal 1 [%.2f, %.2f]", this, currentScrollPosition.x, currentScrollPosition.y);
1220     mScrollCompletedSignal.Emit( currentScrollPosition );
1221   }
1222
1223   if( mPanning ) // are we interrupting a current pan?
1224   {
1225     DALI_LOG_SCROLL_STATE("[0x%X] Interrupting Pan, set to false", this );
1226     mPanning = false;
1227     mGestureStackDepth = 0;
1228     self.SetProperty( Toolkit::ScrollView::Property::PANNING, false );
1229
1230     if( mScrollMainInternalPrePositionConstraint )
1231     {
1232       mScrollMainInternalPrePositionConstraint.Remove();
1233     }
1234   }
1235
1236   self.SetProperty(Toolkit::ScrollView::Property::SCROLLING, true);
1237   mScrolling = true;
1238
1239   DALI_LOG_SCROLL_STATE("[0x%X] mScrollStartedSignal 1 [%.2f, %.2f]", this, currentScrollPosition.x, currentScrollPosition.y);
1240   mScrollStartedSignal.Emit( currentScrollPosition );
1241   bool animating = AnimateTo(-position,
1242                              Vector2::ONE * duration,
1243                              alpha,
1244                              true,
1245                              horizontalBias,
1246                              verticalBias,
1247                              Snap);
1248
1249   if(!animating)
1250   {
1251     // if not animating, then this pan has completed right now.
1252     self.SetProperty(Toolkit::ScrollView::Property::SCROLLING, false);
1253     mScrolling = false;
1254
1255     // If we have no duration, then in the next update frame, we will be at the position specified as we just set.
1256     // In this scenario, we cannot return the currentScrollPosition as this is out-of-date and should instead return the requested final position
1257     Vector2 completedPosition( currentScrollPosition );
1258     if( duration <= Math::MACHINE_EPSILON_10 )
1259     {
1260       completedPosition = position;
1261     }
1262
1263     DALI_LOG_SCROLL_STATE("[0x%X] mScrollCompletedSignal 2 [%.2f, %.2f]", this, completedPosition.x, completedPosition.y);
1264     SetScrollUpdateNotification(false);
1265     mScrollCompletedSignal.Emit( completedPosition );
1266   }
1267 }
1268
1269 void ScrollView::ScrollTo(const Vector2& position)
1270 {
1271   ScrollTo(position, mSnapDuration );
1272 }
1273
1274 void ScrollView::ScrollTo(const Vector2& position, float duration)
1275 {
1276   ScrollTo(position, duration, DirectionBiasNone, DirectionBiasNone);
1277 }
1278
1279 void ScrollView::ScrollTo(const Vector2& position, float duration, AlphaFunction alpha)
1280 {
1281   ScrollTo(position, duration, alpha, DirectionBiasNone, DirectionBiasNone);
1282 }
1283
1284 void ScrollView::ScrollTo(const Vector2& position, float duration,
1285                           DirectionBias horizontalBias, DirectionBias verticalBias)
1286 {
1287   ScrollTo(position, duration, mSnapAlphaFunction, horizontalBias, verticalBias);
1288 }
1289
1290 void ScrollView::ScrollTo(const Vector2& position, float duration, AlphaFunction alpha,
1291                 DirectionBias horizontalBias, DirectionBias verticalBias)
1292 {
1293   DALI_LOG_SCROLL_STATE("[0x%X] position[%.2f, %.2f] duration[%.2f], bias[%d, %d]", this, position.x, position.y, duration, int(horizontalBias), int(verticalBias));
1294   TransformTo(position, duration, alpha, horizontalBias, verticalBias);
1295 }
1296
1297 void ScrollView::ScrollTo(unsigned int page)
1298 {
1299   ScrollTo(page, mSnapDuration);
1300 }
1301
1302 void ScrollView::ScrollTo(unsigned int page, float duration, DirectionBias bias)
1303 {
1304   Vector2 position;
1305   unsigned int volume;
1306   unsigned int libraries;
1307
1308   // The position to scroll to is continuous and linear
1309   // unless a domain has been enabled on the X axis.
1310   // or if WrapMode has been enabled.
1311   bool carryX = mRulerX->GetDomain().enabled | mWrapMode;
1312   bool carryY = mRulerY->GetDomain().enabled | mWrapMode;
1313
1314   position.x = mRulerX->GetPositionFromPage(page, volume, carryX);
1315   position.y = mRulerY->GetPositionFromPage(volume, libraries, carryY);
1316
1317   ScrollTo(position, duration, bias, bias);
1318 }
1319
1320 void ScrollView::ScrollTo(Actor &actor)
1321 {
1322   ScrollTo(actor, mSnapDuration);
1323 }
1324
1325 void ScrollView::ScrollTo(Actor &actor, float duration)
1326 {
1327   DALI_ASSERT_ALWAYS(actor.GetParent() == Self());
1328
1329   Actor self = Self();
1330   Vector3 size = self.GetCurrentSize();
1331   Vector3 position = actor.GetCurrentPosition();
1332   Vector2 prePosition = GetPropertyPrePosition();
1333   position.GetVectorXY() -= prePosition;
1334
1335   ScrollTo(Vector2(position.x - size.width * 0.5f, position.y - size.height * 0.5f), duration);
1336 }
1337
1338 Actor ScrollView::FindClosestActor()
1339 {
1340   Actor self = Self();
1341   Vector3 size = self.GetCurrentSize();
1342
1343   return FindClosestActorToPosition(Vector3(size.width * 0.5f,size.height * 0.5f,0.0f));
1344 }
1345
1346 Actor ScrollView::FindClosestActorToPosition(const Vector3& position, FindDirection dirX, FindDirection dirY, FindDirection dirZ)
1347 {
1348   Actor closestChild;
1349   float closestDistance2 = 0.0f;
1350   Vector3 actualPosition = position;
1351
1352   unsigned int numChildren = Self().GetChildCount();
1353
1354   for(unsigned int i = 0; i < numChildren; ++i)
1355   {
1356     Actor child = Self().GetChildAt(i);
1357
1358     if(mInternalActor == child) // ignore internal actor.
1359     {
1360       continue;
1361     }
1362
1363     Vector3 childPosition = GetPositionOfAnchor(child, AnchorPoint::CENTER);
1364
1365     Vector3 delta = childPosition - actualPosition;
1366
1367     // X-axis checking (only find Actors to the [dirX] of actualPosition)
1368     if(dirX > All) // != All,None
1369     {
1370       FindDirection deltaH = delta.x > 0 ? Right : Left;
1371       if(dirX != deltaH)
1372       {
1373         continue;
1374       }
1375     }
1376
1377     // Y-axis checking (only find Actors to the [dirY] of actualPosition)
1378     if(dirY > All) // != All,None
1379     {
1380       FindDirection deltaV = delta.y > 0 ? Down : Up;
1381       if(dirY  != deltaV)
1382       {
1383         continue;
1384       }
1385     }
1386
1387     // Z-axis checking (only find Actors to the [dirZ] of actualPosition)
1388     if(dirZ > All) // != All,None
1389     {
1390       FindDirection deltaV = delta.y > 0 ? In : Out;
1391       if(dirZ  != deltaV)
1392       {
1393         continue;
1394       }
1395     }
1396
1397     // compare child to closest child in terms of distance.
1398     float distance2 = 0.0f;
1399
1400     // distance2 = the Square of the relevant dimensions of delta
1401     if(dirX != None)
1402     {
1403       distance2 += delta.x * delta.x;
1404     }
1405
1406     if(dirY != None)
1407     {
1408       distance2 += delta.y * delta.y;
1409     }
1410
1411     if(dirZ != None)
1412     {
1413       distance2 += delta.z * delta.z;
1414     }
1415
1416     if(closestChild) // Next time.
1417     {
1418       if(distance2 < closestDistance2)
1419       {
1420         closestChild = child;
1421         closestDistance2 = distance2;
1422       }
1423     }
1424     else // First time.
1425     {
1426       closestChild = child;
1427       closestDistance2 = distance2;
1428     }
1429   }
1430
1431   return closestChild;
1432 }
1433
1434 bool ScrollView::ScrollToSnapPoint()
1435 {
1436   DALI_LOG_SCROLL_STATE("[0x%X]", this );
1437   Vector2 stationaryVelocity = Vector2(0.0f, 0.0f);
1438   return SnapWithVelocity( stationaryVelocity );
1439 }
1440
1441 // TODO: In situations where axes are different (X snap, Y free)
1442 // Each axis should really have their own independent animation (time and equation)
1443 // Consider, X axis snapping to nearest grid point (EaseOut over fixed time)
1444 // Consider, Y axis simulating physics to arrive at a point (Physics equation over variable time)
1445 // Currently, the axes have been split however, they both use the same EaseOut equation.
1446 bool ScrollView::SnapWithVelocity(Vector2 velocity)
1447 {
1448   // Animator takes over now, touches are assumed not to interfere.
1449   // And if touches do interfere, then we'll stop animation, update PrePosition
1450   // to current mScroll's properties, and then resume.
1451   // Note: For Flicking this may work a bit different...
1452
1453   float angle = atan2(velocity.y, velocity.x);
1454   float speed2 = velocity.LengthSquared();
1455   AlphaFunction alphaFunction = mSnapAlphaFunction;
1456   Vector2 positionDuration = Vector2::ONE * mSnapDuration;
1457   float biasX = 0.5f;
1458   float biasY = 0.5f;
1459   FindDirection horizontal = None;
1460   FindDirection vertical = None;
1461
1462   // orthoAngleRange = Angle tolerance within the Exact N,E,S,W direction
1463   // that will be accepted as a general N,E,S,W flick direction.
1464
1465   const float orthoAngleRange = FLICK_ORTHO_ANGLE_RANGE * M_PI / 180.0f;
1466   const float flickSpeedThreshold2 = mFlickSpeedThreshold * mFlickSpeedThreshold;
1467
1468   Vector2 positionSnap = mScrollPrePosition;
1469
1470   // Flick logic X Axis
1471
1472   if(mRulerX->IsEnabled() && mLockAxis != LockHorizontal)
1473   {
1474     horizontal = All;
1475
1476     if( speed2 > flickSpeedThreshold2 || // exceeds flick threshold
1477         mInAccessibilityPan ) // With AccessibilityPan its easier to move between snap positions
1478     {
1479       if((angle >= -orthoAngleRange) && (angle < orthoAngleRange)) // Swiping East
1480       {
1481         biasX = 0.0f, horizontal = Left;
1482
1483         // This guards against an error where no movement occurs, due to the flick finishing
1484         // before the update-thread has advanced mScrollPostPosition past the the previous snap point.
1485         positionSnap.x += 1.0f;
1486       }
1487       else if((angle >= M_PI-orthoAngleRange) || (angle < -M_PI+orthoAngleRange)) // Swiping West
1488       {
1489         biasX = 1.0f, horizontal = Right;
1490
1491         // This guards against an error where no movement occurs, due to the flick finishing
1492         // before the update-thread has advanced mScrollPostPosition past the the previous snap point.
1493         positionSnap.x -= 1.0f;
1494       }
1495     }
1496   }
1497
1498   // Flick logic Y Axis
1499
1500   if(mRulerY->IsEnabled() && mLockAxis != LockVertical)
1501   {
1502     vertical = All;
1503
1504     if( speed2 > flickSpeedThreshold2 || // exceeds flick threshold
1505         mInAccessibilityPan ) // With AccessibilityPan its easier to move between snap positions
1506     {
1507       if((angle >= M_PI_2-orthoAngleRange) && (angle < M_PI_2+orthoAngleRange)) // Swiping South
1508       {
1509         biasY = 0.0f, vertical = Up;
1510       }
1511       else if((angle >= -M_PI_2-orthoAngleRange) && (angle < -M_PI_2+orthoAngleRange)) // Swiping North
1512       {
1513         biasY = 1.0f, vertical = Down;
1514       }
1515     }
1516   }
1517
1518   // isFlick: Whether this gesture is a flick or not.
1519   bool isFlick = (horizontal != All || vertical != All);
1520   // isFreeFlick: Whether this gesture is a flick under free panning criteria.
1521   bool isFreeFlick = velocity.LengthSquared() > (FREE_FLICK_SPEED_THRESHOLD*FREE_FLICK_SPEED_THRESHOLD);
1522
1523   if(isFlick || isFreeFlick)
1524   {
1525     positionDuration = Vector2::ONE * mFlickDuration;
1526     alphaFunction = mFlickAlphaFunction;
1527   }
1528
1529   // Calculate next positionSnap ////////////////////////////////////////////////////////////
1530
1531   if(mActorAutoSnapEnabled)
1532   {
1533     Vector3 size = Self().GetCurrentSize();
1534
1535     Actor child = FindClosestActorToPosition( Vector3(size.width * 0.5f,size.height * 0.5f,0.0f), horizontal, vertical );
1536
1537     if(!child && isFlick )
1538     {
1539       // If we conducted a direction limited search and found no actor, then just snap to the closest actor.
1540       child = FindClosestActorToPosition( Vector3(size.width * 0.5f,size.height * 0.5f,0.0f) );
1541     }
1542
1543     if(child)
1544     {
1545       Vector2 position = Self().GetProperty<Vector2>(Toolkit::ScrollView::Property::SCROLL_POSITION);
1546
1547       // Get center-point of the Actor.
1548       Vector3 childPosition = GetPositionOfAnchor(child, AnchorPoint::CENTER);
1549
1550       if(mRulerX->IsEnabled())
1551       {
1552         positionSnap.x = position.x - childPosition.x + size.width * 0.5f;
1553       }
1554       if(mRulerY->IsEnabled())
1555       {
1556         positionSnap.y = position.y - childPosition.y + size.height * 0.5f;
1557       }
1558     }
1559   }
1560
1561   Vector2 startPosition = positionSnap;
1562   positionSnap.x = -mRulerX->Snap(-positionSnap.x, biasX);  // NOTE: X & Y rulers think in -ve coordinate system.
1563   positionSnap.y = -mRulerY->Snap(-positionSnap.y, biasY);  // That is scrolling RIGHT (e.g. 100.0, 0.0) means moving LEFT.
1564
1565   Vector2 clampDelta(Vector2::ZERO);
1566   ClampPosition(positionSnap);
1567
1568   if( (mRulerX->GetType() == Ruler::Free || mRulerY->GetType() == Ruler::Free)
1569       && isFreeFlick && !mActorAutoSnapEnabled)
1570   {
1571     // Calculate target position based on velocity of flick.
1572
1573     // a = Deceleration (Set to diagonal stage length * friction coefficient)
1574     // u = Initial Velocity (Flick velocity)
1575     // v = 0 (Final Velocity)
1576     // t = Time (Velocity / Deceleration)
1577     Vector2 stageSize = Stage::GetCurrent().GetSize();
1578     float stageLength = Vector3(stageSize.x, stageSize.y, 0.0f).Length();
1579     float a = (stageLength * mFrictionCoefficient);
1580     Vector3 u = Vector3(velocity.x, velocity.y, 0.0f) * mFlickSpeedCoefficient;
1581     float speed = u.Length();
1582     u/= speed;
1583
1584     // TODO: Change this to a decay function. (faster you flick, the slower it should be)
1585     speed = std::min(speed, stageLength * mMaxFlickSpeed );
1586     u*= speed;
1587     alphaFunction = ConstantDecelerationAlphaFunction;
1588
1589     float t = speed / a;
1590
1591     if(mRulerX->IsEnabled() && mRulerX->GetType() == Ruler::Free)
1592     {
1593       positionSnap.x += t*u.x*0.5f;
1594     }
1595
1596     if(mRulerY->IsEnabled() && mRulerY->GetType() == Ruler::Free)
1597     {
1598       positionSnap.y += t*u.y*0.5f;
1599     }
1600
1601     clampDelta = positionSnap;
1602     ClampPosition(positionSnap);
1603     if((positionSnap - startPosition).LengthSquared() > Math::MACHINE_EPSILON_0)
1604     {
1605       clampDelta -= positionSnap;
1606       clampDelta.x = clampDelta.x > 0.0f ? std::min(clampDelta.x, mMaxOvershoot.x) : std::max(clampDelta.x, -mMaxOvershoot.x);
1607       clampDelta.y = clampDelta.y > 0.0f ? std::min(clampDelta.y, mMaxOvershoot.y) : std::max(clampDelta.y, -mMaxOvershoot.y);
1608     }
1609     else
1610     {
1611       clampDelta = Vector2::ZERO;
1612     }
1613
1614     // If Axis is Free and has velocity, then calculate time taken
1615     // to reach target based on velocity in axis.
1616     if(mRulerX->IsEnabled() && mRulerX->GetType() == Ruler::Free)
1617     {
1618       float deltaX = fabsf(startPosition.x - positionSnap.x);
1619
1620       if(fabsf(u.x) > Math::MACHINE_EPSILON_1)
1621       {
1622         positionDuration.x = fabsf(deltaX / u.x);
1623       }
1624       else
1625       {
1626         positionDuration.x = 0;
1627       }
1628     }
1629
1630     if(mRulerY->IsEnabled() && mRulerY->GetType() == Ruler::Free)
1631     {
1632       float deltaY = fabsf(startPosition.y - positionSnap.y);
1633
1634       if(fabsf(u.y) > Math::MACHINE_EPSILON_1)
1635       {
1636         positionDuration.y = fabsf(deltaY / u.y);
1637       }
1638       else
1639       {
1640         positionDuration.y = 0;
1641       }
1642     }
1643   }
1644
1645   if(IsOvershootEnabled())
1646   {
1647     // Scroll to the end of the overshoot only when overshoot is enabled.
1648     positionSnap += clampDelta;
1649   }
1650
1651   bool animating = AnimateTo(positionSnap, positionDuration,
1652                              alphaFunction, false,
1653                              DirectionBiasNone, DirectionBiasNone,
1654                              isFlick || isFreeFlick ? Flick : Snap);
1655
1656   return animating;
1657 }
1658
1659 void ScrollView::StopAnimation(void)
1660 {
1661   // Clear Snap animation if exists.
1662   StopAnimation(mInternalXAnimation);
1663   StopAnimation(mInternalYAnimation);
1664   mScrollStateFlags = 0;
1665   // remove scroll animation flags
1666   HandleStoppedAnimation();
1667 }
1668
1669 void ScrollView::StopAnimation(Animation& animation)
1670 {
1671   if(animation)
1672   {
1673     animation.Stop();
1674     animation.Reset();
1675   }
1676 }
1677
1678 bool ScrollView::AnimateTo(const Vector2& position, const Vector2& positionDuration,
1679                            AlphaFunction alpha, bool findShortcuts,
1680                            DirectionBias horizontalBias, DirectionBias verticalBias,
1681                            SnapType snapType)
1682 {
1683   // Here we perform an animation on a number of properties (depending on which have changed)
1684   // The animation is applied to all ScrollBases
1685   Actor self = Self();
1686   mScrollTargetPosition = position;
1687   float totalDuration = 0.0f;
1688
1689   bool positionChanged = (mScrollTargetPosition != mScrollPostPosition);
1690
1691   if(positionChanged)
1692   {
1693     totalDuration = std::max(totalDuration, positionDuration.x);
1694     totalDuration = std::max(totalDuration, positionDuration.y);
1695   }
1696   else
1697   {
1698     // try to animate for a frame, on some occasions update will be changing scroll value while event side thinks it hasnt changed
1699     totalDuration = 0.01f;
1700     positionChanged = true;
1701   }
1702
1703   StopAnimation();
1704
1705   // Position Delta ///////////////////////////////////////////////////////
1706   if(positionChanged)
1707   {
1708     if(mWrapMode && findShortcuts)
1709     {
1710       // In Wrap Mode, the shortest distance is a little less intuitive...
1711       const RulerDomain rulerDomainX = mRulerX->GetDomain();
1712       const RulerDomain rulerDomainY = mRulerY->GetDomain();
1713
1714       if(mRulerX->IsEnabled())
1715       {
1716         float dir = VectorInDomain(-mScrollPrePosition.x, -mScrollTargetPosition.x, rulerDomainX.min, rulerDomainX.max, horizontalBias);
1717         mScrollTargetPosition.x = mScrollPrePosition.x + -dir;
1718       }
1719
1720       if(mRulerY->IsEnabled())
1721       {
1722         float dir = VectorInDomain(-mScrollPrePosition.y, -mScrollTargetPosition.y, rulerDomainY.min, rulerDomainY.max, verticalBias);
1723         mScrollTargetPosition.y = mScrollPrePosition.y + -dir;
1724       }
1725     }
1726
1727     // note we have two separate animations for X & Y, this deals with sliding diagonally and hitting
1728     // a horizonal/vertical wall.delay
1729     AnimateInternalXTo(mScrollTargetPosition.x, positionDuration.x, alpha);
1730     AnimateInternalYTo(mScrollTargetPosition.y, positionDuration.y, alpha);
1731
1732     if( !(mScrollStateFlags & SCROLL_ANIMATION_FLAGS) )
1733     {
1734       DALI_LOG_SCROLL_STATE("[0x%X] Setting SCROLL_PRE_POSITION To[%.2f, %.2f]", this, mScrollTargetPosition.x, mScrollTargetPosition.y );
1735       self.SetProperty(Toolkit::ScrollView::Property::SCROLL_PRE_POSITION, mScrollTargetPosition);
1736       mScrollPrePosition = mScrollTargetPosition;
1737       mScrollPostPosition = mScrollTargetPosition;
1738       WrapPosition(mScrollPostPosition);
1739     }
1740
1741     DALI_LOG_SCROLL_STATE("[0x%X] position-changed, mScrollTargetPosition[%.2f, %.2f], mScrollPrePosition[%.2f, %.2f], mScrollPostPosition[%.2f, %.2f]", this, mScrollTargetPosition.x, mScrollTargetPosition.y, mScrollPrePosition.x, mScrollPrePosition.y, mScrollPostPosition.x, mScrollPostPosition.y );
1742     DALI_LOG_SCROLL_STATE("[0x%X] SCROLL_PRE_POSITION[%.2f, %.2f], SCROLL_POSITION[%.2f, %.2f]", this, self.GetProperty( Toolkit::ScrollView::Property::SCROLL_PRE_POSITION ).Get<Vector2>().x, self.GetProperty( Toolkit::ScrollView::Property::SCROLL_PRE_POSITION ).Get<Vector2>().y, self.GetProperty( Toolkit::ScrollView::Property::SCROLL_POSITION ).Get<Vector2>().x, self.GetProperty( Toolkit::ScrollView::Property::SCROLL_POSITION ).Get<Vector2>().y );
1743   }
1744
1745   SetScrollUpdateNotification(true);
1746
1747   // Always send a snap event when AnimateTo is called.
1748   Toolkit::ScrollView::SnapEvent snapEvent;
1749   snapEvent.type = snapType;
1750   snapEvent.position = -mScrollTargetPosition;
1751   snapEvent.duration = totalDuration;
1752
1753   DALI_LOG_SCROLL_STATE("[0x%X] mSnapStartedSignal [%.2f, %.2f]", this, snapEvent.position.x, snapEvent.position.y);
1754   mSnapStartedSignal.Emit( snapEvent );
1755
1756   return (mScrollStateFlags & SCROLL_ANIMATION_FLAGS) != 0;
1757 }
1758
1759 void ScrollView::EnableScrollOvershoot(bool enable)
1760 {
1761   if (enable)
1762   {
1763     if (!mOvershootIndicator)
1764     {
1765       mOvershootIndicator = ScrollOvershootIndicator::New();
1766     }
1767
1768     mOvershootIndicator->AttachToScrollable(*this);
1769   }
1770   else
1771   {
1772     mMaxOvershoot = mUserMaxOvershoot;
1773
1774     if (mOvershootIndicator)
1775     {
1776       mOvershootIndicator->DetachFromScrollable(*this);
1777     }
1778   }
1779
1780   UpdateMainInternalConstraint();
1781 }
1782
1783 void ScrollView::AddOverlay(Actor actor)
1784 {
1785   actor.SetDrawMode( DrawMode::OVERLAY_2D );
1786   mInternalActor.Add( actor );
1787 }
1788
1789 void ScrollView::RemoveOverlay(Actor actor)
1790 {
1791   mInternalActor.Remove( actor );
1792 }
1793
1794 void ScrollView::SetOvershootEffectColor( const Vector4& color )
1795 {
1796   mOvershootEffectColor = color;
1797   if( mOvershootIndicator )
1798   {
1799     mOvershootIndicator->SetOvershootEffectColor( color );
1800   }
1801 }
1802
1803 void ScrollView::SetScrollingDirection( Radian direction, Radian threshold )
1804 {
1805   PanGestureDetector panGesture( GetPanGestureDetector() );
1806
1807   // First remove just in case we have some set, then add.
1808   panGesture.RemoveDirection( direction );
1809   panGesture.AddDirection( direction, threshold );
1810 }
1811
1812 void ScrollView::RemoveScrollingDirection( Radian direction )
1813 {
1814   PanGestureDetector panGesture( GetPanGestureDetector() );
1815   panGesture.RemoveDirection( direction );
1816 }
1817
1818 Toolkit::ScrollView::SnapStartedSignalType& ScrollView::SnapStartedSignal()
1819 {
1820   return mSnapStartedSignal;
1821 }
1822
1823 void ScrollView::FindAndUnbindActor(Actor child)
1824 {
1825   UnbindActor(child);
1826 }
1827
1828 Vector2 ScrollView::GetPropertyPrePosition() const
1829 {
1830   Vector2 position = Self().GetProperty<Vector2>(Toolkit::ScrollView::Property::SCROLL_PRE_POSITION);
1831   WrapPosition(position);
1832   return position;
1833 }
1834
1835 Vector2 ScrollView::GetPropertyPosition() const
1836 {
1837   Vector2 position = Self().GetProperty<Vector2>(Toolkit::ScrollView::Property::SCROLL_POSITION);
1838   WrapPosition(position);
1839
1840   return position;
1841 }
1842
1843 void ScrollView::HandleStoppedAnimation()
1844 {
1845   SetScrollUpdateNotification(false);
1846 }
1847
1848 void ScrollView::HandleSnapAnimationFinished()
1849 {
1850   // Emit Signal that scrolling has completed.
1851   mScrolling = false;
1852   Actor self = Self();
1853   self.SetProperty(Toolkit::ScrollView::Property::SCROLLING, false);
1854
1855   Vector2 deltaPosition(mScrollPrePosition);
1856
1857   UpdateLocalScrollProperties();
1858   WrapPosition(mScrollPrePosition);
1859   DALI_LOG_SCROLL_STATE("[0x%X] Setting SCROLL_PRE_POSITION To[%.2f, %.2f]", this, mScrollPrePosition.x, mScrollPrePosition.y );
1860   self.SetProperty(Toolkit::ScrollView::Property::SCROLL_PRE_POSITION, mScrollPrePosition);
1861
1862   Vector2 currentScrollPosition = GetCurrentScrollPosition();
1863   DALI_LOG_SCROLL_STATE("[0x%X] mScrollCompletedSignal 3 current[%.2f, %.2f], mScrollTargetPosition[%.2f, %.2f]", this, currentScrollPosition.x, currentScrollPosition.y, -mScrollTargetPosition.x, -mScrollTargetPosition.y );
1864   mScrollCompletedSignal.Emit( currentScrollPosition );
1865
1866   mDomainOffset += deltaPosition - mScrollPostPosition;
1867   self.SetProperty(Toolkit::ScrollView::Property::SCROLL_DOMAIN_OFFSET, mDomainOffset);
1868   HandleStoppedAnimation();
1869 }
1870
1871 void ScrollView::SetScrollUpdateNotification( bool enabled )
1872 {
1873   Actor self = Self();
1874   if( mScrollXUpdateNotification )
1875   {
1876     // disconnect now to avoid a notification before removed from update thread
1877     mScrollXUpdateNotification.NotifySignal().Disconnect(this, &ScrollView::OnScrollUpdateNotification);
1878     self.RemovePropertyNotification(mScrollXUpdateNotification);
1879     mScrollXUpdateNotification.Reset();
1880   }
1881   if( enabled && !mScrollUpdatedSignal.Empty())
1882   {
1883     // Only set up the notification when the application has connected to the updated signal
1884     mScrollXUpdateNotification = self.AddPropertyNotification(Toolkit::ScrollView::Property::SCROLL_POSITION, 0, StepCondition(mScrollUpdateDistance, 0.0f));
1885     mScrollXUpdateNotification.NotifySignal().Connect( this, &ScrollView::OnScrollUpdateNotification );
1886   }
1887   if( mScrollYUpdateNotification )
1888   {
1889     // disconnect now to avoid a notification before removed from update thread
1890     mScrollYUpdateNotification.NotifySignal().Disconnect(this, &ScrollView::OnScrollUpdateNotification);
1891     self.RemovePropertyNotification(mScrollYUpdateNotification);
1892     mScrollYUpdateNotification.Reset();
1893   }
1894   if( enabled && !mScrollUpdatedSignal.Empty())
1895   {
1896     // Only set up the notification when the application has connected to the updated signal
1897     mScrollYUpdateNotification = self.AddPropertyNotification(Toolkit::ScrollView::Property::SCROLL_POSITION, 1, StepCondition(mScrollUpdateDistance, 0.0f));
1898     mScrollYUpdateNotification.NotifySignal().Connect( this, &ScrollView::OnScrollUpdateNotification );
1899   }
1900 }
1901
1902 void ScrollView::OnScrollUpdateNotification(Dali::PropertyNotification& source)
1903 {
1904   // Guard against destruction during signal emission
1905   Toolkit::ScrollView handle( GetOwner() );
1906
1907   Vector2 currentScrollPosition = GetCurrentScrollPosition();
1908   mScrollUpdatedSignal.Emit( currentScrollPosition );
1909 }
1910
1911 bool ScrollView::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
1912 {
1913   Dali::BaseHandle handle( object );
1914
1915   bool connected( true );
1916   Toolkit::ScrollView view = Toolkit::ScrollView::DownCast( handle );
1917
1918   if( 0 == strcmp( signalName.c_str(), SIGNAL_SNAP_STARTED ) )
1919   {
1920     view.SnapStartedSignal().Connect( tracker, functor );
1921   }
1922   else
1923   {
1924     // signalName does not match any signal
1925     connected = false;
1926   }
1927
1928   return connected;
1929 }
1930
1931 void ScrollView::OnSizeAnimation(Animation& animation, const Vector3& targetSize)
1932 {
1933   // need to update domain properties for new size
1934   UpdatePropertyDomain();
1935 }
1936
1937 void ScrollView::OnSizeSet( const Vector3& size )
1938 {
1939   // need to update domain properties for new size
1940   if( mDefaultMaxOvershoot )
1941   {
1942     mUserMaxOvershoot.x = size.x * 0.5f;
1943     mUserMaxOvershoot.y = size.y * 0.5f;
1944     if( !IsOvershootEnabled() )
1945     {
1946       mMaxOvershoot = mUserMaxOvershoot;
1947     }
1948   }
1949   UpdatePropertyDomain();
1950   UpdateMainInternalConstraint();
1951   if( IsOvershootEnabled() )
1952   {
1953     mOvershootIndicator->Reset();
1954   }
1955 }
1956
1957 void ScrollView::OnChildAdd(Actor& child)
1958 {
1959   Dali::Toolkit::ScrollBar scrollBar = Dali::Toolkit::ScrollBar::DownCast(child);
1960   if(scrollBar)
1961   {
1962     mInternalActor.Add(scrollBar);
1963     if(scrollBar.GetScrollDirection() == Toolkit::ScrollBar::Horizontal)
1964     {
1965       scrollBar.SetScrollPropertySource(Self(),
1966                                         Toolkit::ScrollView::Property::SCROLL_PRE_POSITION_X,
1967                                         Toolkit::Scrollable::Property::SCROLL_POSITION_MIN_X,
1968                                         Toolkit::ScrollView::Property::SCROLL_PRE_POSITION_MAX_X,
1969                                         Toolkit::ScrollView::Property::SCROLL_DOMAIN_SIZE_X);
1970     }
1971     else
1972     {
1973       scrollBar.SetScrollPropertySource(Self(),
1974                                         Toolkit::ScrollView::Property::SCROLL_PRE_POSITION_Y,
1975                                         Toolkit::Scrollable::Property::SCROLL_POSITION_MIN_Y,
1976                                         Toolkit::ScrollView::Property::SCROLL_PRE_POSITION_MAX_Y,
1977                                         Toolkit::ScrollView::Property::SCROLL_DOMAIN_SIZE_Y);
1978     }
1979   }
1980   else if(mAlterChild)
1981   {
1982     BindActor(child);
1983   }
1984 }
1985
1986 void ScrollView::OnChildRemove(Actor& child)
1987 {
1988   // TODO: Actor needs a RemoveConstraint method to take out an individual constraint.
1989   UnbindActor(child);
1990 }
1991
1992 void ScrollView::StartTouchDownTimer()
1993 {
1994   if ( !mTouchDownTimer )
1995   {
1996     mTouchDownTimer = Timer::New( TOUCH_DOWN_TIMER_INTERVAL );
1997     mTouchDownTimer.TickSignal().Connect( this, &ScrollView::OnTouchDownTimeout );
1998   }
1999
2000   mTouchDownTimer.Start();
2001 }
2002
2003 void ScrollView::StopTouchDownTimer()
2004 {
2005   if ( mTouchDownTimer )
2006   {
2007     mTouchDownTimer.Stop();
2008   }
2009 }
2010
2011 bool ScrollView::OnTouchDownTimeout()
2012 {
2013   DALI_LOG_SCROLL_STATE("[0x%X]", this);
2014
2015   mTouchDownTimeoutReached = true;
2016
2017   unsigned int currentScrollStateFlags( mScrollStateFlags ); // Cleared in StopAnimation so keep local copy for comparison
2018   if( currentScrollStateFlags & (SCROLL_ANIMATION_FLAGS | SNAP_ANIMATION_FLAGS) )
2019   {
2020     DALI_LOG_SCROLL_STATE("[0x%X] Scrolling Or snapping flags set, stopping animation", this);
2021
2022     StopAnimation();
2023     if( currentScrollStateFlags & SCROLL_ANIMATION_FLAGS )
2024     {
2025       DALI_LOG_SCROLL_STATE("[0x%X] Scrolling flags set, emitting signal", this);
2026
2027       mScrollInterrupted = true;
2028       // reset domain offset as scrolling from original plane.
2029       mDomainOffset = Vector2::ZERO;
2030       Self().SetProperty(Toolkit::ScrollView::Property::SCROLL_DOMAIN_OFFSET, Vector2::ZERO);
2031
2032       UpdateLocalScrollProperties();
2033       Vector2 currentScrollPosition = GetCurrentScrollPosition();
2034       DALI_LOG_SCROLL_STATE("[0x%X] mScrollCompletedSignal 4 [%.2f, %.2f]", this, currentScrollPosition.x, currentScrollPosition.y);
2035       mScrollCompletedSignal.Emit( currentScrollPosition );
2036     }
2037   }
2038
2039   return false;
2040 }
2041
2042 bool ScrollView::OnTouchEvent(const TouchEvent& event)
2043 {
2044   if(!mSensitive)
2045   {
2046     DALI_LOG_SCROLL_STATE("[0x%X], Not Sensitive, ignoring", this);
2047
2048     // Ignore this touch event, if scrollview is insensitive.
2049     return false;
2050   }
2051
2052   // Ignore events with multiple-touch points
2053   if (event.GetPointCount() != 1)
2054   {
2055     DALI_LOG_SCROLL_STATE("[0x%X], multiple touch, ignoring", this);
2056
2057     return false;
2058   }
2059
2060   const TouchPoint::State pointState = event.GetPoint(0).state;
2061   if( pointState == TouchPoint::Down )
2062   {
2063     DALI_LOG_SCROLL_STATE("[0x%X] Down", this);
2064
2065     if(mGestureStackDepth==0)
2066     {
2067       mTouchDownTime = event.time;
2068
2069       // This allows time for a pan-gesture to start, to avoid breaking snap-animation behavior with fast flicks.
2070       // If touch-down does not become a pan (after timeout interval), then snap-animation can be interrupted.
2071       mTouchDownTimeoutReached = false;
2072       mScrollInterrupted = false;
2073       StartTouchDownTimer();
2074     }
2075   }
2076   else if( ( pointState == TouchPoint::Up ) ||
2077            ( ( pointState == TouchPoint::Interrupted ) && ( event.GetPoint(0).hitActor == Self() ) ) )
2078   {
2079     DALI_LOG_SCROLL_STATE("[0x%X] %s", this, ( ( pointState == TouchPoint::Up ) ? "Up" : "Interrupted" ) );
2080
2081     StopTouchDownTimer();
2082
2083     // if the user touches and releases without enough movement to go
2084     // into a gesture state, then we should snap to nearest point.
2085     // otherwise our scroll could be stopped (interrupted) half way through an animation.
2086     if(mGestureStackDepth==0 && mTouchDownTimeoutReached)
2087     {
2088       if( ( event.GetPoint(0).state == TouchPoint::Interrupted ) ||
2089           ( ( event.time - mTouchDownTime ) >= MINIMUM_TIME_BETWEEN_DOWN_AND_UP_FOR_RESET ) )
2090       {
2091         // Reset the velocity only if down was received a while ago
2092         mLastVelocity = Vector2( 0.0f, 0.0f );
2093       }
2094
2095       UpdateLocalScrollProperties();
2096       // Only finish the transform if scrolling was interrupted on down or if we are scrolling
2097       if ( mScrollInterrupted || mScrolling )
2098       {
2099         DALI_LOG_SCROLL_STATE("[0x%X] Calling FinishTransform", this);
2100
2101         FinishTransform();
2102       }
2103     }
2104     mTouchDownTimeoutReached = false;
2105     mScrollInterrupted = false;
2106   }
2107
2108   return true;
2109 }
2110
2111 bool ScrollView::OnWheelEvent(const WheelEvent& event)
2112 {
2113   if(!mSensitive)
2114   {
2115     // Ignore this wheel event, if scrollview is insensitive.
2116     return false;
2117   }
2118
2119   Vector2 targetScrollPosition = GetPropertyPosition();
2120
2121   if(mRulerX->IsEnabled() && !mRulerY->IsEnabled())
2122   {
2123     // If only the ruler in the X axis is enabled, scroll in the X axis.
2124     if(mRulerX->GetType() == Ruler::Free)
2125     {
2126       // Free panning mode
2127       targetScrollPosition.x += event.z * mWheelScrollDistanceStep.x;
2128       ClampPosition(targetScrollPosition);
2129       ScrollTo(-targetScrollPosition);
2130     }
2131     else if(!mScrolling)
2132     {
2133       // Snap mode, only respond to the event when the previous snap animation is finished.
2134       ScrollTo(GetCurrentPage() - event.z);
2135     }
2136   }
2137   else
2138   {
2139     // If the ruler in the Y axis is enabled, scroll in the Y axis.
2140     if(mRulerY->GetType() == Ruler::Free)
2141     {
2142       // Free panning mode
2143       targetScrollPosition.y += event.z * mWheelScrollDistanceStep.y;
2144       ClampPosition(targetScrollPosition);
2145       ScrollTo(-targetScrollPosition);
2146     }
2147     else if(!mScrolling)
2148     {
2149       // Snap mode, only respond to the event when the previous snap animation is finished.
2150       ScrollTo(GetCurrentPage() - event.z * mRulerX->GetTotalPages());
2151     }
2152   }
2153
2154   return true;
2155 }
2156
2157 void ScrollView::ResetScrolling()
2158 {
2159   Actor self = Self();
2160   self.GetProperty(Toolkit::ScrollView::Property::SCROLL_POSITION).Get(mScrollPostPosition);
2161   mScrollPrePosition = mScrollPostPosition;
2162   DALI_LOG_SCROLL_STATE("[0x%X] Setting SCROLL_PRE_POSITION To[%.2f, %.2f]", this, mScrollPostPosition.x, mScrollPostPosition.y );
2163   self.SetProperty(Toolkit::ScrollView::Property::SCROLL_PRE_POSITION, mScrollPostPosition);
2164 }
2165
2166 void ScrollView::UpdateLocalScrollProperties()
2167 {
2168   Actor self = Self();
2169   self.GetProperty(Toolkit::ScrollView::Property::SCROLL_PRE_POSITION).Get(mScrollPrePosition);
2170   self.GetProperty(Toolkit::ScrollView::Property::SCROLL_POSITION).Get(mScrollPostPosition);
2171 }
2172
2173 // private functions
2174
2175 void ScrollView::PreAnimatedScrollSetup()
2176 {
2177   // SCROLL_PRE_POSITION is our unclamped property with wrapping
2178   // SCROLL_POSITION is our final scroll position after clamping
2179
2180   Actor self = Self();
2181
2182   Vector2 deltaPosition(mScrollPostPosition);
2183   WrapPosition(mScrollPostPosition);
2184   mDomainOffset += deltaPosition - mScrollPostPosition;
2185   Self().SetProperty(Toolkit::ScrollView::Property::SCROLL_DOMAIN_OFFSET, mDomainOffset);
2186
2187   if( mScrollStateFlags & SCROLL_X_STATE_MASK )
2188   {
2189     // already performing animation on internal x position
2190     StopAnimation(mInternalXAnimation);
2191   }
2192
2193   if( mScrollStateFlags & SCROLL_Y_STATE_MASK )
2194   {
2195     // already performing animation on internal y position
2196     StopAnimation(mInternalYAnimation);
2197   }
2198
2199   mScrollStateFlags = 0;
2200
2201   // Update Actor position with this wrapped value.
2202 }
2203
2204 void ScrollView::FinaliseAnimatedScroll()
2205 {
2206   // TODO - common animation finishing code in here
2207 }
2208
2209 void ScrollView::AnimateInternalXTo( float position, float duration, AlphaFunction alpha )
2210 {
2211   StopAnimation(mInternalXAnimation);
2212
2213   if( duration > Math::MACHINE_EPSILON_10 )
2214   {
2215     Actor self = Self();
2216     DALI_LOG_SCROLL_STATE("[0x%X], Animating from[%.2f] to[%.2f]", this, self.GetProperty(Toolkit::ScrollView::Property::SCROLL_PRE_POSITION).Get<Vector2>().x, position );
2217     mInternalXAnimation = Animation::New(duration);
2218     DALI_LOG_SCROLL_STATE("[0x%X], mInternalXAnimation[0x%X]", this, mInternalXAnimation.GetObjectPtr() );
2219     mInternalXAnimation.FinishedSignal().Connect(this, &ScrollView::OnScrollAnimationFinished);
2220     mInternalXAnimation.AnimateTo( Property(self, Toolkit::ScrollView::Property::SCROLL_PRE_POSITION, 0), position, alpha, TimePeriod(duration));
2221     mInternalXAnimation.Play();
2222
2223     // erase current state flags
2224     mScrollStateFlags &= ~SCROLL_X_STATE_MASK;
2225     // add internal animation state flag
2226     mScrollStateFlags |= AnimatingInternalX;
2227   }
2228 }
2229
2230 void ScrollView::AnimateInternalYTo( float position, float duration, AlphaFunction alpha )
2231 {
2232   StopAnimation(mInternalYAnimation);
2233
2234   if( duration > Math::MACHINE_EPSILON_10 )
2235   {
2236     Actor self = Self();
2237     DALI_LOG_SCROLL_STATE("[0x%X], Animating from[%.2f] to[%.2f]", this, self.GetProperty(Toolkit::ScrollView::Property::SCROLL_PRE_POSITION).Get<Vector2>().y, position );
2238     mInternalYAnimation = Animation::New(duration);
2239     DALI_LOG_SCROLL_STATE("[0x%X], mInternalYAnimation[0x%X]", this, mInternalYAnimation.GetObjectPtr() );
2240     mInternalYAnimation.FinishedSignal().Connect(this, &ScrollView::OnScrollAnimationFinished);
2241     mInternalYAnimation.AnimateTo( Property(self, Toolkit::ScrollView::Property::SCROLL_PRE_POSITION, 1), position, alpha, TimePeriod(duration));
2242     mInternalYAnimation.Play();
2243
2244     // erase current state flags
2245     mScrollStateFlags &= ~SCROLL_Y_STATE_MASK;
2246     // add internal animation state flag
2247     mScrollStateFlags |= AnimatingInternalY;
2248   }
2249 }
2250
2251 void ScrollView::OnScrollAnimationFinished( Animation& source )
2252 {
2253   // Guard against destruction during signal emission
2254   // Note that ScrollCompletedSignal is emitted from HandleSnapAnimationFinished()
2255   Toolkit::ScrollView handle( GetOwner() );
2256
2257   bool scrollingFinished = false;
2258
2259   // update our local scroll positions
2260   UpdateLocalScrollProperties();
2261
2262   if( source == mInternalXAnimation )
2263   {
2264     DALI_LOG_SCROLL_STATE("[0x%X] mInternalXAnimation[0x%X], expected[%.2f], actual[%.2f], post[%.2f]", this, mInternalXAnimation.GetObjectPtr(), mScrollTargetPosition.x, Self().GetProperty(SCROLL_PRE_POSITION).Get<Vector2>().x, mScrollPostPosition.x );
2265
2266     if( !(mScrollStateFlags & AnimatingInternalY) )
2267     {
2268       scrollingFinished = true;
2269     }
2270     mInternalXAnimation.Reset();
2271     // wrap pre scroll x position and set it
2272     if( mWrapMode )
2273     {
2274       const RulerDomain rulerDomain = mRulerX->GetDomain();
2275       mScrollPrePosition.x = -WrapInDomain(-mScrollPrePosition.x, rulerDomain.min, rulerDomain.max);
2276       DALI_LOG_SCROLL_STATE("[0x%X] Setting SCROLL_PRE_POSITION To[%.2f, %.2f]", this, mScrollPrePosition.x, mScrollPrePosition.y );
2277       handle.SetProperty(Toolkit::ScrollView::Property::SCROLL_PRE_POSITION, mScrollPrePosition);
2278     }
2279     SnapInternalXTo(mScrollPostPosition.x);
2280   }
2281
2282   if( source == mInternalYAnimation )
2283   {
2284     DALI_LOG_SCROLL_STATE("[0x%X] mInternalYAnimation[0x%X], expected[%.2f], actual[%.2f], post[%.2f]", this, mInternalYAnimation.GetObjectPtr(), mScrollTargetPosition.y, Self().GetProperty(SCROLL_PRE_POSITION).Get<Vector2>().y, mScrollPostPosition.y );
2285
2286     if( !(mScrollStateFlags & AnimatingInternalX) )
2287     {
2288       scrollingFinished = true;
2289     }
2290     mInternalYAnimation.Reset();
2291     if( mWrapMode )
2292     {
2293       // wrap pre scroll y position and set it
2294       const RulerDomain rulerDomain = mRulerY->GetDomain();
2295       mScrollPrePosition.y = -WrapInDomain(-mScrollPrePosition.y, rulerDomain.min, rulerDomain.max);
2296       DALI_LOG_SCROLL_STATE("[0x%X] Setting SCROLL_PRE_POSITION To[%.2f, %.2f]", this, mScrollPrePosition.x, mScrollPrePosition.y );
2297       handle.SetProperty(Toolkit::ScrollView::Property::SCROLL_PRE_POSITION, mScrollPrePosition);
2298     }
2299     SnapInternalYTo(mScrollPostPosition.y);
2300   }
2301
2302   DALI_LOG_SCROLL_STATE("[0x%X] scrollingFinished[%d] Animation[0x%X]", this, scrollingFinished, source.GetObjectPtr());
2303
2304   if(scrollingFinished)
2305   {
2306     HandleSnapAnimationFinished();
2307   }
2308 }
2309
2310 void ScrollView::OnSnapInternalPositionFinished( Animation& source )
2311 {
2312   Actor self = Self();
2313   UpdateLocalScrollProperties();
2314   if( source == mInternalXAnimation )
2315   {
2316     DALI_LOG_SCROLL_STATE("[0x%X] Finished X PostPosition Animation", this );
2317
2318     // clear internal x animation flags
2319     mScrollStateFlags &= ~SCROLL_X_STATE_MASK;
2320     mInternalXAnimation.Reset();
2321     WrapPosition(mScrollPrePosition);
2322   }
2323   if( source == mInternalYAnimation )
2324   {
2325     DALI_LOG_SCROLL_STATE("[0x%X] Finished Y PostPosition Animation", this );
2326
2327     mScrollStateFlags &= ~SCROLL_Y_STATE_MASK;
2328     mInternalYAnimation.Reset();
2329     WrapPosition(mScrollPrePosition);
2330   }
2331 }
2332
2333 void ScrollView::SnapInternalXTo(float position)
2334 {
2335   Actor self = Self();
2336
2337   StopAnimation(mInternalXAnimation);
2338
2339   // erase current state flags
2340   mScrollStateFlags &= ~SCROLL_X_STATE_MASK;
2341
2342   // if internal x not equal to inputed parameter, animate it
2343   float duration = std::min(fabsf((position - mScrollPrePosition.x) / mMaxOvershoot.x) * mSnapOvershootDuration, mSnapOvershootDuration);
2344   DALI_LOG_SCROLL_STATE("[0x%X] duration[%.2f]", this, duration );
2345   if( duration > Math::MACHINE_EPSILON_1 )
2346   {
2347     DALI_LOG_SCROLL_STATE("[0x%X] Starting X Snap Animation to[%.2f]", this, position );
2348
2349     mInternalXAnimation = Animation::New(duration);
2350     mInternalXAnimation.FinishedSignal().Connect(this, &ScrollView::OnSnapInternalPositionFinished);
2351     mInternalXAnimation.AnimateTo(Property(self, Toolkit::ScrollView::Property::SCROLL_PRE_POSITION, 0), position);
2352     mInternalXAnimation.Play();
2353
2354     // add internal animation state flag
2355     mScrollStateFlags |= SnappingInternalX;
2356   }
2357 }
2358
2359 void ScrollView::SnapInternalYTo(float position)
2360 {
2361   Actor self = Self();
2362
2363   StopAnimation(mInternalYAnimation);
2364
2365   // erase current state flags
2366   mScrollStateFlags &= ~SCROLL_Y_STATE_MASK;
2367
2368   // if internal y not equal to inputed parameter, animate it
2369   float duration = std::min(fabsf((position - mScrollPrePosition.y) / mMaxOvershoot.y) * mSnapOvershootDuration, mSnapOvershootDuration);
2370   DALI_LOG_SCROLL_STATE("[0x%X] duration[%.2f]", this, duration );
2371   if( duration > Math::MACHINE_EPSILON_1 )
2372   {
2373     DALI_LOG_SCROLL_STATE("[0x%X] Starting Y Snap Animation to[%.2f]", this, position );
2374
2375     mInternalYAnimation = Animation::New(duration);
2376     mInternalYAnimation.FinishedSignal().Connect(this, &ScrollView::OnSnapInternalPositionFinished);
2377     mInternalYAnimation.AnimateTo(Property(self, Toolkit::ScrollView::Property::SCROLL_PRE_POSITION, 1), position);
2378     mInternalYAnimation.Play();
2379
2380     // add internal animation state flag
2381     mScrollStateFlags |= SnappingInternalY;
2382   }
2383 }
2384
2385 void ScrollView::GestureStarted()
2386 {
2387   // we handle the first gesture.
2388   // if we're currently doing a gesture and receive another
2389   // we continue and combine the effects of the gesture instead of reseting.
2390   if(mGestureStackDepth++==0)
2391   {
2392     Actor self = Self();
2393     StopTouchDownTimer();
2394     StopAnimation();
2395     mPanDelta = Vector2::ZERO;
2396     mLastVelocity = Vector2::ZERO;
2397     if( !mScrolling )
2398     {
2399       mLockAxis = LockPossible;
2400     }
2401
2402     if( mScrollStateFlags & SCROLL_X_STATE_MASK )
2403     {
2404       StopAnimation(mInternalXAnimation);
2405     }
2406     if( mScrollStateFlags & SCROLL_Y_STATE_MASK )
2407     {
2408       StopAnimation(mInternalYAnimation);
2409     }
2410     mScrollStateFlags = 0;
2411
2412     if(mScrolling) // are we interrupting a current scroll?
2413     {
2414       // set mScrolling to false, in case user has code that interrogates mScrolling Getter() in complete.
2415       mScrolling = false;
2416       // send negative scroll position since scroll internal scroll position works as an offset for actors,
2417       // give applications the position within the domain from the scroll view's anchor position
2418       DALI_LOG_SCROLL_STATE("[0x%X] mScrollCompletedSignal 5 [%.2f, %.2f]", this, -mScrollPostPosition.x, -mScrollPostPosition.y);
2419       mScrollCompletedSignal.Emit( -mScrollPostPosition );
2420     }
2421   }
2422 }
2423
2424 void ScrollView::GestureContinuing(const Vector2& panDelta)
2425 {
2426   mPanDelta.x+= panDelta.x;
2427   mPanDelta.y+= panDelta.y;
2428
2429   // Save the velocity, there is a bug in PanGesture
2430   // Whereby the Gesture::Finished's velocity is either:
2431   // NaN (due to time delta of zero between the last two events)
2432   // or 0 (due to position being the same between the last two events)
2433
2434   // Axis Auto Lock - locks the panning to the horizontal or vertical axis if the pan
2435   // appears mostly horizontal or mostly vertical respectively.
2436   if(mAxisAutoLock)
2437   {
2438     mLockAxis = GetLockAxis(mPanDelta, mLockAxis, mAxisAutoLockGradient);
2439   } // end if mAxisAutoLock
2440 }
2441
2442 // TODO: Upgrade to use a more powerful gesture detector (one that supports multiple touches on pan - so works as pan and flick gesture)
2443 // BUG: Gesture::Finished doesn't always return velocity on release (due to
2444 // timeDelta between last two events being 0 sometimes, or posiiton being the same)
2445 void ScrollView::OnPan( const PanGesture& gesture )
2446 {
2447   // Guard against destruction during signal emission
2448   // Note that Emit() methods are called indirectly e.g. from within ScrollView::OnGestureEx()
2449   Actor self( Self() );
2450
2451   if(!mSensitive)
2452   {
2453     DALI_LOG_SCROLL_STATE("[0x%X] Pan Ignored, Insensitive", this);
2454
2455     // If another callback on the same original signal disables sensitivity,
2456     // this callback will still be called, so we must suppress it.
2457     return;
2458   }
2459
2460   // translate Gesture input to get useful data...
2461   switch(gesture.state)
2462   {
2463     case Gesture::Started:
2464     {
2465       DALI_LOG_SCROLL_STATE("[0x%X] Pan Started", this);
2466       mPanStartPosition = gesture.position - gesture.displacement;
2467       UpdateLocalScrollProperties();
2468       GestureStarted();
2469       mPanning = true;
2470       self.SetProperty( Toolkit::ScrollView::Property::PANNING, true );
2471       self.SetProperty( Toolkit::ScrollView::Property::START_PAGE_POSITION, Vector3(gesture.position.x, gesture.position.y, 0.0f) );
2472
2473       UpdateMainInternalConstraint();
2474       break;
2475     }
2476
2477     case Gesture::Continuing:
2478     {
2479       if ( mPanning )
2480       {
2481         DALI_LOG_SCROLL_STATE("[0x%X] Pan Continuing", this);
2482         GestureContinuing(gesture.screenDisplacement);
2483       }
2484       else
2485       {
2486         // If we do not think we are panning, then we should not do anything here
2487         return;
2488       }
2489       break;
2490     }
2491
2492     case Gesture::Finished:
2493     case Gesture::Cancelled:
2494     {
2495       if ( mPanning )
2496       {
2497         DALI_LOG_SCROLL_STATE("[0x%X] Pan %s", this, ( ( gesture.state == Gesture::Finished ) ? "Finished" : "Cancelled" ) );
2498
2499         UpdateLocalScrollProperties();
2500         mLastVelocity = gesture.velocity;
2501         mPanning = false;
2502         self.SetProperty( Toolkit::ScrollView::Property::PANNING, false );
2503
2504         if( mScrollMainInternalPrePositionConstraint )
2505         {
2506           mScrollMainInternalPrePositionConstraint.Remove();
2507         }
2508       }
2509       else
2510       {
2511         // If we do not think we are panning, then we should not do anything here
2512         return;
2513       }
2514       break;
2515     }
2516
2517     case Gesture::Possible:
2518     case Gesture::Clear:
2519     {
2520       // Nothing to do, not needed.
2521       break;
2522     }
2523
2524   } // end switch(gesture.state)
2525
2526   OnGestureEx(gesture.state);
2527 }
2528
2529 void ScrollView::OnGestureEx(Gesture::State state)
2530 {
2531   // call necessary signals for application developer
2532
2533   if(state == Gesture::Started)
2534   {
2535     Vector2 currentScrollPosition = GetCurrentScrollPosition();
2536     Self().SetProperty(Toolkit::ScrollView::Property::SCROLLING, true);
2537     mScrolling = true;
2538     DALI_LOG_SCROLL_STATE("[0x%X] mScrollStartedSignal 2 [%.2f, %.2f]", this, currentScrollPosition.x, currentScrollPosition.y);
2539     mScrollStartedSignal.Emit( currentScrollPosition );
2540   }
2541   else if( (state == Gesture::Finished) ||
2542            (state == Gesture::Cancelled) ) // Finished/default
2543   {
2544     // when all the gestures have finished, we finish the transform.
2545     // so if a user decides to pan (1 gesture), and then pan+zoom (2 gestures)
2546     // then stop panning (back to 1 gesture), and then stop zooming (0 gestures).
2547     // this is the point we end, and perform necessary snapping.
2548     mGestureStackDepth--;
2549     if(mGestureStackDepth==0)
2550     {
2551       // no flick if we have not exceeded min flick distance
2552       if( (fabsf(mPanDelta.x) < mMinFlickDistance.x)
2553           && (fabsf(mPanDelta.y) < mMinFlickDistance.y) )
2554       {
2555         // reset flick velocity
2556         mLastVelocity = Vector2::ZERO;
2557       }
2558       FinishTransform();
2559     }
2560     else
2561     {
2562       DALI_LOG_SCROLL_STATE("[0x%X] mGestureStackDepth[%d]", this, mGestureStackDepth);
2563     }
2564   }
2565 }
2566
2567 void ScrollView::FinishTransform()
2568 {
2569   // at this stage internal x and x scroll position should have followed prescroll position exactly
2570   Actor self = Self();
2571
2572   PreAnimatedScrollSetup();
2573
2574   // convert pixels/millisecond to pixels per second
2575   bool animating = SnapWithVelocity(mLastVelocity * 1000.0f);
2576
2577   if(!animating)
2578   {
2579     // if not animating, then this pan has completed right now.
2580     SetScrollUpdateNotification(false);
2581     mScrolling = false;
2582     Self().SetProperty(Toolkit::ScrollView::Property::SCROLLING, false);
2583
2584     if( fabs(mScrollPrePosition.x - mScrollTargetPosition.x) > Math::MACHINE_EPSILON_10 )
2585     {
2586       SnapInternalXTo(mScrollTargetPosition.x);
2587     }
2588     if( fabs(mScrollPrePosition.y - mScrollTargetPosition.y) > Math::MACHINE_EPSILON_10 )
2589     {
2590       SnapInternalYTo(mScrollTargetPosition.y);
2591     }
2592     Vector2 currentScrollPosition = GetCurrentScrollPosition();
2593     DALI_LOG_SCROLL_STATE("[0x%X] mScrollCompletedSignal 6 [%.2f, %.2f]", this, currentScrollPosition.x, currentScrollPosition.y);
2594     mScrollCompletedSignal.Emit( currentScrollPosition );
2595   }
2596 }
2597
2598 Vector2 ScrollView::GetOvershoot(Vector2& position) const
2599 {
2600   Vector3 size = Self().GetCurrentSize();
2601   Vector2 overshoot;
2602
2603   const RulerDomain rulerDomainX = mRulerX->GetDomain();
2604   const RulerDomain rulerDomainY = mRulerY->GetDomain();
2605
2606   if(mRulerX->IsEnabled() && rulerDomainX.enabled)
2607   {
2608     const float left = rulerDomainX.min - position.x;
2609     const float right = size.width - rulerDomainX.max - position.x;
2610     if(left<0)
2611     {
2612       overshoot.x = left;
2613     }
2614     else if(right>0)
2615     {
2616       overshoot.x = right;
2617     }
2618   }
2619
2620   if(mRulerY->IsEnabled() && rulerDomainY.enabled)
2621   {
2622     const float top = rulerDomainY.min - position.y;
2623     const float bottom = size.height - rulerDomainY.max - position.y;
2624     if(top<0)
2625     {
2626       overshoot.y = top;
2627     }
2628     else if(bottom>0)
2629     {
2630       overshoot.y = bottom;
2631     }
2632   }
2633
2634   return overshoot;
2635 }
2636
2637 bool ScrollView::OnAccessibilityPan(PanGesture gesture)
2638 {
2639   // Keep track of whether this is an AccessibilityPan
2640   mInAccessibilityPan = true;
2641   OnPan(gesture);
2642   mInAccessibilityPan = false;
2643
2644   return true;
2645 }
2646
2647 void ScrollView::ClampPosition(Vector2& position) const
2648 {
2649   ClampState2D clamped;
2650   ClampPosition(position, clamped);
2651 }
2652
2653 void ScrollView::ClampPosition(Vector2& position, ClampState2D &clamped) const
2654 {
2655   Vector3 size = Self().GetCurrentSize();
2656
2657   position.x = -mRulerX->Clamp(-position.x, size.width, 1.0f, clamped.x);    // NOTE: X & Y rulers think in -ve coordinate system.
2658   position.y = -mRulerY->Clamp(-position.y, size.height, 1.0f, clamped.y);   // That is scrolling RIGHT (e.g. 100.0, 0.0) means moving LEFT.
2659 }
2660
2661 void ScrollView::WrapPosition(Vector2& position) const
2662 {
2663   if(mWrapMode)
2664   {
2665     const RulerDomain rulerDomainX = mRulerX->GetDomain();
2666     const RulerDomain rulerDomainY = mRulerY->GetDomain();
2667
2668     if(mRulerX->IsEnabled())
2669     {
2670       position.x = -WrapInDomain(-position.x, rulerDomainX.min, rulerDomainX.max);
2671     }
2672
2673     if(mRulerY->IsEnabled())
2674     {
2675       position.y = -WrapInDomain(-position.y, rulerDomainY.min, rulerDomainY.max);
2676     }
2677   }
2678 }
2679
2680 void ScrollView::UpdateMainInternalConstraint()
2681 {
2682   // TODO: Only update the constraints which have changed, rather than remove all and add all again.
2683   // Requires a dali-core ApplyConstraintAt, or a ReplaceConstraint. The former is probably more flexible.
2684   Actor self = Self();
2685   PanGestureDetector detector( GetPanGestureDetector() );
2686
2687   if(mScrollMainInternalPositionConstraint)
2688   {
2689     mScrollMainInternalPositionConstraint.Remove();
2690     mScrollMainInternalDeltaConstraint.Remove();
2691     mScrollMainInternalFinalConstraint.Remove();
2692     mScrollMainInternalRelativeConstraint.Remove();
2693     mScrollMainInternalDomainConstraint.Remove();
2694     mScrollMainInternalPrePositionMaxConstraint.Remove();
2695   }
2696   if( mScrollMainInternalPrePositionConstraint )
2697   {
2698     mScrollMainInternalPrePositionConstraint.Remove();
2699   }
2700
2701   // TODO: It's probably better to use a local displacement value as this will give a displacement when scrolling just commences
2702   // but we need to make sure than the gesture system gives displacement since last frame (60Hz), not displacement since last touch event (90Hz).
2703
2704   // 1. First calculate the pre-position (this is the scroll position if no clamping has taken place)
2705   Vector2 initialPanMask = Vector2(mRulerX->IsEnabled() ? 1.0f : 0.0f, mRulerY->IsEnabled() ? 1.0f : 0.0f);
2706
2707   if( mLockAxis == LockVertical )
2708   {
2709     initialPanMask.y = 0.0f;
2710   }
2711   else if( mLockAxis == LockHorizontal )
2712   {
2713     initialPanMask.x = 0.0f;
2714   }
2715
2716   if( mPanning )
2717   {
2718     mScrollMainInternalPrePositionConstraint = Constraint::New<Vector2>( self,
2719                                                                          Toolkit::ScrollView::Property::SCROLL_PRE_POSITION,
2720                                                                          InternalPrePositionConstraint( mPanStartPosition,
2721                                                                                                         initialPanMask,
2722                                                                                                         mAxisAutoLock,
2723                                                                                                         mAxisAutoLockGradient,
2724                                                                                                         mLockAxis,
2725                                                                                                         mMaxOvershoot,
2726                                                                                                         mRulerX,
2727                                                                                                         mRulerY ) );
2728     mScrollMainInternalPrePositionConstraint.AddSource( Source( detector, PanGestureDetector::Property::LOCAL_POSITION ) );
2729     mScrollMainInternalPrePositionConstraint.AddSource( Source( detector, PanGestureDetector::Property::PANNING ) );
2730     mScrollMainInternalPrePositionConstraint.AddSource( Source( self, Actor::Property::SIZE ) );
2731     mScrollMainInternalPrePositionConstraint.Apply();
2732   }
2733
2734   // 2. Second calculate the clamped position (actual position)
2735   mScrollMainInternalPositionConstraint = Constraint::New<Vector2>( self,
2736                                                                     Toolkit::ScrollView::Property::SCROLL_POSITION,
2737                                                                     InternalPositionConstraint( mRulerX->GetDomain(),
2738                                                                                                 mRulerY->GetDomain(),
2739                                                                                                 mWrapMode ) );
2740   mScrollMainInternalPositionConstraint.AddSource( LocalSource( Toolkit::ScrollView::Property::SCROLL_PRE_POSITION ) );
2741   mScrollMainInternalPositionConstraint.AddSource( LocalSource( Toolkit::Scrollable::Property::SCROLL_POSITION_MIN ) );
2742   mScrollMainInternalPositionConstraint.AddSource( LocalSource( Toolkit::Scrollable::Property::SCROLL_POSITION_MAX ) );
2743   mScrollMainInternalPositionConstraint.AddSource( Source( self, Actor::Property::SIZE ) );
2744   mScrollMainInternalPositionConstraint.Apply();
2745
2746   mScrollMainInternalDeltaConstraint = Constraint::New<Vector2>( self, Toolkit::ScrollView::Property::SCROLL_POSITION_DELTA, InternalPositionDeltaConstraint );
2747   mScrollMainInternalDeltaConstraint.AddSource( LocalSource( Toolkit::ScrollView::Property::SCROLL_POSITION ) );
2748   mScrollMainInternalDeltaConstraint.AddSource( LocalSource( Toolkit::ScrollView::Property::SCROLL_DOMAIN_OFFSET ) );
2749   mScrollMainInternalDeltaConstraint.Apply();
2750
2751   mScrollMainInternalFinalConstraint = Constraint::New<Vector2>( self, Toolkit::ScrollView::Property::SCROLL_FINAL,
2752                                                                  InternalFinalConstraint( FinalDefaultAlphaFunction,
2753                                                                                           FinalDefaultAlphaFunction ) );
2754   mScrollMainInternalFinalConstraint.AddSource( LocalSource( Toolkit::ScrollView::Property::SCROLL_POSITION ) );
2755   mScrollMainInternalFinalConstraint.AddSource( LocalSource( Toolkit::ScrollView::Property::OVERSHOOT_X ) );
2756   mScrollMainInternalFinalConstraint.AddSource( LocalSource( Toolkit::ScrollView::Property::OVERSHOOT_Y ) );
2757   mScrollMainInternalFinalConstraint.Apply();
2758
2759   mScrollMainInternalRelativeConstraint = Constraint::New<Vector2>( self, Toolkit::Scrollable::Property::SCROLL_RELATIVE_POSITION, InternalRelativePositionConstraint );
2760   mScrollMainInternalRelativeConstraint.AddSource( LocalSource( Toolkit::ScrollView::Property::SCROLL_POSITION ) );
2761   mScrollMainInternalRelativeConstraint.AddSource( LocalSource( Toolkit::Scrollable::Property::SCROLL_POSITION_MIN ) );
2762   mScrollMainInternalRelativeConstraint.AddSource( LocalSource( Toolkit::Scrollable::Property::SCROLL_POSITION_MAX ) );
2763   mScrollMainInternalRelativeConstraint.AddSource( LocalSource( Actor::Property::SIZE ) );
2764   mScrollMainInternalRelativeConstraint.Apply();
2765
2766   mScrollMainInternalDomainConstraint = Constraint::New<Vector2>( self, Toolkit::ScrollView::Property::SCROLL_DOMAIN_SIZE, InternalScrollDomainConstraint );
2767   mScrollMainInternalDomainConstraint.AddSource( LocalSource( Toolkit::Scrollable::Property::SCROLL_POSITION_MIN ) );
2768   mScrollMainInternalDomainConstraint.AddSource( LocalSource( Toolkit::Scrollable::Property::SCROLL_POSITION_MAX ) );
2769   mScrollMainInternalDomainConstraint.AddSource( LocalSource( Actor::Property::SIZE ) );
2770   mScrollMainInternalDomainConstraint.Apply();
2771
2772   mScrollMainInternalPrePositionMaxConstraint = Constraint::New<Vector2>( self, Toolkit::ScrollView::Property::SCROLL_PRE_POSITION_MAX, InternalPrePositionMaxConstraint );
2773   mScrollMainInternalPrePositionMaxConstraint.AddSource( LocalSource( Toolkit::Scrollable::Property::SCROLL_POSITION_MAX ) );
2774   mScrollMainInternalPrePositionMaxConstraint.AddSource( LocalSource( Actor::Property::SIZE ) );
2775   mScrollMainInternalPrePositionMaxConstraint.Apply();
2776
2777   // When panning we want to make sure overshoot values are affected by pre position and post position
2778   SetOvershootConstraintsEnabled(!mWrapMode);
2779 }
2780
2781 void ScrollView::SetOvershootConstraintsEnabled(bool enabled)
2782 {
2783   Actor self( Self() );
2784   // remove and reset, it may now be in wrong order with the main internal constraints
2785   if( mScrollMainInternalOvershootXConstraint )
2786   {
2787     mScrollMainInternalOvershootXConstraint.Remove();
2788     mScrollMainInternalOvershootXConstraint.Reset();
2789     mScrollMainInternalOvershootYConstraint.Remove();
2790     mScrollMainInternalOvershootYConstraint.Reset();
2791   }
2792   if( enabled )
2793   {
2794     mScrollMainInternalOvershootXConstraint= Constraint::New<float>( self, Toolkit::ScrollView::Property::OVERSHOOT_X, OvershootXConstraint(mMaxOvershoot.x) );
2795     mScrollMainInternalOvershootXConstraint.AddSource( LocalSource( Toolkit::ScrollView::Property::SCROLL_PRE_POSITION ) );
2796     mScrollMainInternalOvershootXConstraint.AddSource( LocalSource( Toolkit::ScrollView::Property::SCROLL_POSITION ) );
2797     mScrollMainInternalOvershootXConstraint.AddSource( LocalSource( Toolkit::Scrollable::Property::CAN_SCROLL_HORIZONTAL ) );
2798     mScrollMainInternalOvershootXConstraint.Apply();
2799
2800     mScrollMainInternalOvershootYConstraint = Constraint::New<float>( self, Toolkit::ScrollView::Property::OVERSHOOT_Y, OvershootYConstraint(mMaxOvershoot.y) );
2801     mScrollMainInternalOvershootYConstraint.AddSource( LocalSource( Toolkit::ScrollView::Property::SCROLL_PRE_POSITION ) );
2802     mScrollMainInternalOvershootYConstraint.AddSource( LocalSource( Toolkit::ScrollView::Property::SCROLL_POSITION ) );
2803     mScrollMainInternalOvershootYConstraint.AddSource( LocalSource( Toolkit::Scrollable::Property::CAN_SCROLL_VERTICAL ) );
2804     mScrollMainInternalOvershootYConstraint.Apply();
2805   }
2806   else
2807   {
2808     self.SetProperty(Toolkit::ScrollView::Property::OVERSHOOT_X, 0.0f);
2809     self.SetProperty(Toolkit::ScrollView::Property::OVERSHOOT_Y, 0.0f);
2810   }
2811 }
2812
2813 void ScrollView::SetInternalConstraints()
2814 {
2815   // Internal constraints (applied to target ScrollBase Actor itself) /////////
2816   UpdateMainInternalConstraint();
2817
2818   // User definable constraints to apply to all child actors //////////////////
2819   Actor self = Self();
2820
2821   // Apply some default constraints to ScrollView & its bound actors
2822   // Movement + Wrap function
2823
2824   Constraint constraint;
2825
2826   // MoveActor (scrolling)
2827   constraint = Constraint::New<Vector3>( self, Actor::Property::POSITION, MoveActorConstraint );
2828   constraint.AddSource( Source( self, Toolkit::ScrollView::Property::SCROLL_POSITION ) );
2829   constraint.SetRemoveAction(Constraint::Discard);
2830   ApplyConstraintToBoundActors(constraint);
2831
2832   // WrapActor (wrap functionality)
2833   constraint = Constraint::New<Vector3>( self, Actor::Property::POSITION, WrapActorConstraint );
2834   constraint.AddSource( LocalSource( Actor::Property::SCALE ) );
2835   constraint.AddSource( LocalSource( Actor::Property::ANCHOR_POINT ) );
2836   constraint.AddSource( LocalSource( Actor::Property::SIZE ) );
2837   constraint.AddSource( Source( self, Toolkit::Scrollable::Property::SCROLL_POSITION_MIN ) );
2838   constraint.AddSource( Source( self, Toolkit::Scrollable::Property::SCROLL_POSITION_MAX ) );
2839   constraint.AddSource( Source( self, Toolkit::ScrollView::Property::WRAP ) );
2840   constraint.SetRemoveAction(Constraint::Discard);
2841   ApplyConstraintToBoundActors(constraint);
2842 }
2843
2844 void ScrollView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
2845 {
2846   Toolkit::ScrollView scrollView = Toolkit::ScrollView::DownCast( Dali::BaseHandle( object ) );
2847
2848   if( scrollView )
2849   {
2850     ScrollView& scrollViewImpl( GetImpl( scrollView ) );
2851     switch( index )
2852     {
2853       case Toolkit::ScrollView::Property::WRAP_ENABLED:
2854       {
2855         scrollViewImpl.SetWrapMode( value.Get<bool>() );
2856         break;
2857       }
2858       case Toolkit::ScrollView::Property::PANNING_ENABLED:
2859       {
2860         scrollViewImpl.SetScrollSensitive( value.Get<bool>() );
2861         break;
2862       }
2863       case Toolkit::ScrollView::Property::AXIS_AUTO_LOCK_ENABLED:
2864       {
2865         scrollViewImpl.SetAxisAutoLock( value.Get<bool>() );
2866         break;
2867       }
2868       case Toolkit::ScrollView::Property::WHEEL_SCROLL_DISTANCE_STEP:
2869       {
2870         scrollViewImpl.SetWheelScrollDistanceStep( value.Get<Vector2>() );
2871         break;
2872       }
2873     }
2874   }
2875 }
2876
2877 Property::Value ScrollView::GetProperty( BaseObject* object, Property::Index index )
2878 {
2879   Property::Value value;
2880
2881   Toolkit::ScrollView scrollView = Toolkit::ScrollView::DownCast( Dali::BaseHandle( object ) );
2882
2883   if( scrollView )
2884   {
2885     ScrollView& scrollViewImpl( GetImpl( scrollView ) );
2886     switch( index )
2887     {
2888       case Toolkit::ScrollView::Property::WRAP_ENABLED:
2889       {
2890         value = scrollViewImpl.GetWrapMode();
2891         break;
2892       }
2893       case Toolkit::ScrollView::Property::PANNING_ENABLED:
2894       {
2895         value = scrollViewImpl.GetScrollSensitive();
2896         break;
2897       }
2898       case Toolkit::ScrollView::Property::AXIS_AUTO_LOCK_ENABLED:
2899       {
2900         value = scrollViewImpl.GetAxisAutoLock();
2901         break;
2902       }
2903       case Toolkit::ScrollView::Property::WHEEL_SCROLL_DISTANCE_STEP:
2904       {
2905         value = scrollViewImpl.GetWheelScrollDistanceStep();
2906         break;
2907       }
2908     }
2909   }
2910
2911   return value;
2912 }
2913
2914 } // namespace Internal
2915
2916 } // namespace Toolkit
2917
2918 } // namespace Dali