1 /* === S Y N F I G ========================================================= */
2 /*! \file canvasinterface.cpp
3 ** \brief Template File
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 ** Copyright (c) 2007 Chris Moore
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.
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.
22 /* ========================================================================= */
24 /* === H E A D E R S ======================================================= */
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>
45 #include <synfig/waypoint.h>
46 #include <synfig/loadcanvas.h>
47 #include <synfig/importer.h>
48 #include <synfig/guidset.h>
50 #include "canvasinterface.h"
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"
61 #include <synfig/gradient.h>
67 /* === U S I N G =========================================================== */
71 using namespace synfig;
72 using namespace synfigapp;
74 /* === M A C R O S ========================================================= */
76 /* === G L O B A L S ======================================================= */
78 /* === P R O C E D U R E S ================================================= */
80 /* === M E T H O D S ======================================================= */
82 CanvasInterface::CanvasInterface(etl::loose_handle<Instance> instance,etl::handle<synfig::Canvas> canvas):
85 cur_time_(canvas->rend_desc().get_frame_start()),
86 mode_(MODE_NORMAL|MODE_ANIMATE_PAST|MODE_ANIMATE_FUTURE)
88 set_selection_manager(get_instance()->get_selection_manager());
89 set_ui_interface(get_instance()->get_ui_interface());
92 CanvasInterface::~CanvasInterface()
94 synfig::info("synfigapp::CanvasInterface::~CanvasInterface(): Deleted");
98 CanvasInterface::set_time(synfig::Time x)
100 if(get_canvas()->rend_desc().get_frame_rate())
102 float fps(get_canvas()->rend_desc().get_frame_rate());
103 Time r(x.round(fps));
104 //synfig::info("CanvasInterface::set_time(): %s rounded to %s\n",x.get_string(fps).c_str(),r.get_string(fps).c_str());
107 if(cur_time_.is_equal(x))
109 get_canvas()->set_time(cur_time_=x);
111 // update the time in all the child canvases
112 Canvas::Children children = get_canvas()->get_root()->children();
113 handle<CanvasInterface> interface;
114 for (Canvas::Children::iterator iter = children.begin(); iter != children.end(); iter++)
115 if ((interface = get_instance()->find_canvas_interface(*iter)) != this)
116 interface->set_time(interface->get_canvas()->get_time());
118 signal_time_changed()();
119 signal_dirty_preview()();
123 CanvasInterface::get_time()const
129 CanvasInterface::refresh_current_values()
131 get_canvas()->set_time(cur_time_);
132 signal_time_changed()();
133 signal_dirty_preview()();
136 etl::handle<CanvasInterface>
137 CanvasInterface::create(etl::loose_handle<Instance> instance, etl::handle<synfig::Canvas> canvas)
139 etl::handle<CanvasInterface> intrfc;
140 intrfc=new CanvasInterface(instance,canvas);
141 instance->canvas_interface_list().push_front(intrfc);
146 CanvasInterface::set_mode(Mode x)
148 Action::Handle action(Action::EditModeSet::create());
152 action->set_param("canvas",get_canvas());
153 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
154 action->set_param("edit_mode",x);
156 if(!action->is_ready())
158 get_ui_interface()->error(_("Action Not Ready, unable to change mode"));
163 if(!get_instance()->perform_action(action))
164 get_ui_interface()->error(_("Unable to change mode"));
167 // signal_mode_changed_(x);
170 CanvasInterface::Mode
171 CanvasInterface::get_mode()const
179 CanvasInterface::add_layer_to(synfig::String name, synfig::Canvas::Handle canvas, int depth)
181 synfigapp::Action::PassiveGrouper group(get_instance().get(),_("Add Layer To"));
183 Layer::Handle layer(Layer::create(name));
190 if(canvas!=get_canvas() && !canvas->is_inline())
192 synfig::error("Bad canvas passed to \"add_layer_to\"");
196 layer->set_canvas(canvas);
198 // Apply some defaults
199 if(layer->set_param("fg",synfigapp::Main::get_foreground_color()))
200 layer->set_param("bg",synfigapp::Main::get_background_color());
202 layer->set_param("color",synfigapp::Main::get_foreground_color());
204 layer->set_param("width",synfigapp::Main::get_bline_width().units(get_canvas()->rend_desc()));
205 layer->set_param("gradient",synfigapp::Main::get_gradient());
207 layer->set_param("amount",synfigapp::Main::get_opacity());
208 layer->set_param("blend_method",synfigapp::Main::get_blend_method());
211 // Grab the layer's list of parameters
212 Layer::ParamList paramlist=layer->get_param_list();
213 Layer::ParamList::iterator iter;
214 for(iter=paramlist.begin();iter!=paramlist.end();++iter)
216 ValueNode::Handle value_node;
218 if(iter->second.get_type()==ValueBase::TYPE_LIST)
219 value_node=LinkableValueNode::create("dynamic_list",iter->second);
220 else if(LinkableValueNode::check_type("composite",iter->second.get_type()) &&
221 (iter->second.get_type()!=ValueBase::TYPE_COLOR && iter->second.get_type()!=ValueBase::TYPE_VECTOR)
223 value_node=LinkableValueNode::create("composite",iter->second);
226 layer->connect_dynamic_param(iter->first,value_node);
230 // Action to add the layer
231 Action::Handle action(Action::LayerAdd::create());
237 action->set_param("canvas",canvas);
238 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
239 action->set_param("new",layer);
241 if(!action->is_ready())
243 get_ui_interface()->error(_("Action Not Ready"));
247 if(!get_instance()->perform_action(action))
249 get_ui_interface()->error(_("Action Failed."));
253 synfig::info("DEPTH=%d",depth);
254 // Action to move the layer (if necessary)
257 Action::Handle action(Action::create("layer_move"));
263 action->set_param("canvas",canvas);
264 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
265 action->set_param("layer",layer);
266 action->set_param("new_index",depth);
268 if(!action->is_ready())
270 get_ui_interface()->error(_("Move Action Not Ready"));
274 if(!get_instance()->perform_action(action))
276 get_ui_interface()->error(_("Move Action Failed."));
287 CanvasInterface::convert(ValueDesc value_desc, synfig::String type)
289 Action::Handle action(Action::ValueDescConvert::create());
295 action->set_param("canvas",get_canvas());
296 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
297 action->set_param("value_desc",value_desc);
298 action->set_param("type",type);
300 if(!action->is_ready())
302 get_ui_interface()->error(_("Action Not Ready"));
306 if(get_instance()->perform_action(action))
309 get_ui_interface()->error(_("Action Failed."));
314 CanvasInterface::add_value_node(synfig::ValueNode::Handle value_node, synfig::String name)
318 get_ui_interface()->error(_("Empty name!"));
322 Action::Handle action(Action::ValueNodeAdd::create());
328 action->set_param("canvas",get_canvas());
329 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
330 action->set_param("new",value_node);
331 action->set_param("name",name);
333 if(!action->is_ready())
335 get_ui_interface()->error(_("Action Not Ready"));
339 if(get_instance()->perform_action(action))
342 get_ui_interface()->error(_("Action Failed."));
347 CanvasInterface::generate_param_list(const ValueDesc &value_desc)
349 synfigapp::Action::ParamList param_list;
350 param_list.add("time",get_time());
351 param_list.add("canvas_interface",etl::handle<CanvasInterface>(this));
352 param_list.add("canvas",get_canvas());
354 param_list.add("value_desc",value_desc);
356 if(value_desc.parent_is_value_node())
357 param_list.add("parent_value_node",value_desc.get_parent_value_node());
359 if(value_desc.is_value_node())
360 param_list.add("value_node",value_desc.get_value_node());
362 if(value_desc.is_const())
363 param_list.add("value",value_desc.get_value());
365 if(value_desc.parent_is_layer_param())
367 param_list.add("parent_layer",value_desc.get_layer());
368 param_list.add("parent_layer_param",value_desc.get_param_name());
372 synfigapp::SelectionManager::ChildrenList children_list;
373 children_list=get_selection_manager()->get_selected_children();
374 if(!value_desc.parent_is_canvas() && children_list.size()==1)
376 param_list.add("dest",value_desc);
377 param_list.add("src",children_list.front().get_value_node());
384 CanvasInterface::generate_param_list(const std::list<synfigapp::ValueDesc> &value_desc_list)
386 synfigapp::Action::ParamList param_list;
387 param_list.add("time",get_time());
388 param_list.add("canvas_interface",etl::handle<CanvasInterface>(this));
389 param_list.add("canvas",get_canvas());
391 std::list<synfigapp::ValueDesc>::const_iterator iter;
392 for(iter=value_desc_list.begin();iter!=value_desc_list.end();++iter)
394 param_list.add("value_desc",*iter);
395 if(iter->is_value_node())
397 param_list.add("value_node",iter->get_value_node());
406 CanvasInterface::set_rend_desc(const synfig::RendDesc &rend_desc)
408 Action::Handle action(Action::create("canvas_rend_desc_set"));
414 action->set_param("canvas",get_canvas());
415 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
416 action->set_param("rend_desc",rend_desc);
418 if(!get_instance()->perform_action(action))
419 get_ui_interface()->error(_("Action Failed."));
423 CanvasInterface::set_name(const synfig::String &x)
425 //! \todo This needs to be converted into an action
426 get_canvas()->set_name(x);
427 signal_id_changed_();
432 CanvasInterface::set_description(const synfig::String &x)
434 //! \todo This needs to be converted into an action
435 get_canvas()->set_description(x);
440 CanvasInterface::set_id(const synfig::String &x)
442 //! \todo This needs to be converted into an action
443 get_canvas()->set_id(x);
444 signal_id_changed_();
450 CanvasInterface::jump_to_next_keyframe()
452 synfig::info("Current time: %s",get_time().get_string().c_str());
455 synfig::Keyframe keyframe(*get_canvas()->keyframe_list().find_next(get_time()));
456 synfig::info("Jumping to keyframe \"%s\" at %s",keyframe.get_description().c_str(),keyframe.get_time().get_string().c_str());
457 set_time(keyframe.get_time());
459 catch(...) { synfig::warning("Unable to find next keyframe"); }
463 CanvasInterface::jump_to_prev_keyframe()
465 synfig::info("Current time: %s",get_time().get_string().c_str());
468 synfig::Keyframe keyframe(*get_canvas()->keyframe_list().find_prev(get_time()));
469 synfig::info("Jumping to keyframe \"%s\" at %s",keyframe.get_description().c_str(),keyframe.get_time().get_string().c_str());
470 set_time(keyframe.get_time());
472 catch(...) { synfig::warning("Unable to find prev keyframe"); }
476 CanvasInterface::import(const synfig::String &filename, bool /*copy*/)
478 Action::PassiveGrouper group(get_instance().get(),_("Import Image"));
480 synfig::info("Attempting to import "+filename);
482 if (filename_extension(filename) == "")
484 get_ui_interface()->error(_("Filename must have an extension!"));
488 String ext(filename_extension(filename));
489 if (ext.size()) ext = ext.substr(1); // skip initial '.'
490 std::transform(ext.begin(),ext.end(),ext.begin(),&::tolower);
492 // If this is a SIF file, then we need to do things slightly differently
493 if(ext=="sif" || ext=="sifz")try
496 Canvas::Handle outside_canvas(synfig::open_canvas(filename));
498 throw String(_("Unable to open this composition"));
500 Layer::Handle layer(add_layer_to("PasteCanvas",get_canvas()));
502 throw String(_("Unable to create \"Paste Canvas\" layer"));
503 if(!layer->set_param("canvas",ValueBase(outside_canvas)))
506 //layer->set_description(basename(filename));
507 signal_layer_new_description()(layer,filename);
512 get_ui_interface()->error(x+" -- "+filename);
517 get_ui_interface()->error(_("Uncaught exception when attempting\nto open this composition -- ")+filename);
521 if(!Importer::book().count(ext))
523 get_ui_interface()->error(_("I don't know how to open images of this type -- ")+ext);
529 Layer::Handle layer(add_layer_to("Import",get_canvas()));
533 if(!layer->set_param("filename",ValueBase(filename)))
535 w=layer->get_param("_width").get(int());
536 h=layer->get_param("_height").get(int());
539 Vector size=ValueBase(get_canvas()->rend_desc().get_br()-get_canvas()->rend_desc().get_tl());
545 if(size[0]<0 ^ size[1]<0)
552 if(size[0]<0 ^ size[1]<0)
555 if(!layer->set_param("tl",ValueBase(-x/2)))
557 if(!layer->set_param("br",ValueBase(x/2)))
562 if(!layer->set_param("tl",ValueBase(get_canvas()->rend_desc().get_tl())))
564 if(!layer->set_param("br",ValueBase(get_canvas()->rend_desc().get_br())))
568 layer->set_description(basename(filename));
569 signal_layer_new_description()(layer,filename);
575 get_ui_interface()->error("Unable to import "+filename);
583 CanvasInterface::waypoint_duplicate(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
585 Action::Handle action(Action::create("waypoint_set_smart"));
591 waypoint.make_unique();
592 waypoint.set_time(get_time());
594 ValueNode::Handle value_node(value_desc.get_value_node());
596 action->set_param("canvas",get_canvas());
597 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
598 action->set_param("waypoint",waypoint);
599 action->set_param("time",get_time());
600 action->set_param("value_node",value_node);
602 if(!get_instance()->perform_action(action))
603 get_ui_interface()->error(_("Action Failed."));
607 CanvasInterface::waypoint_remove(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
609 Action::Handle action(Action::create("waypoint_remove"));
615 ValueNode::Handle value_node(value_desc.get_value_node());
617 action->set_param("canvas",get_canvas());
618 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
619 action->set_param("waypoint",waypoint);
620 action->set_param("value_node",value_node);
622 if(!get_instance()->perform_action(action))
623 get_ui_interface()->error(_("Action Failed."));
628 CanvasInterface::auto_export(synfig::ValueNode::Handle /*value_node*/)
631 // Check to see if we are already exported.
632 if(value_node->is_exported())
635 Action::Handle action(Action::create("value_node_add"));
641 String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
643 action->set_param("canvas",get_canvas());
644 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
645 action->set_param("new",value_node);
646 action->set_param("name",name);
648 if(!get_instance()->perform_action(action))
649 get_ui_interface()->error(_("Action Failed."));
654 CanvasInterface::auto_export(const ValueDesc& /*value_desc*/)
656 // THIS FUNCTION IS DEPRECATED, AND IS NOW A STUB.
658 // Check to see if we are already exported.
659 if(value_desc.is_exported())
662 Action::Handle action(Action::create("value_desc_export"));
668 String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
670 action->set_param("canvas",get_canvas());
671 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
672 action->set_param("value_desc",value_desc);
673 action->set_param("name",name);
675 if(!get_instance()->perform_action(action))
676 get_ui_interface()->error(_("Action Failed."));
681 CanvasInterface::change_value(synfigapp::ValueDesc value_desc,synfig::ValueBase new_value)
683 // If this isn't really a change, then don't bother
684 if(new_value==value_desc.get_value(get_time()))
687 // If this change needs to take place elsewhere, then so be it.
688 if(value_desc.get_canvas() && value_desc.get_canvas()->get_root()!=get_canvas()->get_root())do
690 etl::handle<Instance> instance;
691 instance=find_instance(value_desc.get_canvas()->get_root());
694 return instance->find_canvas_interface(value_desc.get_canvas())->change_value(value_desc,new_value);
697 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."));
703 { synfig::warning("Can't get canvas from value desc...?"); }
706 synfigapp::Action::Handle action(synfigapp::Action::create("value_desc_set"));
712 action->set_param("canvas",get_canvas());
713 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
714 action->set_param("time",get_time());
715 action->set_param("value_desc",value_desc);
716 action->set_param("new_value",new_value);
718 return get_instance()->perform_action(action);
722 CanvasInterface::set_meta_data(const synfig::String& key,const synfig::String& data)
724 get_canvas()->set_meta_data(key,data);
728 // this function goes with find_important_value_descs()
730 _process_value_desc(const synfigapp::ValueDesc& value_desc,std::vector<synfigapp::ValueDesc>& out, synfig::GUIDSet& guid_set)
734 if(value_desc.get_value_type()==ValueBase::TYPE_CANVAS)
736 Canvas::Handle canvas;
737 canvas=value_desc.get_value().get(canvas);
738 if(!canvas || !canvas->is_inline())
740 ret+=CanvasInterface::find_important_value_descs(canvas,out,guid_set);
743 if(value_desc.is_value_node())
745 ValueNode::Handle value_node(value_desc.get_value_node());
747 if(guid_set.count(value_node->get_guid()))
749 guid_set.insert(value_node->get_guid());
751 if(LinkableValueNode::Handle::cast_dynamic(value_node))
753 if(ValueNode_DynamicList::Handle::cast_dynamic(value_node))
755 out.push_back(value_desc);
758 // Process the linkable ValueNode's children
759 LinkableValueNode::Handle value_node_copy(LinkableValueNode::Handle::cast_dynamic(value_node));
761 for(i=0;i<value_node_copy->link_count();i++)
763 ValueNode::Handle link(value_node_copy->get_link(i));
764 if(!link->is_exported())
765 ret+=_process_value_desc(ValueDesc(value_node_copy,i),out,guid_set);
768 else if(ValueNode_Animated::Handle::cast_dynamic(value_node))
770 out.push_back(value_desc);
779 CanvasInterface::find_important_value_descs(synfig::Canvas::Handle canvas,std::vector<synfigapp::ValueDesc>& out,synfig::GUIDSet& guid_set)
782 if(!canvas->is_inline())
784 ValueNodeList::const_iterator iter;
787 iter=canvas->value_node_list().begin();
788 iter!=canvas->value_node_list().end();
790 ret+=_process_value_desc(ValueDesc(canvas,(*iter)->get_id()),out,guid_set);
793 Canvas::const_iterator iter;
795 for(iter=canvas->begin();iter!=canvas->end();++iter)
797 Layer::Handle layer(*iter);
799 Layer::DynamicParamList::const_iterator iter;
801 iter=layer->dynamic_param_list().begin();
802 iter!=layer->dynamic_param_list().end();
805 if(!iter->second->is_exported())
806 ret+=_process_value_desc(ValueDesc(layer,iter->first),out,guid_set);
808 ValueBase value(layer->get_param("canvas"));
810 ret+=_process_value_desc(ValueDesc(layer,"canvas"),out,guid_set);
817 CanvasInterface::find_important_value_descs(std::vector<synfigapp::ValueDesc>& out)
820 return find_important_value_descs(get_canvas(),out,tmp);
824 CanvasInterface::seek_frame(int frames)
828 float fps(get_canvas()->rend_desc().get_frame_rate());
829 Time newtime(get_time()+(float)frames/fps);
830 newtime=newtime.round(fps);
832 if(newtime<=get_canvas()->rend_desc().get_time_start())
833 newtime=get_canvas()->rend_desc().get_time_start();
834 if(newtime>=get_canvas()->rend_desc().get_time_end())
835 newtime=get_canvas()->rend_desc().get_time_end();
840 CanvasInterface::seek_time(synfig::Time time)
845 float fps(get_canvas()->rend_desc().get_frame_rate());
847 if(time>=synfig::Time::end())
849 set_time(get_canvas()->rend_desc().get_time_end());
852 if(time<=synfig::Time::begin())
854 set_time(get_canvas()->rend_desc().get_time_start());
858 Time newtime(get_time()+time);
859 newtime=newtime.round(fps);
861 if(newtime<=get_canvas()->rend_desc().get_time_start())
862 newtime=get_canvas()->rend_desc().get_time_start();
863 if(newtime>=get_canvas()->rend_desc().get_time_end())
864 newtime=get_canvas()->rend_desc().get_time_end();