2 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h>
22 #include <dali/public-api/animation/constraints.h>
23 #include <dali/public-api/object/type-registry.h>
24 #include <dali/public-api/images/resource-image.h>
27 #include <dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h>
34 const char* DEFAULT_INDICATOR_IMAGE_PATH = DALI_IMAGE_DIR "popup_scroll.png";
35 const Vector4 DEFAULT_INDICATOR_NINE_PATCH_BORDER(4.0f, 9.0f, 7.0f, 11.0f);
36 const float MINIMUM_INDICATOR_HEIGHT(20.0f); // The minimum indicator height for the nine patch border
37 const float DEFAULT_SLIDER_DEPTH(1.0f);
38 const float DEFAULT_INDICATOR_SHOW_DURATION(0.5f);
39 const float DEFAULT_INDICATOR_HIDE_DURATION(0.5f);
40 const float DEFAULT_PAN_GESTURE_PROCESS_TIME(16.7f); // 16.7 milliseconds, i.e. one frame
41 const float DEFAULT_INDICATOR_FIXED_HEIGHT(80.0f);
44 * Indicator size depends on both indicator's parent size and the scroll content size
46 Vector3 IndicatorSize( const Vector3& parentSize, float contentSize)
48 float height = contentSize > parentSize.height ?
49 parentSize.height * ( parentSize.height / contentSize ) :
50 parentSize.height * ( (parentSize.height - contentSize * 0.5f) / parentSize.height);
51 return Vector3( parentSize.width, std::max(MINIMUM_INDICATOR_HEIGHT, height), parentSize.depth );
55 * Indicator position constraint
56 * Positions the indicator to reflect the current scroll position within the scroll domain.
58 struct IndicatorPositionConstraint
61 * @param[in] minPosition The minimum limit of scroll position
62 * @param[in] maxPosition the maximum limit of scroll position
64 IndicatorPositionConstraint(float minPosition, float maxPosition)
65 : mMinPosition(minPosition),
66 mMaxPosition(maxPosition)
72 * @param[in] current The current indicator position
73 * @param[in] indicatorSizeProperty The size of indicator.
74 * @param[in] parentSizeProperty The parent size of indicator.
75 * @param[in] scrollPositionProperty The scroll position of the scrollable container // (from 0.0 -> 1.0 in each axis)
76 * @return The new indicator position is returned.
78 Vector3 operator()(const Vector3& current,
79 const PropertyInput& indicatorSizeProperty,
80 const PropertyInput& parentSizeProperty,
81 const PropertyInput& scrollPositionProperty)
83 Vector3 indicatorSize = indicatorSizeProperty.GetVector3();
84 Vector3 parentSize = parentSizeProperty.GetVector3();
85 float scrollPosition = scrollPositionProperty.GetFloat();
87 const float domainSize = fabs(mMaxPosition - mMinPosition);
88 float relativePosition = (mMaxPosition - scrollPosition) / domainSize;
89 return Vector3(current.x, relativePosition * (parentSize.height - indicatorSize.height), DEFAULT_SLIDER_DEPTH);
92 float mMinPosition; ///< The minimum scroll position
93 float mMaxPosition; ///< The maximum scroll position
96 } // unnamed namespace
104 const Property::Index ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX );
105 const Property::Index ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 1 );
106 const Property::Index ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 2 );
107 const Property::Index ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 3 );
115 using namespace Dali;
117 const char* INDICATOR_HEIGHT_POLICY_NAME[] = {"Variable", "Fixed"};
121 return Toolkit::ScrollBar::New();
124 TypeRegistration typeRegistration( typeid( Toolkit::ScrollBar ), typeid( Toolkit::ScrollComponent ), Create );
126 const char* const SCROLL_POSITION_NOTIFIED_SIGNAL_NAME = "scroll-position-notified";
128 PropertyRegistration property1( typeRegistration, "indicator-height-policy", Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY, Property::STRING, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
129 PropertyRegistration property2( typeRegistration, "indicator-fixed-height", Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
130 PropertyRegistration property3( typeRegistration, "indicator-show-duration", Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
131 PropertyRegistration property4( typeRegistration, "indicator-hide-duration", Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
134 ScrollBar::ScrollBar()
135 : mIndicatorShowDuration(DEFAULT_INDICATOR_SHOW_DURATION),
136 mIndicatorHideDuration(DEFAULT_INDICATOR_HIDE_DURATION),
139 mCurrentScrollPosition(0.0f),
140 mIndicatorHeightPolicy(Toolkit::ScrollBar::Variable),
141 mIndicatorFixedHeight(DEFAULT_INDICATOR_FIXED_HEIGHT),
142 mPropertyIndicatorPosition(Property::INVALID_INDEX)
146 ScrollBar::~ScrollBar()
150 void ScrollBar::OnInitialize()
154 Image indicatorImage = ResourceImage::New( DEFAULT_INDICATOR_IMAGE_PATH );
155 mIndicator = ImageActor::New( indicatorImage );
156 mIndicator.SetNinePatchBorder( DEFAULT_INDICATOR_NINE_PATCH_BORDER );
157 mIndicator.SetStyle( ImageActor::STYLE_NINE_PATCH );
158 mIndicator.SetParentOrigin( ParentOrigin::TOP_LEFT );
159 mIndicator.SetAnchorPoint( AnchorPoint::TOP_LEFT );
160 self.Add(mIndicator);
162 self.SetDrawMode(DrawMode::OVERLAY);
164 // Enable the pan gesture which is attached to the control
165 EnableGestureDetection(Gesture::Type(Gesture::Pan));
168 void ScrollBar::OnScrollConnectorSet( Toolkit::ScrollConnector oldConnector )
172 oldConnector.DomainChangedSignal().Disconnect(this, &ScrollBar::OnScrollDomainChanged);
174 mScrollPositionObject.Reset();
177 if( mScrollConnector )
179 mScrollPositionObject = mScrollConnector.GetScrollPositionObject();
182 mScrollConnector.DomainChangedSignal().Connect(this, &ScrollBar::OnScrollDomainChanged);
186 void ScrollBar::SetIndicatorImage( Image image )
188 mIndicator.SetImage(image);
191 Actor ScrollBar::GetScrollIndicator()
196 void ScrollBar::ApplyConstraints()
198 if( mScrollConnector )
200 Constraint constraint;
202 if(mIndicatorSizeConstraint)
204 mIndicator.RemoveConstraint(mIndicatorSizeConstraint);
207 // Set indicator height according to the indicator's height policy
208 if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
210 mIndicator.SetSize(Self().GetCurrentSize().width, mIndicatorFixedHeight);
214 mIndicator.SetSize( IndicatorSize( Self().GetCurrentSize(), mScrollConnector.GetContentLength() ) );
217 if(mIndicatorPositionConstraint)
219 mIndicator.RemoveConstraint(mIndicatorPositionConstraint);
222 constraint = Constraint::New<Vector3>( Actor::POSITION,
223 LocalSource( Actor::SIZE ),
224 ParentSource( Actor::SIZE ),
225 Source( mScrollPositionObject, Toolkit::ScrollConnector::SCROLL_POSITION ),
226 IndicatorPositionConstraint( mScrollConnector.GetMinLimit(), mScrollConnector.GetMaxLimit() ) );
227 mIndicatorPositionConstraint = mIndicator.ApplyConstraint( constraint );
231 void ScrollBar::SetPositionNotifications( const std::vector<float>& positions )
233 if(mScrollPositionObject)
235 if(mPositionNotification)
237 mScrollPositionObject.RemovePropertyNotification(mPositionNotification);
239 mPositionNotification = mScrollPositionObject.AddPropertyNotification( Toolkit::ScrollConnector::SCROLL_POSITION, VariableStepCondition(positions) );
240 mPositionNotification.NotifySignal().Connect( this, &ScrollBar::OnScrollPositionNotified );
244 void ScrollBar::OnScrollPositionNotified(PropertyNotification& source)
246 // Emit the signal to notify the scroll position crossing
247 mScrollPositionNotifiedSignal.Emit(mScrollConnector.GetScrollPosition());
250 void ScrollBar::Show()
252 // Cancel any animation
259 if(mIndicatorShowDuration > 0.0f)
261 mAnimation = Animation::New( mIndicatorShowDuration );
262 mAnimation.OpacityTo( Self(), 1.0f, AlphaFunctions::EaseIn );
267 Self().SetOpacity(1.0f);
271 void ScrollBar::Hide()
273 // Cancel any animation
280 if(mIndicatorHideDuration > 0.0f)
282 mAnimation = Animation::New( mIndicatorHideDuration );
283 mAnimation.OpacityTo( Self(), 0.0f, AlphaFunctions::EaseIn );
288 Self().SetOpacity(0.0f);
292 bool ScrollBar::OnPanGestureProcessTick()
294 // Update the scroll position property.
295 if( mScrollConnector )
297 mScrollConnector.SetScrollPosition(mCurrentScrollPosition);
303 void ScrollBar::OnPan( PanGesture gesture )
307 Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast(Self().GetParent());
309 switch(gesture.state)
311 case Gesture::Started:
315 // Make sure the pan gesture is only being processed once per frame.
316 mTimer = Timer::New( DEFAULT_PAN_GESTURE_PROCESS_TIME );
317 mTimer.TickSignal().Connect( this, &ScrollBar::OnPanGestureProcessTick );
322 mScrollStart = mScrollConnector.GetScrollPosition();
323 mGestureDisplacement = Vector3::ZERO;
328 case Gesture::Continuing:
330 Vector3 delta(gesture.displacement.x, gesture.displacement.y, 0.0f);
331 mGestureDisplacement+=delta;
333 Vector3 span = Self().GetCurrentSize() - mIndicator.GetCurrentSize();
334 const float domainSize = fabs(mScrollConnector.GetMaxLimit() - mScrollConnector.GetMinLimit());
335 mCurrentScrollPosition = mScrollStart - mGestureDisplacement.y * domainSize / span.y;
336 mCurrentScrollPosition = std::min(mScrollConnector.GetMaxLimit(), std::max(mCurrentScrollPosition, mScrollConnector.GetMinLimit()));
346 // Destroy the timer when pan gesture is finished.
348 mTimer.TickSignal().Disconnect( this, &ScrollBar::OnPanGestureProcessTick );
354 // Refresh the ItemView cache with extra items
355 GetImpl(itemView).DoRefresh(mCurrentScrollPosition, true);
364 // Disable automatic refresh in ItemView during fast scrolling
365 GetImpl(itemView).SetRefreshEnabled(!mIsPanning);
370 void ScrollBar::OnControlSizeSet( const Vector3& size )
372 if(mIndicatorHeightPolicy != Toolkit::ScrollBar::Fixed && mScrollConnector)
374 mIndicator.SetSize( IndicatorSize( size, mScrollConnector.GetContentLength() ) );
378 void ScrollBar::OnScrollDomainChanged(float minPosition, float maxPosition, float contentSize)
380 // Reapply constraints when the scroll domain is changed
384 void ScrollBar::SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy )
386 mIndicatorHeightPolicy = policy;
390 Toolkit::ScrollBar::IndicatorHeightPolicy ScrollBar::GetIndicatorHeightPolicy()
392 return mIndicatorHeightPolicy;
395 void ScrollBar::SetIndicatorFixedHeight( float height )
397 mIndicatorFixedHeight = height;
401 float ScrollBar::GetIndicatorFixedHeight()
403 return mIndicatorFixedHeight;
406 void ScrollBar::SetIndicatorShowDuration( float durationSeconds )
408 mIndicatorShowDuration = durationSeconds;
411 float ScrollBar::GetIndicatorShowDuration()
413 return mIndicatorShowDuration;
416 void ScrollBar::SetIndicatorHideDuration( float durationSeconds )
418 mIndicatorHideDuration = durationSeconds;
421 float ScrollBar::GetIndicatorHideDuration()
423 return mIndicatorHideDuration;
426 void ScrollBar::OnIndicatorHeightPolicyPropertySet( Property::Value propertyValue )
428 std::string policyName( propertyValue.Get<std::string>() );
429 if(policyName == "Variable")
431 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Variable);
433 else if(policyName == "Fixed")
435 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Fixed);
439 DALI_ASSERT_ALWAYS( !"ScrollBar::OnIndicatorHeightPolicyPropertySet(). Invalid Property value." );
443 bool ScrollBar::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
445 Dali::BaseHandle handle( object );
447 bool connected( true );
448 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( handle );
450 if( 0 == strcmp( signalName.c_str(), SCROLL_POSITION_NOTIFIED_SIGNAL_NAME ) )
452 scrollBar.ScrollPositionNotifiedSignal().Connect( tracker, functor );
456 // signalName does not match any signal
463 void ScrollBar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
465 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
469 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
472 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
474 scrollBarImpl.OnIndicatorHeightPolicyPropertySet( value );
477 case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
479 scrollBarImpl.SetIndicatorFixedHeight(value.Get<float>());
482 case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
484 scrollBarImpl.SetIndicatorShowDuration(value.Get<float>());
487 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
489 scrollBarImpl.SetIndicatorHideDuration(value.Get<float>());
496 Property::Value ScrollBar::GetProperty( BaseObject* object, Property::Index index )
498 Property::Value value;
500 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
504 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
507 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
509 value = INDICATOR_HEIGHT_POLICY_NAME[ scrollBarImpl.GetIndicatorHeightPolicy() ];
512 case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
514 value = scrollBarImpl.GetIndicatorFixedHeight();
517 case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
519 value = scrollBarImpl.GetIndicatorShowDuration();
522 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
524 value = scrollBarImpl.GetIndicatorHideDuration();
532 Toolkit::ScrollBar ScrollBar::New()
534 // Create the implementation, temporarily owned by this handle on stack
535 IntrusivePtr< ScrollBar > impl = new ScrollBar();
537 // Pass ownership to CustomActor handle
538 Toolkit::ScrollBar handle( *impl );
540 // Second-phase init of the implementation
541 // This can only be done after the CustomActor connection has been made...
547 } // namespace Internal
549 } // namespace Toolkit