dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.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/internal/controls/scroll-bar/scroll-bar-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/animation/constraints.h>
  23 #include <dali/public-api/object/type-registry.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h>
  27
  28 using namespace Dali;
  29
  30 namespace
  31 {
  32
  33 const char* DEFAULT_INDICATOR_IMAGE_PATH = DALI_IMAGE_DIR "popup_scroll.png";
  34 const Vector4 DEFAULT_INDICATOR_NINE_PATCH_BORDER(4.0f, 9.0f, 7.0f, 11.0f);
  35 const float MINIMUM_INDICATOR_HEIGHT(20.0f); // The minimum indicator height for the nine patch border
  36 const float DEFAULT_SLIDER_DEPTH(1.0f);
  37 const float DEFAULT_INDICATOR_SHOW_DURATION(0.5f);
  38 const float DEFAULT_INDICATOR_HIDE_DURATION(0.5f);
  39 const float DEFAULT_PAN_GESTURE_PROCESS_TIME(16.7f); // 16.7 milliseconds, i.e. one frame
  40 const float DEFAULT_INDICATOR_FIXED_HEIGHT(80.0f);
  41
  42 /**
  43  * Indicator size depends on both indicator's parent size and the scroll content size
  44  */
  45 Vector3 IndicatorSize( const Vector3& parentSize, float contentSize)
  46 {
  47   float height = contentSize > parentSize.height ?
  48                  parentSize.height * ( parentSize.height / contentSize ) :
  49                  parentSize.height * ( (parentSize.height - contentSize * 0.5f) / parentSize.height);
  50   return Vector3( parentSize.width, std::max(MINIMUM_INDICATOR_HEIGHT, height), parentSize.depth );
  51 }
  52
  53 /**
  54  * Indicator position constraint
  55  * Positions the indicator to reflect the current scroll position within the scroll domain.
  56  */
  57 struct IndicatorPositionConstraint
  58 {
  59   /**
  60    * @param[in] minPosition The minimum limit of scroll position
  61    * @param[in] maxPosition the maximum limit of scroll position
  62    */
  63   IndicatorPositionConstraint(float minPosition, float maxPosition)
  64   : mMinPosition(minPosition),
  65     mMaxPosition(maxPosition)
  66   {
  67   }
  68
  69   /**
  70    * Constraint operator
  71    * @param[in] current The current indicator position
  72    * @param[in] indicatorSizeProperty The size of indicator.
  73    * @param[in] parentSizeProperty The parent size of indicator.
  74    * @param[in] scrollPositionProperty The scroll position of the scrollable container // (from 0.0 -> 1.0 in each axis)
  75    * @return The new indicator position is returned.
  76    */
  77   Vector3 operator()(const Vector3& current,
  78                      const PropertyInput& indicatorSizeProperty,
  79                      const PropertyInput& parentSizeProperty,
  80                      const PropertyInput& scrollPositionProperty)
  81   {
  82     Vector3 indicatorSize = indicatorSizeProperty.GetVector3();
  83     Vector3 parentSize = parentSizeProperty.GetVector3();
  84     float scrollPosition = scrollPositionProperty.GetFloat();
  85
  86     const float domainSize = fabs(mMaxPosition - mMinPosition);
  87     float relativePosition = (mMaxPosition - scrollPosition) / domainSize;
  88     return Vector3(current.x, relativePosition * (parentSize.height - indicatorSize.height), DEFAULT_SLIDER_DEPTH);
  89   }
  90
  91   float mMinPosition;  ///< The minimum scroll position
  92   float mMaxPosition;  ///< The maximum scroll position
  93 };
  94
  95 } // unnamed namespace
  96
  97 namespace Dali
  98 {
  99
 100 namespace Toolkit
 101 {
 102
 103 const Property::Index ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX );
 104 const Property::Index ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 1 );
 105 const Property::Index ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 2 );
 106 const Property::Index ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 3 );
 107
 108 namespace Internal
 109 {
 110
 111 namespace
 112 {
 113
 114 using namespace Dali;
 115
 116 const char* INDICATOR_HEIGHT_POLICY_NAME[] = {"Variable", "Fixed"};
 117
 118 BaseHandle Create()
 119 {
 120   return Toolkit::ScrollBar::New();
 121 }
 122
 123 TypeRegistration typeRegistration( typeid(Toolkit::ScrollBar), typeid(Toolkit::ScrollComponent), Create );
 124
 125 PropertyRegistration property1( typeRegistration, "indicator-height-policy", Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY, Property::STRING, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
 126 PropertyRegistration property2( typeRegistration, "indicator-fixed-height",  Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT,  Property::FLOAT,  &ScrollBar::SetProperty, &ScrollBar::GetProperty );
 127 PropertyRegistration property3( typeRegistration, "indicator-show-duration",  Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION,  Property::FLOAT,  &ScrollBar::SetProperty, &ScrollBar::GetProperty );
 128 PropertyRegistration property4( typeRegistration, "indicator-hide-duration",  Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION,  Property::FLOAT,  &ScrollBar::SetProperty, &ScrollBar::GetProperty );
 129 }
 130
 131 ScrollBar::ScrollBar()
 132 : mIndicatorShowDuration(DEFAULT_INDICATOR_SHOW_DURATION),
 133   mIndicatorHideDuration(DEFAULT_INDICATOR_HIDE_DURATION),
 134   mScrollStart(0.0f),
 135   mIsPanning(false),
 136   mCurrentScrollPosition(0.0f),
 137   mIndicatorHeightPolicy(Toolkit::ScrollBar::Variable),
 138   mIndicatorFixedHeight(DEFAULT_INDICATOR_FIXED_HEIGHT),
 139   mPropertyIndicatorPosition(Property::INVALID_INDEX)
 140 {
 141 }
 142
 143 ScrollBar::~ScrollBar()
 144 {
 145 }
 146
 147 void ScrollBar::OnInitialize()
 148 {
 149   Actor self = Self();
 150
 151   Image indicatorImage = Image::New( DEFAULT_INDICATOR_IMAGE_PATH );
 152   mIndicator = ImageActor::New( indicatorImage );
 153   mIndicator.SetNinePatchBorder( DEFAULT_INDICATOR_NINE_PATCH_BORDER );
 154   mIndicator.SetStyle( ImageActor::STYLE_NINE_PATCH );
 155   mIndicator.SetParentOrigin( ParentOrigin::TOP_LEFT );
 156   mIndicator.SetAnchorPoint( AnchorPoint::TOP_LEFT );
 157   self.Add(mIndicator);
 158
 159   self.SetDrawMode(DrawMode::OVERLAY);
 160
 161   // Enable the pan gesture which is attached to the control
 162   EnableGestureDetection(Gesture::Type(Gesture::Pan));
 163 }
 164
 165 void ScrollBar::OnScrollConnectorSet( Toolkit::ScrollConnector oldConnector )
 166 {
 167   if( oldConnector )
 168   {
 169     oldConnector.DomainChangedSignal().Disconnect(this, &ScrollBar::OnScrollDomainChanged);
 170
 171     mScrollPositionObject.Reset();
 172   }
 173
 174   if( mScrollConnector )
 175   {
 176     mScrollPositionObject = mScrollConnector.GetScrollPositionObject();
 177
 178     ApplyConstraints();
 179     mScrollConnector.DomainChangedSignal().Connect(this, &ScrollBar::OnScrollDomainChanged);
 180   }
 181 }
 182
 183 void ScrollBar::SetIndicatorImage( Image image )
 184 {
 185   mIndicator.SetImage(image);
 186 }
 187
 188 Actor ScrollBar::GetScrollIndicator()
 189 {
 190   return mIndicator;
 191 }
 192
 193 void ScrollBar::ApplyConstraints()
 194 {
 195   if( mScrollConnector )
 196   {
 197     Constraint constraint;
 198
 199     if(mIndicatorSizeConstraint)
 200     {
 201       mIndicator.RemoveConstraint(mIndicatorSizeConstraint);
 202     }
 203
 204     // Set indicator height according to the indicator's height policy
 205     if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
 206     {
 207       mIndicator.SetSize(Self().GetCurrentSize().width, mIndicatorFixedHeight);
 208     }
 209     else
 210     {
 211       mIndicator.SetSize( IndicatorSize( Self().GetCurrentSize(), mScrollConnector.GetContentLength() ) );
 212     }
 213
 214     if(mIndicatorPositionConstraint)
 215     {
 216       mIndicator.RemoveConstraint(mIndicatorPositionConstraint);
 217     }
 218
 219     constraint = Constraint::New<Vector3>( Actor::POSITION,
 220                                            LocalSource( Actor::SIZE ),
 221                                            ParentSource( Actor::SIZE ),
 222                                            Source( mScrollPositionObject, Toolkit::ScrollConnector::SCROLL_POSITION ),
 223                                            IndicatorPositionConstraint( mScrollConnector.GetMinLimit(), mScrollConnector.GetMaxLimit() ) );
 224     mIndicatorPositionConstraint = mIndicator.ApplyConstraint( constraint );
 225   }
 226 }
 227
 228 void ScrollBar::SetPositionNotifications( const std::vector<float>& positions )
 229 {
 230   if(mScrollPositionObject)
 231   {
 232     if(mPositionNotification)
 233     {
 234       mScrollPositionObject.RemovePropertyNotification(mPositionNotification);
 235     }
 236     mPositionNotification = mScrollPositionObject.AddPropertyNotification( Toolkit::ScrollConnector::SCROLL_POSITION, VariableStepCondition(positions) );
 237     mPositionNotification.NotifySignal().Connect( this, &ScrollBar::OnScrollPositionNotified );
 238   }
 239 }
 240
 241 void ScrollBar::OnScrollPositionNotified(PropertyNotification& source)
 242 {
 243   // Emit the signal to notify the scroll position crossing
 244   mScrollPositionNotifiedSignal.Emit(mScrollConnector.GetScrollPosition());
 245 }
 246
 247 void ScrollBar::Show()
 248 {
 249   // Cancel any animation
 250   if(mAnimation)
 251   {
 252     mAnimation.Clear();
 253     mAnimation.Reset();
 254   }
 255
 256   if(mIndicatorShowDuration > 0.0f)
 257   {
 258     mAnimation = Animation::New( mIndicatorShowDuration );
 259     mAnimation.OpacityTo( Self(), 1.0f, AlphaFunctions::EaseIn );
 260     mAnimation.Play();
 261   }
 262   else
 263   {
 264     Self().SetOpacity(1.0f);
 265   }
 266 }
 267
 268 void ScrollBar::Hide()
 269 {
 270   // Cancel any animation
 271   if(mAnimation)
 272   {
 273     mAnimation.Clear();
 274     mAnimation.Reset();
 275   }
 276
 277   if(mIndicatorHideDuration > 0.0f)
 278   {
 279     mAnimation = Animation::New( mIndicatorHideDuration );
 280     mAnimation.OpacityTo( Self(), 0.0f, AlphaFunctions::EaseIn );
 281     mAnimation.Play();
 282   }
 283   else
 284   {
 285     Self().SetOpacity(0.0f);
 286   }
 287 }
 288
 289 bool ScrollBar::OnPanGestureProcessTick()
 290 {
 291   // Update the scroll position property.
 292   if( mScrollConnector )
 293   {
 294     mScrollConnector.SetScrollPosition(mCurrentScrollPosition);
 295   }
 296
 297   return true;
 298 }
 299
 300 void ScrollBar::OnPan( PanGesture gesture )
 301 {
 302   if(mScrollConnector)
 303   {
 304     Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast(Self().GetParent());
 305
 306     switch(gesture.state)
 307     {
 308       case Gesture::Started:
 309       {
 310         if( !mTimer )
 311         {
 312           // Make sure the pan gesture is only being processed once per frame.
 313           mTimer = Timer::New( DEFAULT_PAN_GESTURE_PROCESS_TIME );
 314           mTimer.TickSignal().Connect( this, &ScrollBar::OnPanGestureProcessTick );
 315           mTimer.Start();
 316         }
 317
 318         Show();
 319         mScrollStart = mScrollConnector.GetScrollPosition();
 320         mGestureDisplacement = Vector3::ZERO;
 321         mIsPanning = true;
 322
 323         break;
 324       }
 325       case Gesture::Continuing:
 326       {
 327         Vector3 delta(gesture.displacement.x, gesture.displacement.y, 0.0f);
 328         mGestureDisplacement+=delta;
 329
 330         Vector3 span = Self().GetCurrentSize() - mIndicator.GetCurrentSize();
 331         const float domainSize = fabs(mScrollConnector.GetMaxLimit() - mScrollConnector.GetMinLimit());
 332         mCurrentScrollPosition = mScrollStart - mGestureDisplacement.y * domainSize / span.y;
 333         mCurrentScrollPosition = std::min(mScrollConnector.GetMaxLimit(), std::max(mCurrentScrollPosition, mScrollConnector.GetMinLimit()));
 334
 335         break;
 336       }
 337       default:
 338       {
 339         mIsPanning = false;
 340
 341         if( mTimer )
 342         {
 343           // Destroy the timer when pan gesture is finished.
 344           mTimer.Stop();
 345           mTimer.TickSignal().Disconnect( this, &ScrollBar::OnPanGestureProcessTick );
 346           mTimer.Reset();
 347         }
 348
 349         if(itemView)
 350         {
 351           // Refresh the ItemView cache with extra items
 352           GetImpl(itemView).DoRefresh(mCurrentScrollPosition, true);
 353         }
 354
 355         break;
 356       }
 357     }
 358
 359     if(itemView)
 360     {
 361       // Disable automatic refresh in ItemView during fast scrolling
 362       GetImpl(itemView).SetRefreshEnabled(!mIsPanning);
 363     }
 364   }
 365 }
 366
 367 void ScrollBar::OnControlSizeSet( const Vector3& size )
 368 {
 369   if(mIndicatorHeightPolicy != Toolkit::ScrollBar::Fixed && mScrollConnector)
 370   {
 371     mIndicator.SetSize( IndicatorSize( size, mScrollConnector.GetContentLength() ) );
 372   }
 373 }
 374
 375 void ScrollBar::OnScrollDomainChanged(float minPosition, float maxPosition, float contentSize)
 376 {
 377   // Reapply constraints when the scroll domain is changed
 378   ApplyConstraints();
 379 }
 380
 381 void ScrollBar::SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy )
 382 {
 383   mIndicatorHeightPolicy = policy;
 384   ApplyConstraints();
 385 }
 386
 387 Toolkit::ScrollBar::IndicatorHeightPolicy ScrollBar::GetIndicatorHeightPolicy()
 388 {
 389   return mIndicatorHeightPolicy;
 390 }
 391
 392 void ScrollBar::SetIndicatorFixedHeight( float height )
 393 {
 394   mIndicatorFixedHeight = height;
 395   ApplyConstraints();
 396 }
 397
 398 float ScrollBar::GetIndicatorFixedHeight()
 399 {
 400   return mIndicatorFixedHeight;
 401 }
 402
 403 void ScrollBar::SetIndicatorShowDuration( float durationSeconds )
 404 {
 405   mIndicatorShowDuration = durationSeconds;
 406 }
 407
 408 float ScrollBar::GetIndicatorShowDuration()
 409 {
 410   return mIndicatorShowDuration;
 411 }
 412
 413 void ScrollBar::SetIndicatorHideDuration( float durationSeconds )
 414 {
 415   mIndicatorHideDuration = durationSeconds;
 416 }
 417
 418 float ScrollBar::GetIndicatorHideDuration()
 419 {
 420   return mIndicatorHideDuration;
 421 }
 422
 423 void ScrollBar::OnIndicatorHeightPolicyPropertySet( Property::Value propertyValue )
 424 {
 425   std::string policyName( propertyValue.Get<std::string>() );
 426   if(policyName == "Variable")
 427   {
 428     SetIndicatorHeightPolicy(Toolkit::ScrollBar::Variable);
 429   }
 430   else if(policyName == "Fixed")
 431   {
 432     SetIndicatorHeightPolicy(Toolkit::ScrollBar::Fixed);
 433   }
 434   else
 435   {
 436     DALI_ASSERT_ALWAYS( !"ScrollBar::OnIndicatorHeightPolicyPropertySet(). Invalid Property value." );
 437   }
 438 }
 439
 440 void ScrollBar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 441 {
 442   Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
 443
 444   if( scrollBar )
 445   {
 446     ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
 447     switch( index )
 448     {
 449       case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
 450       {
 451         scrollBarImpl.OnIndicatorHeightPolicyPropertySet( value );
 452         break;
 453       }
 454       case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
 455       {
 456         scrollBarImpl.SetIndicatorFixedHeight(value.Get<float>());
 457         break;
 458       }
 459       case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
 460       {
 461         scrollBarImpl.SetIndicatorShowDuration(value.Get<float>());
 462         break;
 463       }
 464       case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
 465       {
 466         scrollBarImpl.SetIndicatorHideDuration(value.Get<float>());
 467         break;
 468       }
 469     }
 470   }
 471 }
 472
 473 Property::Value ScrollBar::GetProperty( BaseObject* object, Property::Index index )
 474 {
 475   Property::Value value;
 476
 477   Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
 478
 479   if( scrollBar )
 480   {
 481     ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
 482     switch( index )
 483     {
 484       case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
 485       {
 486         value = INDICATOR_HEIGHT_POLICY_NAME[ scrollBarImpl.GetIndicatorHeightPolicy() ];
 487         break;
 488       }
 489       case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
 490       {
 491         value = scrollBarImpl.GetIndicatorFixedHeight();
 492         break;
 493       }
 494       case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
 495       {
 496         value = scrollBarImpl.GetIndicatorShowDuration();
 497         break;
 498       }
 499       case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
 500       {
 501         value = scrollBarImpl.GetIndicatorHideDuration();
 502         break;
 503       }
 504     }
 505   }
 506   return value;
 507 }
 508
 509 Toolkit::ScrollBar ScrollBar::New()
 510 {
 511   // Create the implementation, temporarily owned by this handle on stack
 512   IntrusivePtr< ScrollBar > impl = new ScrollBar();
 513
 514   // Pass ownership to CustomActor handle
 515   Toolkit::ScrollBar handle( *impl );
 516
 517   // Second-phase init of the implementation
 518   // This can only be done after the CustomActor connection has been made...
 519   impl->Initialize();
 520
 521   return handle;
 522 }
 523
 524 } // namespace Internal
 525
 526 } // namespace Toolkit
 527
 528 } // namespace Dali