Tanoda
UnityEngine.UI.Extensions.ScrollSnapBase Class Reference
Inheritance diagram for UnityEngine.UI.Extensions.ScrollSnapBase:
UnityEngine.UI.Extensions.HorizontalScrollSnap UnityEngine.UI.Extensions.VerticalScrollSnap

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...
 
virtual void OnEndDrag (PointerEventData eventData)
 
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...
 
void OnPointerClick (PointerEventData eventData)
 

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]
 

Detailed Description

Definition at line 11 of file ScrollSnapBase.cs.

Member Function Documentation

◆ ChangePage()

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

Added to provide a uniform interface for the ScrollBarHelper

Definition at line 624 of file ScrollSnapBase.cs.

◆ CurrentPageObject() [1/2]

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

Returns the Transform of the Current page

Returns
Currently selected Page Transform

Definition at line 563 of file ScrollSnapBase.cs.

◆ CurrentPageObject() [2/2]

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

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

Parameters
returnObjectCurrently selected Page Transform

Definition at line 572 of file ScrollSnapBase.cs.

◆ GoToScreen()

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

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

Parameters
screenIndex0 starting index of page to jump to

Definition at line 360 of file ScrollSnapBase.cs.

◆ NextScreen()

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

Definition at line 313 of file ScrollSnapBase.cs.

◆ OnBeginDrag()

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

Touch screen to start swiping

Parameters
eventData

Definition at line 582 of file ScrollSnapBase.cs.

◆ OnDrag()

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

While dragging do

Parameters
eventData

Definition at line 594 of file ScrollSnapBase.cs.

◆ OnEndDrag()

virtual void UnityEngine.UI.Extensions.ScrollSnapBase.OnEndDrag ( PointerEventData  eventData)
virtual

◆ OnPointerClick()

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

Definition at line 629 of file ScrollSnapBase.cs.

◆ PreviousScreen()

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

Definition at line 335 of file ScrollSnapBase.cs.

◆ SetLerp()

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

Added to provide a uniform interface for the ScrollBarHelper

Definition at line 616 of file ScrollSnapBase.cs.

◆ StartScreenChange()

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

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

Definition at line 532 of file ScrollSnapBase.cs.

Member Data Documentation

◆ ChildObjects

GameObject [] UnityEngine.UI.Extensions.ScrollSnapBase.ChildObjects

Definition at line 151 of file ScrollSnapBase.cs.

◆ FastSwipeThreshold

int UnityEngine.UI.Extensions.ScrollSnapBase.FastSwipeThreshold = 100

Definition at line 77 of file ScrollSnapBase.cs.

◆ JumpOnEnable

bool UnityEngine.UI.Extensions.ScrollSnapBase.JumpOnEnable = false

Definition at line 142 of file ScrollSnapBase.cs.

◆ MaskArea

RectTransform UnityEngine.UI.Extensions.ScrollSnapBase.MaskArea

Definition at line 89 of file ScrollSnapBase.cs.

◆ MaskBuffer

float UnityEngine.UI.Extensions.ScrollSnapBase.MaskBuffer = 1

Definition at line 92 of file ScrollSnapBase.cs.

◆ NextButton

GameObject UnityEngine.UI.Extensions.ScrollSnapBase.NextButton

Definition at line 62 of file ScrollSnapBase.cs.

◆ PageStep

float UnityEngine.UI.Extensions.ScrollSnapBase.PageStep = 1

Definition at line 53 of file ScrollSnapBase.cs.

◆ Pagination

GameObject UnityEngine.UI.Extensions.ScrollSnapBase.Pagination

Definition at line 56 of file ScrollSnapBase.cs.

◆ PrevButton

GameObject UnityEngine.UI.Extensions.ScrollSnapBase.PrevButton

Definition at line 59 of file ScrollSnapBase.cs.

◆ RestartOnEnable

bool UnityEngine.UI.Extensions.ScrollSnapBase.RestartOnEnable = false

Definition at line 145 of file ScrollSnapBase.cs.

◆ StartingScreen

int UnityEngine.UI.Extensions.ScrollSnapBase.StartingScreen = 0

Definition at line 48 of file ScrollSnapBase.cs.

◆ SwipeDeltaThreshold

float UnityEngine.UI.Extensions.ScrollSnapBase.SwipeDeltaThreshold = 5.0f

Definition at line 83 of file ScrollSnapBase.cs.

◆ SwipeVelocityThreshold

int UnityEngine.UI.Extensions.ScrollSnapBase.SwipeVelocityThreshold = 100

Definition at line 80 of file ScrollSnapBase.cs.

◆ transitionSpeed

float UnityEngine.UI.Extensions.ScrollSnapBase.transitionSpeed = 7.5f

Definition at line 65 of file ScrollSnapBase.cs.

◆ UseFastSwipe

Boolean UnityEngine.UI.Extensions.ScrollSnapBase.UseFastSwipe = false

Definition at line 71 of file ScrollSnapBase.cs.

◆ UseHardSwipe

Boolean UnityEngine.UI.Extensions.ScrollSnapBase.UseHardSwipe = false

Definition at line 68 of file ScrollSnapBase.cs.

◆ UseParentTransform

bool UnityEngine.UI.Extensions.ScrollSnapBase.UseParentTransform = true

Definition at line 148 of file ScrollSnapBase.cs.

◆ UseSwipeDeltaThreshold

Boolean UnityEngine.UI.Extensions.ScrollSnapBase.UseSwipeDeltaThreshold = false

Definition at line 74 of file ScrollSnapBase.cs.

◆ UseTimeScale

Boolean UnityEngine.UI.Extensions.ScrollSnapBase.UseTimeScale = true

Definition at line 86 of file ScrollSnapBase.cs.

Property Documentation

◆ CurrentPage

int UnityEngine.UI.Extensions.ScrollSnapBase.CurrentPage
getset

Definition at line 94 of file ScrollSnapBase.cs.

◆ OnSelectionChangeEndEvent

SelectionChangeEndEvent UnityEngine.UI.Extensions.ScrollSnapBase.OnSelectionChangeEndEvent
getset

Definition at line 166 of file ScrollSnapBase.cs.

◆ OnSelectionChangeStartEvent

SelectionChangeStartEvent UnityEngine.UI.Extensions.ScrollSnapBase.OnSelectionChangeStartEvent
getset

Definition at line 156 of file ScrollSnapBase.cs.

◆ OnSelectionPageChangedEvent

SelectionPageChangedEvent UnityEngine.UI.Extensions.ScrollSnapBase.OnSelectionPageChangedEvent
getset

Definition at line 161 of file ScrollSnapBase.cs.


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