UnityEngine.UI.Extensions.ScrollSnapBase Class Reference

Inheritance diagram for UnityEngine.UI.Extensions.ScrollSnapBase:

Collaboration diagram for UnityEngine.UI.Extensions.ScrollSnapBase:

Classes
class	SelectionChangeEndEvent
class	SelectionChangeStartEvent
class	SelectionPageChangedEvent

Public Member Functions
void	NextScreen ()
void	PreviousScreen ()
void	GoToScreen (int screenIndex)
	Function for switching to a specific screen *Note, this is based on a 0 starting index - 0 to x More...
void	StartScreenChange ()
	Event fires when the user starts to change the page, either via swipe or button. More...
Transform	CurrentPageObject ()
	Returns the Transform of the Current page More...
void	CurrentPageObject (out Transform returnObject)
	Returns the Transform of the Current page in an out parameter for performance More...
void	OnBeginDrag (PointerEventData eventData)
	Touch screen to start swiping More...
void	OnDrag (PointerEventData eventData)
	While dragging do More...
void	SetLerp (bool value)
	Added to provide a uniform interface for the ScrollBarHelper More...
void	ChangePage (int page)
	Added to provide a uniform interface for the ScrollBarHelper More...

Public Attributes
int	StartingScreen = 0
float	PageStep = 1
GameObject	Pagination
GameObject	PrevButton
GameObject	NextButton
float	transitionSpeed = 7.5f
Boolean	UseHardSwipe = false
Boolean	UseFastSwipe = false
Boolean	UseSwipeDeltaThreshold = false
int	FastSwipeThreshold = 100
int	SwipeVelocityThreshold = 100
float	SwipeDeltaThreshold = 5.0f
Boolean	UseTimeScale = true
RectTransform	MaskArea
float	MaskBuffer = 1
bool	JumpOnEnable = false
bool	RestartOnEnable = false
bool	UseParentTransform = true
GameObject[]	ChildObjects

Properties
int?	CurrentPage [get, set]
SelectionChangeStartEvent	OnSelectionChangeStartEvent [get, set]
SelectionPageChangedEvent	OnSelectionPageChangedEvent [get, set]
SelectionChangeEndEvent	OnSelectionChangeEndEvent [get, set]

Member Function Documentation

ChangePage()

void UnityEngine.UI.Extensions.ScrollSnapBase.ChangePage ( int  page )

inline

Added to provide a uniform interface for the ScrollBarHelper

CurrentPageObject() [1/2]

Transform UnityEngine.UI.Extensions.ScrollSnapBase.CurrentPageObject ( )

inline

Returns the Transform of the Current page

Returns

Currently selected Page Transform

CurrentPageObject() [2/2]

void UnityEngine.UI.Extensions.ScrollSnapBase.CurrentPageObject ( out Transform  returnObject )

inline

Returns the Transform of the Current page in an out parameter for performance

Parameters

returnObject

Currently selected Page Transform

GoToScreen()

void UnityEngine.UI.Extensions.ScrollSnapBase.GoToScreen ( int  screenIndex )

inline

Function for switching to a specific screen *Note, this is based on a 0 starting index - 0 to x

Parameters

screenIndex

0 starting index of page to jump to

OnBeginDrag()

void UnityEngine.UI.Extensions.ScrollSnapBase.OnBeginDrag ( PointerEventData  eventData )

inline

Touch screen to start swiping

Parameters

eventData

OnDrag()

void UnityEngine.UI.Extensions.ScrollSnapBase.OnDrag ( PointerEventData  eventData )

inline

While dragging do

Parameters

eventData

SetLerp()

void UnityEngine.UI.Extensions.ScrollSnapBase.SetLerp ( bool  value )

inline

Added to provide a uniform interface for the ScrollBarHelper

StartScreenChange()

void UnityEngine.UI.Extensions.ScrollSnapBase.StartScreenChange ( )

inline

Event fires when the user starts to change the page, either via swipe or button.

---

The documentation for this class was generated from the following file:

• client/Packages/com.beamable/Runtime/3rdParty/UnityUIExtensions/ScrollSnapBase.cs