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