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