Detailed Description

A view controller that controls a CYIActivityIndicatorView.

This class is primarily used with CYIScreenTransition, to display an indicator between two screens.

The layout given to this view controller must be a CYIActivityIndicatorView.

See also: CYIScreenTransition; CYIActivityIndicatorView

#include <screen/YiActivityIndicatorViewController.h>

Inheritance diagram for CYIActivityIndicatorViewController:

[legend]

Public Member Functions
	CYIActivityIndicatorViewController (CYISceneManager *pSceneManager, const CYIString &screenName, const CYIString &layoutName, int32_t nStageLayerIndex, YI_RECT_REL screenRegion)

virtual	~CYIActivityIndicatorViewController ()

	CYIActivityIndicatorViewController (CYISceneManager *pSceneManager, const CYIString &screenName, const CYIString &layoutName, int32_t nStageLayerIndex)

	CYIActivityIndicatorViewController (const CYIString &screenName, const CYIString &layoutName, int32_t nStageLayerIndex)

virtual void	Begin () override

virtual void	End () override

void	UpdateViewWithRect (YI_RECT_REL surfaceRect)

virtual void	BeginWithNotificationTimer (int32_t nNotificationTimeMS)

Public Member Functions inherited from CYIViewController
	CYIViewController (CYISceneManager *pSceneManager)

	CYIViewController (CYISceneManager pSceneManager, CYISceneView pView)

virtual	~CYIViewController ()

virtual void	Init ()

virtual void	UpdateView ()

void	SetViewLoaded (bool bIsLoaded)

virtual bool	IsViewLoaded () const

void	SetClearFocus (bool bClearFocus)

bool	ShouldClearFocus () const

virtual CYISceneNode *	GetSceneRoot () const

virtual void	OnBeginAnimationComplete ()

virtual void	OnEndAnimationComplete ()

Public Member Functions inherited from CYIScriptableObject
	CYIScriptableObject ()

	CYIScriptableObject (const CYIScriptableObject &other)

CYIScriptableObject &	operator= (const CYIScriptableObject &other)

virtual	~CYIScriptableObject ()

CYIBindingImplementation *	GetBindingImplementation () const

void	SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)

virtual const CYIRuntimeTypeInfo *	GetRuntimeTypeInfoForScriptObject () const

Public Member Functions inherited from CYISignalHandler
	CYISignalHandler ()

	CYISignalHandler (const CYISignalHandler &rSignalHandler)

virtual	~CYISignalHandler ()

CYISignalHandler &	operator= (const CYISignalHandler &rSignalHandler)

void	MoveToThread (CYIThread *pThread)
	This function allows the user to override the default thread affinity to any CYIThread that may or may not be running. More...

CYIThreadHandle	GetThreadAffinity () const

void	SetThreadAffinity (const CYIThreadHandle &rThreadAffinity)

virtual bool	IsConnected () const

virtual bool	IsConnected (const CYISignalBase &rSignal) const

void	Disconnect (CYISignalBase &rSignal)

void	DisconnectFromAllSignals ()

Public Member Functions inherited from CYIThread::Listener
	Listener ()

virtual	~Listener ()

virtual void	OnThreadStarted (CYIThread *)

virtual void	OnThreadTerminated (CYIThread *)

virtual void	OnThreadFinished (CYIThread *)

Public Attributes
CYISignal	NotificationTimeElapsed

CYISignal	EndAnimationCompleted

Protected Member Functions
virtual void	BuildTimelines () override

void	OnNotificationTimerCompleted ()

void	OnActivityTimelineEnded ()

Protected Member Functions inherited from CYIViewController
void	SetBeginAnimation (CYIAbstractTimeline *pAnimation, TimelineHelper::ANIMATION_DIRECTION eDirection)

void	SetEndAnimation (CYIAbstractTimeline *pAnimation, TimelineHelper::ANIMATION_DIRECTION eDirection)

Additional Inherited Members
Protected Attributes inherited from CYIViewController
CYISceneManager *	m_pSceneManager

CYISceneView *	m_pView

CYIAbstractTimeline *	m_pAnimationIn

CYIAbstractTimeline *	m_pAnimationOut

Constructor & Destructor Documentation

CYIActivityIndicatorViewController::CYIActivityIndicatorViewController	(	CYISceneManager *	pSceneManager,
		const CYIString &	screenName,
		const CYIString &	layoutName,
		int32_t	nStageLayerIndex,
		YI_RECT_REL	screenRegion
	)

Creates this CYIViewController with pSceneManager, and loads an CYIActivtiyIndicatorView from layoutName with screenRegion and adds it to the CYISceneManager at nStageLayerIndex with specified screenName.

See also: CYIViewController(CYISceneManager *pSceneManager); CYISceneManager::LoadScene; CYISceneManager::AddScene

virtual CYIActivityIndicatorViewController::~CYIActivityIndicatorViewController ( )

virtual

CYIActivityIndicatorViewController::CYIActivityIndicatorViewController	(	CYISceneManager *	pSceneManager,
		const CYIString &	screenName,
		const CYIString &	layoutName,
		int32_t	nStageLayerIndex
	)

Constructs a CYIActivityIndicatorViewController with the width and height of the CYISurface.

See also: CYIAppContext::GetSurface; CYISurface::GetWidth; CYISurface::GetHeight; CYIActivityIndicatorViewController(CYISceneManager *pSceneManager, const CYIString &screenName, const CYIString &layoutName, int32_t nStageLayerIndex, YI_RECT_REL screenRegion)

CYIActivityIndicatorViewController::CYIActivityIndicatorViewController	(	const CYIString &	screenName,
		const CYIString &	layoutName,
		int32_t	nStageLayerIndex
	)

Constructs a CYIActivityIndicatorViewController using the CYISceneManager from the current application context.

See also: CYIAppContext::GetApp; CYIApp::GetSceneManager; CYIActivityIndicatorViewController(CYISceneManager *pSceneManager, const CYIString &screenName, const CYIString &layoutName, int32_t nStageLayerIndex)

Member Function Documentation

virtual void CYIActivityIndicatorViewController::Begin ( )

overridevirtual

Stages and starts the CYIActivityIndicatorView.

See also: CYISceneManager::StageScene; CYIActivityIndicatorView::Start

Reimplemented from CYIViewController.

virtual void CYIActivityIndicatorViewController::BeginWithNotificationTimer ( int32_t nNotificationTimeMS )

virtual

Begins displaying the CYIActivityIndicator and emits a CYIActivityIndicatorViewController::NotificationTimeElapsed signal after nNotificationTimeMS milliseconds have elapsed.