UI.Pagination.Page Class Reference

An individual page within a PagedRect. More...

Inheritance diagram for UI.Pagination.Page:

Classes
class	PageEvent

Public Member Functions
void	Initialise (PagedRect pagedRect)
	Initialise this Page object and attach it to its parent PagedRect. More...
void	UpdateDimensions ()
void	OnShow ()
	Called when this Page is shown. Triggers any OnShow events that have been set. More...
void	OnHide ()
	Called when this Page is hidden. Triggers any OnHide events that have been set. More...
void	FadeIn ()
	Show a Fade-In animation. More...
void	FadeOut ()
	Show a Fade-Out animation. More...
void	SlideIn (PagedRect.eDirection directionFrom, bool vertical=false)
	Show a Slide-In animation. More...
void	SlideOut (PagedRect.eDirection directionTo, bool vertical=false)
	Show a Slide-Out animation. More...
void	ResetPositionAndAlpha ()
	Return this Page to its default position and visibility More...
void	EnablePage ()
	Enable this Page More...
void	DisablePage ()
	Disable this Page (this will cause its pagination button to become disabled) More...
void	OverlayClicked ()
void	ScaleToScale (Vector2 scale, float animationSpeed=0.5f)
void	SetPagePosition (int position)
	Move this page to the specified position (position starts at 1 for page 1) More...
void	ShowOverlay ()
void	HideOverlay ()

Public Attributes
string	PageTitle = ""
bool	PageEnabled = true
bool	ShowOnPagination = true
PageEvent	OnShowEvent = new PageEvent()
PageEvent	OnHideEvent = new PageEvent()
bool	UsePageAnimationType = false
PagedRect.eAnimationType	AnimationType
bool	FlipAnimationDirection = false
bool	IsDuplicate = false
Page	OriginalPage = null
Vector2	DesiredScale = Vector2.one

Protected Member Functions
IEnumerator	DisableWhenAnimationIsComplete ()
	Used to disable this Page GameObject once a FadeOut/SlideOut animation has completed. More...
void	PlayNewAnimation (string animationName)
	Stop any animations currently being played and switch to a new one. More...
IEnumerator	ScaleToScaleInternal (Vector3 scale, float animationSpeed)

Protected Attributes
CanvasGroup	_CanvasGroup

Properties
int	PageNumber [get, set]
bool	Initialised [get, protected set]
Animator	Animator [get, protected set]
bool	Visible [get, protected set]
PagedRect	_pagedRect [get, set]
Vector3	initialPosition [get, set]
CanvasGroup	CanvasGroup [get]
LayoutElement	layoutElement [get]
PageOverlay	pageOverlay [get]
RectTransform	rectTransform [get]

Detailed Description

An individual page within a PagedRect.

Member Function Documentation

void UI.Pagination.Page.DisablePage

(

)

Disable this Page (this will cause its pagination button to become disabled)

IEnumerator UI.Pagination.Page.DisableWhenAnimationIsComplete ( )

protected

Used to disable this Page GameObject once a FadeOut/SlideOut animation has completed.

Returns

void UI.Pagination.Page.EnablePage

(

)

Enable this Page

void UI.Pagination.Page.FadeIn

(

)

Show a Fade-In animation.

void UI.Pagination.Page.FadeOut

(

)

Show a Fade-Out animation.

void UI.Pagination.Page.HideOverlay

(

)

void UI.Pagination.Page.Initialise

(

PagedRect

pagedRect

)

Initialise this Page object and attach it to its parent PagedRect.

Parameters

pagedRect

void UI.Pagination.Page.OnHide

(

)

Called when this Page is hidden. Triggers any OnHide events that have been set.

void UI.Pagination.Page.OnShow

(

)

Called when this Page is shown. Triggers any OnShow events that have been set.

void UI.Pagination.Page.OverlayClicked

(

)

void UI.Pagination.Page.PlayNewAnimation ( string  animationName )

protected

Stop any animations currently being played and switch to a new one.

Parameters

animationName

void UI.Pagination.Page.ResetPositionAndAlpha

(

)

Return this Page to its default position and visibility

void UI.Pagination.Page.ScaleToScale	(	Vector2	scale,
		float	animationSpeed = 0.5f
	)

IEnumerator UI.Pagination.Page.ScaleToScaleInternal ( Vector3  scale, float  animationSpeed  )

protected

void UI.Pagination.Page.SetPagePosition

(

int

position

)

Move this page to the specified position (position starts at 1 for page 1)

Parameters

position

void UI.Pagination.Page.ShowOverlay

(

)

void UI.Pagination.Page.SlideIn	(	PagedRect.eDirection	directionFrom,
		bool	vertical = false
	)

Show a Slide-In animation.

Parameters

directionFrom
vertical

void UI.Pagination.Page.SlideOut	(	PagedRect.eDirection	directionTo,
		bool	vertical = false
	)

Show a Slide-Out animation.

Parameters

directionTo
vertical

void UI.Pagination.Page.UpdateDimensions

(

)

Member Data Documentation

CanvasGroup UI.Pagination.Page._CanvasGroup

protected

PagedRect.eAnimationType UI.Pagination.Page.AnimationType

Vector2 UI.Pagination.Page.DesiredScale = Vector2.one

bool UI.Pagination.Page.FlipAnimationDirection = false

bool UI.Pagination.Page.IsDuplicate = false

PageEvent UI.Pagination.Page.OnHideEvent = new PageEvent()

PageEvent UI.Pagination.Page.OnShowEvent = new PageEvent()

Page UI.Pagination.Page.OriginalPage = null

bool UI.Pagination.Page.PageEnabled = true

string UI.Pagination.Page.PageTitle = ""

bool UI.Pagination.Page.ShowOnPagination = true

bool UI.Pagination.Page.UsePageAnimationType = false

Property Documentation

PagedRect UI.Pagination.Page._pagedRect

getsetprotected

Animator UI.Pagination.Page.Animator

getprotected set

CanvasGroup UI.Pagination.Page.CanvasGroup

get

bool UI.Pagination.Page.Initialised

getprotected set

Vector3 UI.Pagination.Page.initialPosition

getsetprotected

LayoutElement UI.Pagination.Page.layoutElement

get

int UI.Pagination.Page.PageNumber

getset

PageOverlay UI.Pagination.Page.pageOverlay

getprotected

RectTransform UI.Pagination.Page.rectTransform

get

bool UI.Pagination.Page.Visible

getprotected set

---

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

• C:/Users/Kyle Brunette/Documents/Visual Studio 2012/Projects/UI/PagedRect/PagedRect/Assets/UI/Pagination/Page.cs