]> Creatis software - creaImageIO.git/blob - src2/creaImageIOGimmickView.h
memory leak tracking
[creaImageIO.git] / src2 / creaImageIOGimmickView.h
1 #ifndef __creaImageIOGimmickView_h_INCLUDED__
2 #define __creaImageIOGimmickView_h_INCLUDED__
3
4 #include <creaImageIOGimmick.h>
5 #include <creaImageIOTreeView.h>
6 #include <creaImageIOSystem.h>
7 #include <creaImageIOImagePointerHolder.h>
8
9 //#include <map>
10 #include <vtkImageData.h>
11 #include <creaImageIOMultiThreadImageReader.h>
12
13 // Signal/slot mechanism for progress events
14 #include <boost/signal.hpp>
15 #include <boost/bind.hpp>
16
17 #define GIMMICK_NO_IMAGE_SELECTION 0
18 #define GIMMICK_2D_IMAGE_SELECTION 2
19 #define GIMMICK_3D_IMAGE_SELECTION 3
20 #define GIMMICK_4D_IMAGE_SELECTION 4
21
22 #define NATIVE 0
23 #define _2D 2
24 #define _3D 3
25
26
27 namespace creaImageIO
28 {
29         /**
30         * \ingroup View
31         */
32          
33         class ImageExtent;
34     //=====================================================================
35     
36     //=====================================================================
37     ///Abstract class that handles views, attributes and previews (GUI) for Gimmick.
38         class GimmickView: public MultiThreadImageReaderUser
39     {
40     public:
41       /// Ctor
42       GimmickView(Gimmick*, int number_of_threads = 0 );
43       /// Virtual destructor
44       virtual ~GimmickView();
45       /// Initializes the view : 
46       /// Creates the TreeViews for all the TreeHandler of the Controller
47       /// 
48       virtual void Initialize();
49
50       /// Type of map from View name to TreeView* 
51       /// (This map is equivalent for Views of the TreeHandlerMap of Gimmick)
52       typedef std::map<std::string, TreeView*> TreeViewMapType;
53       
54       /// Returns the TreeViewMap (ref)
55       TreeViewMapType& GetTreeViewMap() { return mTreeViewMap; }
56       /// Returns the TreeViewMap (const ref)
57       const TreeViewMapType& GetTreeViewMap() const
58       { return mTreeViewMap; }
59
60       /// Finalize 
61       virtual void Finalize();
62
63           //Returns the maximal priority
64           int GetMaximalPriority(){return mReader.GetMaximalPriority();}
65
66       ///Adds the selected Images to the given vector and validates to see if they comply with the given parameter (4D)
67       virtual void GetSelectedImages(std::vector<vtkImageData*>& s, int dim) 
68           { GimmickError("INTERNAL ERROR : GetSelectedImages not implemented"); }
69
70       virtual void GetSelectedFiles(std::vector<std::string>& s)
71       { GimmickError("INTERNAL ERROR : GetSelectedFiles not implemented"); }
72
73           virtual void GetImages(int dim, std::vector<std::string> files, std::vector<vtkImageData*>& s) 
74           { GimmickError("INTERNAL ERROR : GetImages not implemented"); }
75
76       virtual void OnSelectionChange(const std::vector<tree::Node*>& s, bool isSelection, int selection, bool mProcess)
77       { GimmickError("INTERNAL ERROR : OnSelectionChange not implemented"); }
78
79            virtual void ClearSelection()
80       { GimmickError("INTERNAL ERROR : ClearSelection not implemented"); }
81
82           ///Adds a file to ignore
83           virtual void AddIgnoreFile(tree::Node* toRemove)
84           { GimmickError("INTERNAL ERROR : AddIgnoreFile not implemented"); }
85       
86           ///Copies selected files
87           virtual void CopyFiles(const std::vector<std::string>& filenames)
88           { GimmickError("INTERNAL ERROR : CopyFiles not implemented"); }
89
90           ///Edits the fields of a given node
91           virtual void CreateEditFieldsDialog(tree::Node* node, std::vector<std::string> names, std::vector<std::string> keys)
92           { GimmickError("INTERNAL ERROR : EditFields not implemented"); }
93       
94            ///Copies selected files
95           virtual void SaveAs(const std::vector<std::string>& filenames)
96           { GimmickError("INTERNAL ERROR : SaveAs not implemented"); }
97
98
99       ///Validates the dimension compliance of the images with the maximum and minimum given, and between their sizes
100       bool ValidateSelected (tree::Node* sel, int min_dim, int max_dim);
101       
102       ///Reads the vector of images, builds it in the dimension required and returns them in the supplied vector.
103           void ReadImagesNotThreaded(std::vector<vtkImageData*>& s,std::vector<std::string> files, int dim);
104       ///Requests the reading of an image with priority and index in the 
105       /// current selection (-1 if not in selection)
106       //void RequestReading(tree::Node* n, int prio, int selection_index , ImagePointerHolder *p);
107           void RequestReading(tree::Node* n, int prio, int selection_index , boost::shared_ptr<ImagePointerHolder> p);
108      
109       
110       ///Obtains the message of the state
111       std::string GetMessage(){return mMess;}
112       ///Obtains the message of the state
113       void SetMessage(std::string mess){mMess=mess;}
114           ///Resets the data of the extent and begins a new selection
115           void ResetExtent();
116
117       /// Create the tree views 
118       void CreateTreeViews();
119
120           /// Create a tree view with a given name
121           void CreateSingleTreeView(std::string &i_name);
122
123       /// Create the tree view for TreeHandler provided
124       virtual void CreateTreeView( TreeHandler* ) 
125       { GimmickError("INTERNAL ERROR : CreateTreeView not implemented"); }
126
127       /// Updates the TreeView of given name from level l to bottom
128       /// (calls the virtual method TreeView::UpdateLevel(l))
129       virtual void UpdateTreeViewLevel(const std::string&, int l);
130           // Multi-thread image reader callback
131           void OnMultiThreadImageReaderEvent(const std::string& filename,
132                                        MultiThreadImageReaderUser::EventType t,
133                                        vtkImageData* image);
134
135       vtkImageData* GetDefaultImage() { return mReader.GetImage(""); }
136
137
138       //=============================================
139       typedef boost::signal<void (bool)>  ValidationSignalType;
140       typedef ValidationSignalType::slot_function_type ValidationCallbackType;
141       //=============================================
142
143      //==================================================================
144       /// Adds the function f to the list of functions to call 
145       /// when the addition progresses.
146       /// f is of type ProgressCallbackType which is:
147       /// void (*ProgressCallbackType)(Progress&)
148       /// To pass a member function 'f' of an instance 'c' of a class 'C' 
149       /// as callback you have to 'bind' it, i.e. call:
150       /// ConnectValidationObserver ( boost::bind( &C::f , c, _1 ) );
151       void ConnectValidationObserver(ValidationCallbackType callback);
152      //==================================================================
153
154           
155
156         void modifyValidationSignal(bool ivalid);
157
158     private:
159         
160       /// Controller which manages the interaction with the model
161                 boost::shared_ptr< Gimmick> mGimmick;
162       /// The views 
163       TreeViewMapType mTreeViewMap;
164       /// The message that results from the validation
165       std::string mMess;
166
167       /// Multi-thread image reader
168       MultiThreadImageReader mReader;
169       /// Internal type of image reading event
170       /// If the image pointer is non null then the image is available (loaded)
171       /// else it has been unloaded
172       struct ImageEventType
173       {
174         ImageEventType( tree::Node* no = 0,   
175                         int sel_index = -1)
176 //                      ImagePointerHolder* ph= 0)
177 : node(no), index(sel_index){}//,  pointerHolder(ph){}
178         ImageEventType(vtkImageData* im )
179           : image(im) {}
180         tree::Node* node;
181         vtkImageData* image;
182                 int index;
183                 boost::shared_ptr<ImagePointerHolder> pointerHolder;
184       };
185       typedef std::map<std::string,ImageEventType> ImageEventTypeMap;
186       /// Map of images' names to ImageEventType
187       /// Used to associated a filename to a the data of a request
188       ImageEventTypeMap mImageEventMap;
189       // queue of image event 
190       typedef std::deque<ImageEventType> ImageEventQueueType;
191       //ImageEventQueueType mImageEventQueue;
192
193           ///The current image extent
194           ImageExtent* mImageExtent;
195           ///The validation signal
196           ValidationSignalType mValidationSignal;
197           ///Boolean that determines if the selection is valid
198           bool valid;
199           ///Boolean that determines if the reader has been started
200           bool mReaderStarted;
201       
202         };
203   // EO class GimmickView
204     //=====================================================================
205   
206
207  
208  
209 } // EO namespace creaImageIO
210
211 // EOF
212 #endif