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>
26 #include <dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h>
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);
43 * Indicator size constraint
44 * Indicator size depends on both indicator's parent size and the scroll content size
46 struct IndicatorSizeConstraint
49 * @param[in] contentSize The size of scrollable content
51 IndicatorSizeConstraint(float contentSize)
52 : mContentSize(contentSize)
58 * @param[in] current The current indicator size
59 * @param[in] parentSizeProperty The parent size of scroll indicator.
60 * @return The new scroll indicator size.
62 Vector3 operator()(const Vector3& current,
63 const PropertyInput& parentSizeProperty)
65 const Vector3& parentSize = parentSizeProperty.GetVector3();
66 float height = mContentSize > parentSize.height ? parentSize.height * ( parentSize.height / mContentSize ) : parentSize.height * ( (parentSize.height - mContentSize * 0.5f) / parentSize.height);
67 return Vector3( parentSize.width, std::max(MINIMUM_INDICATOR_HEIGHT, height), parentSize.depth );
70 float mContentSize; ///< The size of scrollable content
74 * Indicator position constraint
75 * Positions the indicator to reflect the current scroll position within the scroll domain.
77 struct IndicatorPositionConstraint
80 * @param[in] minPosition The minimum limit of scroll position
81 * @param[in] maxPosition the maximum limit of scroll position
83 IndicatorPositionConstraint(float minPosition, float maxPosition)
84 : mMinPosition(minPosition),
85 mMaxPosition(maxPosition)
91 * @param[in] current The current indicator position
92 * @param[in] indicatorSizeProperty The size of indicator.
93 * @param[in] parentSizeProperty The parent size of indicator.
94 * @param[in] scrollPositionProperty The scroll position of the scrollable container // (from 0.0 -> 1.0 in each axis)
95 * @return The new indicator position is returned.
97 Vector3 operator()(const Vector3& current,
98 const PropertyInput& indicatorSizeProperty,
99 const PropertyInput& parentSizeProperty,
100 const PropertyInput& scrollPositionProperty)
102 Vector3 indicatorSize = indicatorSizeProperty.GetVector3();
103 Vector3 parentSize = parentSizeProperty.GetVector3();
104 float scrollPosition = scrollPositionProperty.GetFloat();
106 const float domainSize = fabs(mMaxPosition - mMinPosition);
107 float relativePosition = (mMaxPosition - scrollPosition) / domainSize;
108 return Vector3(current.x, relativePosition * (parentSize.height - indicatorSize.height), DEFAULT_SLIDER_DEPTH);
111 float mMinPosition; ///< The minimum scroll position
112 float mMaxPosition; ///< The maximum scroll position
115 } // unnamed namespace
123 const Property::Index ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX );
124 const Property::Index ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 1 );
125 const Property::Index ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 2 );
126 const Property::Index ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 3 );
134 using namespace Dali;
136 const char* INDICATOR_HEIGHT_POLICY_NAME[] = {"Variable", "Fixed"};
140 return Toolkit::ScrollBar::New();
143 TypeRegistration typeRegistration( typeid(Toolkit::ScrollBar), typeid(Toolkit::ScrollComponent), Create );
145 PropertyRegistration property1( typeRegistration, "indicator-height-policy", Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY, Property::STRING, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
146 PropertyRegistration property2( typeRegistration, "indicator-fixed-height", Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
147 PropertyRegistration property3( typeRegistration, "indicator-show-duration", Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
148 PropertyRegistration property4( typeRegistration, "indicator-hide-duration", Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
151 ScrollBar::ScrollBar()
152 : mIndicatorShowDuration(DEFAULT_INDICATOR_SHOW_DURATION),
153 mIndicatorHideDuration(DEFAULT_INDICATOR_HIDE_DURATION),
156 mCurrentScrollPosition(0.0f),
157 mIndicatorHeightPolicy(Toolkit::ScrollBar::Variable),
158 mIndicatorFixedHeight(DEFAULT_INDICATOR_FIXED_HEIGHT),
159 mPropertyIndicatorPosition(Property::INVALID_INDEX)
163 ScrollBar::~ScrollBar()
167 void ScrollBar::OnInitialize()
171 Image indicatorImage = Image::New( DEFAULT_INDICATOR_IMAGE_PATH );
172 mIndicator = ImageActor::New( indicatorImage );
173 mIndicator.SetNinePatchBorder( DEFAULT_INDICATOR_NINE_PATCH_BORDER );
174 mIndicator.SetStyle( ImageActor::STYLE_NINE_PATCH );
175 mIndicator.SetParentOrigin( ParentOrigin::TOP_LEFT );
176 mIndicator.SetAnchorPoint( AnchorPoint::TOP_LEFT );
177 self.Add(mIndicator);
179 self.SetDrawMode(DrawMode::OVERLAY);
181 // Enable the pan gesture which is attached to the control
182 EnableGestureDetection(Gesture::Type(Gesture::Pan));
185 void ScrollBar::OnScrollConnectorSet( Toolkit::ScrollConnector oldConnector )
189 oldConnector.DomainChangedSignal().Disconnect(this, &ScrollBar::OnScrollDomainChanged);
191 mScrollPositionObject.Reset();
194 if( mScrollConnector )
196 mScrollPositionObject = mScrollConnector.GetScrollPositionObject();
199 mScrollConnector.DomainChangedSignal().Connect(this, &ScrollBar::OnScrollDomainChanged);
203 void ScrollBar::SetIndicatorImage( Image image )
205 mIndicator.SetImage(image);
208 Actor ScrollBar::GetScrollIndicator()
213 void ScrollBar::ApplyConstraints()
215 if( mScrollConnector )
217 Constraint constraint;
219 if(mIndicatorSizeConstraint)
221 mIndicator.RemoveConstraint(mIndicatorSizeConstraint);
224 // Set indicator height according to the indicator's height policy
225 if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
227 mIndicator.SetSize(Self().GetCurrentSize().width, mIndicatorFixedHeight);
231 constraint = Constraint::New<Vector3>( Actor::SIZE,
232 ParentSource( Actor::SIZE ),
233 IndicatorSizeConstraint( mScrollConnector.GetContentLength() ) );
234 mIndicatorSizeConstraint = mIndicator.ApplyConstraint( constraint );
237 if(mIndicatorPositionConstraint)
239 mIndicator.RemoveConstraint(mIndicatorPositionConstraint);
242 constraint = Constraint::New<Vector3>( Actor::POSITION,
243 LocalSource( Actor::SIZE ),
244 ParentSource( Actor::SIZE ),
245 Source( mScrollPositionObject, Toolkit::ScrollConnector::SCROLL_POSITION ),
246 IndicatorPositionConstraint( mScrollConnector.GetMinLimit(), mScrollConnector.GetMaxLimit() ) );
247 mIndicatorPositionConstraint = mIndicator.ApplyConstraint( constraint );
251 mBackground.RemoveConstraints();
253 constraint = Constraint::New<Vector3>(Actor::SIZE,
254 ParentSource(Actor::SIZE),
255 EqualToConstraint());
256 mBackground.ApplyConstraint(constraint);
261 void ScrollBar::SetPositionNotifications( const std::vector<float>& positions )
263 if(mScrollPositionObject)
265 if(mPositionNotification)
267 mScrollPositionObject.RemovePropertyNotification(mPositionNotification);
269 mPositionNotification = mScrollPositionObject.AddPropertyNotification( Toolkit::ScrollConnector::SCROLL_POSITION, VariableStepCondition(positions) );
270 mPositionNotification.NotifySignal().Connect( this, &ScrollBar::OnScrollPositionNotified );
274 void ScrollBar::OnScrollPositionNotified(PropertyNotification& source)
276 // Emit the signal to notify the scroll position crossing
277 mScrollPositionNotifiedSignal.Emit(mScrollConnector.GetScrollPosition());
280 void ScrollBar::Show()
282 // Cancel any animation
289 if(mIndicatorShowDuration > 0.0f)
291 mAnimation = Animation::New( mIndicatorShowDuration );
292 mAnimation.OpacityTo( Self(), 1.0f, AlphaFunctions::EaseIn );
297 Self().SetOpacity(1.0f);
301 void ScrollBar::Hide()
303 // Cancel any animation
310 if(mIndicatorHideDuration > 0.0f)
312 mAnimation = Animation::New( mIndicatorHideDuration );
313 mAnimation.OpacityTo( Self(), 0.0f, AlphaFunctions::EaseIn );
318 Self().SetOpacity(0.0f);
322 bool ScrollBar::OnPanGestureProcessTick()
324 // Update the scroll position property.
325 if( mScrollConnector )
327 mScrollConnector.SetScrollPosition(mCurrentScrollPosition);
333 void ScrollBar::OnPan( PanGesture gesture )
337 Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast(Self().GetParent());
339 switch(gesture.state)
341 case Gesture::Started:
345 // Make sure the pan gesture is only being processed once per frame.
346 mTimer = Timer::New( DEFAULT_PAN_GESTURE_PROCESS_TIME );
347 mTimer.TickSignal().Connect( this, &ScrollBar::OnPanGestureProcessTick );
352 mScrollStart = mScrollConnector.GetScrollPosition();
353 mGestureDisplacement = Vector3::ZERO;
358 case Gesture::Continuing:
360 Vector3 delta(gesture.displacement.x, gesture.displacement.y, 0.0f);
361 mGestureDisplacement+=delta;
363 Vector3 span = Self().GetCurrentSize() - mIndicator.GetCurrentSize();
364 const float domainSize = fabs(mScrollConnector.GetMaxLimit() - mScrollConnector.GetMinLimit());
365 mCurrentScrollPosition = mScrollStart - mGestureDisplacement.y * domainSize / span.y;
366 mCurrentScrollPosition = std::min(mScrollConnector.GetMaxLimit(), std::max(mCurrentScrollPosition, mScrollConnector.GetMinLimit()));
376 // Destroy the timer when pan gesture is finished.
378 mTimer.TickSignal().Disconnect( this, &ScrollBar::OnPanGestureProcessTick );
384 // Refresh the ItemView cache with extra items
385 GetImpl(itemView).DoRefresh(mCurrentScrollPosition, true);
394 // Disable automatic refresh in ItemView during fast scrolling
395 GetImpl(itemView).SetRefreshEnabled(!mIsPanning);
400 void ScrollBar::OnScrollDomainChanged(float minPosition, float maxPosition, float contentSize)
402 // Reapply constraints when the scroll domain is changed
406 void ScrollBar::SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy )
408 mIndicatorHeightPolicy = policy;
412 Toolkit::ScrollBar::IndicatorHeightPolicy ScrollBar::GetIndicatorHeightPolicy()
414 return mIndicatorHeightPolicy;
417 void ScrollBar::SetIndicatorFixedHeight( float height )
419 mIndicatorFixedHeight = height;
423 float ScrollBar::GetIndicatorFixedHeight()
425 return mIndicatorFixedHeight;
428 void ScrollBar::SetIndicatorShowDuration( float durationSeconds )
430 mIndicatorShowDuration = durationSeconds;
433 float ScrollBar::GetIndicatorShowDuration()
435 return mIndicatorShowDuration;
438 void ScrollBar::SetIndicatorHideDuration( float durationSeconds )
440 mIndicatorHideDuration = durationSeconds;
443 float ScrollBar::GetIndicatorHideDuration()
445 return mIndicatorHideDuration;
448 void ScrollBar::OnIndicatorHeightPolicyPropertySet( Property::Value propertyValue )
450 std::string policyName( propertyValue.Get<std::string>() );
451 if(policyName == "Variable")
453 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Variable);
455 else if(policyName == "Fixed")
457 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Fixed);
461 DALI_ASSERT_ALWAYS( !"ScrollBar::OnIndicatorHeightPolicyPropertySet(). Invalid Property value." );
465 void ScrollBar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
467 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
471 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
474 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
476 scrollBarImpl.OnIndicatorHeightPolicyPropertySet( value );
479 case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
481 scrollBarImpl.SetIndicatorFixedHeight(value.Get<float>());
484 case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
486 scrollBarImpl.SetIndicatorShowDuration(value.Get<float>());
489 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
491 scrollBarImpl.SetIndicatorHideDuration(value.Get<float>());
498 Property::Value ScrollBar::GetProperty( BaseObject* object, Property::Index index )
500 Property::Value value;
502 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
506 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
509 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
511 value = INDICATOR_HEIGHT_POLICY_NAME[ scrollBarImpl.GetIndicatorHeightPolicy() ];
514 case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
516 value = scrollBarImpl.GetIndicatorFixedHeight();
519 case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
521 value = scrollBarImpl.GetIndicatorShowDuration();
524 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
526 value = scrollBarImpl.GetIndicatorHideDuration();
534 Toolkit::ScrollBar ScrollBar::New()
536 // Create the implementation, temporarily owned by this handle on stack
537 IntrusivePtr< ScrollBar > impl = new ScrollBar();
539 // Pass ownership to CustomActor handle
540 Toolkit::ScrollBar handle( *impl );
542 // Second-phase init of the implementation
543 // This can only be done after the CustomActor connection has been made...
549 } // namespace Internal
551 } // namespace Toolkit