MRHistoryStore.h

Go to the documentation of this file.

#pragma once
 
#include "MRViewerFwd.h"
#include "MRMesh/MRHistoryAction.h"
#include "MRMesh/MRSignal.h"
#include <memory>
 
namespace MR
{
 
 
class MRVIEWER_CLASS HistoryStore
{
public:
    [[nodiscard]] MRVIEWER_API static HistoryStore* getViewerInstance();
 
    MRVIEWER_API virtual ~HistoryStore();
 
    MRVIEWER_API virtual void appendAction( std::shared_ptr<HistoryAction> action );
 
    [[nodiscard]] HistoryActionsVector* getScopeBlockPtr() const { return scopedBlock_; }
 
    void setScopeBlockPtr( HistoryActionsVector* scopedBlock ) { scopedBlock_ = scopedBlock; }
 
    [[nodiscard]] bool isSceneModified() const { return firstRedoIndex_ != savedSceneIndex_; }
 
    void setSavedState() { savedSceneIndex_ = firstRedoIndex_; }
 
    MRVIEWER_API void clear();
 
    void setMemoryLimit( size_t limit ) { storageLimit_ = limit; }
 
    [[nodiscard]] size_t getMemoryLimit() const { return storageLimit_; }
 
    [[nodiscard]] MRVIEWER_API size_t calcUsedMemory() const;
 
    [[nodiscard]] const HistoryActionsVector& getHistoryStack() const { return stack_; }
 
    [[nodiscard]] size_t getStackPointer() const { return firstRedoIndex_; }
 
    MRVIEWER_API void filterStack( HistoryStackFilter filteringCondition, bool deepFiltering = true );
 
    MRVIEWER_API virtual bool undo();
 
    MRVIEWER_API virtual bool redo();
 
    [[nodiscard]] bool undoRedoInProgress() const { return undoRedoInProgress_; }
 
    [[nodiscard]] MRVIEWER_API std::vector<std::string> getNActions( unsigned n, HistoryAction::Type type ) const;
 
    [[nodiscard]] MRVIEWER_API std::shared_ptr<HistoryAction> getLastAction( HistoryAction::Type type ) const;
 
    [[nodiscard]] MRVIEWER_API std::string getLastActionName( HistoryAction::Type type ) const;
 
    enum class ChangeType
    {
        PreAppendAction, 
        PostAppendAction, 
        PreUndo, 
        PostUndo, 
        PreRedo, 
        PostRedo, 
        Clear, 
        PopAction, 
        Filter 
    };
    using HistoryStoreChangedSignal = boost::signals2::signal<void( HistoryStore& store, ChangeType, std::shared_ptr<HistoryAction> action )>;
    HistoryStoreChangedSignal changedSignal;
 
private:
    HistoryActionsVector* scopedBlock_{ nullptr };
 
    HistoryActionsVector stack_;
 
    size_t firstRedoIndex_{ 0 };
 
    size_t savedSceneIndex_{ 0 };
 
    size_t storageLimit_{ size_t( ~0 ) };
 
    bool undoRedoInProgress_{ false };
 
    void filterByMemoryLimit_();
};
 
 
}