Detailed Description

Simple class to keep track of data changes in a SharedImageSet.

History is represented linearly, the class does not handle branching Nothing happens automatically, the UndoRecorder must be called explicitly to record the current state Best used with labelMaps, which compress well in memory

Public Member Functions
	UndoRecorder (SharedImageSet &sis, size_t maxSize=256 1024 1204, const std::vector< std::string > &dataComponentsId={})

	~UndoRecorder ()
	Connects the finished signals for proper deletion of QThread and UndoSerializer, exits the thread.

void	recordUndoLevel (const std::string &description, uint64_t timestamp)
	Record the entire pixel data of the image and store it as an 'undo level' This 'undo level' can later be used to restore the state (= pixel data) of the image when it was recorded If the size limit is exceeded, previous data is automatically removed starting from the oldest, until either the total compressed size is below the limit, or only the undo level that was just recorded remains.

void	recordUndoLevel (const std::string &description, uint64_t timestamp, const std::vector< size_t > &framesToRecord)
	Finer-grained version of the previous function.

int	restoreUndoLevel (size_t index)
	Restores the undo level and returns the index of the new focused frame Or -1 in case of failure.

void	deleteLevelsAfter (size_t index)
	Deletes all UndoLevel that are more recent than the one pointed by index This is useful in "branching" cases where the user undoes and then continues from the given state all pre-existing "redo" must then be removed.

size_t	currentSize () const
	Returns the size in bytes used by the UndoRecorder.

void	setupSerializer (const std::string &filePath)
	Sets up the serializer (UndoSerializer) for the given undo file-path.

void	setupSerializer (std::unique_ptr< internal::UndoSerializer > serializer)

const std::vector< internal::UndoLevel > &	data () const
	A single UndoLevel is a full snapshot of the image data.

void	setData (std::vector< internal::UndoLevel > &&undos)
	Setter for undos, should move/copy the data.

void	deleteUndoFilesAsync (std::vector< std::string > &&undosToDelete, bool deleteEmptyUndoDir=false) const
	Deletes asynchronously the passed undo-files If m_waitDeletingDone is true, this function blocks until deletion is over.

void	waitWritingDone () const
	Blocks the calling thread until all writing processes are done.

void	setWaitDeletingDone (bool wait)
	If set, the calling thread is blocked untile the deleting thread is done deleting (on deleteUndoFilesAsync)

Constructor & Destructor Documentation

◆ UndoRecorder()

UndoRecorder	(	SharedImageSet &	sis,
		size_t	maxSize = 256 1024 1204,
		const std::vector< std::string > &	dataComponentsId = {} )

Parameters

sis	the SharedImageSet whose data will be recorded and restored
maxSize	the size in bytes of the cache. 256MB by default
dataComponentsId	all the IDs of data components that shall be recorded in an undo level

Member Function Documentation

◆ recordUndoLevel() [1/2]

void recordUndoLevel	(	const std::string &	description,
		uint64_t	timestamp )

Record the entire pixel data of the image and store it as an 'undo level' This 'undo level' can later be used to restore the state (= pixel data) of the image when it was recorded If the size limit is exceeded, previous data is automatically removed starting from the oldest, until either the total compressed size is below the limit, or only the undo level that was just recorded remains.

For multi-frame images, prefer using the overload where each frame to be recorded is specified.

◆ recordUndoLevel() [2/2]

void recordUndoLevel	(	const std::string &	description,
		uint64_t	timestamp,
		const std::vector< size_t > &	framesToRecord )

Finer-grained version of the previous function.

The framesToRecord argument is an explicit list of frame indices, indicating which frames of the image should be recorded. All other frames are automatically de-duplicated with those of previous undo levels, resulting in more efficient (speed and size) undo recording when only few frames are modified.

◆ setupSerializer()

void setupSerializer ( const std::string & filePath )

Sets up the serializer (UndoSerializer) for the given undo file-path.

The serializer is moved inside a QThread.

◆ data()

const std::vector< internal::UndoLevel > & data ( ) const

inline

A single UndoLevel is a full snapshot of the image data.

Get the already recorded undo data

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

ImFusion/Seg/UndoRecorder.h