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, 2008 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 if (getenv("SYNFIG_DEBUG_DESTRUCTORS"))
95 synfig::info("CanvasInterface::~CanvasInterface(): Deleted");
99 CanvasInterface::set_time(synfig::Time x)
101 if(get_canvas()->rend_desc().get_frame_rate())
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());
108 if(cur_time_.is_equal(x))
110 get_canvas()->set_time(cur_time_=x);
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());
119 signal_time_changed()();
120 signal_dirty_preview()();
124 CanvasInterface::get_time()const
130 CanvasInterface::refresh_current_values()
132 get_canvas()->set_time(cur_time_);
133 signal_time_changed()();
134 signal_dirty_preview()();
137 etl::handle<CanvasInterface>
138 CanvasInterface::create(etl::loose_handle<Instance> instance, etl::handle<synfig::Canvas> canvas)
140 etl::handle<CanvasInterface> intrfc;
141 intrfc=new CanvasInterface(instance,canvas);
142 instance->canvas_interface_list().push_front(intrfc);
147 CanvasInterface::set_mode(Mode x)
149 Action::Handle action(Action::EditModeSet::create());
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);
157 if(!action->is_ready())
159 get_ui_interface()->error(_("Action Not Ready, unable to change mode"));
164 if(!get_instance()->perform_action(action))
165 get_ui_interface()->error(_("Unable to change mode"));
168 // signal_mode_changed_(x);
171 CanvasInterface::Mode
172 CanvasInterface::get_mode()const
180 CanvasInterface::add_layer_to(synfig::String name, synfig::Canvas::Handle canvas, int depth)
182 synfigapp::Action::PassiveGrouper group(get_instance().get(),_("Add Layer To"));
184 Layer::Handle layer(Layer::create(name));
191 if(canvas!=get_canvas() && !canvas->is_inline())
193 synfig::error("Bad canvas passed to \"add_layer_to\"");
197 // automatically export the Index parameter of new Duplicate layers
198 if (name == "duplicate")
199 for (int i = 1; ; i++)
201 String name = strprintf(_("Index %d"), i);
204 canvas->find_value_node(name);
206 catch (Exception::IDNotFound x)
208 add_value_node(layer->dynamic_param_list().find("index")->second, name);
213 layer->set_canvas(canvas);
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());
219 layer->set_param("color",synfigapp::Main::get_foreground_color());
221 layer->set_param("width",synfigapp::Main::get_bline_width().units(get_canvas()->rend_desc()));
222 layer->set_param("gradient",synfigapp::Main::get_gradient());
224 layer->set_param("amount",synfigapp::Main::get_opacity());
225 layer->set_param("blend_method",synfigapp::Main::get_blend_method());
228 // Grab the layer's list of parameters
229 Layer::ParamList paramlist=layer->get_param_list();
230 Layer::ParamList::iterator iter;
232 // loop through the static parameters
233 for(iter=paramlist.begin();iter!=paramlist.end();++iter)
235 ValueNode::Handle value_node;
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);
249 layer->connect_dynamic_param(iter->first,value_node);
253 // Action to add the layer
254 Action::Handle action(Action::LayerAdd::create());
260 action->set_param("canvas",canvas);
261 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
262 action->set_param("new",layer);
264 if(!action->is_ready())
266 get_ui_interface()->error(_("Action Not Ready"));
270 if(!get_instance()->perform_action(action))
272 get_ui_interface()->error(_("Action Failed."));
276 // synfig::info("DEPTH=%d",depth);
278 // Action to move the layer (if necessary)
281 Action::Handle action(Action::create("layer_move"));
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);
292 if(!action->is_ready())
294 get_ui_interface()->error(_("Move Action Not Ready"));
298 if(!get_instance()->perform_action(action))
300 get_ui_interface()->error(_("Move Action Failed."));
311 CanvasInterface::convert(ValueDesc value_desc, synfig::String type)
313 Action::Handle action(Action::ValueDescConvert::create());
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());
325 if(!action->is_ready())
327 get_ui_interface()->error(_("Action Not Ready"));
331 if(get_instance()->perform_action(action))
334 get_ui_interface()->error(_("Action Failed."));
339 CanvasInterface::add_value_node(synfig::ValueNode::Handle value_node, synfig::String name)
343 get_ui_interface()->error(_("Empty name!"));
347 Action::Handle action(Action::ValueNodeAdd::create());
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);
358 if(!action->is_ready())
360 get_ui_interface()->error(_("Action Not Ready"));
364 if(get_instance()->perform_action(action))
367 get_ui_interface()->error(_("Action Failed."));
372 CanvasInterface::generate_param_list(const ValueDesc &value_desc)
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());
379 param_list.add("value_desc",value_desc);
381 if(value_desc.parent_is_value_node())
382 param_list.add("parent_value_node",value_desc.get_parent_value_node());
384 if(value_desc.is_value_node())
385 param_list.add("value_node",value_desc.get_value_node());
387 if(value_desc.is_const())
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())));
398 param_list.add("value",value_desc.get_value());
401 if(value_desc.parent_is_layer_param())
403 param_list.add("parent_layer",value_desc.get_layer());
404 param_list.add("parent_layer_param",value_desc.get_param_name());
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)
412 param_list.add("dest",value_desc);
413 param_list.add("src",children_list.front().get_value_node());
420 CanvasInterface::generate_param_list(const std::list<synfigapp::ValueDesc> &value_desc_list)
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());
427 std::list<synfigapp::ValueDesc>::const_iterator iter;
428 for(iter=value_desc_list.begin();iter!=value_desc_list.end();++iter)
430 param_list.add("value_desc",*iter);
431 if(iter->is_value_node())
433 param_list.add("value_node",iter->get_value_node());
442 CanvasInterface::set_rend_desc(const synfig::RendDesc &rend_desc)
444 Action::Handle action(Action::create("canvas_rend_desc_set"));
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);
454 if(!get_instance()->perform_action(action))
455 get_ui_interface()->error(_("Action Failed."));
459 CanvasInterface::set_name(const synfig::String &x)
461 //! \todo This needs to be converted into an action
462 get_canvas()->set_name(x);
463 signal_id_changed_();
468 CanvasInterface::set_description(const synfig::String &x)
470 //! \todo This needs to be converted into an action
471 get_canvas()->set_description(x);
476 CanvasInterface::set_id(const synfig::String &x)
478 //! \todo This needs to be converted into an action
479 get_canvas()->set_id(x);
480 signal_id_changed_();
486 CanvasInterface::jump_to_next_keyframe()
488 synfig::info("Current time: %s",get_time().get_string().c_str());
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());
495 catch(...) { synfig::warning("Unable to find next keyframe"); }
499 CanvasInterface::jump_to_prev_keyframe()
501 synfig::info("Current time: %s",get_time().get_string().c_str());
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());
508 catch(...) { synfig::warning("Unable to find prev keyframe"); }
512 CanvasInterface::import(const synfig::String &filename, bool /*copy*/)
514 Action::PassiveGrouper group(get_instance().get(),_("Import Image"));
516 synfig::info("Attempting to import "+filename);
518 if (filename_extension(filename) == "")
520 get_ui_interface()->error(_("Filename must have an extension!"));
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);
528 // If this is a SIF file, then we need to do things slightly differently
529 if(ext=="sif" || ext=="sifz")try
532 Canvas::Handle outside_canvas(synfig::open_canvas(filename));
534 throw String(_("Unable to open this composition"));
536 Layer::Handle layer(add_layer_to("PasteCanvas",get_canvas()));
538 throw String(_("Unable to create \"Paste Canvas\" layer"));
539 if(!layer->set_param("canvas",ValueBase(outside_canvas)))
542 //layer->set_description(basename(filename));
543 signal_layer_new_description()(layer,filename);
548 get_ui_interface()->error(x+" -- "+filename);
553 get_ui_interface()->error(_("Uncaught exception when attempting\nto open this composition -- ")+filename);
557 if(!Importer::book().count(ext))
559 get_ui_interface()->error(_("I don't know how to open images of this type -- ")+ext);
565 Layer::Handle layer(add_layer_to("Import",get_canvas()));
569 if(!layer->set_param("filename",ValueBase(filename)))
571 w=layer->get_param("_width").get(int());
572 h=layer->get_param("_height").get(int());
575 Vector size=ValueBase(get_canvas()->rend_desc().get_br()-get_canvas()->rend_desc().get_tl());
581 if((size[0]<0) ^ (size[1]<0))
588 if((size[0]<0) ^ (size[1]<0))
591 if(!layer->set_param("tl",ValueBase(-x/2)))
593 if(!layer->set_param("br",ValueBase(x/2)))
598 if(!layer->set_param("tl",ValueBase(get_canvas()->rend_desc().get_tl())))
600 if(!layer->set_param("br",ValueBase(get_canvas()->rend_desc().get_br())))
604 layer->set_description(basename(filename));
605 signal_layer_new_description()(layer,filename);
611 get_ui_interface()->error("Unable to import "+filename);
619 CanvasInterface::waypoint_duplicate(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
621 ValueNode::Handle value_node();
622 waypoint_duplicate(value_desc.get_value_node(), waypoint);
626 CanvasInterface::waypoint_duplicate(ValueNode::Handle value_node,synfig::Waypoint waypoint)
628 Action::Handle action(Action::create("waypoint_set_smart"));
634 waypoint.make_unique();
635 waypoint.set_time(get_time());
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);
643 if(!get_instance()->perform_action(action))
644 get_ui_interface()->error(_("Action Failed."));
648 CanvasInterface::waypoint_remove(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
650 ValueNode::Handle value_node();
651 waypoint_remove(value_desc.get_value_node(), waypoint);
655 CanvasInterface::waypoint_remove(ValueNode::Handle value_node,synfig::Waypoint waypoint)
657 Action::Handle action(Action::create("waypoint_remove"));
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);
668 if(!get_instance()->perform_action(action))
669 get_ui_interface()->error(_("Action Failed."));
674 CanvasInterface::auto_export(synfig::ValueNode::Handle /*value_node*/)
677 // Check to see if we are already exported.
678 if(value_node->is_exported())
681 Action::Handle action(Action::create("value_node_add"));
687 String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
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);
694 if(!get_instance()->perform_action(action))
695 get_ui_interface()->error(_("Action Failed."));
700 CanvasInterface::auto_export(const ValueDesc& /*value_desc*/)
702 // THIS FUNCTION IS DEPRECATED, AND IS NOW A STUB.
704 // Check to see if we are already exported.
705 if(value_desc.is_exported())
708 Action::Handle action(Action::create("value_desc_export"));
714 String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
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);
721 if(!get_instance()->perform_action(action))
722 get_ui_interface()->error(_("Action Failed."));
727 CanvasInterface::change_value(synfigapp::ValueDesc value_desc,synfig::ValueBase new_value)
729 // If this isn't really a change, then don't bother
730 if(new_value==value_desc.get_value(get_time()))
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
736 etl::handle<Instance> instance;
737 instance=find_instance(value_desc.get_canvas()->get_root());
740 return instance->find_canvas_interface(value_desc.get_canvas())->change_value(value_desc,new_value);
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."));
749 { synfig::warning("Can't get canvas from value desc...?"); }
752 synfigapp::Action::Handle action(synfigapp::Action::create("value_desc_set"));
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);
764 return get_instance()->perform_action(action);
768 CanvasInterface::set_meta_data(const synfig::String& key,const synfig::String& data)
770 get_canvas()->set_meta_data(key,data);
774 // this function goes with find_important_value_descs()
776 _process_value_desc(const synfigapp::ValueDesc& value_desc,std::vector<synfigapp::ValueDesc>& out, synfig::GUIDSet& guid_set)
780 if(value_desc.get_value_type()==ValueBase::TYPE_CANVAS)
782 Canvas::Handle canvas;
783 canvas=value_desc.get_value().get(canvas);
784 if(!canvas || !canvas->is_inline())
786 ret+=CanvasInterface::find_important_value_descs(canvas,out,guid_set);
789 if(value_desc.is_value_node())
791 ValueNode::Handle value_node(value_desc.get_value_node());
793 if(guid_set.count(value_node->get_guid()))
795 guid_set.insert(value_node->get_guid());
797 if(LinkableValueNode::Handle::cast_dynamic(value_node))
799 if(ValueNode_DynamicList::Handle::cast_dynamic(value_node))
801 out.push_back(value_desc);
804 // Process the linkable ValueNode's children
805 LinkableValueNode::Handle value_node_copy(LinkableValueNode::Handle::cast_dynamic(value_node));
807 for(i=0;i<value_node_copy->link_count();i++)
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);
814 else if(ValueNode_Animated::Handle::cast_dynamic(value_node))
816 out.push_back(value_desc);
825 CanvasInterface::find_important_value_descs(synfig::Canvas::Handle canvas,std::vector<synfigapp::ValueDesc>& out,synfig::GUIDSet& guid_set)
828 if(!canvas->is_inline())
830 ValueNodeList::const_iterator iter;
833 iter=canvas->value_node_list().begin();
834 iter!=canvas->value_node_list().end();
836 ret+=_process_value_desc(ValueDesc(canvas,(*iter)->get_id()),out,guid_set);
839 Canvas::const_iterator iter;
841 for(iter=canvas->begin();iter!=canvas->end();++iter)
843 Layer::Handle layer(*iter);
845 Layer::DynamicParamList::const_iterator iter;
847 iter=layer->dynamic_param_list().begin();
848 iter!=layer->dynamic_param_list().end();
851 if(!iter->second->is_exported())
852 ret+=_process_value_desc(ValueDesc(layer,iter->first),out,guid_set);
854 ValueBase value(layer->get_param("canvas"));
856 ret+=_process_value_desc(ValueDesc(layer,"canvas"),out,guid_set);
863 CanvasInterface::find_important_value_descs(std::vector<synfigapp::ValueDesc>& out)
866 return find_important_value_descs(get_canvas(),out,tmp);
870 CanvasInterface::seek_frame(int frames)
874 float fps(get_canvas()->rend_desc().get_frame_rate());
875 Time newtime(get_time()+(float)frames/fps);
876 newtime=newtime.round(fps);
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();
886 CanvasInterface::seek_time(synfig::Time time)
891 float fps(get_canvas()->rend_desc().get_frame_rate());
893 if(time>=synfig::Time::end())
895 set_time(get_canvas()->rend_desc().get_time_end());
898 if(time<=synfig::Time::begin())
900 set_time(get_canvas()->rend_desc().get_time_start());
904 Time newtime(get_time()+time);
905 newtime=newtime.round(fps);
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();