Use get_layer_descriptions() to format the layer list rather than including a copy...
[synfig.git] / synfig-studio / trunk / src / synfigapp / actions / layerencapsulate.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file layerencapsulate.cpp
3 **      \brief Template File
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **      Copyright (c) 2007 Chris Moore
10 **
11 **      This package is free software; you can redistribute it and/or
12 **      modify it under the terms of the GNU General Public License as
13 **      published by the Free Software Foundation; either version 2 of
14 **      the License, or (at your option) any later version.
15 **
16 **      This package is distributed in the hope that it will be useful,
17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 **      General Public License for more details.
20 **      \endlegal
21 */
22 /* ========================================================================= */
23
24 /* === H E A D E R S ======================================================= */
25
26 #ifdef USING_PCH
27 #       include "pch.h"
28 #else
29 #ifdef HAVE_CONFIG_H
30 #       include <config.h>
31 #endif
32
33 #include "layerencapsulate.h"
34 #include "layeradd.h"
35 #include "layerremove.h"
36 #include <synfigapp/canvasinterface.h>
37
38 #include <synfigapp/general.h>
39
40 #endif
41
42 using namespace std;
43 using namespace etl;
44 using namespace synfig;
45 using namespace synfigapp;
46 using namespace Action;
47
48 /* === M A C R O S ========================================================= */
49
50 ACTION_INIT(Action::LayerEncapsulate);
51 ACTION_SET_NAME(Action::LayerEncapsulate,"layer_encapsulate");
52 ACTION_SET_LOCAL_NAME(Action::LayerEncapsulate,N_("Encapsulate"));
53 ACTION_SET_TASK(Action::LayerEncapsulate,"encapsulate");
54 ACTION_SET_CATEGORY(Action::LayerEncapsulate,Action::CATEGORY_LAYER);
55 ACTION_SET_PRIORITY(Action::LayerEncapsulate,0);
56 ACTION_SET_VERSION(Action::LayerEncapsulate,"0.0");
57 ACTION_SET_CVS_ID(Action::LayerEncapsulate,"$Id$");
58
59 /* === G L O B A L S ======================================================= */
60
61 /* === P R O C E D U R E S ================================================= */
62
63 /* === M E T H O D S ======================================================= */
64
65 Action::LayerEncapsulate::LayerEncapsulate()
66 {
67 }
68
69 Action::ParamVocab
70 Action::LayerEncapsulate::get_param_vocab()
71 {
72         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
73
74         ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
75                 .set_local_name(_("Layer"))
76                 .set_desc(_("Layer to be encapsulated"))
77                 .set_supports_multiple()
78         );
79
80         return ret;
81 }
82
83 bool
84 Action::LayerEncapsulate::is_candidate(const ParamList &x)
85 {
86         return candidate_check(get_param_vocab(),x);
87 }
88
89 bool
90 Action::LayerEncapsulate::set_param(const synfig::String& name, const Action::Param &param)
91 {
92         if(name=="layer" && param.get_type()==Param::TYPE_LAYER)
93         {
94                 layers.push_back(param.get_layer());
95
96                 return true;
97         }
98
99         return Action::CanvasSpecific::set_param(name,param);
100 }
101
102 bool
103 Action::LayerEncapsulate::is_ready()const
104 {
105         if(layers.empty())
106                 return false;
107         return Action::CanvasSpecific::is_ready();
108 }
109
110 int
111 Action::LayerEncapsulate::lowest_depth()const
112 {
113         std::list<synfig::Layer::Handle>::const_iterator iter;
114         int lowest_depth(0x7fffffff);
115
116         for(iter=layers.begin();iter!=layers.end();++iter)
117         {
118                 int depth((*iter)->get_depth());
119                 if(depth<lowest_depth)
120                         lowest_depth=depth;
121         }
122         if(lowest_depth==0x7fffffff)
123                 return 0;
124         return lowest_depth;
125 }
126
127 void
128 Action::LayerEncapsulate::prepare()
129 {
130
131         if(!first_time())
132                 return;
133
134         if(layers.empty())
135                 throw Error(_("No layers to encapsulate"));
136
137         // First create the new canvas and layer
138         if(!child_canvas)
139                 child_canvas=Canvas::create_inline(get_canvas());
140
141         Layer::Handle new_layer(Layer::create("PasteCanvas"));
142
143         new_layer->set_param("canvas",child_canvas);
144
145         int target_depth(lowest_depth());
146
147         // Add the layer
148         {
149                 Action::Handle action(LayerAdd::create());
150
151                 action->set_param("canvas",get_canvas());
152                 action->set_param("canvas_interface",get_canvas_interface());
153                 action->set_param("new",new_layer);
154
155                 add_action(action);
156         }
157
158         // Move the layer
159         {
160                 Action::Handle action(Action::create("layer_move"));
161
162                 assert(action);
163
164                 action->set_param("canvas",get_canvas());
165                 action->set_param("canvas_interface",get_canvas_interface());
166                 action->set_param("layer",new_layer);
167                 action->set_param("new_index",target_depth);
168
169                 add_action(action);
170         }
171
172         std::list<synfig::Layer::Handle>::reverse_iterator iter;
173
174         for(iter=layers.rbegin();iter!=layers.rend();++iter)
175         {
176                 Layer::Handle layer(*iter);
177
178                 Canvas::Handle subcanvas(layer->get_canvas());
179
180                 // Find the iterator for the layer
181                 Canvas::iterator iter=find(subcanvas->begin(),subcanvas->end(),layer);
182
183                 // If we couldn't find the layer in the canvas, then bail
184                 if(*iter!=layer)
185                         throw Error(_("This layer doesn't exist anymore."));
186
187                 if(!subcanvas)
188                         throw Error(_("This layer doesn't have a parent canvas"));
189
190                 // If the subcanvas isn't the same as the canvas,
191                 // then it had better be an inline canvas. If not,
192                 // bail
193                 if(get_canvas()!=subcanvas && !subcanvas->is_inline())
194                         throw Error(_("This layer doesn't belong to this canvas anymore"));
195
196                 if(get_canvas()!=subcanvas)
197                         throw Error(_("get_canvas()!=subcanvas"));
198
199                 // Remove the layer from the old canvas
200                 {
201                         Action::Handle action(LayerRemove::create());
202
203                         action->set_param("canvas",subcanvas);
204                         action->set_param("canvas_interface",get_canvas_interface());
205                         action->set_param("layer",layer);
206
207                         add_action(action);
208                 }
209                 // Add the layer to the new canvas
210                 {
211                         Action::Handle action(LayerAdd::create());
212
213                         action->set_param("canvas",child_canvas);
214                         action->set_param("canvas_interface",get_canvas_interface());
215                         action->set_param("new",layer);
216
217                         add_action(action);
218                 }
219         }
220 }