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 // automatically export the Index parameter of new Duplicate layers
197 if (name == "duplicate")
198 for (int i = 1; ; i++)
200 String name = strprintf(_("Index %d"), i);
203 canvas->find_value_node(name);
205 catch (Exception::IDNotFound x)
207 add_value_node(layer->dynamic_param_list().find("index")->second, name);
212 layer->set_canvas(canvas);
214 // Apply some defaults
215 if(layer->set_param("fg",synfigapp::Main::get_foreground_color()))
216 layer->set_param("bg",synfigapp::Main::get_background_color());
218 layer->set_param("color",synfigapp::Main::get_foreground_color());
220 layer->set_param("width",synfigapp::Main::get_bline_width().units(get_canvas()->rend_desc()));
221 layer->set_param("gradient",synfigapp::Main::get_gradient());
223 layer->set_param("amount",synfigapp::Main::get_opacity());
224 layer->set_param("blend_method",synfigapp::Main::get_blend_method());
227 // Grab the layer's list of parameters
228 Layer::ParamList paramlist=layer->get_param_list();
229 Layer::ParamList::iterator iter;
230 for(iter=paramlist.begin();iter!=paramlist.end();++iter)
232 ValueNode::Handle value_node;
234 if(iter->second.get_type()==ValueBase::TYPE_LIST)
235 value_node=LinkableValueNode::create("dynamic_list",iter->second);
236 else if(LinkableValueNode::check_type("composite",iter->second.get_type()) &&
237 (iter->second.get_type()!=ValueBase::TYPE_COLOR && iter->second.get_type()!=ValueBase::TYPE_VECTOR)
239 value_node=LinkableValueNode::create("composite",iter->second);
242 layer->connect_dynamic_param(iter->first,value_node);
246 // Action to add the layer
247 Action::Handle action(Action::LayerAdd::create());
253 action->set_param("canvas",canvas);
254 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
255 action->set_param("new",layer);
257 if(!action->is_ready())
259 get_ui_interface()->error(_("Action Not Ready"));
263 if(!get_instance()->perform_action(action))
265 get_ui_interface()->error(_("Action Failed."));
269 synfig::info("DEPTH=%d",depth);
270 // Action to move the layer (if necessary)
273 Action::Handle action(Action::create("layer_move"));
279 action->set_param("canvas",canvas);
280 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
281 action->set_param("layer",layer);
282 action->set_param("new_index",depth);
284 if(!action->is_ready())
286 get_ui_interface()->error(_("Move Action Not Ready"));
290 if(!get_instance()->perform_action(action))
292 get_ui_interface()->error(_("Move Action Failed."));
303 CanvasInterface::convert(ValueDesc value_desc, synfig::String type)
305 Action::Handle action(Action::ValueDescConvert::create());
311 action->set_param("canvas",get_canvas());
312 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
313 action->set_param("value_desc",value_desc);
314 action->set_param("type",type);
315 action->set_param("time",get_time());
317 if(!action->is_ready())
319 get_ui_interface()->error(_("Action Not Ready"));
323 if(get_instance()->perform_action(action))
326 get_ui_interface()->error(_("Action Failed."));
331 CanvasInterface::add_value_node(synfig::ValueNode::Handle value_node, synfig::String name)
335 get_ui_interface()->error(_("Empty name!"));
339 Action::Handle action(Action::ValueNodeAdd::create());
345 action->set_param("canvas",get_canvas());
346 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
347 action->set_param("new",value_node);
348 action->set_param("name",name);
350 if(!action->is_ready())
352 get_ui_interface()->error(_("Action Not Ready"));
356 if(get_instance()->perform_action(action))
359 get_ui_interface()->error(_("Action Failed."));
364 CanvasInterface::generate_param_list(const ValueDesc &value_desc)
366 synfigapp::Action::ParamList param_list;
367 param_list.add("time",get_time());
368 param_list.add("canvas_interface",etl::handle<CanvasInterface>(this));
369 param_list.add("canvas",get_canvas());
371 param_list.add("value_desc",value_desc);
373 if(value_desc.parent_is_value_node())
374 param_list.add("parent_value_node",value_desc.get_parent_value_node());
376 if(value_desc.is_value_node())
377 param_list.add("value_node",value_desc.get_value_node());
379 if(value_desc.is_const())
381 // Fix 1868911: if we put a ValueBase holding a Canvas handle
382 // into the param_list and then export the canvas, the handle
383 // will miss out of having its reference count reduced,
384 // because by the time the handle is destructed the canvas
385 // will no longer be inline. So let's not propogate that
386 // ValueBase any further than here.
387 if (value_desc.get_value_type() == ValueBase::TYPE_CANVAS)
388 param_list.add("value",Canvas::LooseHandle(value_desc.get_value().get(Canvas::LooseHandle())));
390 param_list.add("value",value_desc.get_value());
393 if(value_desc.parent_is_layer_param())
395 param_list.add("parent_layer",value_desc.get_layer());
396 param_list.add("parent_layer_param",value_desc.get_param_name());
400 synfigapp::SelectionManager::ChildrenList children_list;
401 children_list=get_selection_manager()->get_selected_children();
402 if(!value_desc.parent_is_canvas() && children_list.size()==1)
404 param_list.add("dest",value_desc);
405 param_list.add("src",children_list.front().get_value_node());
412 CanvasInterface::generate_param_list(const std::list<synfigapp::ValueDesc> &value_desc_list)
414 synfigapp::Action::ParamList param_list;
415 param_list.add("time",get_time());
416 param_list.add("canvas_interface",etl::handle<CanvasInterface>(this));
417 param_list.add("canvas",get_canvas());
419 std::list<synfigapp::ValueDesc>::const_iterator iter;
420 for(iter=value_desc_list.begin();iter!=value_desc_list.end();++iter)
422 param_list.add("value_desc",*iter);
423 if(iter->is_value_node())
425 param_list.add("value_node",iter->get_value_node());
434 CanvasInterface::set_rend_desc(const synfig::RendDesc &rend_desc)
436 Action::Handle action(Action::create("canvas_rend_desc_set"));
442 action->set_param("canvas",get_canvas());
443 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
444 action->set_param("rend_desc",rend_desc);
446 if(!get_instance()->perform_action(action))
447 get_ui_interface()->error(_("Action Failed."));
451 CanvasInterface::set_name(const synfig::String &x)
453 //! \todo This needs to be converted into an action
454 get_canvas()->set_name(x);
455 signal_id_changed_();
460 CanvasInterface::set_description(const synfig::String &x)
462 //! \todo This needs to be converted into an action
463 get_canvas()->set_description(x);
468 CanvasInterface::set_id(const synfig::String &x)
470 //! \todo This needs to be converted into an action
471 get_canvas()->set_id(x);
472 signal_id_changed_();
478 CanvasInterface::jump_to_next_keyframe()
480 synfig::info("Current time: %s",get_time().get_string().c_str());
483 synfig::Keyframe keyframe(*get_canvas()->keyframe_list().find_next(get_time()));
484 synfig::info("Jumping to keyframe \"%s\" at %s",keyframe.get_description().c_str(),keyframe.get_time().get_string().c_str());
485 set_time(keyframe.get_time());
487 catch(...) { synfig::warning("Unable to find next keyframe"); }
491 CanvasInterface::jump_to_prev_keyframe()
493 synfig::info("Current time: %s",get_time().get_string().c_str());
496 synfig::Keyframe keyframe(*get_canvas()->keyframe_list().find_prev(get_time()));
497 synfig::info("Jumping to keyframe \"%s\" at %s",keyframe.get_description().c_str(),keyframe.get_time().get_string().c_str());
498 set_time(keyframe.get_time());
500 catch(...) { synfig::warning("Unable to find prev keyframe"); }
504 CanvasInterface::import(const synfig::String &filename, bool /*copy*/)
506 Action::PassiveGrouper group(get_instance().get(),_("Import Image"));
508 synfig::info("Attempting to import "+filename);
510 if (filename_extension(filename) == "")
512 get_ui_interface()->error(_("Filename must have an extension!"));
516 String ext(filename_extension(filename));
517 if (ext.size()) ext = ext.substr(1); // skip initial '.'
518 std::transform(ext.begin(),ext.end(),ext.begin(),&::tolower);
520 // If this is a SIF file, then we need to do things slightly differently
521 if(ext=="sif" || ext=="sifz")try
524 Canvas::Handle outside_canvas(synfig::open_canvas(filename));
526 throw String(_("Unable to open this composition"));
528 Layer::Handle layer(add_layer_to("PasteCanvas",get_canvas()));
530 throw String(_("Unable to create \"Paste Canvas\" layer"));
531 if(!layer->set_param("canvas",ValueBase(outside_canvas)))
534 //layer->set_description(basename(filename));
535 signal_layer_new_description()(layer,filename);
540 get_ui_interface()->error(x+" -- "+filename);
545 get_ui_interface()->error(_("Uncaught exception when attempting\nto open this composition -- ")+filename);
549 if(!Importer::book().count(ext))
551 get_ui_interface()->error(_("I don't know how to open images of this type -- ")+ext);
557 Layer::Handle layer(add_layer_to("Import",get_canvas()));
561 if(!layer->set_param("filename",ValueBase(filename)))
563 w=layer->get_param("_width").get(int());
564 h=layer->get_param("_height").get(int());
567 Vector size=ValueBase(get_canvas()->rend_desc().get_br()-get_canvas()->rend_desc().get_tl());
573 if((size[0]<0) ^ (size[1]<0))
580 if((size[0]<0) ^ (size[1]<0))
583 if(!layer->set_param("tl",ValueBase(-x/2)))
585 if(!layer->set_param("br",ValueBase(x/2)))
590 if(!layer->set_param("tl",ValueBase(get_canvas()->rend_desc().get_tl())))
592 if(!layer->set_param("br",ValueBase(get_canvas()->rend_desc().get_br())))
596 layer->set_description(basename(filename));
597 signal_layer_new_description()(layer,filename);
603 get_ui_interface()->error("Unable to import "+filename);
611 CanvasInterface::waypoint_duplicate(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
613 Action::Handle action(Action::create("waypoint_set_smart"));
619 waypoint.make_unique();
620 waypoint.set_time(get_time());
622 ValueNode::Handle value_node(value_desc.get_value_node());
624 action->set_param("canvas",get_canvas());
625 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
626 action->set_param("waypoint",waypoint);
627 action->set_param("time",get_time());
628 action->set_param("value_node",value_node);
630 if(!get_instance()->perform_action(action))
631 get_ui_interface()->error(_("Action Failed."));
635 CanvasInterface::waypoint_remove(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
637 Action::Handle action(Action::create("waypoint_remove"));
643 ValueNode::Handle value_node(value_desc.get_value_node());
645 action->set_param("canvas",get_canvas());
646 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
647 action->set_param("waypoint",waypoint);
648 action->set_param("value_node",value_node);
650 if(!get_instance()->perform_action(action))
651 get_ui_interface()->error(_("Action Failed."));
656 CanvasInterface::auto_export(synfig::ValueNode::Handle /*value_node*/)
659 // Check to see if we are already exported.
660 if(value_node->is_exported())
663 Action::Handle action(Action::create("value_node_add"));
669 String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
671 action->set_param("canvas",get_canvas());
672 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
673 action->set_param("new",value_node);
674 action->set_param("name",name);
676 if(!get_instance()->perform_action(action))
677 get_ui_interface()->error(_("Action Failed."));
682 CanvasInterface::auto_export(const ValueDesc& /*value_desc*/)
684 // THIS FUNCTION IS DEPRECATED, AND IS NOW A STUB.
686 // Check to see if we are already exported.
687 if(value_desc.is_exported())
690 Action::Handle action(Action::create("value_desc_export"));
696 String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
698 action->set_param("canvas",get_canvas());
699 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
700 action->set_param("value_desc",value_desc);
701 action->set_param("name",name);
703 if(!get_instance()->perform_action(action))
704 get_ui_interface()->error(_("Action Failed."));
709 CanvasInterface::change_value(synfigapp::ValueDesc value_desc,synfig::ValueBase new_value)
711 // If this isn't really a change, then don't bother
712 if(new_value==value_desc.get_value(get_time()))
715 // If this change needs to take place elsewhere, then so be it.
716 if(value_desc.get_canvas() && value_desc.get_canvas()->get_root()!=get_canvas()->get_root())do
718 etl::handle<Instance> instance;
719 instance=find_instance(value_desc.get_canvas()->get_root());
722 return instance->find_canvas_interface(value_desc.get_canvas())->change_value(value_desc,new_value);
725 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."));
731 { synfig::warning("Can't get canvas from value desc...?"); }
734 synfigapp::Action::Handle action(synfigapp::Action::create("value_desc_set"));
740 action->set_param("canvas",get_canvas());
741 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
742 action->set_param("time",get_time());
743 action->set_param("value_desc",value_desc);
744 action->set_param("new_value",new_value);
746 return get_instance()->perform_action(action);
750 CanvasInterface::set_meta_data(const synfig::String& key,const synfig::String& data)
752 get_canvas()->set_meta_data(key,data);
756 // this function goes with find_important_value_descs()
758 _process_value_desc(const synfigapp::ValueDesc& value_desc,std::vector<synfigapp::ValueDesc>& out, synfig::GUIDSet& guid_set)
762 if(value_desc.get_value_type()==ValueBase::TYPE_CANVAS)
764 Canvas::Handle canvas;
765 canvas=value_desc.get_value().get(canvas);
766 if(!canvas || !canvas->is_inline())
768 ret+=CanvasInterface::find_important_value_descs(canvas,out,guid_set);
771 if(value_desc.is_value_node())
773 ValueNode::Handle value_node(value_desc.get_value_node());
775 if(guid_set.count(value_node->get_guid()))
777 guid_set.insert(value_node->get_guid());
779 if(LinkableValueNode::Handle::cast_dynamic(value_node))
781 if(ValueNode_DynamicList::Handle::cast_dynamic(value_node))
783 out.push_back(value_desc);
786 // Process the linkable ValueNode's children
787 LinkableValueNode::Handle value_node_copy(LinkableValueNode::Handle::cast_dynamic(value_node));
789 for(i=0;i<value_node_copy->link_count();i++)
791 ValueNode::Handle link(value_node_copy->get_link(i));
792 if(!link->is_exported())
793 ret+=_process_value_desc(ValueDesc(value_node_copy,i),out,guid_set);
796 else if(ValueNode_Animated::Handle::cast_dynamic(value_node))
798 out.push_back(value_desc);
807 CanvasInterface::find_important_value_descs(synfig::Canvas::Handle canvas,std::vector<synfigapp::ValueDesc>& out,synfig::GUIDSet& guid_set)
810 if(!canvas->is_inline())
812 ValueNodeList::const_iterator iter;
815 iter=canvas->value_node_list().begin();
816 iter!=canvas->value_node_list().end();
818 ret+=_process_value_desc(ValueDesc(canvas,(*iter)->get_id()),out,guid_set);
821 Canvas::const_iterator iter;
823 for(iter=canvas->begin();iter!=canvas->end();++iter)
825 Layer::Handle layer(*iter);
827 Layer::DynamicParamList::const_iterator iter;
829 iter=layer->dynamic_param_list().begin();
830 iter!=layer->dynamic_param_list().end();
833 if(!iter->second->is_exported())
834 ret+=_process_value_desc(ValueDesc(layer,iter->first),out,guid_set);
836 ValueBase value(layer->get_param("canvas"));
838 ret+=_process_value_desc(ValueDesc(layer,"canvas"),out,guid_set);
845 CanvasInterface::find_important_value_descs(std::vector<synfigapp::ValueDesc>& out)
848 return find_important_value_descs(get_canvas(),out,tmp);
852 CanvasInterface::seek_frame(int frames)
856 float fps(get_canvas()->rend_desc().get_frame_rate());
857 Time newtime(get_time()+(float)frames/fps);
858 newtime=newtime.round(fps);
860 if(newtime<=get_canvas()->rend_desc().get_time_start())
861 newtime=get_canvas()->rend_desc().get_time_start();
862 if(newtime>=get_canvas()->rend_desc().get_time_end())
863 newtime=get_canvas()->rend_desc().get_time_end();
868 CanvasInterface::seek_time(synfig::Time time)
873 float fps(get_canvas()->rend_desc().get_frame_rate());
875 if(time>=synfig::Time::end())
877 set_time(get_canvas()->rend_desc().get_time_end());
880 if(time<=synfig::Time::begin())
882 set_time(get_canvas()->rend_desc().get_time_start());
886 Time newtime(get_time()+time);
887 newtime=newtime.round(fps);
889 if(newtime<=get_canvas()->rend_desc().get_time_start())
890 newtime=get_canvas()->rend_desc().get_time_start();
891 if(newtime>=get_canvas()->rend_desc().get_time_end())
892 newtime=get_canvas()->rend_desc().get_time_end();