You.i Engine
CYIScreenTransitionManager::ScreenTransitionDelegate Class Referenceabstract

Detailed Description

Listener interface for the CYIScreenTransitionManager events.

#include <screen/YiScreenTransitionManager.h>

Public Member Functions

 ScreenTransitionDelegate ()
 
virtual ~ScreenTransitionDelegate ()
 
virtual void onTransitionStart (CYIScreenTransitionManager *pSTM, CYIPersistentStore &fromState)
 
virtual void onTransitionComplete (CYIScreenTransitionManager *pSTM)
 
virtual void onPreloadStart (CYIScreenTransitionManager *pSTM, CYIAbstractScreenViewController *pToScreen, CYIBundle toBundle)
 
virtual void OnLoadingAnimationsStart (CYIScreenTransitionManager *pSTM, CYIAbstractScreenViewController *pToScreen, const CYIPersistentStore &pToState)
 
virtual void onTransitionError (CYIScreenTransitionManager *pSTM, CYIBundle bundle)
 
virtual void onSurfaceChangeRequested (CYIScreenTransitionManager *pSTM, CYIScreenProperty::Orientation orientation, CYIScreenProperty::StatusBar statusBarVisibility, CYIScreenProperty::NavigationBar navigationBarVisibility)=0
 
virtual void onSurfaceReady (CYIScreenTransitionManager *pSTM, CYIScreenProperty::Orientation orientation, CYIScreenProperty::StatusBar statusBarVisibility, CYIScreenProperty::NavigationBar navigationBarVisibility)=0
 
virtual void OnPopScreen (CYIScreenTransitionManager *pSTM, CYIAbstractScreenViewController *pScreen)
 

Constructor & Destructor Documentation

◆ ScreenTransitionDelegate()

CYIScreenTransitionManager::ScreenTransitionDelegate::ScreenTransitionDelegate ( )
inline

◆ ~ScreenTransitionDelegate()

virtual CYIScreenTransitionManager::ScreenTransitionDelegate::~ScreenTransitionDelegate ( )
inlinevirtual

Member Function Documentation

◆ OnLoadingAnimationsStart()

virtual void CYIScreenTransitionManager::ScreenTransitionDelegate::OnLoadingAnimationsStart ( CYIScreenTransitionManager pSTM,
CYIAbstractScreenViewController pToScreen,
const CYIPersistentStore pToState 
)
virtual

Callback notifying that loading animations have started.

The implementation of this method is expected to perform additional animations and/or read the pToState data belonging to pToScreen. In the case of navigation via PopScreen() the state data will contain data previously stored via onTransitionStart().

AppSpecificLoadingComplete() must be called when any required app specific loading has completed. AppSpecificLoadingComplete() will be called in the default implementation thus just calling the default implementation would also fulfil this requirement.

◆ OnPopScreen()

virtual void CYIScreenTransitionManager::ScreenTransitionDelegate::OnPopScreen ( CYIScreenTransitionManager pSTM,
CYIAbstractScreenViewController pScreen 
)
virtual

Callback notifying that PopScreen() has been called.

◆ onPreloadStart()

virtual void CYIScreenTransitionManager::ScreenTransitionDelegate::onPreloadStart ( CYIScreenTransitionManager pSTM,
CYIAbstractScreenViewController pToScreen,
CYIBundle  toBundle 
)
virtual

Callback notifying that a screen transition is about to start.

The implementation of this method is expected to contain any generic application level operations that are not screen-specific but are required during transition.

◆ onSurfaceChangeRequested()

virtual void CYIScreenTransitionManager::ScreenTransitionDelegate::onSurfaceChangeRequested ( CYIScreenTransitionManager pSTM,
CYIScreenProperty::Orientation  orientation,
CYIScreenProperty::StatusBar  statusBarVisibility,
CYIScreenProperty::NavigationBar  navigationBarVisibility 
)
pure virtual

Callback notifying that a surface change has occurred while navigating between the "From Screen" and "To Screen". Examples of this may be: an orientation change, status bar change or navigation bar visibility change.

This will be called just prior to the loading animations starting on the "To Screen" It is only called if there is a corresponding "From Screen" on the stack.

See also
onSurfaceReady

◆ onSurfaceReady()

virtual void CYIScreenTransitionManager::ScreenTransitionDelegate::onSurfaceReady ( CYIScreenTransitionManager pSTM,
CYIScreenProperty::Orientation  orientation,
CYIScreenProperty::StatusBar  statusBarVisibility,
CYIScreenProperty::NavigationBar  navigationBarVisibility 
)
pure virtual

Callback notifying that the surface is ready and staged scenes will now be drawn.

This will occur just prior to the loading animations starting on the very first "To Screen" where no other screens exist on the stack.

This method must be implemented in a manner similar to onSurfaceChangeRequested() to assure symmetry in the initial and subsequent screen transitions.

See also
onSurfaceChangeRequested

◆ onTransitionComplete()

virtual void CYIScreenTransitionManager::ScreenTransitionDelegate::onTransitionComplete ( CYIScreenTransitionManager pSTM)
virtual

Callback notifying that a screen has been pushed to the stack and that the screen transition has completed.

◆ onTransitionError()

virtual void CYIScreenTransitionManager::ScreenTransitionDelegate::onTransitionError ( CYIScreenTransitionManager pSTM,
CYIBundle  bundle 
)
virtual

Callback notifying that a failure has occurred during the CYIAbstractScreenViewController::OnPreloadValidateScreen() of the screen to which the manager was transitioning, and attempt to transition is complete.

bundle will contain the accompanying CYIBundle for the screen that suffered the preload validate failure. This is provided by "To Screen" with PreloadValidateFailed signal.

◆ onTransitionStart()

virtual void CYIScreenTransitionManager::ScreenTransitionDelegate::onTransitionStart ( CYIScreenTransitionManager pSTM,
CYIPersistentStore fromState 
)
virtual

Callback notifying that a screen has been pushed to the stack and that the screen transition has started.

fromState contains state data for the screen being transitioned from. This data can be set in the implementation of CYIAbstractScreenViewController::OnUnloadScreen().


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