MRRibbonNotification.h

Go to the documentation of this file.

#pragma once
#include "MRViewerFwd.h"
#include "MRNotificationType.h"
#include "MRAsyncTimer.h"
#include "MRMesh/MRFlagOperators.h"
#include "MRMesh/MRBox.h"
#include <functional>
#include <chrono>
 
namespace MR
{
 
 
struct NotificationTags
{
    enum Tag : unsigned
    {
        None = 0b0000,
        Report = 0b0001,
        Recommendation = 0b0010,
        ImplicitChanges = 0b0100,
        Important = 0b1000,
        Default = Important | ImplicitChanges,
        All = Report | ImplicitChanges | Recommendation | Important,
    };
};
MR_MAKE_FLAG_OPERATORS( NotificationTags::Tag )
 
using NotificationTagMask = unsigned;

enum class RibbonNotificationCorner
{
    LowerLeft,
    LowerRight
};
 
struct RibbonNotification
{
    using OnButtonClick = std::function<void()>;
    OnButtonClick onButtonClick;

    std::string buttonName = "OK";
    std::string header;
    std::string text;
    NotificationType type{ NotificationType::Info };
    float lifeTimeSec = -1.0f;
    NotificationTagMask tags = NotificationTags::All;
    bool operator==( const RibbonNotification& other ) const;
};

class MRVIEWER_CLASS RibbonNotifier
{
public:
    MRVIEWER_API void pushNotification( const RibbonNotification& notification );

    MRVIEWER_API void draw( const Box2i& limitFramebuffer );

    MRVIEWER_API void setHitoryButtonMaxLifeTime( float histBtnMaxLifeTime );

    float defaultNotificationLifeTimeSeconds = 5.0f;

    NotificationTagMask allowedTagMask = NotificationTags::Default;

    RibbonNotificationCorner cornerPosition = RibbonNotificationCorner::LowerLeft;
private:
    struct NotificationWithTimer
    {
        RibbonNotification notification;
        float timer{ 0.0f };
        int sameCounter = 1;
    };
    std::vector<NotificationWithTimer> notifications_;
    std::vector<NotificationWithTimer> notificationsHistory_;
    bool requestRedraw_ = false;
    bool historyMode_ = false;
 
    float showHistoryBtnMaxTime_{ -1.0f }; 
    float currentHistoryBtnTimer_{ -1.0f }; 
#ifndef __EMSCRIPTEN__
    Time requestedTime_{ Time::max() };
    AsyncRequest asyncRequest_;
#endif

    void drawHistoryButton_( const Box2i& limitFramebuffer );
    void drawHistory_( const Box2i& limitFramebuffer );
    void drawFloating_( const Box2i& limitFramebuffer );

    bool scrollDownNeeded_ = false;
    float prevHistoryScrollMax_ = 0.0f;
    struct DrawNotificationSettings
    {
        int index{ 0 };
        float width{ 0.0f };
        bool historyMode{ false };
        Vector2f* currentPos{ nullptr };
    };
    bool drawNotification_( const DrawNotificationSettings& settings );
    void addNotification_( std::vector<NotificationWithTimer>& store, const RibbonNotification& notification );
    void filterInvalid_( int numInvalid = -1 );
    void requestClosestRedraw_();
};
 
}