1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/*=========================================================================
Program: ITK-SNAP
Module: $RCSfile: UndoDataManager.h,v $
Language: C++
Date: $Date: 2008/11/15 12:20:38 $
Version: $Revision: 1.4 $
Copyright (c) 2007 Paul A. Yushkevich
This file is part of ITK-SNAP
ITK-SNAP is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-----
Copyright (c) 2003 Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __UndoDataManager_h_
#define __UndoDataManager_h_
#include <vector>
#include <list>
#include <RLEImage.h>
/**
* \class UndoDataManager
* \brief Manages data (delta updates) for undo/redo in itk-snap
*/
template<typename TPixel> class UndoDataManager
{
public:
typedef itk::ImageRegion<3> RegionType;
/**
* The Delta class represents a difference between two images used in
* the Undo system. It only supports linear traversal of images and
* stores differences in an RLE (run length encoding) format.
*/
class Delta
{
public:
Delta()
{
m_CurrentLength = 0;
m_UniqueID = m_UniqueIDCounter++;
}
void SetRegion(const RegionType ®ion)
{
this->m_Region = region;
}
const RegionType &GetRegion()
{
return m_Region;
}
void Encode(const TPixel &value)
{
if(m_CurrentLength == 0)
{
m_LastValue = value;
m_CurrentLength = 1;
}
else if(value == m_LastValue)
{
m_CurrentLength++;
}
else
{
m_Array.push_back(std::make_pair(m_CurrentLength, m_LastValue));
m_CurrentLength = 1;
m_LastValue = value;
}
}
void FinishEncoding()
{
if(m_CurrentLength > 0)
m_Array.push_back(std::make_pair(m_CurrentLength, m_LastValue));
}
size_t GetNumberOfRLEs()
{ return m_Array.size(); }
TPixel GetRLEValue(size_t i)
{ return m_Array[i].second; }
size_t GetRLELength(size_t i)
{ return m_Array[i].first; }
unsigned long GetUniqueID() const
{ return m_UniqueID; }
Delta & operator = (const Delta &other)
{
m_Array = other.m_Array;
m_CurrentLength = other.m_CurrentLength;
m_LastValue = other.m_LastValue;
m_Region = other.m_Region;
return *this;
}
protected:
typedef std::pair<size_t, TPixel> RLEPair;
typedef std::vector<RLEPair> RLEArray;
RLEArray m_Array;
size_t m_CurrentLength;
TPixel m_LastValue;
// The delta is associated with an image region
RegionType m_Region;
// Each delta is assigned a unique ID at creation
unsigned long m_UniqueID;
static unsigned long m_UniqueIDCounter;
};
/** List of deltas and related iterators */
typedef std::list<Delta *> DList;
typedef typename DList::iterator DIterator;
typedef typename DList::const_iterator DConstIterator;
/**
* A "commit" to the undo system consists of one or more deltas. For example
* in paintbrush drawing, as you drag the paintbrush, deltas are generated, but
* these deltas are associated with a single commit. The commit owns the deltas
* and deletes them when it is itself deleted.
*/
class Commit
{
public:
Commit(const DList &list, const char *name);
void DeleteDeltas();
size_t GetNumberOfRLEs() const;
const DList &GetDeltas() const { return m_Deltas; }
protected:
DList m_Deltas;
std::string m_Name;
};
UndoDataManager(size_t nMinCommits, size_t nMaxTotalSize);
/** Add a delta to the staging list. The staging list must be committed */
void AddDeltaToStaging(Delta *delta);
/** Commit the deltas in the staging list - returns total number of RLEs updated */
int CommitStaging(const char *text);
/** Clear the undo stack (removes all commits) */
void Clear();
bool IsUndoPossible();
const Commit &GetCommitForUndo();
bool IsRedoPossible();
const Commit &GetCommitForRedo();
size_t GetNumberOfCommits()
{ return m_CommitList.size(); }
private:
// Current staging list - where deltas are added
DList m_StagingList;
// List of commits typedefs
typedef std::list<Commit> CList;
typedef typename CList::iterator CIterator;
typedef typename CList::const_iterator CConstIterator;
// A list of commits
CList m_CommitList;
CIterator m_Position;
size_t m_TotalSize, m_MinCommits, m_MaxTotalSize;
};
#endif // __UndoDataManager_h_
|
