YiScreenTransitionManager.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_SCREEN_TRANSITION_MANAGER_H_
#define _YI_SCREEN_TRANSITION_MANAGER_H_

#include "utility/YiPersistentStore.h"

#include "binding/YiScriptableObject.h"
#include "signal/YiSignal.h"
#include "signal/YiSignalHandler.h"
#include "utility/YiBundle.h"
#include "view/YiViewProperty.h"

class CYIScreenTransition;
class CYIAbstractScreenViewController;


class CYIScreenTransitionManager : public CYISignalHandler, public CYIScriptableObject
{
public:
    
    struct ScreenTransitionBundle
    {
        CYIAbstractScreenViewController *m_pScreenController;
        CYIBundle                        m_bundle;
    
        ScreenTransitionBundle();
        ScreenTransitionBundle(CYIAbstractScreenViewController *pScreenController, const CYIBundle &screenBundle);
        ScreenTransitionBundle(const ScreenTransitionBundle &screenBundle);

        ScreenTransitionBundle &operator=(const ScreenTransitionBundle &screenBundle);
    };

    class ScreenTransitionDelegate
    {
        
    public:
        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, YIViewProperty::Orientation orientation, YIViewProperty::StatusBar statusBarVisibility, YIViewProperty::NavigationBar navigationBarVisibility) = 0;
        
        virtual void onSurfaceReady(CYIScreenTransitionManager *pSTM, YIViewProperty::Orientation orientation, YIViewProperty::StatusBar statusBarVisibility, YIViewProperty::NavigationBar navigationBarVisibility) = 0;

        virtual void OnPopScreen(CYIScreenTransitionManager *pSTM, CYIAbstractScreenViewController *pScreen);
    };

    CYIScreenTransitionManager();
    virtual ~CYIScreenTransitionManager();

    bool Connect(CYIAbstractScreenViewController *pScreen);

    bool Disconnect(CYIAbstractScreenViewController *pScreen);

    void UseTransition(CYIScreenTransition *pTransition);

    void SetTransitionDelegate(ScreenTransitionDelegate *pScreenTransitionDelegate);

    bool IsTransitionActive() const;

    void AppSpecificLoadingComplete();

    void SetMaxScreenStackSize(uint32_t uSize);

    void PushScreen(CYIAbstractScreenViewController *pScreen);

    void PushScreen(CYIAbstractScreenViewController *pScreen, const CYIBundle &bundle);
    
    void PushScreen(CYIAbstractScreenViewController *pScreen, const CYIBundle &bundle, const std::vector<ScreenTransitionBundle> &historyScreens);

    bool PopScreen();

    void PopAllScreens();

    void ClearScreenNavigationHistory();

    CYIAbstractScreenViewController *PeekScreen() const;

    CYIBundle PeekScreenBundle() const;

    CYISignal<const CYIPersistentStore &/* fromState */> TransitionStarted; 
    CYISignal<> TransitionCompleted; 
    CYISignal<const CYIBundle &/* bundle */> TransitionFailed; 

protected:
    uint32_t GetStackSize() const;

private:

    enum NAVIGATE_BACK_BEHAVIOUR
    {
        DONT_ALLOW_NAVIGATE_BACK = 0,
        ALLOW_NAVIGATE_BACK = 1
    };

    class StackData
    {
    public:
        StackData(CYIAbstractScreenViewController                       *pScreen,
                  CYIScreenTransitionManager::NAVIGATE_BACK_BEHAVIOUR   eNavigateBackBehaviour,
                  const CYIString                                       &titleText,
                  bool                                                  bIsNavigationHistoryEnabled,
                  CYIBundle                                             bundle
                  );
        StackData();
        ~StackData();
        
        CYIAbstractScreenViewController *GetScreen() const;
        
        CYIBundle GetBundle() const;
        
        bool IsBackNavigationAllowed() const;

        void SetNavigationHistoryEnabled(bool bEnable);
        
        bool IsNavigationHistoryEnabled() const;
        
        CYIString GetTitleText() const;

        void SetScreenState(CYIPersistentStore &screenState);

        CYIPersistentStore GetScreenState() const;
        
    private:
        CYIAbstractScreenViewController                    *m_pScreen;
        CYIScreenTransitionManager::NAVIGATE_BACK_BEHAVIOUR m_eNavigateBackBehaviour;
        bool                                                m_bIsNavigationHistoryEnabled;
        CYIString                                           m_sTitleText;
        CYIPersistentStore                                  m_screenState;
        CYIBundle                                           m_bundle;
    };

    enum TRANSITION_STATE
    {
        TRANSITION_ACTIVE,
        TRANSITION_INACTIVE
    };
    
    void                        _PushScreen(CYIAbstractScreenViewController *pScreen, const CYIBundle *pBundle, const std::vector<ScreenTransitionBundle> &historyScreens);

    bool                        IsSurfaceChangeRequired(const CYIAbstractScreenViewController *pFromController, const CYIAbstractScreenViewController *pToController);

    void                        OnPreloadValidateSucceeded(CYIAbstractScreenViewController * pController);
    void                        OnPreloadValidateFailed(CYIAbstractScreenViewController *pController, CYIBundle bundle);
    void                        OnPreloadComplete(CYIAbstractScreenViewController *pController);
    void                        OnUnloadComplete(CYIAbstractScreenViewController *pController);

    CYISignal<>                 ScreenTransitionCompleted;
    CYISignal<>                 ScreenTransitionFailed;

    void                        OnPushTransitionComplete();
    void                        OnPopTransitionComplete();
    void                        OnPushTransitionFail();
    void                        OnPopTransitionFail();
    void                        OnPopScreenTransitionComplete();

    void                        OnLoadAnimationStarted();
    void                        OnLoadAnimationComplete();

    void                        ClearScreenStack();
  
    void                        DumpScreenStack(const CYIString& sTitle);

    void                        StartTransitionState();
    void                        StopTransitionState();
    void                        ResetTransitionState();
    void                        InitiateTransition(CYIAbstractScreenViewController *pFromController, const CYIBundle &fromBundle, 
                                                   CYIAbstractScreenViewController *pToController, const CYIBundle &toBundle, const CYIPersistentStore &toStateData, 
                                                   const std::vector<ScreenTransitionBundle> &historyScreens);

    void                        OnScreenTransitionStopped();
    void                        CheckForLoad();
    void                        Load();

    TRANSITION_STATE                    m_eTransitionState;

    CYIAbstractScreenViewController    *m_pNavigateFromScreenController;
    CYIAbstractScreenViewController    *m_pNavigateToScreenController;
    CYIBundle                           m_FromBundle;
    CYIBundle                           m_ToBundle;
    CYIBundle                           m_ErrorBundle;
    std::vector<ScreenTransitionBundle> m_HistoryScreens;

    bool                             m_bUnloadComplete;
    bool                             m_bUnloadAnimationComplete;
    bool                             m_bLoadingAnimationComplete;
    bool                             m_bLoadingUserComplete;

    CYIPersistentStore                  m_unloadingScreenState;
    CYIPersistentStore                  m_loadingScreenState;

    std::deque<StackData>               m_screenStack;
    CYIScreenTransition                *m_pScreenTransition;
    ScreenTransitionDelegate           *m_pDelegate;

    uint32_t m_uMaxScreenStackSize;
};

#endif // _YI_SCREEN_TRANSITION_MANAGER_H_