YiScreenTransition.h

Go to the documentation of this file.

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

#include "binding/YiScriptableObject.h"
#include "framework/YiPredef.h"
#include "signal/YiSignalHandler.h"
#include "signal/YiSignal.h"
#include "utility/YiTime.h"

class CYIActivityIndicatorViewController;
class CYISceneManager;
class CYIAbstractScreenViewController;


class CYIScreenTransition : public CYISignalHandler, public CYITime::UpdateListener, public CYIScriptableObject
{
public:
    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;

    CYISignal<> UnloadAnimationCompleted;
    
    CYISignal<> LoadAnimationStarted;
    
    CYISignal<> ScreenTransitionCompleted;
    
    CYISignal<> ScreenTransitionStopped;
    
protected:
    
    virtual void OnScreenTransitionStarted() {}

    virtual void OnScreenTransitionEnded() {}
    
    virtual void OnUnloadAnimationComplete();

    CYIAbstractScreenViewController *GetFromScreen() const;

    CYIAbstractScreenViewController *GetToScreen() const;
    
private:
    enum STATE
    {
        TRANSITION_STARTED,
        TRANSITION_UNBLOCKED,
        TRANSITION_LOADING_ANIMATION_STARTED,
        TRANSITION_STOPPED,
        TRANSITION_IDLE
    };
    
    void StartUnloadAnimation();
    void StartLoadAnimation();
    
    void OnForwardLoadAnimationComplete();
    void OnReverseLoadAnimationComplete();
    void End();
    
    void OnActivityIndicatorMinimumTimeComplete();
    void OnActivityIndicatorEndAnimationComplete();
    void ConfigureForCurrentState();
    
    CYIActivityIndicatorViewController *m_pActivityIndicatorViewController;
    CYIAbstractScreenViewController *m_pFromController;
    CYIAbstractScreenViewController *m_pToController;
    
    bool m_bUserEventsEnabled;
    bool m_bActivityIndicatorStarted;
    int32_t m_nMinActivityIndicatorMs;
    STATE m_eCurrentStatus;
};

#endif // _YI_SCREEN_TRANSITION_H_