source: synfigstudio/trunk/fuentes/src/synfigapp/actions/valuedescexport.cpp @ 481

Last change on this file since 481 was 481, checked in by jrpelegrina, 4 years ago

First release to xenial

File size: 10.4 KB
Line 
1/* === S Y N F I G ========================================================= */
2/*!     \file valuedescexport.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) 2008 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 "valuenodeadd.h"
34
35#include "canvasadd.h"
36#include "valuedescexport.h"
37#include "layerparamconnect.h"
38#include "layerparamset.h"
39#include "valuedescconnect.h"
40
41#include <synfigapp/canvasinterface.h>
42#include <synfig/valuenodes/valuenode_const.h>
43#include <synfig/context.h>
44
45#include <synfigapp/general.h>
46
47#endif
48
49using namespace std;
50using namespace etl;
51using namespace synfig;
52using namespace synfigapp;
53using namespace Action;
54
55/* === M A C R O S ========================================================= */
56
57ACTION_INIT_NO_GET_LOCAL_NAME(Action::ValueDescExport);
58ACTION_SET_NAME(Action::ValueDescExport,"ValueDescExport");
59ACTION_SET_LOCAL_NAME(Action::ValueDescExport,N_("Export Value"));
60ACTION_SET_TASK(Action::ValueDescExport,"export");
61ACTION_SET_CATEGORY(Action::ValueDescExport,Action::CATEGORY_VALUEDESC);
62ACTION_SET_PRIORITY(Action::ValueDescExport,0);
63ACTION_SET_VERSION(Action::ValueDescExport,"0.0");
64ACTION_SET_CVS_ID(Action::ValueDescExport,"$Id$");
65
66/* === G L O B A L S ======================================================= */
67
68/* === P R O C E D U R E S ================================================= */
69
70/* === M E T H O D S ======================================================= */
71
72Action::ValueDescExport::ValueDescExport()
73{
74}
75
76synfig::String
77Action::ValueDescExport::get_local_name()const
78{
79        // TRANSLATORS: This is used in the 'history' dialog when a ValueNode is exported.  The first %s is what is exported, the 2nd is the name it is given.
80        return strprintf(_("Export '%s' as '%s'"),
81                                         value_desc.get_description(false).c_str(),
82                                         name.c_str());
83}
84
85Action::ParamVocab
86Action::ValueDescExport::get_param_vocab()
87{
88        ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
89
90        ret.push_back(ParamDesc("value_desc",Param::TYPE_VALUEDESC)
91                .set_local_name(_("ValueDesc"))
92        );
93
94        ret.push_back(ParamDesc("name",Param::TYPE_STRING)
95                .set_local_name(_("Name"))
96                .set_desc(_("Export the value."))
97                .set_user_supplied()
98        );
99
100        return ret;
101}
102
103bool
104Action::ValueDescExport::is_candidate(const ParamList &x)
105{
106        if(candidate_check(get_param_vocab(),x))
107        {
108                ValueDesc value_desc=x.find("value_desc")->second.get_value_desc();
109                if(!value_desc)
110                        return false;
111                if(value_desc.get_value_type()==type_canvas)
112                        if(!value_desc.get_value().get(Canvas::Handle()))
113                                return false;
114                if(
115                        value_desc.parent_is_canvas()
116                        ||
117                        (value_desc.is_value_node() && value_desc.get_value_node()->is_exported())
118                        )
119                {
120                        return false;
121                }
122        // Don't allow to export lower and upper boundaries of the WidhtPoint
123                if(value_desc.parent_is_linkable_value_node()
124                        && value_desc.get_parent_value_node()->get_name()=="composite"
125                        && value_desc.get_parent_value_node()->get_type()==type_width_point
126                        && (value_desc.get_index()==4 || value_desc.get_index()==5))
127                        return false;
128                return true;
129        }
130        return false;
131}
132
133bool
134Action::ValueDescExport::set_param(const synfig::String& param_name, const Action::Param &param)
135{
136        if(param_name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
137        {
138                value_desc=param.get_value_desc();
139
140                return true;
141        }
142
143        if(param_name=="name" && param.get_type()==Param::TYPE_STRING)
144        {
145                name=param.get_string();
146
147                return true;
148        }
149
150        return Action::CanvasSpecific::set_param(param_name,param);
151}
152
153bool
154Action::ValueDescExport::is_ready()const
155{
156        if(!value_desc || name.empty())
157                return false;
158        return Action::CanvasSpecific::is_ready();
159}
160
161void Action::ValueDescExport::scan_canvas(synfig::Canvas::Handle prev_canvas, synfig::Canvas::Handle new_canvas, synfig::Canvas::Handle canvas)
162{
163        { // scan children
164                std::list<Canvas::Handle> &children = canvas->children();
165                for(std::list<Canvas::Handle>::iterator i = children.begin(); i != children.end(); i++)
166                        scan_canvas(prev_canvas, new_canvas, *i);
167        }
168
169        { // scan layers
170                for(IndependentContext i = canvas->get_independent_context(); *i; i++)
171                        scan_layer(prev_canvas, new_canvas, *i);
172        }
173
174        { // scan values
175                const ValueNodeList &value_node_list = canvas->value_node_list();
176                for(ValueNodeList::const_iterator i = value_node_list.begin(); i != value_node_list.end(); i++)
177                {
178                        LinkableValueNode::Handle linkable_value_node = etl::handle<LinkableValueNode>::cast_dynamic(*i);
179                        if (linkable_value_node)
180                                scan_linkable_value_node(prev_canvas, new_canvas, linkable_value_node);
181                }
182        }
183}
184
185void Action::ValueDescExport::scan_layer(synfig::Canvas::Handle prev_canvas, synfig::Canvas::Handle new_canvas, synfig::Layer::Handle layer)
186{
187        // dynamic params
188        const Layer::DynamicParamList &dynamic_param_list = layer->dynamic_param_list();
189        for(Layer::DynamicParamList::const_iterator i = dynamic_param_list.begin(); i != dynamic_param_list.end(); i++)
190        {
191                if (i->second->get_parent_canvas() == prev_canvas)
192                {
193                        // create action
194                        Action::Handle action(ValueDescConnect::create());
195                        action->set_param("canvas",get_canvas());
196                        action->set_param("canvas_interface",get_canvas_interface());
197                        action->set_param("dest",ValueDesc(layer, i->first));
198                        action->set_param("src",new_canvas->find_value_node(i->second->get_id(),false));
199                        assert(action->is_ready());
200                        add_action(action);
201                }
202
203                if (!i->second->get_parent_canvas())
204                {
205                        LinkableValueNode::Handle linkable_value_node = etl::handle<LinkableValueNode>::cast_dynamic(i->second);
206                        if (linkable_value_node)
207                                scan_linkable_value_node(prev_canvas, new_canvas, linkable_value_node);
208                }
209        }
210}
211
212void Action::ValueDescExport::scan_linkable_value_node(synfig::Canvas::Handle prev_canvas, synfig::Canvas::Handle new_canvas, synfig::LinkableValueNode::Handle linkable_value_node)
213{
214        for(int i = 0; i < linkable_value_node->link_count(); i++)
215        {
216                ValueNode::Handle link = linkable_value_node->get_link(i);
217                if (link)
218                {
219                        if (link->get_parent_canvas() == prev_canvas)
220                        {
221                                // create action
222                                Action::Handle action(ValueDescConnect::create());
223                                action->set_param("canvas",get_canvas());
224                                action->set_param("canvas_interface",get_canvas_interface());
225                                action->set_param("dest",ValueDesc(linkable_value_node, i));
226                                action->set_param("src",new_canvas->find_value_node(link->get_id(),false));
227                                assert(action->is_ready());
228                                add_action(action);
229                        }
230                        if (!link->get_parent_canvas())
231                        {
232                                LinkableValueNode::Handle sub_linkable_value_node = etl::handle<LinkableValueNode>::cast_dynamic(link);
233                                if (sub_linkable_value_node)
234                                        scan_linkable_value_node(prev_canvas, new_canvas, sub_linkable_value_node);
235                        }
236                }
237        }
238}
239
240void
241Action::ValueDescExport::prepare()
242{
243        clear();
244
245        ValueNode::Handle value_node;
246
247        if(value_desc.get_value_type()==type_canvas)
248        {
249                // action: CanvasAdd
250                if(!value_desc.is_const())
251                        throw Error(_("Can only export Canvas when used as constant parameter"));
252                Canvas::Handle canvas(value_desc.get_value().get(Canvas::Handle()));
253
254                bool external = !canvas->parent();
255                Canvas::Handle prev_canvas = canvas;
256
257                // clone canvas (all code that clones a canvas has this comment)
258                if (canvas) canvas=canvas->clone(GUID(), true);
259
260                if (external)
261                {
262                        // clone value nodes
263                        const ValueNodeList &value_node_list = prev_canvas->value_node_list();
264                        for(ValueNodeList::const_iterator i = value_node_list.begin(); i != value_node_list.end(); i++)
265                        {
266                                ValueNode::Handle new_node = (*i)->clone(canvas, guid);
267                                assert(new_node);
268                                if (new_node)
269                                        canvas->add_value_node(new_node, (*i)->get_id());
270                        }
271
272                        // scan all layers and canvases and relink value nodes
273                        scan_canvas(prev_canvas, canvas, get_canvas());
274                        scan_canvas(prev_canvas, canvas, canvas);
275                }
276
277                Action::Handle action(CanvasAdd::create());
278
279                action->set_param("canvas",get_canvas());
280                action->set_param("canvas_interface",get_canvas_interface());
281                action->set_param("src",canvas);
282                action->set_param("id",name);
283
284                assert(action->is_ready());
285                if(!action->is_ready())
286                        throw Error(Error::TYPE_NOTREADY);
287
288                add_action_front(action);
289
290                if(value_desc.parent_is_layer() && !value_desc.is_value_node())
291                {
292                        // action: LayerParamSet
293                        Action::Handle action(LayerParamSet::create());
294
295                        action->set_param("canvas",get_canvas());
296                        action->set_param("canvas_interface",get_canvas_interface());
297                        action->set_param("layer",value_desc.get_layer());
298                        action->set_param("param",value_desc.get_param_name());
299                        action->set_param("new_value",ValueBase(canvas));
300
301                        assert(action->is_ready());
302                        if(!action->is_ready())
303                                throw Error(Error::TYPE_NOTREADY);
304
305                        add_action_front(action);
306                }
307
308                return;
309        }
310
311        if(value_desc.is_value_node())
312        {
313                if(value_desc.get_value_node()->is_exported())
314                        throw Error(_("ValueBase is already exported"));
315
316                value_node=value_desc.get_value_node();
317        }
318        else
319        {
320                // action: LayerParamConnect
321                if(!value_desc.parent_is_layer())
322                        throw Error(_("Unable to export parameter. (Bug?)"));
323
324                value_node=ValueNode_Const::create(value_desc.get_value());
325
326                Action::Handle action(LayerParamConnect::create());
327
328                action->set_param("canvas",get_canvas());
329                action->set_param("canvas_interface",get_canvas_interface());
330                action->set_param("layer",value_desc.get_layer());
331                action->set_param("param",value_desc.get_param_name());
332                action->set_param("value_node",value_node);
333
334                assert(action->is_ready());
335                if(!action->is_ready())
336                        throw Error(Error::TYPE_NOTREADY);
337
338                add_action_front(action);
339        }
340
341        // action: ValueNodeAdd
342        Action::Handle action(ValueNodeAdd::create());
343
344        action->set_param("canvas",get_canvas());
345        action->set_param("canvas_interface",get_canvas_interface());
346        action->set_param("new",value_node);
347        action->set_param("name",name);
348
349        assert(action->is_ready());
350        if(!action->is_ready())
351                throw Error(Error::TYPE_NOTREADY);
352
353        add_action_front(action);
354}
Note: See TracBrowser for help on using the repository browser.