CYIScreenTransition Class Reference

Detailed Description

Performs animated transitions from one application screen to another.

When Start(CYIAbstractScreenViewController *pFromScreen, CYIAbstractScreenViewController *pToScreen) is called from the application:

1. pFromScreen will animate out as CYIAbstractScreenViewController::Unload() is executed.
2. An activity indicator will be shown if it was provided in the constructor.
3. pToScreen will animate in as CYIAbstractScreenViewController::Load() is executed.

Overloading this class provides the ability for the client application to perform other actions when the screen transition starts and ends and when the pFromScreen unload animation is complete.

Allows connection of signals to a listener in order for it to be notified when the screen transition starts and ends, and when the unload animation ends and the load animation starts.

See also

CYIAbstractScreenViewController

#include <screen/YiScreenTransition.h>

Inheritance diagram for CYIScreenTransition:

Public Member Functions
	CYIScreenTransition (CYIActivityIndicatorViewController *pActivityIndicator, int32_t nMinActivityIndicatorMs)
virtual	~CYIScreenTransition ()
void	Start (CYIAbstractScreenViewController *pFromScreen, CYIAbstractScreenViewController *pToScreen)
void	Stop ()
void	UnblockLoadingAnimation ()
virtual bool	AreUserEventsEnabled ()
void	EnableUserEvents ()
void	DisableUserEvents ()
virtual bool	OnFrameTimeUpdated (std::chrono::microseconds nFrameTime) override
virtual bool	GetDisablesInput () override
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 Member Functions inherited from CYITime::UpdateListener
	UpdateListener ()
virtual	~UpdateListener ()
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 Attributes
CYISignal	UnloadAnimationCompleted
CYISignal	LoadAnimationStarted
CYISignal	ScreenTransitionCompleted
CYISignal	ScreenTransitionStopped

Protected Member Functions
virtual void	OnScreenTransitionStarted ()
virtual void	OnScreenTransitionEnded ()
virtual void	OnUnloadAnimationComplete ()
CYIAbstractScreenViewController *	GetFromScreen () const
CYIAbstractScreenViewController *	GetToScreen () const

Constructor & Destructor Documentation

CYIScreenTransition::CYIScreenTransition	(	CYIActivityIndicatorViewController *	pActivityIndicator,
		int32_t	nMinActivityIndicatorMs
	)

The pActivityIndicator will run for nMinActivityIndicatorMs milliseconds.

If no activity indicator is needed, call CYIScreenTransition(nullptr, 0).

virtual CYIScreenTransition::~CYIScreenTransition ( )

virtual

Member Function Documentation

virtual bool CYIScreenTransition::AreUserEventsEnabled ( )

virtual

Returns true if action, key, and trackpad events have been enabled for this screen transition. Default is false.

See also

CYIActionEvent

CYIKeyEvent

CYITrackpadEvent

void CYIScreenTransition::DisableUserEvents

(

)

Action, key, and trackpad events will be ignored during screen transition. This is the default behaviour.

See also

CYIActionEvent

CYIKeyEvent

CYITrackpadEvent

void CYIScreenTransition::EnableUserEvents

(

)

Action, key, and trackpad events will be processed during screen transition. Default value is disabled.

See also

CYIActionEvent

CYIKeyEvent

CYITrackpadEvent

virtual bool CYIScreenTransition::GetDisablesInput ( )

overridevirtual

Override and return true if this listener blocks user input. The default implementation returns false.

Reimplemented from CYITime::UpdateListener.

CYIAbstractScreenViewController* CYIScreenTransition::GetFromScreen ( ) const

protected

Returns pFromScreen that was specified in Start().

CYIAbstractScreenViewController* CYIScreenTransition::GetToScreen ( ) const

protected

Returns pToScreen that was specified in Start().

virtual bool CYIScreenTransition::OnFrameTimeUpdated ( std::chrono::microseconds  nFrameTime )

overridevirtual

Implement this function to receive frame time update notifications. Return true if you want to keep receiving notifications. Return false if you want the listener to unregister.

Implements CYITime::UpdateListener.

virtual void CYIScreenTransition::OnScreenTransitionEnded ( )

inlineprotectedvirtual

Called when the screen transition has been ended by Stop().

virtual void CYIScreenTransition::OnScreenTransitionStarted ( )

inlineprotectedvirtual

Called when the screen transition has been initiated by Start().

virtual void CYIScreenTransition::OnUnloadAnimationComplete ( )

protectedvirtual

Called when the unload animation has completed.

Note

The base class method must be called when this is overridden.

void CYIScreenTransition::Start	(	CYIAbstractScreenViewController *	pFromScreen,
		CYIAbstractScreenViewController *	pToScreen
	)

Initiates the unloading animation on the pFromScreen.

When this animation completes, the loading animation on the pToScreen will start.

If pActivityIndicator set in the constructor is not nullptr, the activity indicator animation will start after the pFromScreen unloading animation completes. The indicator will loop for at least nMinActivityIndicatorMs and will continue looping until UnblockLoadingAnimation() is emitted. Once UnblockLoadingAnimation() is emitted the activity indicator will be dismissed and the load animation for pToScreen will start.

Note

If UnblockLoadingAnimation() is emitted before the unload of pFromScreen completes the activity inidicator will not be shown.

void CYIScreenTransition::Stop

(

)

Stops the transition. The begin animation will play for pFromScreen specified in Start.

Note

Calling this method before Start() has no effect.

The stop will not occur until after UnloadAnimationCompleted() is emitted.

void CYIScreenTransition::UnblockLoadingAnimation

(

)

Stops the activity indicator, if provided, and continues to the loading animation of pToScreen specified in Start().

Note

Calling this method before Start() has no effect.

The unblock will not take effect until after UnloadAnimationCompleted() is emitted.

Member Data Documentation

CYISignal CYIScreenTransition::LoadAnimationStarted

Emitted immediately before the load animation starts playing for the pToScreen specified in Start().

CYISignal CYIScreenTransition::ScreenTransitionCompleted

Emitted when the transition to the pToScreen specified in Start() has completed.

CYISignal CYIScreenTransition::ScreenTransitionStopped

Emitted when the transition back to the pFromScreen specified in Start() has completed afer Stop() has been called on an active transition. This signal is emitted instead of ScreenTransitionCompleted().

CYISignal CYIScreenTransition::UnloadAnimationCompleted

Emitted when the unload animation has finished playing for the pFromScreen specified in Start().

If pFromScreen is nullptr the signal will be emitted in the Start() method.

---

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

• screen/YiScreenTransition.h