Apply patch #17: Implement a Fill/Outline system in place of Foreground/Background...
[synfig.git] / synfig-studio / trunk / src / synfigapp / canvasinterface.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file canvasinterface.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, 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 <iostream>
34
35 #include <ETL/clock>
36 #include <synfig/valuenode_scale.h>
37 #include <synfig/valuenode_timedswap.h>
38 #include <synfig/valuenode_composite.h>
39 #include <synfig/valuenode_subtract.h>
40 #include <synfig/valuenode_linear.h>
41 #include <synfig/valuenode_reference.h>
42 #include <synfig/valuenode_twotone.h>
43 #include <synfig/valuenode_stripes.h>
44 #include <synfig/valuenode_bline.h>
45
46 #include <synfig/waypoint.h>
47 #include <synfig/loadcanvas.h>
48 #include <synfig/importer.h>
49 #include <synfig/guidset.h>
50
51 #include "canvasinterface.h"
52 #include "instance.h"
53
54 #include "actions/layeradd.h"
55 #include "actions/valuedescconvert.h"
56 #include "actions/valuenodeadd.h"
57 #include "actions/editmodeset.h"
58 #include "action_system.h"
59
60 #include "main.h"
61
62 #include <synfig/gradient.h>
63
64 #include "general.h"
65
66 #endif
67
68 /* === U S I N G =========================================================== */
69
70 using namespace std;
71 using namespace etl;
72 using namespace synfig;
73 using namespace synfigapp;
74
75 /* === M A C R O S ========================================================= */
76
77 /* === G L O B A L S ======================================================= */
78
79 /* === P R O C E D U R E S ================================================= */
80
81 /* === M E T H O D S ======================================================= */
82
83 CanvasInterface::CanvasInterface(etl::loose_handle<Instance> instance,etl::handle<synfig::Canvas> canvas):
84         instance_(instance),
85         canvas_(canvas),
86         cur_time_(canvas->rend_desc().get_frame_start()),
87         mode_(MODE_NORMAL|MODE_ANIMATE_PAST|MODE_ANIMATE_FUTURE)
88 {
89         set_selection_manager(get_instance()->get_selection_manager());
90         set_ui_interface(get_instance()->get_ui_interface());
91 }
92
93 CanvasInterface::~CanvasInterface()
94 {
95         if (getenv("SYNFIG_DEBUG_DESTRUCTORS"))
96                 synfig::info("CanvasInterface::~CanvasInterface(): Deleted");
97 }
98
99 void
100 CanvasInterface::set_time(synfig::Time x)
101 {
102         if(get_canvas()->rend_desc().get_frame_rate())
103         {
104                 float fps(get_canvas()->rend_desc().get_frame_rate());
105                 Time r(x.round(fps));
106                 //synfig::info("CanvasInterface::set_time(): %s rounded to %s\n",x.get_string(fps).c_str(),r.get_string(fps).c_str());
107                 x=r;
108         }
109         if(cur_time_.is_equal(x))
110                 return;
111         get_canvas()->set_time(cur_time_=x);
112
113         // update the time in all the child canvases
114         Canvas::Children children = get_canvas()->get_root()->children();
115         handle<CanvasInterface> interface;
116         for (Canvas::Children::iterator iter = children.begin(); iter != children.end(); iter++)
117                 if ((interface = get_instance()->find_canvas_interface(*iter)) != this)
118                         interface->set_time(interface->get_canvas()->get_time());
119
120         signal_time_changed()();
121         signal_dirty_preview()();
122 }
123
124 synfig::Time
125 CanvasInterface::get_time()const
126 {
127         return cur_time_;
128 }
129
130 void
131 CanvasInterface::refresh_current_values()
132 {
133         get_canvas()->set_time(cur_time_);
134         signal_time_changed()();
135         signal_dirty_preview()();
136 }
137
138 etl::handle<CanvasInterface>
139 CanvasInterface::create(etl::loose_handle<Instance> instance, etl::handle<synfig::Canvas> canvas)
140 {
141         etl::handle<CanvasInterface> intrfc;
142         intrfc=new CanvasInterface(instance,canvas);
143         instance->canvas_interface_list().push_front(intrfc);
144         return intrfc;
145 }
146
147 void
148 CanvasInterface::set_mode(Mode x)
149 {
150         Action::Handle  action(Action::EditModeSet::create());
151
152         assert(action);
153
154         action->set_param("canvas",get_canvas());
155         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
156         action->set_param("edit_mode",x);
157
158         if(!action->is_ready())
159         {
160                 get_ui_interface()->error(_("Action Not Ready, unable to change mode"));
161                 assert(0);
162                 return;
163         }
164
165         if(!get_instance()->perform_action(action))
166                 get_ui_interface()->error(_("Unable to change mode"));
167
168 //      mode_=x;
169 //      signal_mode_changed_(x);
170 }
171
172 CanvasInterface::Mode
173 CanvasInterface::get_mode()const
174 {
175         return mode_;
176 }
177
178
179
180 Layer::Handle
181 CanvasInterface::add_layer_to(synfig::String name, synfig::Canvas::Handle canvas, int depth)
182 {
183         synfigapp::Action::PassiveGrouper group(get_instance().get(),_("Add Layer To"));
184
185         Layer::Handle   layer(Layer::create(name));
186
187         assert(layer);
188
189         if(!layer)
190                 return 0;
191
192         if(canvas!=get_canvas() && !canvas->is_inline())
193         {
194                 synfig::error("Bad canvas passed to \"add_layer_to\"");
195                 return 0;
196         }
197
198         // automatically export the Index parameter of new Duplicate layers
199         if (name == "duplicate")
200                 for (int i = 1; ; i++)
201                 {
202                         String name = strprintf(_("Index %d"), i);
203                         try
204                         {
205                                 canvas->find_value_node(name);
206                         }
207                         catch (Exception::IDNotFound x)
208                         {
209                                 add_value_node(layer->dynamic_param_list().find("index")->second, name);
210                                 break;
211                         }
212                 }
213
214         layer->set_canvas(canvas);
215
216         // Apply some defaults
217         if(layer->set_param("fg",synfigapp::Main::get_outline_color()))
218                 layer->set_param("bg",synfigapp::Main::get_fill_color());
219         else if (name == "outline")
220                 layer->set_param("color",synfigapp::Main::get_outline_color());
221         else
222                 layer->set_param("color",synfigapp::Main::get_fill_color());
223
224         layer->set_param("width",synfigapp::Main::get_bline_width().units(get_canvas()->rend_desc()));
225         layer->set_param("gradient",synfigapp::Main::get_gradient());
226         if(name!="zoom")
227                 layer->set_param("amount",synfigapp::Main::get_opacity());
228         layer->set_param("blend_method",synfigapp::Main::get_blend_method());
229
230         {
231                 // Grab the layer's list of parameters
232                 Layer::ParamList paramlist=layer->get_param_list();
233                 Layer::ParamList::iterator iter;
234
235                 // loop through the static parameters
236                 for(iter=paramlist.begin();iter!=paramlist.end();++iter)
237                 {
238                         ValueNode::Handle value_node;
239
240                         // if we find any which are list values then make them
241                         // into dynamic list valuenodes, unless every element of
242                         // the list is a blinepoint, in which case convert it to a
243                         // bline
244                         if(iter->second.get_type()==ValueBase::TYPE_LIST)
245                         {
246                                 // check whether it's a list of blinepoints only
247                                 vector<ValueBase> list(iter->second.get_list());
248                                 if (list.size())
249                                 {
250                                         vector<ValueBase>::iterator iter2;
251                                         for (iter2 = list.begin(); iter2 != list.end(); iter2++)
252                                                 if (iter2->get_type() != ValueBase::TYPE_BLINEPOINT)
253                                                         break;
254                                         if (iter2 == list.end())
255                                         {
256                                                 value_node=LinkableValueNode::create("bline",iter->second);
257                                                 ValueNode_BLine::Handle::cast_dynamic(value_node)->set_member_canvas(canvas);
258                                         }
259                                 }
260
261                                 if (!value_node)
262                                         value_node=LinkableValueNode::create("dynamic_list",iter->second);
263                         }
264                         // otherwise, if it's a type that can be converted to
265                         // 'composite' (other than the types that can be radial
266                         // composite) then do so
267                         else if(LinkableValueNode::check_type("composite",iter->second.get_type()) &&
268                                          (iter->second.get_type()!=ValueBase::TYPE_COLOR &&
269                                           iter->second.get_type()!=ValueBase::TYPE_VECTOR))
270                                 value_node=LinkableValueNode::create("composite",iter->second);
271
272                         if(value_node)
273                                 layer->connect_dynamic_param(iter->first,value_node);
274                 }
275         }
276
277         // Action to add the layer
278         Action::Handle  action(Action::LayerAdd::create());
279
280         assert(action);
281         if(!action)
282                 return 0;
283
284         action->set_param("canvas",canvas);
285         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
286         action->set_param("new",layer);
287
288         if(!action->is_ready())
289         {
290                 get_ui_interface()->error(_("Action Not Ready"));
291                 return 0;
292         }
293
294         if(!get_instance()->perform_action(action))
295         {
296                 get_ui_interface()->error(_("Action Failed."));
297                 return 0;
298         }
299
300         // synfig::info("DEPTH=%d",depth);
301
302         // Action to move the layer (if necessary)
303         if(depth>0)
304         {
305                 Action::Handle  action(Action::create("LayerMove"));
306
307                 assert(action);
308                 if(!action)
309                         return 0;
310
311                 action->set_param("canvas",canvas);
312                 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
313                 action->set_param("layer",layer);
314                 action->set_param("new_index",depth);
315
316                 if(!action->is_ready())
317                 {
318                         get_ui_interface()->error(_("Move Action Not Ready"));
319                         return 0;
320                 }
321
322                 if(!get_instance()->perform_action(action))
323                 {
324                         get_ui_interface()->error(_("Move Action Failed."));
325                         return 0;
326                 }
327         }
328
329
330         return layer;
331 }
332
333
334 bool
335 CanvasInterface::convert(ValueDesc value_desc, synfig::String type)
336 {
337         Action::Handle  action(Action::ValueDescConvert::create());
338
339         assert(action);
340         if(!action)
341                 return 0;
342
343         action->set_param("canvas",get_canvas());
344         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
345         action->set_param("value_desc",value_desc);
346         action->set_param("type",type);
347         action->set_param("time",get_time());
348
349         if(!action->is_ready())
350         {
351                 get_ui_interface()->error(_("Action Not Ready"));
352                 return 0;
353         }
354
355         if(get_instance()->perform_action(action))
356                 return true;
357
358         get_ui_interface()->error(_("Action Failed."));
359         return false;
360 }
361
362 bool
363 CanvasInterface::add_value_node(synfig::ValueNode::Handle value_node, synfig::String name)
364 {
365         if(name.empty())
366         {
367                 get_ui_interface()->error(_("Empty name!"));
368                 return false;
369         }
370
371         Action::Handle  action(Action::ValueNodeAdd::create());
372
373         assert(action);
374         if(!action)
375                 return 0;
376
377         action->set_param("canvas",get_canvas());
378         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
379         action->set_param("new",value_node);
380         action->set_param("name",name);
381
382         if(!action->is_ready())
383         {
384                 get_ui_interface()->error(_("Action Not Ready"));
385                 return 0;
386         }
387
388         if(get_instance()->perform_action(action))
389                 return true;
390
391         get_ui_interface()->error(_("Action Failed."));
392         return false;
393 }
394
395 Action::ParamList
396 CanvasInterface::generate_param_list(const ValueDesc &value_desc)
397 {
398         synfigapp::Action::ParamList param_list;
399         param_list.add("time",get_time());
400         param_list.add("canvas_interface",etl::handle<CanvasInterface>(this));
401         param_list.add("canvas",get_canvas());
402
403         param_list.add("value_desc",value_desc);
404
405         if(value_desc.parent_is_value_node())
406                 param_list.add("parent_value_node",value_desc.get_parent_value_node());
407
408         if(value_desc.is_value_node())
409                 param_list.add("value_node",value_desc.get_value_node());
410
411         if(value_desc.is_const())
412         {
413                 // Fix 1868911: if we put a ValueBase holding a Canvas handle
414                 // into the param_list and then export the canvas, the handle
415                 // will miss out of having its reference count reduced,
416                 // because by the time the handle is destructed the canvas
417                 // will no longer be inline.  So let's not propogate that
418                 // ValueBase any further than here.
419                 if (value_desc.get_value_type() == ValueBase::TYPE_CANVAS)
420                         param_list.add("value",Canvas::LooseHandle(value_desc.get_value().get(Canvas::LooseHandle())));
421                 else
422                         param_list.add("value",value_desc.get_value());
423         }
424
425         if(value_desc.parent_is_layer_param())
426         {
427                 param_list.add("parent_layer",value_desc.get_layer());
428                 param_list.add("parent_layer_param",value_desc.get_param_name());
429         }
430
431         {
432                 synfigapp::SelectionManager::ChildrenList children_list;
433                 children_list=get_selection_manager()->get_selected_children();
434                 if(!value_desc.parent_is_canvas() && children_list.size()==1)
435                 {
436                         param_list.add("dest",value_desc);
437                         param_list.add("src",children_list.front().get_value_node());
438                 }
439         }
440         return param_list;
441 }
442
443 Action::ParamList
444 CanvasInterface::generate_param_list(const std::list<synfigapp::ValueDesc> &value_desc_list)
445 {
446         synfigapp::Action::ParamList param_list;
447         param_list.add("time",get_time());
448         param_list.add("canvas_interface",etl::handle<CanvasInterface>(this));
449         param_list.add("canvas",get_canvas());
450
451         std::list<synfigapp::ValueDesc>::const_iterator iter;
452         for(iter=value_desc_list.begin();iter!=value_desc_list.end();++iter)
453         {
454                 param_list.add("value_desc",*iter);
455                 if(iter->is_value_node())
456                 {
457                         param_list.add("value_node",iter->get_value_node());
458                 }
459         }
460
461
462         return param_list;
463 }
464
465 void
466 CanvasInterface::set_rend_desc(const synfig::RendDesc &rend_desc)
467 {
468         Action::Handle  action(Action::create("CanvasRendDescSet"));
469
470         assert(action);
471         if(!action)
472                 return;
473
474         action->set_param("canvas",get_canvas());
475         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
476         action->set_param("rend_desc",rend_desc);
477
478         if(!get_instance()->perform_action(action))
479                 get_ui_interface()->error(_("Action Failed."));
480 }
481
482 void
483 CanvasInterface::set_name(const synfig::String &x)
484 {
485         Action::Handle  action(Action::create("CanvasNameSet"));
486
487         assert(action);
488         if(!action)
489                 return;
490
491         action->set_param("canvas",get_canvas());
492         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
493         action->set_param("name",x);
494
495         if(!get_instance()->perform_action(action))
496                 get_ui_interface()->error(_("Action Failed."));
497
498         signal_id_changed_();
499 }
500
501 void
502 CanvasInterface::set_description(const synfig::String &x)
503 {
504         Action::Handle  action(Action::create("CanvasDescriptionSet"));
505
506         assert(action);
507         if(!action)
508                 return;
509
510         action->set_param("canvas",get_canvas());
511         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
512         action->set_param("description",x);
513
514         if(!get_instance()->perform_action(action))
515                 get_ui_interface()->error(_("Action Failed."));
516 }
517
518 void
519 CanvasInterface::set_id(const synfig::String &x)
520 {
521         Action::Handle  action(Action::create("CanvasIdSet"));
522
523         assert(action);
524         if(!action)
525                 return;
526
527         action->set_param("canvas",get_canvas());
528         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
529         action->set_param("id",x);
530
531         if(!get_instance()->perform_action(action))
532                 get_ui_interface()->error(_("Action Failed."));
533
534         signal_id_changed_();
535 }
536
537
538 void
539 CanvasInterface::jump_to_next_keyframe()
540 {
541         synfig::info("Current time: %s",get_time().get_string().c_str());
542         try
543         {
544                 synfig::Keyframe keyframe(*get_canvas()->keyframe_list().find_next(get_time()));
545                 synfig::info("Jumping to keyframe \"%s\" at %s",keyframe.get_description().c_str(),keyframe.get_time().get_string().c_str());
546                 set_time(keyframe.get_time());
547         }
548         catch(...) { synfig::warning("Unable to find next keyframe"); }
549 }
550
551 void
552 CanvasInterface::jump_to_prev_keyframe()
553 {
554         synfig::info("Current time: %s",get_time().get_string().c_str());
555         try
556         {
557                 synfig::Keyframe keyframe(*get_canvas()->keyframe_list().find_prev(get_time()));
558                 synfig::info("Jumping to keyframe \"%s\" at %s",keyframe.get_description().c_str(),keyframe.get_time().get_string().c_str());
559                 set_time(keyframe.get_time());
560         }
561         catch(...) { synfig::warning("Unable to find prev keyframe"); }
562 }
563
564 bool
565 CanvasInterface::import(const synfig::String &filename, synfig::String &errors, synfig::String &warnings, bool resize_image)
566 {
567         Action::PassiveGrouper group(get_instance().get(),_("Import Image"));
568
569         synfig::info("Attempting to import "+filename);
570
571         if (filename_extension(filename) == "")
572         {
573                 get_ui_interface()->error(_("Filename must have an extension!"));
574                 return false;
575         }
576
577         String ext(filename_extension(filename));
578         if (ext.size()) ext = ext.substr(1); // skip initial '.'
579         std::transform(ext.begin(),ext.end(),ext.begin(),&::tolower);
580
581         // If this is a SIF file, then we need to do things slightly differently
582         if(ext=="sif" || ext=="sifz")try
583         {
584                 Canvas::Handle outside_canvas(synfig::open_canvas(filename, errors, warnings));
585                 if(!outside_canvas)
586                         throw String(_("Unable to open this composition")) + ":\n\n" + errors;
587
588                 Layer::Handle layer(add_layer_to("PasteCanvas",get_canvas()));
589                 if(!layer)
590                         throw String(_("Unable to create \"Paste Canvas\" layer"));
591                 if(!layer->set_param("canvas",ValueBase(outside_canvas)))
592                         throw int();
593                 get_canvas()->register_external_canvas(filename, outside_canvas);
594
595                 //layer->set_description(basename(filename));
596                 signal_layer_new_description()(layer,filename);
597                 return true;
598         }
599         catch(String x)
600         {
601                 get_ui_interface()->error(filename + ": " + x);
602                 return false;
603         }
604         catch(...)
605         {
606                 get_ui_interface()->error(_("Uncaught exception when attempting\nto open this composition -- ")+filename);
607                 return false;
608         }
609
610         if(!Importer::book().count(ext))
611         {
612                 get_ui_interface()->error(_("I don't know how to open images of this type -- ")+ext);
613                 return false;
614         }
615
616         try
617         {
618                 Layer::Handle layer(add_layer_to("Import",get_canvas()));
619                 int w,h;
620                 if(!layer)
621                         throw int();
622                 if(!layer->set_param("filename",ValueBase(filename)))
623                         throw int();
624                 w=layer->get_param("_width").get(int());
625                 h=layer->get_param("_height").get(int());
626                 if(w&&h)
627                 {
628                         Vector x, size=ValueBase(get_canvas()->rend_desc().get_br()-get_canvas()->rend_desc().get_tl());
629
630                         // vector from top left of canvas to bottom right
631                         if (resize_image)
632                         {
633                                 if(abs(size[0])<abs(size[1]))   // if canvas is tall and thin
634                                 {
635                                         x[0]=size[0];   // use full width
636                                         x[1]=size[0]/w*h; // and scale for height
637                                         if((size[0]<0) ^ (size[1]<0))
638                                                 x[1]=-x[1];
639                                 }
640                                 else                            // else canvas is short and fat (or maybe square)
641                                 {
642                                         x[1]=size[1];   // use full height
643                                         x[0]=size[1]/h*w; // and scale for width
644                                         if((size[0]<0) ^ (size[1]<0))
645                                                 x[0]=-x[0];
646                                 }
647                         }
648                         else
649                         {
650                                 x[0] = w/60.0;
651                                 x[1] = h/60.0;
652                                 if((size[0]<0)) x[0]=-x[0];
653                                 if((size[1]<0)) x[1]=-x[1];
654                         }
655
656                         if(!layer->set_param("tl",ValueBase(-x/2)))
657                                 throw int();
658                         if(!layer->set_param("br",ValueBase(x/2)))
659                                 throw int();
660                 }
661                 else
662                 {
663                         if(!layer->set_param("tl",ValueBase(get_canvas()->rend_desc().get_tl())))
664                                 throw int();
665                         if(!layer->set_param("br",ValueBase(get_canvas()->rend_desc().get_br())))
666                                 throw int();
667                 }
668
669                 layer->set_description(basename(filename));
670                 signal_layer_new_description()(layer,filename);
671
672                 return true;
673         }
674         catch(...)
675         {
676                 get_ui_interface()->error("Unable to import "+filename);
677                 group.cancel();
678                 return false;
679         }
680 }
681
682
683 void
684 CanvasInterface::waypoint_duplicate(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
685 {
686         ValueNode::Handle value_node();
687         waypoint_duplicate(value_desc.get_value_node(), waypoint);
688 }
689
690 void
691 CanvasInterface::waypoint_duplicate(ValueNode::Handle value_node,synfig::Waypoint waypoint)
692 {
693         Action::Handle  action(Action::create("WaypointSetSmart"));
694
695         assert(action);
696         if(!action)
697                 return;
698
699         waypoint.make_unique();
700         waypoint.set_time(get_time());
701
702         action->set_param("canvas",get_canvas());
703         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
704         action->set_param("waypoint",waypoint);
705         action->set_param("time",get_time());
706         action->set_param("value_node",value_node);
707
708         if(!get_instance()->perform_action(action))
709                 get_ui_interface()->error(_("Action Failed."));
710 }
711
712 void
713 CanvasInterface::waypoint_remove(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
714 {
715         ValueNode::Handle value_node();
716         waypoint_remove(value_desc.get_value_node(), waypoint);
717 }
718
719 void
720 CanvasInterface::waypoint_remove(ValueNode::Handle value_node,synfig::Waypoint waypoint)
721 {
722         Action::Handle  action(Action::create("WaypointRemove"));
723
724         assert(action);
725         if(!action)
726                 return;
727
728         action->set_param("canvas",get_canvas());
729         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
730         action->set_param("waypoint",waypoint);
731         action->set_param("value_node",value_node);
732
733         if(!get_instance()->perform_action(action))
734                 get_ui_interface()->error(_("Action Failed."));
735 }
736
737
738 void
739 CanvasInterface::auto_export(synfig::ValueNode::Handle /*value_node*/)
740 {
741 /*
742         // Check to see if we are already exported.
743         if(value_node->is_exported())
744                 return;
745
746         Action::Handle  action(Action::create("ValueNodeAdd"));
747
748         assert(action);
749         if(!action)
750                 return;
751
752         String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
753
754         action->set_param("canvas",get_canvas());
755         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
756         action->set_param("new",value_node);
757         action->set_param("name",name);
758
759         if(!get_instance()->perform_action(action))
760                 get_ui_interface()->error(_("Action Failed."));
761 */
762 }
763
764 void
765 CanvasInterface::auto_export(const ValueDesc& /*value_desc*/)
766 {
767         // THIS FUNCTION IS DEPRECATED, AND IS NOW A STUB.
768 #if 0
769         // Check to see if we are already exported.
770         if(value_desc.is_exported())
771                 return;
772
773         Action::Handle  action(Action::create("ValueDescExport"));
774
775         assert(action);
776         if(!action)
777                 return;
778
779         String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
780
781         action->set_param("canvas",get_canvas());
782         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
783         action->set_param("value_desc",value_desc);
784         action->set_param("name",name);
785
786         if(!get_instance()->perform_action(action))
787                 get_ui_interface()->error(_("Action Failed."));
788 #endif
789 }
790
791 bool
792 CanvasInterface::change_value(synfigapp::ValueDesc value_desc,synfig::ValueBase new_value)
793 {
794         // If this isn't really a change, then don't bother
795         if(new_value==value_desc.get_value(get_time()))
796                 return true;
797
798         // If this change needs to take place elsewhere, then so be it.
799         if(value_desc.get_canvas())
800         {
801                 if (value_desc.get_canvas()->get_root() != get_canvas()->get_root())
802                 {
803                         etl::handle<Instance> instance;
804                         instance=find_instance(value_desc.get_canvas()->get_root());
805
806                         if(instance)
807                                 return instance->find_canvas_interface(value_desc.get_canvas())->change_value(value_desc,new_value);
808                         else
809                         {
810                                 get_ui_interface()->error(_("The value you are trying to edit is in a composition\nwhich doesn't seem to be open. Open that composition and you\nshould be able to edit this value as normal."));
811                                 return false;
812                         }
813                 }
814         }
815 #ifdef _DEBUG
816         else
817         { synfig::warning("Can't get canvas from value desc...?"); }
818 #endif
819
820         synfigapp::Action::Handle action(synfigapp::Action::create("ValueDescSet"));
821         if(!action)
822         {
823                 return false;
824         }
825
826         action->set_param("canvas",get_canvas());
827         action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
828         action->set_param("time",get_time());
829         action->set_param("value_desc",value_desc);
830         action->set_param("new_value",new_value);
831
832         return get_instance()->perform_action(action);
833 }
834
835 void
836 CanvasInterface::set_meta_data(const synfig::String& key,const synfig::String& data)
837 {
838         get_canvas()->set_meta_data(key,data);
839 }
840
841
842 // this function goes with find_important_value_descs()
843 static int
844 _process_value_desc(const synfigapp::ValueDesc& value_desc,std::vector<synfigapp::ValueDesc>& out, synfig::GUIDSet& guid_set)
845 {
846         int ret(0);
847
848         if(value_desc.get_value_type()==ValueBase::TYPE_CANVAS)
849         {
850                 Canvas::Handle canvas;
851                 canvas=value_desc.get_value().get(canvas);
852                 if(!canvas || !canvas->is_inline())
853                         return ret;
854                 ret+=CanvasInterface::find_important_value_descs(canvas,out,guid_set);
855         }
856
857         if(value_desc.is_value_node())
858         {
859                 ValueNode::Handle value_node(value_desc.get_value_node());
860
861                 if(guid_set.count(value_node->get_guid()))
862                         return ret;
863                 guid_set.insert(value_node->get_guid());
864
865                 if(LinkableValueNode::Handle::cast_dynamic(value_node))
866                 {
867                         if(ValueNode_DynamicList::Handle::cast_dynamic(value_node))
868                         {
869                                 out.push_back(value_desc);
870                                 ret++;
871                         }
872                         // Process the linkable ValueNode's children
873                         LinkableValueNode::Handle value_node_copy(LinkableValueNode::Handle::cast_dynamic(value_node));
874                         int i;
875                         for(i=0;i<value_node_copy->link_count();i++)
876                         {
877                                 ValueNode::Handle link(value_node_copy->get_link(i));
878                                 if(!link->is_exported())
879                                         ret+=_process_value_desc(ValueDesc(value_node_copy,i),out,guid_set);
880                         }
881                 }
882                 else if(ValueNode_Animated::Handle::cast_dynamic(value_node))
883                 {
884                         out.push_back(value_desc);
885                         ret++;
886                 }
887         }
888
889         return ret;
890 }
891
892 int
893 CanvasInterface::find_important_value_descs(synfig::Canvas::Handle canvas,std::vector<synfigapp::ValueDesc>& out,synfig::GUIDSet& guid_set)
894 {
895         int ret(0);
896         if(!canvas->is_inline())
897         {
898                 ValueNodeList::const_iterator iter;
899
900                 for(
901                         iter=canvas->value_node_list().begin();
902                         iter!=canvas->value_node_list().end();
903                         ++iter)
904                         ret+=_process_value_desc(ValueDesc(canvas,(*iter)->get_id()),out,guid_set);
905         }
906
907         Canvas::const_iterator iter;
908
909         for(iter=canvas->begin();iter!=canvas->end();++iter)
910         {
911                 Layer::Handle layer(*iter);
912
913                 Layer::DynamicParamList::const_iterator iter;
914                 for(
915                         iter=layer->dynamic_param_list().begin();
916                         iter!=layer->dynamic_param_list().end();
917                         ++iter)
918                 {
919                         if(!iter->second->is_exported())
920                                 ret+=_process_value_desc(ValueDesc(layer,iter->first),out,guid_set);
921                 }
922                 ValueBase value(layer->get_param("canvas"));
923                 if(value.is_valid())
924                         ret+=_process_value_desc(ValueDesc(layer,"canvas"),out,guid_set);
925         }
926
927         return ret;
928 }
929
930 int
931 CanvasInterface::find_important_value_descs(std::vector<synfigapp::ValueDesc>& out)
932 {
933         synfig::GUIDSet tmp;
934         return find_important_value_descs(get_canvas(),out,tmp);
935 }
936
937 void
938 CanvasInterface::seek_frame(int frames)
939 {
940         if(!frames)
941                 return;
942         float fps(get_canvas()->rend_desc().get_frame_rate());
943         Time newtime(get_time()+(float)frames/fps);
944         newtime=newtime.round(fps);
945
946         if(newtime<=get_canvas()->rend_desc().get_time_start())
947                 newtime=get_canvas()->rend_desc().get_time_start();
948         if(newtime>=get_canvas()->rend_desc().get_time_end())
949                 newtime=get_canvas()->rend_desc().get_time_end();
950         set_time(newtime);
951 }
952
953 void
954 CanvasInterface::seek_time(synfig::Time time)
955 {
956         if(!time)
957                 return;
958
959         float fps(get_canvas()->rend_desc().get_frame_rate());
960
961         if(time>=synfig::Time::end())
962         {
963                 set_time(get_canvas()->rend_desc().get_time_end());
964                 return;
965         }
966         if(time<=synfig::Time::begin())
967         {
968                 set_time(get_canvas()->rend_desc().get_time_start());
969                 return;
970         }
971
972         Time newtime(get_time()+time);
973         newtime=newtime.round(fps);
974
975         if(newtime<=get_canvas()->rend_desc().get_time_start())
976                 newtime=get_canvas()->rend_desc().get_time_start();
977         if(newtime>=get_canvas()->rend_desc().get_time_end())
978                 newtime=get_canvas()->rend_desc().get_time_end();
979         set_time(newtime);
980 }