dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.cpp

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/integration-api/debug.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
  26 #include <dali-toolkit/internal/controls/scrollable/scroll-view/scroll-view-impl.h>
  27
  28 using namespace Dali;
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 ///////////////////////////////////////////////////////////////////////////////////////////////////
  37 // RulerDomain
  38 ///////////////////////////////////////////////////////////////////////////////////////////////////
  39
  40 RulerDomain::RulerDomain(float min, float max, bool enabled)
  41 : min(min),
  42   max(max),
  43   enabled(enabled)
  44 {
  45 }
  46
  47 float RulerDomain::Clamp(float x, float length, float scale) const
  48 {
  49   ClampState clamped;
  50
  51   return Clamp(x, length, scale, clamped);
  52 }
  53
  54 float RulerDomain::Clamp(float x, float length, float scale, ClampState &clamped) const
  55 {
  56   if(!enabled)
  57   {
  58     clamped = NotClamped;
  59     return x;
  60   }
  61
  62   const float minExtent = min * scale;
  63   const float maxExtent = max * scale - length;
  64   if(x < minExtent)
  65   {
  66     clamped = ClampedToMin;
  67     return minExtent;
  68   }
  69   else if(x > maxExtent)
  70   {
  71     clamped = ClampedToMax;
  72     return maxExtent;
  73   }
  74
  75   clamped = NotClamped;
  76   return x;
  77 }
  78
  79 float RulerDomain::GetSize() const
  80 {
  81   return max-min;
  82 }
  83
  84 ///////////////////////////////////////////////////////////////////////////////////////////////////
  85 // Ruler
  86 ///////////////////////////////////////////////////////////////////////////////////////////////////
  87
  88 Ruler::Ruler()
  89 : mType(Free),
  90   mEnabled(true),
  91   mDomain(RulerDomain(0.0f,1.0f,false))
  92 {
  93 }
  94
  95 Ruler::~Ruler()
  96 {
  97 }
  98
  99 Ruler::RulerType Ruler::GetType() const
 100 {
 101   return mType;
 102 }
 103
 104 bool Ruler::IsEnabled() const
 105 {
 106   return mEnabled;
 107 }
 108
 109 void Ruler::Enable()
 110 {
 111   mEnabled = true;
 112 }
 113
 114 void Ruler::Disable()
 115 {
 116   mEnabled = false;
 117 }
 118
 119 void Ruler::SetDomain(RulerDomain domain)
 120 {
 121   mDomain = domain;
 122 }
 123
 124 const RulerDomain &Ruler::GetDomain() const
 125 {
 126   return mDomain;
 127 }
 128
 129 void Ruler::DisableDomain()
 130 {
 131   mDomain = RulerDomain(0.0f,1.0f,false);
 132 }
 133
 134 float Ruler::Clamp(float x, float length, float scale) const
 135 {
 136   return mDomain.Clamp(x, length, scale);
 137 }
 138
 139 float Ruler::Clamp(float x, float length, float scale, ClampState &clamped) const
 140 {
 141   return mDomain.Clamp(x, length, scale, clamped);
 142 }
 143
 144 float Ruler::SnapAndClamp(float x, float bias, float length, float scale) const
 145 {
 146   return Clamp(Snap(x, bias), length, scale);
 147 }
 148
 149 float Ruler::SnapAndClamp(float x, float bias, float length, float scale, ClampState &clamped) const
 150 {
 151   return Clamp(Snap(x, bias), length, scale, clamped);
 152 }
 153
 154 ///////////////////////////////////////////////////////////////////////////////////////////////////
 155 // DefaultRuler
 156 ///////////////////////////////////////////////////////////////////////////////////////////////////
 157
 158 DefaultRuler::DefaultRuler()
 159 {
 160   mType = Free;
 161 }
 162
 163 float DefaultRuler::Snap(float x, float bias) const
 164 {
 165   return x;
 166 }
 167
 168 float DefaultRuler::GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const
 169 {
 170   volume = 0;
 171   return 0.0f;
 172 }
 173
 174 unsigned int DefaultRuler::GetPageFromPosition(float position, bool wrap) const
 175 {
 176   return 0;
 177 }
 178
 179 unsigned int DefaultRuler::GetTotalPages() const
 180 {
 181   return 1;
 182 }
 183
 184 ///////////////////////////////////////////////////////////////////////////////////////////////////
 185 // FixedRuler
 186 ///////////////////////////////////////////////////////////////////////////////////////////////////
 187
 188 FixedRuler::FixedRuler(float spacing)
 189 : mSpacing(spacing)
 190 {
 191   if(fabsf(mSpacing) <= Math::MACHINE_EPSILON_1)
 192   {
 193     DALI_LOG_ERROR( "Page spacing too small (%f).", double(spacing) );
 194     mSpacing = spacing >= 0.0f ? Math::MACHINE_EPSILON_1 : -Math::MACHINE_EPSILON_1;
 195   }
 196   mType = Fixed;
 197 }
 198
 199 float FixedRuler::Snap(float x, float bias) const
 200 {
 201   return floor(x / mSpacing + bias) * mSpacing;
 202 }
 203
 204 float FixedRuler::GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const
 205 {
 206   float position = mDomain.min;
 207
 208   volume = 0;
 209
 210   // spacing must be present.
 211   if( mEnabled )
 212   {
 213     unsigned int column = page;
 214
 215     // In carry mode, a volume (carry) is produced when page exceeds limit within domain
 216     if(wrap)
 217     {
 218       unsigned int pagesPerVolume = mDomain.GetSize() / mSpacing;
 219       if(pagesPerVolume>0)
 220       {
 221         column += pagesPerVolume;
 222         column %= pagesPerVolume;
 223         volume = page/pagesPerVolume;
 224       }
 225     }
 226
 227     position = mDomain.min + column * mSpacing;
 228   }
 229   else  // Domain (or Spacing) is not present, carry page to volume.
 230   {
 231     if(wrap)
 232     {
 233       volume = page;
 234     }
 235   }
 236
 237   return position;
 238 }
 239
 240 unsigned int FixedRuler::GetPageFromPosition(float position, bool wrap) const
 241 {
 242   unsigned int page = 0;
 243
 244   // spacing must be present.
 245   if( mEnabled )
 246   {
 247     if( wrap )
 248     {
 249       position = WrapInDomain(position, mDomain.min, mDomain.max);
 250     }
 251     page = floor((position - mDomain.min) / mSpacing + 0.5f);
 252
 253     if(wrap)
 254     {
 255       unsigned int pagesPerVolume = mDomain.GetSize() / mSpacing;
 256       // Defensive check to avoid a divide by zero below when the ruler is in an invalid state (entire domain smaller than spacing between pages of it):
 257       if(pagesPerVolume < 1u)
 258       {
 259         pagesPerVolume = 1u;
 260         DALI_LOG_ERROR("Ruler domain(%f) is smaller than its spacing(%f).", mDomain.GetSize() * 1.0, mSpacing * 1.0 );
 261       }
 262       page %= pagesPerVolume;
 263     }
 264   }
 265
 266   return page;
 267 }
 268
 269 unsigned int FixedRuler::GetTotalPages() const
 270 {
 271   unsigned int pagesPerVolume = 1;
 272
 273   // spacing must be present.
 274   if( mEnabled )
 275   {
 276     pagesPerVolume = mDomain.GetSize() / mSpacing;
 277   }
 278
 279   return pagesPerVolume;
 280 }
 281
 282 ///////////////////////////////////////////////////////////////////////////////////////////////////
 283 // ScrollView
 284 ///////////////////////////////////////////////////////////////////////////////////////////////////
 285
 286 const std::string ScrollView::SCROLL_TIME_PROPERTY_NAME( "scroll-time" );
 287 const std::string ScrollView::SCROLL_POSITION_PROPERTY_NAME( "scroll-position" );
 288 const std::string ScrollView::SCROLL_PRE_POSITION_PROPERTY_NAME( "scroll-pre-position" );
 289 const std::string ScrollView::SCROLL_OVERSHOOT_X_PROPERTY_NAME( "scroll-overshoot-x" );
 290 const std::string ScrollView::SCROLL_OVERSHOOT_Y_PROPERTY_NAME( "scroll-overshoot-y" );
 291 const std::string ScrollView::SCROLL_FINAL_PROPERTY_NAME( "scroll-final" );
 292 const std::string ScrollView::SCROLL_WRAP_PROPERTY_NAME( "scroll-wrap" );
 293 const std::string ScrollView::SCROLL_PANNING_PROPERTY_NAME( "scroll-panning" );
 294 const std::string ScrollView::SCROLL_SCROLLING_PROPERTY_NAME( "scroll-scrolling" );
 295 const std::string ScrollView::SCROLL_POSITION_DELTA_PROPERTY_NAME( "scroll-position-delta" );
 296 const std::string ScrollView::SCROLL_START_PAGE_POSITION_PROPERTY_NAME( "scroll-start-page-position" );
 297
 298 const float ScrollView::DEFAULT_SLOW_SNAP_ANIMATION_DURATION(0.5f);
 299 const float ScrollView::DEFAULT_FAST_SNAP_ANIMATION_DURATION(0.25f);
 300 const float ScrollView::DEFAULT_SNAP_OVERSHOOT_DURATION(0.5f);
 301 const float ScrollView::DEFAULT_MAX_OVERSHOOT(100.0f);  // 100 pixels
 302
 303 const float ScrollView::DEFAULT_AXIS_AUTO_LOCK_GRADIENT(0.36f);
 304 const float ScrollView::DEFAULT_FRICTION_COEFFICIENT(1.0f);
 305 const float ScrollView::DEFAULT_FLICK_SPEED_COEFFICIENT(1.0f);
 306 const float ScrollView::DEFAULT_MAX_FLICK_SPEED(3.0f);
 307
 308 ScrollView::ScrollView()
 309 {
 310 }
 311
 312 ScrollView::ScrollView(Internal::ScrollView& implementation)
 313 : Scrollable(implementation)
 314 {
 315 }
 316
 317 ScrollView::ScrollView( Dali::Internal::CustomActor* internal )
 318 : Scrollable( internal )
 319 {
 320   VerifyCustomActorPointer<Internal::ScrollView>(internal);
 321 }
 322
 323 ScrollView::ScrollView( const ScrollView& handle )
 324 : Scrollable( handle )
 325 {
 326 }
 327
 328 ScrollView& ScrollView::operator=( const ScrollView& handle )
 329 {
 330   if( &handle != this )
 331   {
 332     Control::operator=( handle );
 333   }
 334   return *this;
 335 }
 336
 337 ScrollView ScrollView::New()
 338 {
 339   return Internal::ScrollView::New();
 340 }
 341
 342 ScrollView::~ScrollView()
 343 {
 344 }
 345
 346 ScrollView ScrollView::DownCast( BaseHandle handle )
 347 {
 348   return Control::DownCast<ScrollView, Internal::ScrollView>(handle);
 349 }
 350
 351 AlphaFunction ScrollView::GetScrollSnapAlphaFunction() const
 352 {
 353   return GetImpl(*this).GetScrollSnapAlphaFunction();
 354 }
 355
 356 void ScrollView::SetScrollSnapAlphaFunction(AlphaFunction alpha)
 357 {
 358   GetImpl(*this).SetScrollSnapAlphaFunction(alpha);
 359 }
 360
 361 AlphaFunction ScrollView::GetScrollFlickAlphaFunction() const
 362 {
 363   return GetImpl(*this).GetScrollFlickAlphaFunction();
 364 }
 365
 366 void ScrollView::SetScrollFlickAlphaFunction(AlphaFunction alpha)
 367 {
 368   GetImpl(*this).SetScrollFlickAlphaFunction(alpha);
 369 }
 370
 371 float ScrollView::GetScrollSnapDuration() const
 372 {
 373   return GetImpl(*this).GetScrollSnapDuration();
 374 }
 375
 376 void ScrollView::SetScrollSnapDuration(float time)
 377 {
 378   GetImpl(*this).SetScrollSnapDuration(time);
 379 }
 380
 381 float ScrollView::GetScrollFlickDuration() const
 382 {
 383   return GetImpl(*this).GetScrollFlickDuration();
 384 }
 385
 386 void ScrollView::SetScrollFlickDuration(float time)
 387 {
 388   GetImpl(*this).SetScrollFlickDuration(time);
 389 }
 390
 391 void ScrollView::SetRulerX(RulerPtr ruler)
 392 {
 393   GetImpl(*this).SetRulerX(ruler);
 394 }
 395
 396 void ScrollView::SetRulerY(RulerPtr ruler)
 397 {
 398   GetImpl(*this).SetRulerY(ruler);
 399 }
 400
 401 void ScrollView::SetScrollSensitive(bool sensitive)
 402 {
 403   GetImpl(*this).SetScrollSensitive(sensitive);
 404 }
 405
 406 void ScrollView::SetMaxOvershoot(float overshootX, float overshootY)
 407 {
 408   GetImpl(*this).SetMaxOvershoot(overshootX, overshootY);
 409 }
 410
 411 void ScrollView::SetSnapOvershootAlphaFunction(AlphaFunction alpha)
 412 {
 413   GetImpl(*this).SetSnapOvershootAlphaFunction(alpha);
 414 }
 415
 416 void ScrollView::SetSnapOvershootDuration(float duration)
 417 {
 418   GetImpl(*this).SetSnapOvershootDuration(duration);
 419 }
 420
 421 void ScrollView::SetActorAutoSnap(bool enable)
 422 {
 423   GetImpl(*this).SetActorAutoSnap(enable);
 424 }
 425
 426 void ScrollView::SetWrapMode(bool enable)
 427 {
 428   GetImpl(*this).SetWrapMode(enable);
 429 }
 430
 431 int ScrollView::GetScrollUpdateDistance() const
 432 {
 433   return GetImpl(*this).GetScrollUpdateDistance();
 434 }
 435
 436 void ScrollView::SetScrollUpdateDistance(int distance)
 437 {
 438   GetImpl(*this).SetScrollUpdateDistance(distance);
 439 }
 440
 441 bool ScrollView::GetAxisAutoLock() const
 442 {
 443   return GetImpl(*this).GetAxisAutoLock();
 444 }
 445
 446 void ScrollView::SetAxisAutoLock(bool enable)
 447 {
 448   GetImpl(*this).SetAxisAutoLock(enable);
 449 }
 450
 451 float ScrollView::GetAxisAutoLockGradient() const
 452 {
 453   return GetImpl(*this).GetAxisAutoLockGradient();
 454 }
 455
 456 void ScrollView::SetAxisAutoLockGradient(float gradient)
 457 {
 458   GetImpl(*this).SetAxisAutoLockGradient(gradient);
 459 }
 460
 461 float ScrollView::GetFrictionCoefficient() const
 462 {
 463   return GetImpl(*this).GetFrictionCoefficient();
 464 }
 465
 466 void ScrollView::SetFrictionCoefficient(float friction)
 467 {
 468   GetImpl(*this).SetFrictionCoefficient(friction);
 469 }
 470
 471 float ScrollView::GetFlickSpeedCoefficient() const
 472 {
 473   return GetImpl(*this).GetFlickSpeedCoefficient();
 474 }
 475
 476 void ScrollView::SetFlickSpeedCoefficient(float speed)
 477 {
 478   GetImpl(*this).SetFlickSpeedCoefficient(speed);
 479 }
 480
 481 Vector2 ScrollView::GetMinimumDistanceForFlick() const
 482 {
 483   return GetImpl(*this).GetMinimumDistanceForFlick();
 484 }
 485
 486 void ScrollView::SetMinimumDistanceForFlick( const Vector2& distance )
 487 {
 488   GetImpl(*this).SetMinimumDistanceForFlick(distance);
 489 }
 490
 491 float ScrollView::GetMinimumSpeedForFlick() const
 492 {
 493   return GetImpl(*this).GetMinimumSpeedForFlick();
 494 }
 495
 496 void ScrollView::SetMinimumSpeedForFlick( float speed )
 497 {
 498   GetImpl(*this).SetMinimumSpeedForFlick(speed);
 499 }
 500
 501 float ScrollView::GetMaxFlickSpeed() const
 502 {
 503   return GetImpl(*this).GetMaxFlickSpeed();
 504 }
 505
 506 void ScrollView::SetMaxFlickSpeed(float speed)
 507 {
 508   GetImpl(*this).SetMaxFlickSpeed(speed);
 509 }
 510
 511 Vector2 ScrollView::GetMouseWheelScrollDistanceStep() const
 512 {
 513   return GetImpl(*this).GetMouseWheelScrollDistanceStep();
 514 }
 515
 516 void ScrollView::SetMouseWheelScrollDistanceStep(Vector2 step)
 517 {
 518   GetImpl(*this).SetMouseWheelScrollDistanceStep(step);
 519 }
 520
 521 Vector3 ScrollView::GetCurrentScrollPosition() const
 522 {
 523   return GetImpl(*this).GetCurrentScrollPosition();
 524 }
 525
 526 void ScrollView::SetScrollPosition(const Vector3& position)
 527 {
 528   GetImpl(*this).SetScrollPosition(position);
 529 }
 530
 531 unsigned int ScrollView::GetCurrentPage() const
 532 {
 533   return GetImpl(*this).GetCurrentPage();
 534 }
 535
 536 void ScrollView::ScrollTo(const Vector3 &position)
 537 {
 538   GetImpl(*this).ScrollTo(position);
 539 }
 540
 541 void ScrollView::ScrollTo(const Vector3 &position, float duration)
 542 {
 543   GetImpl(*this).ScrollTo(position, duration);
 544 }
 545
 546 void ScrollView::ScrollTo(const Vector3 &position, float duration, AlphaFunction alpha)
 547 {
 548   GetImpl(*this).ScrollTo(position, duration, alpha);
 549 }
 550
 551 void ScrollView::ScrollTo(const Vector3 &position, float duration,
 552                           DirectionBias horizontalBias, DirectionBias verticalBias)
 553 {
 554   GetImpl(*this).ScrollTo(position, duration, horizontalBias, verticalBias);
 555 }
 556
 557 void ScrollView::ScrollTo(const Vector3 &position, float duration, AlphaFunction alpha,
 558                           DirectionBias horizontalBias, DirectionBias verticalBias)
 559 {
 560   GetImpl(*this).ScrollTo(position, duration, alpha, horizontalBias, verticalBias);
 561 }
 562
 563 void ScrollView::ScrollTo(unsigned int page)
 564 {
 565   GetImpl(*this).ScrollTo(page);
 566 }
 567
 568 void ScrollView::ScrollTo(unsigned int page, float duration)
 569 {
 570   GetImpl(*this).ScrollTo(page, duration);
 571 }
 572
 573 void ScrollView::ScrollTo(unsigned int page, float duration, DirectionBias bias)
 574 {
 575   GetImpl(*this).ScrollTo(page, duration, bias);
 576 }
 577
 578 void ScrollView::ScrollTo(Actor &actor)
 579 {
 580   GetImpl(*this).ScrollTo(actor);
 581 }
 582
 583 void ScrollView::ScrollTo(Actor &actor, float duration)
 584 {
 585   GetImpl(*this).ScrollTo(actor, duration);
 586 }
 587
 588 bool ScrollView::ScrollToSnapPoint()
 589 {
 590   return GetImpl(*this).ScrollToSnapPoint();
 591 }
 592
 593 void ScrollView::ApplyConstraintToChildren(Constraint constraint)
 594 {
 595   GetImpl(*this).ApplyConstraintToChildren(constraint);
 596 }
 597
 598 void ScrollView::RemoveConstraintsFromChildren()
 599 {
 600   GetImpl(*this).RemoveConstraintsFromChildren();
 601 }
 602
 603 void ScrollView::ApplyEffect(ScrollViewEffect effect)
 604 {
 605   GetImpl(*this).ApplyEffect(effect);
 606 }
 607
 608 void ScrollView::RemoveEffect(ScrollViewEffect effect)
 609 {
 610   GetImpl(*this).RemoveEffect(effect);
 611 }
 612
 613 void ScrollView::RemoveAllEffects()
 614 {
 615   GetImpl(*this).RemoveAllEffects();
 616 }
 617
 618 void ScrollView::BindActor(Actor child)
 619 {
 620   GetImpl(*this).BindActor(child);
 621 }
 622
 623 void ScrollView::UnbindActor(Actor child)
 624 {
 625   GetImpl(*this).UnbindActor(child);
 626 }
 627
 628 ScrollView::SnapStartedSignalType& ScrollView::SnapStartedSignal()
 629 {
 630   return GetImpl(*this).SnapStartedSignal();
 631 }
 632
 633 void ScrollView::SetScrollingDirection( Radian direction, Radian threshold )
 634 {
 635   GetImpl(*this).SetScrollingDirection( direction, threshold );
 636 }
 637
 638 void ScrollView::RemoveScrollingDirection( Radian direction )
 639 {
 640   GetImpl(*this).RemoveScrollingDirection( direction );
 641 }
 642
 643 } // namespace Toolkit
 644
 645 } // namespace Dali