/* Copyright (c) 2020 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
using System;
using Tizen.NUI.BaseComponents;
using System.ComponentModel;
using System.Diagnostics;
namespace Tizen.NUI.Components
{
///
/// [Draft] This class provides a View that can scroll a single View with a layout. This View can be a nest of Views.
///
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public class ScrollableBase : Control
{
static bool LayoutDebugScrollableBase = false; // Debug flag
private Direction mScrollingDirection = Direction.Vertical;
private bool mScrollEnabled = true;
private int mPageWidth = 0;
private class ScrollableBaseCustomLayout : LayoutGroup
{
protected override void OnMeasure(MeasureSpecification widthMeasureSpec, MeasureSpecification heightMeasureSpec)
{
Extents padding = Padding;
float totalHeight = padding.Top + padding.Bottom;
float totalWidth = padding.Start + padding.End;
MeasuredSize.StateType childWidthState = MeasuredSize.StateType.MeasuredSizeOK;
MeasuredSize.StateType childHeightState = MeasuredSize.StateType.MeasuredSizeOK;
Direction scrollingDirection = Direction.Vertical;
ScrollableBase scrollableBase = this.Owner as ScrollableBase;
if (scrollableBase)
{
scrollingDirection = scrollableBase.ScrollingDirection;
}
// measure child, should be a single scrolling child
foreach (LayoutItem childLayout in LayoutChildren)
{
if (childLayout != null)
{
// Get size of child
// Use an Unspecified MeasureSpecification mode so scrolling child is not restricted to it's parents size in Height (for vertical scrolling)
// or Width for horizontal scrolling
MeasureSpecification unrestrictedMeasureSpec = new MeasureSpecification(heightMeasureSpec.Size, MeasureSpecification.ModeType.Unspecified);
if (scrollingDirection == Direction.Vertical)
{
MeasureChild(childLayout, widthMeasureSpec, unrestrictedMeasureSpec); // Height unrestricted by parent
}
else
{
MeasureChild(childLayout, unrestrictedMeasureSpec, heightMeasureSpec); // Width unrestricted by parent
}
float childWidth = childLayout.MeasuredWidth.Size.AsDecimal();
float childHeight = childLayout.MeasuredHeight.Size.AsDecimal();
// Determine the width and height needed by the children using their given position and size.
// Children could overlap so find the left most and right most child.
Position2D childPosition = childLayout.Owner.Position2D;
float childLeft = childPosition.X;
float childTop = childPosition.Y;
// Store current width and height needed to contain all children.
Extents childMargin = childLayout.Margin;
totalWidth = childWidth + childMargin.Start + childMargin.End;
totalHeight = childHeight + childMargin.Top + childMargin.Bottom;
if (childLayout.MeasuredWidth.State == MeasuredSize.StateType.MeasuredSizeTooSmall)
{
childWidthState = MeasuredSize.StateType.MeasuredSizeTooSmall;
}
if (childLayout.MeasuredWidth.State == MeasuredSize.StateType.MeasuredSizeTooSmall)
{
childHeightState = MeasuredSize.StateType.MeasuredSizeTooSmall;
}
}
}
MeasuredSize widthSizeAndState = ResolveSizeAndState(new LayoutLength(totalWidth + Padding.Start + Padding.End), widthMeasureSpec, MeasuredSize.StateType.MeasuredSizeOK);
MeasuredSize heightSizeAndState = ResolveSizeAndState(new LayoutLength(totalHeight + Padding.Top + Padding.Bottom), heightMeasureSpec, MeasuredSize.StateType.MeasuredSizeOK);
totalWidth = widthSizeAndState.Size.AsDecimal();
totalHeight = heightSizeAndState.Size.AsDecimal();
// Ensure layout respects it's given minimum size
totalWidth = Math.Max(totalWidth, SuggestedMinimumWidth.AsDecimal());
totalHeight = Math.Max(totalHeight, SuggestedMinimumHeight.AsDecimal());
widthSizeAndState.State = childWidthState;
heightSizeAndState.State = childHeightState;
SetMeasuredDimensions(ResolveSizeAndState(new LayoutLength(totalWidth + Padding.Start + Padding.End), widthMeasureSpec, childWidthState),
ResolveSizeAndState(new LayoutLength(totalHeight + Padding.Top + Padding.Bottom), heightMeasureSpec, childHeightState));
// Size of ScrollableBase is changed. Change Page width too.
scrollableBase.mPageWidth = (int)MeasuredWidth.Size.AsRoundedValue();
}
protected override void OnLayout(bool changed, LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom)
{
foreach (LayoutItem childLayout in LayoutChildren)
{
if (childLayout != null)
{
LayoutLength childWidth = childLayout.MeasuredWidth.Size;
LayoutLength childHeight = childLayout.MeasuredHeight.Size;
Position2D childPosition = childLayout.Owner.Position2D;
Extents padding = Padding;
Extents childMargin = childLayout.Margin;
LayoutLength childLeft = new LayoutLength(childPosition.X + childMargin.Start + padding.Start);
LayoutLength childTop = new LayoutLength(childPosition.Y + childMargin.Top + padding.Top);
childLayout.Layout(childLeft, childTop, childLeft + childWidth, childTop + childHeight);
}
}
}
} // ScrollableBaseCustomLayout
///
/// The direction axis to scroll.
///
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public enum Direction
{
///
/// Horizontal axis.
///
/// 6
Horizontal,
///
/// Vertical axis.
///
/// 6
Vertical
}
///
/// [Draft] Configurable speed threshold that register the gestures as a flick.
/// If the flick speed less than the threshold then will not be considered a flick.
///
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public float FlickThreshold { get; set; } = 0.2f;
///
/// [Draft] Configurable duration modifer for the flick animation.
/// Determines the speed of the scroll, large value results in a longer flick animation. Range (0.1 - 1.0)
///
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public float FlickAnimationSpeed { get; set; } = 0.4f;
///
/// [Draft] Configurable modifer for the distance to be scrolled when flicked detected.
/// It a ratio of the ScrollableBase's length. (not child's length).
/// First value is the ratio of the distance to scroll with the weakest flick.
/// Second value is the ratio of the distance to scroll with the strongest flick.
/// Second > First.
///
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public Vector2 FlickDistanceMultiplierRange { get; set; } = new Vector2(0.6f, 1.8f);
///
/// [Draft] Scrolling direction mode.
/// Default is Vertical scrolling.
///
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public Direction ScrollingDirection
{
get
{
return mScrollingDirection;
}
set
{
if (value != mScrollingDirection)
{
mScrollingDirection = value;
mPanGestureDetector.RemoveDirection(value == Direction.Horizontal ? PanGestureDetector.DirectionVertical : PanGestureDetector.DirectionHorizontal);
mPanGestureDetector.AddDirection(value == Direction.Horizontal ? PanGestureDetector.DirectionHorizontal : PanGestureDetector.DirectionVertical);
}
}
}
///
/// [Draft] Enable or disable scrolling.
///
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public bool ScrollEnabled
{
get
{
return mScrollEnabled;
}
set
{
if (value != mScrollEnabled)
{
mScrollEnabled = value;
if (mScrollEnabled)
{
mPanGestureDetector.Detected += OnPanGestureDetected;
mTapGestureDetector.Detected += OnTapGestureDetected;
}
else
{
mPanGestureDetector.Detected -= OnPanGestureDetected;
mTapGestureDetector.Detected -= OnTapGestureDetected;
}
}
}
}
///
/// [Draft] Pages mode, enables moving to the next or return to current page depending on pan displacement.
/// Default is false.
///
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public bool SnapToPage { set; get; } = false;
///
/// [Draft] Get current page.
/// Working propery with SnapToPage property.
///
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public int CurrentPage { get; private set; } = 0;
///
/// [Draft] Duration of scroll animation.
///
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public int ScrollDuration { set; get; } = 125;
///
/// [Draft] Scroll Available area.
///
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public Vector2 ScrollAvailableArea { set; get; }
///
/// ScrollEventArgs is a class to record scroll event arguments which will sent to user.
///
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public class ScrollEventArgs : EventArgs
{
Position position;
///
/// Default constructor.
///
/// Current scroll position
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
public ScrollEventArgs(Position position)
{
this.position = position;
}
///
/// [Draft] Current scroll position.
///
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public Position Position
{
get
{
return position;
}
}
}
///
/// An event emitted when user starts dragging ScrollableBase, user can subscribe or unsubscribe to this event handler.
///
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler ScrollDragStartEvent;
///
/// An event emitted when user stops dragging ScrollableBase, user can subscribe or unsubscribe to this event handler.
///
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler ScrollDragEndEvent;
///
/// An event emitted when the scrolling slide animation starts, user can subscribe or unsubscribe to this event handler.
///
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler ScrollAnimationStartEvent;
///
/// An event emitted when the scrolling slide animation ends, user can subscribe or unsubscribe to this event handler.
///
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler ScrollAnimationEndEvent;
///
/// An event emitted when scrolling, user can subscribe or unsubscribe to this event handler.
///
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public event EventHandler ScrollEvent;
private Animation scrollAnimation;
private float maxScrollDistance;
private float childTargetPosition = 0.0f;
private PanGestureDetector mPanGestureDetector;
private TapGestureDetector mTapGestureDetector;
private View mScrollingChild;
private View mInterruptTouchingChild;
private float multiplier = 1.0f;
private bool scrolling = false;
private float ratioOfScreenWidthToCompleteScroll = 0.5f;
private float totalDisplacementForPan = 0.0f;
// If false then can only flick pages when the current animation/scroll as ended.
private bool flickWhenAnimating = false;
private PropertyNotification propertyNotification;
protected float finalTargetPosition;
///
/// [Draft] Constructor
///
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public ScrollableBase() : base()
{
mPanGestureDetector = new PanGestureDetector();
mPanGestureDetector.Attach(this);
mPanGestureDetector.AddDirection(PanGestureDetector.DirectionVertical);
mPanGestureDetector.Detected += OnPanGestureDetected;
mTapGestureDetector = new TapGestureDetector();
mTapGestureDetector.Attach(this);
mTapGestureDetector.Detected += OnTapGestureDetected;
ClippingMode = ClippingModeType.ClipToBoundingBox;
mScrollingChild = new View();
mScrollingChild.Name = "DefaultScrollingChild";
//Interrupt touching when panning is started;
mInterruptTouchingChild = new View()
{
Name = "InterruptTouchingChild",
Size = new Size(Window.Instance.WindowSize),
BackgroundColor = Color.Transparent,
};
mInterruptTouchingChild.TouchEvent += (object source, View.TouchEventArgs args) =>
{
return true;
};
Layout = new ScrollableBaseCustomLayout();
}
private void OnPropertyChanged(object source, PropertyNotification.NotifyEventArgs args)
{
OnScroll();
}
///
/// Called after a child has been added to the owning view.
///
/// The child which has been added.
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public override void OnChildAdd(View view)
{
if (view.Name != "InterruptTouchingChild")
{
if (mScrollingChild.Name != "DefaultScrollingChild")
{
propertyNotification.Notified -= OnPropertyChanged;
mScrollingChild.RemovePropertyNotification(propertyNotification);
}
mScrollingChild = view;
propertyNotification = mScrollingChild?.AddPropertyNotification("position", PropertyCondition.Step(1.0f));
propertyNotification.Notified += OnPropertyChanged;
}
}
///
/// Called after a child has been removed from the owning view.
///
/// The child which has been removed.
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public override void OnChildRemove(View view)
{
if (view.Name != "InterruptTouchingChild")
{
propertyNotification.Notified -= OnPropertyChanged;
mScrollingChild.RemovePropertyNotification(propertyNotification);
mScrollingChild = new View();
}
}
///
/// Scrolls to the item at the specified index.
///
/// Index of item.
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
public void ScrollToIndex(int index)
{
if (mScrollingChild.ChildCount - 1 < index || index < 0)
{
return;
}
if (SnapToPage)
{
CurrentPage = index;
}
maxScrollDistance = CalculateMaximumScrollDistance();
float targetPosition = Math.Min(ScrollingDirection == Direction.Vertical ? mScrollingChild.Children[index].Position.Y : mScrollingChild.Children[index].Position.X, maxScrollDistance);
AnimateChildTo(ScrollDuration, -targetPosition);
}
private void OnScrollDragStart()
{
ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
ScrollDragStartEvent?.Invoke(this, eventArgs);
}
private void OnScrollDragEnd()
{
ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
ScrollDragEndEvent?.Invoke(this, eventArgs);
}
private void OnScrollAnimationStart()
{
ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
ScrollAnimationStartEvent?.Invoke(this, eventArgs);
}
private void OnScrollAnimationEnd()
{
ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
ScrollAnimationEndEvent?.Invoke(this, eventArgs);
}
private bool readyToNotice = false;
protected float noticeAnimationEndBeforePosition = 0.0f;
private void OnScroll()
{
ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
ScrollEvent?.Invoke(this, eventArgs);
CheckPreReachedTargetPosition();
}
private void CheckPreReachedTargetPosition()
{
// Check whether we reached pre-reached target position
if (readyToNotice &&
mScrollingChild.CurrentPosition.Y <= finalTargetPosition + noticeAnimationEndBeforePosition &&
mScrollingChild.CurrentPosition.Y >= finalTargetPosition - noticeAnimationEndBeforePosition)
{
//Notice first
readyToNotice = false;
OnPreReachedTargetPosition(finalTargetPosition);
}
}
///
/// This helps developer who wants to know before scroll is reaching target position.
///
/// Index of item.
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
protected virtual void OnPreReachedTargetPosition(float targetPosition)
{
}
private void StopScroll()
{
if (scrollAnimation != null)
{
if (scrollAnimation.State == Animation.States.Playing)
{
Debug.WriteLineIf(LayoutDebugScrollableBase, "StopScroll Animation Playing");
scrollAnimation.Stop(Animation.EndActions.Cancel);
OnScrollAnimationEnd();
}
scrollAnimation.Clear();
}
}
// static constructor registers the control type
static ScrollableBase()
{
// ViewRegistry registers control type with DALi type registry
// also uses introspection to find any properties that need to be registered with type registry
CustomViewRegistry.Instance.Register(CreateInstance, typeof(ScrollableBase));
}
internal static CustomView CreateInstance()
{
return new ScrollableBase();
}
private void AnimateChildTo(int duration, float axisPosition)
{
Debug.WriteLineIf(LayoutDebugScrollableBase, "AnimationTo Animation Duration:" + duration + " Destination:" + axisPosition);
finalTargetPosition = axisPosition;
StopScroll(); // Will replace previous animation so will stop existing one.
if (scrollAnimation == null)
{
scrollAnimation = new Animation();
scrollAnimation.Finished += ScrollAnimationFinished;
}
scrollAnimation.Duration = duration;
scrollAnimation.DefaultAlphaFunction = new AlphaFunction(AlphaFunction.BuiltinFunctions.EaseOutSine);
scrollAnimation.AnimateTo(mScrollingChild, (ScrollingDirection == Direction.Horizontal) ? "PositionX" : "PositionY", axisPosition);
scrolling = true;
OnScrollAnimationStart();
scrollAnimation.Play();
}
///
/// Scroll to specific position with or without animation.
///
/// Destination.
/// Scroll with or without animation
[EditorBrowsable(EditorBrowsableState.Never)]
public void ScrollTo(float position, bool animate)
{
float currentPositionX = mScrollingChild.CurrentPosition.X != 0 ? mScrollingChild.CurrentPosition.X : mScrollingChild.Position.X;
float currentPositionY = mScrollingChild.CurrentPosition.Y != 0 ? mScrollingChild.CurrentPosition.Y : mScrollingChild.Position.Y;
float delta = ScrollingDirection == Direction.Horizontal ? currentPositionX : currentPositionY;
delta -= position;
ScrollBy(delta, animate);
}
private float BoundScrollPosition(float targetPosition)
{
if (ScrollAvailableArea != null)
{
float minScrollPosition = ScrollAvailableArea.X;
float maxScrollPosition = ScrollAvailableArea.Y;
targetPosition = Math.Min(-minScrollPosition, targetPosition);
targetPosition = Math.Max(-maxScrollPosition, targetPosition);
}
else
{
targetPosition = Math.Min(0, targetPosition);
targetPosition = Math.Max(-maxScrollDistance, targetPosition);
}
return targetPosition;
}
private void ScrollBy(float displacement, bool animate)
{
if (GetChildCount() == 0 || maxScrollDistance < 0)
{
return;
}
float childCurrentPosition = (ScrollingDirection == Direction.Horizontal) ? mScrollingChild.PositionX : mScrollingChild.PositionY;
Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy childCurrentPosition:" + childCurrentPosition +
" displacement:" + displacement,
" maxScrollDistance:" + maxScrollDistance);
childTargetPosition = childCurrentPosition + displacement; // child current position + gesture displacement
Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy currentAxisPosition:" + childCurrentPosition + "childTargetPosition:" + childTargetPosition);
if (animate)
{
// Calculate scroll animaton duration
float scrollDistance = Math.Abs(displacement);
int duration = (int)((320 * FlickAnimationSpeed) + (scrollDistance * FlickAnimationSpeed));
Debug.WriteLineIf(LayoutDebugScrollableBase, "Scroll Animation Duration:" + duration + " Distance:" + scrollDistance);
readyToNotice = true;
AnimateChildTo(duration, BoundScrollPosition(AdjustTargetPositionOfScrollAnimation(BoundScrollPosition(childTargetPosition))));
}
else
{
finalTargetPosition = BoundScrollPosition(childTargetPosition);
// Set position of scrolling child without an animation
if (ScrollingDirection == Direction.Horizontal)
{
mScrollingChild.PositionX = finalTargetPosition;
}
else
{
mScrollingChild.PositionY = finalTargetPosition;
}
}
}
///
/// you can override it to clean-up your own resources.
///
/// DisposeTypes
/// 6
/// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
protected override void Dispose(DisposeTypes type)
{
if (disposed)
{
return;
}
if (type == DisposeTypes.Explicit)
{
StopScroll();
if (mPanGestureDetector != null)
{
mPanGestureDetector.Detected -= OnPanGestureDetected;
mPanGestureDetector.Dispose();
mPanGestureDetector = null;
}
if (mTapGestureDetector != null)
{
mTapGestureDetector.Detected -= OnTapGestureDetected;
mTapGestureDetector.Dispose();
mTapGestureDetector = null;
}
}
base.Dispose(type);
}
private float CalculateDisplacementFromVelocity(float axisVelocity)
{
// Map: flick speed of range (2.0 - 6.0) to flick multiplier of range (0.7 - 1.6)
float speedMinimum = FlickThreshold;
float speedMaximum = FlickThreshold + 6.0f;
float multiplierMinimum = FlickDistanceMultiplierRange.X;
float multiplierMaximum = FlickDistanceMultiplierRange.Y;
float flickDisplacement = 0.0f;
float speed = Math.Min(4.0f, Math.Abs(axisVelocity));
Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollableBase Candidate Flick speed:" + speed);
if (speed > FlickThreshold)
{
// Flick length is the length of the ScrollableBase.
float flickLength = (ScrollingDirection == Direction.Horizontal) ? CurrentSize.Width : CurrentSize.Height;
// Calculate multiplier by mapping speed between the multiplier minimum and maximum.
multiplier = ((speed - speedMinimum) / ((speedMaximum - speedMinimum) * (multiplierMaximum - multiplierMinimum))) + multiplierMinimum;
// flick displacement is the product of the flick length and multiplier
flickDisplacement = ((flickLength * multiplier) * speed) / axisVelocity; // *speed and /velocity to perserve sign.
Debug.WriteLineIf(LayoutDebugScrollableBase, "Calculated FlickDisplacement[" + flickDisplacement + "] from speed[" + speed + "] multiplier:"
+ multiplier);
}
return flickDisplacement;
}
private float CalculateMaximumScrollDistance()
{
int scrollingChildLength = 0;
int scrollerLength = 0;
if (ScrollingDirection == Direction.Horizontal)
{
Debug.WriteLineIf(LayoutDebugScrollableBase, "Horizontal");
scrollingChildLength = (int)mScrollingChild.Layout.MeasuredWidth.Size.AsRoundedValue();
scrollerLength = CurrentSize.Width;
}
else
{
Debug.WriteLineIf(LayoutDebugScrollableBase, "Vertical");
scrollingChildLength = (int)mScrollingChild.Layout.MeasuredHeight.Size.AsRoundedValue();
scrollerLength = CurrentSize.Height;
}
Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy maxScrollDistance:" + (scrollingChildLength - scrollerLength) +
" parent length:" + scrollerLength +
" scrolling child length:" + scrollingChildLength);
return Math.Max(scrollingChildLength - scrollerLength, 0);
}
private void PageSnap()
{
Debug.WriteLineIf(LayoutDebugScrollableBase, "PageSnap with pan candidate totalDisplacement:" + totalDisplacementForPan +
" currentPage[" + CurrentPage + "]");
//Increment current page if total displacement enough to warrant a page change.
if (Math.Abs(totalDisplacementForPan) > (mPageWidth * ratioOfScreenWidthToCompleteScroll))
{
if (totalDisplacementForPan < 0)
{
CurrentPage = Math.Min(Math.Max(mScrollingChild.Children.Count - 1, 0), ++CurrentPage);
}
else
{
CurrentPage = Math.Max(0, --CurrentPage);
}
}
// Animate to new page or reposition to current page
float destinationX = -(mScrollingChild.Children[CurrentPage].Position.X + mScrollingChild.Children[CurrentPage].CurrentSize.Width / 2 - CurrentSize.Width / 2); // set to middle of current page
Debug.WriteLineIf(LayoutDebugScrollableBase, "Snapping to page[" + CurrentPage + "] to:" + destinationX + " from:" + mScrollingChild.PositionX);
AnimateChildTo(ScrollDuration, destinationX);
}
private void Flick(float flickDisplacement)
{
if (SnapToPage)
{
if ((flickWhenAnimating && scrolling == true) || (scrolling == false))
{
if (flickDisplacement < 0)
{
CurrentPage = Math.Min(Math.Max(mScrollingChild.Children.Count - 1, 0), CurrentPage + 1);
Debug.WriteLineIf(LayoutDebugScrollableBase, "Snap - to page:" + CurrentPage);
}
else
{
CurrentPage = Math.Max(0, CurrentPage - 1);
Debug.WriteLineIf(LayoutDebugScrollableBase, "Snap + to page:" + CurrentPage);
}
float destinationX = -(mScrollingChild.Children[CurrentPage].Position.X + mScrollingChild.Children[CurrentPage].CurrentSize.Width / 2.0f - CurrentSize.Width / 2.0f); // set to middle of current page
Debug.WriteLineIf(LayoutDebugScrollableBase, "Snapping to :" + destinationX);
AnimateChildTo(ScrollDuration, destinationX);
}
}
else
{
ScrollBy(flickDisplacement, true); // Animate flickDisplacement.
}
}
private void OnPanGestureDetected(object source, PanGestureDetector.DetectedEventArgs e)
{
if (e.PanGesture.State == Gesture.StateType.Started)
{
Add(mInterruptTouchingChild);
Debug.WriteLineIf(LayoutDebugScrollableBase, "Gesture Start");
if (scrolling && !SnapToPage)
{
StopScroll();
}
maxScrollDistance = CalculateMaximumScrollDistance();
totalDisplacementForPan = 0.0f;
OnScrollDragStart();
}
else if (e.PanGesture.State == Gesture.StateType.Continuing)
{
if (ScrollingDirection == Direction.Horizontal)
{
ScrollBy(e.PanGesture.Displacement.X, false);
totalDisplacementForPan += e.PanGesture.Displacement.X;
}
else
{
ScrollBy(e.PanGesture.Displacement.Y, false);
totalDisplacementForPan += e.PanGesture.Displacement.Y;
}
Debug.WriteLineIf(LayoutDebugScrollableBase, "OnPanGestureDetected Continue totalDisplacementForPan:" + totalDisplacementForPan);
}
else if (e.PanGesture.State == Gesture.StateType.Finished)
{
float axisVelocity = (ScrollingDirection == Direction.Horizontal) ? e.PanGesture.Velocity.X : e.PanGesture.Velocity.Y;
float flickDisplacement = CalculateDisplacementFromVelocity(axisVelocity);
Debug.WriteLineIf(LayoutDebugScrollableBase, "FlickDisplacement:" + flickDisplacement + "TotalDisplacementForPan:" + totalDisplacementForPan);
OnScrollDragEnd();
if (flickDisplacement > 0 | flickDisplacement < 0)// Flick detected
{
Flick(flickDisplacement);
}
else
{
// End of panning gesture but was not a flick
if (SnapToPage)
{
PageSnap();
}
else
{
ScrollBy(0, true);
}
}
totalDisplacementForPan = 0;
Remove(mInterruptTouchingChild);
}
}
private new void OnTapGestureDetected(object source, TapGestureDetector.DetectedEventArgs e)
{
if (e.TapGesture.Type == Gesture.GestureType.Tap)
{
// Stop scrolling if tap detected (press then relase).
// Unless in Pages mode, do not want a page change to stop part way.
if (scrolling && !SnapToPage)
{
StopScroll();
}
}
}
private void ScrollAnimationFinished(object sender, EventArgs e)
{
scrolling = false;
CheckPreReachedTargetPosition();
OnScrollAnimationEnd();
}
///
/// Adjust scrolling position by own scrolling rules.
/// Override this function when developer wants to change destination of flicking.(e.g. always snap to center of item)
///
/// 6
/// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
[EditorBrowsable(EditorBrowsableState.Never)]
protected virtual float AdjustTargetPositionOfScrollAnimation(float position)
{
return position;
}
}
} // namespace