API reference
API reference
Select your platform
No SDKs available
No versions available

PageScroll Class

Extends UIBehaviour
This component smoothly moves the contentContainer horizontally until the selected page is completely visible, the anchor of the page is at the (0, any) position relative to the parent of the contentContainer when the page anchor is set to "top-left".

Fields

alphaTransitionCurve : AnimationCurve
Signature
AnimationCurve PageScroll.alphaTransitionCurve
animationSpeed : float
Signature
float PageScroll.animationSpeed

Protected Methods

OnDisable ()
Signature
override void PageScroll.OnDisable()
Returns
override void
OnEnable ()
Signature
override void PageScroll.OnEnable()
Returns
override void
Start ()
Signature
override void PageScroll.Start()
Returns
override void
Update ()
Signature
virtual void PageScroll.Update()
Returns
void

Methods

InjectAllPageScroll ( toggleGroup , contentContainer , pages , pageIndex )
Signature
void PageScroll.InjectAllPageScroll(UnityEngine.UI.ToggleGroup toggleGroup, RectTransform contentContainer, List< Page > pages, int pageIndex)
Parameters
toggleGroup: UnityEngine.UI.ToggleGroup
contentContainer: RectTransform
pages: List< Page >
pageIndex: int
Returns
void
InjectContentContainer ( contentContainer )
Signature
void PageScroll.InjectContentContainer(RectTransform contentContainer)
Parameters
contentContainer: RectTransform
Returns
void
InjectPageIndex ( pageIndex )
Signature
void PageScroll.InjectPageIndex(int pageIndex)
Parameters
pageIndex: int
Returns
void
InjectPages ( pages )
Signature
void PageScroll.InjectPages(List< Page > pages)
Parameters
pages: List< Page >
Returns
void
InjectToggleGroup ( toggleGroup )
Signature
void PageScroll.InjectToggleGroup(UnityEngine.UI.ToggleGroup toggleGroup)
Parameters
toggleGroup: UnityEngine.UI.ToggleGroup
Returns
void
ScrollPage ( direction )
Signature
void PageScroll.ScrollPage(int direction)
Parameters
direction: int
Returns
void
SetPageIndex ( pageIndex )
Signature
void PageScroll.SetPageIndex(int pageIndex)
Parameters
pageIndex: int
Returns
void

Inner Struct

Page Struct

Fields

canvasGroup : CanvasGroup
Signature
CanvasGroup PageScroll.Page.canvasGroup
container : RectTransform
Signature
RectTransform PageScroll.Page.container
toggle : UnityEngine.UI.Toggle
Signature
UnityEngine.UI.Toggle PageScroll.Page.toggle