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
10 ** This package is free software; you can redistribute it and/or
11 ** modify it under the terms of the GNU General Public License as
12 ** published by the Free Software Foundation; either version 2 of
13 ** the License, or (at your option) any later version.
15 ** This package is distributed in the hope that it will be useful,
16 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 ** General Public License for more details.
21 /* ========================================================================= */
23 /* === H E A D E R S ======================================================= */
35 #include <synfig/valuenode_scale.h>
36 #include <synfig/valuenode_timedswap.h>
37 #include <synfig/valuenode_composite.h>
38 #include <synfig/valuenode_subtract.h>
39 #include <synfig/valuenode_linear.h>
40 #include <synfig/valuenode_reference.h>
41 #include <synfig/valuenode_twotone.h>
42 #include <synfig/valuenode_stripes.h>
44 #include <synfig/waypoint.h>
45 #include <synfig/loadcanvas.h>
46 #include <synfig/importer.h>
47 #include <synfig/guidset.h>
49 #include "canvasinterface.h"
52 #include "actions/layeradd.h"
53 #include "actions/valuedescconvert.h"
54 #include "actions/valuenodeadd.h"
55 #include "actions/editmodeset.h"
56 #include "action_system.h"
60 #include <synfig/gradient.h>
64 /* === U S I N G =========================================================== */
68 using namespace synfig;
69 using namespace synfigapp;
71 /* === M A C R O S ========================================================= */
73 /* === G L O B A L S ======================================================= */
75 /* === P R O C E D U R E S ================================================= */
77 /* === M E T H O D S ======================================================= */
79 CanvasInterface::CanvasInterface(loose_handle<Instance> instance,handle<Canvas> canvas):
82 cur_time_(canvas->rend_desc().get_frame_start()),
83 mode_(MODE_NORMAL|MODE_ANIMATE_PAST|MODE_ANIMATE_FUTURE)
85 set_selection_manager(get_instance()->get_selection_manager());
86 set_ui_interface(get_instance()->get_ui_interface());
89 CanvasInterface::~CanvasInterface()
91 synfig::info("synfigapp::CanvasInterface::~CanvasInterface(): Deleted");
95 CanvasInterface::set_time(synfig::Time x)
97 if(get_canvas()->rend_desc().get_frame_rate())
99 float fps(get_canvas()->rend_desc().get_frame_rate());
100 Time r(x.round(fps));
101 //synfig::info("CanvasInterface::set_time(): %s rounded to %s\n",x.get_string(fps).c_str(),r.get_string(fps).c_str());
104 if(cur_time_.is_equal(x))
106 get_canvas()->set_time(cur_time_=x);
108 // update the time in all the child canvases
109 Canvas::Children children = get_canvas()->get_root()->children();
110 for (Canvas::Children::iterator iter = children.begin(); iter != children.end(); iter++)
111 if (handle<CanvasInterface> interface = get_instance()->find_canvas_interface(*iter))
112 interface->set_time(interface->get_canvas()->get_time());
114 signal_time_changed()();
115 signal_dirty_preview()();
119 CanvasInterface::get_time()const
125 CanvasInterface::refresh_current_values()
127 get_canvas()->set_time(cur_time_);
128 signal_time_changed()();
129 signal_dirty_preview()();
132 etl::handle<CanvasInterface>
133 CanvasInterface::create(loose_handle<Instance> instance,handle<Canvas> canvas)
135 etl::handle<CanvasInterface> intrfc;
136 intrfc=new CanvasInterface(instance,canvas);
137 instance->canvas_interface_list().push_front(intrfc);
142 CanvasInterface::set_mode(Mode x)
144 Action::Handle action(Action::EditModeSet::create());
148 action->set_param("canvas",get_canvas());
149 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
150 action->set_param("edit_mode",x);
152 if(!action->is_ready())
154 get_ui_interface()->error(_("Action Not Ready, unable to change mode"));
159 if(!get_instance()->perform_action(action))
160 get_ui_interface()->error(_("Unable to change mode"));
163 // signal_mode_changed_(x);
166 CanvasInterface::Mode
167 CanvasInterface::get_mode()const
175 CanvasInterface::add_layer_to(String name, Canvas::Handle canvas, int depth)
177 synfigapp::Action::PassiveGrouper group(get_instance().get(),_("Add Layer To"));
179 Layer::Handle layer(Layer::create(name));
186 if(canvas!=get_canvas() && !canvas->is_inline())
188 synfig::error("Bad canvas passed to \"add_layer_to\"");
192 layer->set_canvas(canvas);
194 // Apply some defaults
195 if(layer->set_param("fg",synfigapp::Main::get_foreground_color()))
196 layer->set_param("bg",synfigapp::Main::get_background_color());
198 layer->set_param("color",synfigapp::Main::get_foreground_color());
200 layer->set_param("width",synfigapp::Main::get_bline_width().units(get_canvas()->rend_desc()));
201 layer->set_param("gradient",synfigapp::Main::get_gradient());
203 layer->set_param("amount",synfigapp::Main::get_opacity());
204 layer->set_param("blend_method",synfigapp::Main::get_blend_method());
207 // Grab the layer's list pf parameters
208 Layer::ParamList paramlist=layer->get_param_list();
209 Layer::ParamList::iterator iter;
210 for(iter=paramlist.begin();iter!=paramlist.end();++iter)
212 ValueNode::Handle value_node;
214 if(iter->second.get_type()==ValueBase::TYPE_LIST)
215 value_node=LinkableValueNode::create("dynamic_list",iter->second);
216 else if(LinkableValueNode::check_type("composite",iter->second.get_type()) &&
217 (iter->second.get_type()!=ValueBase::TYPE_COLOR && iter->second.get_type()!=ValueBase::TYPE_VECTOR)
219 value_node=LinkableValueNode::create("composite",iter->second);
222 layer->connect_dynamic_param(iter->first,value_node);
226 // Action to add the layer
227 Action::Handle action(Action::LayerAdd::create());
233 action->set_param("canvas",canvas);
234 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
235 action->set_param("new",layer);
237 if(!action->is_ready())
239 get_ui_interface()->error(_("Action Not Ready"));
243 if(!get_instance()->perform_action(action))
245 get_ui_interface()->error(_("Action Failed."));
249 synfig::info("DEPTH=%d",depth);
250 // Action to move the layer (if necessary)
253 Action::Handle action(Action::create("layer_move"));
259 action->set_param("canvas",canvas);
260 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
261 action->set_param("layer",layer);
262 action->set_param("new_index",depth);
264 if(!action->is_ready())
266 get_ui_interface()->error(_("Move Action Not Ready"));
270 if(!get_instance()->perform_action(action))
272 get_ui_interface()->error(_("Move Action Failed."));
283 CanvasInterface::convert(ValueDesc value_desc, String type)
285 Action::Handle action(Action::ValueDescConvert::create());
291 action->set_param("canvas",get_canvas());
292 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
293 action->set_param("value_desc",value_desc);
294 action->set_param("type",type);
296 if(!action->is_ready())
298 get_ui_interface()->error(_("Action Not Ready"));
302 if(get_instance()->perform_action(action))
305 get_ui_interface()->error(_("Action Failed."));
310 CanvasInterface::add_value_node(synfig::ValueNode::Handle value_node, synfig::String name)
314 get_ui_interface()->error(_("Empty name!"));
318 Action::Handle action(Action::ValueNodeAdd::create());
324 action->set_param("canvas",get_canvas());
325 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
326 action->set_param("new",value_node);
327 action->set_param("name",name);
329 if(!action->is_ready())
331 get_ui_interface()->error(_("Action Not Ready"));
335 if(get_instance()->perform_action(action))
338 get_ui_interface()->error(_("Action Failed."));
343 CanvasInterface::generate_param_list(const ValueDesc &value_desc)
345 synfigapp::Action::ParamList param_list;
346 param_list.add("time",get_time());
347 param_list.add("canvas_interface",etl::handle<CanvasInterface>(this));
348 param_list.add("canvas",get_canvas());
350 param_list.add("value_desc",value_desc);
352 if(value_desc.parent_is_value_node())
353 param_list.add("parent_value_node",value_desc.get_parent_value_node());
355 if(value_desc.is_value_node())
356 param_list.add("value_node",value_desc.get_value_node());
358 if(value_desc.is_const())
359 param_list.add("value",value_desc.get_value());
361 if(value_desc.parent_is_layer_param())
363 param_list.add("parent_layer",value_desc.get_layer());
364 param_list.add("parent_layer_param",value_desc.get_param_name());
368 synfigapp::SelectionManager::ChildrenList children_list;
369 children_list=get_selection_manager()->get_selected_children();
370 if(!value_desc.parent_is_canvas() && children_list.size()==1)
372 param_list.add("dest",value_desc);
373 param_list.add("src",children_list.front().get_value_node());
380 CanvasInterface::generate_param_list(const std::list<synfigapp::ValueDesc> &value_desc_list)
382 synfigapp::Action::ParamList param_list;
383 param_list.add("time",get_time());
384 param_list.add("canvas_interface",etl::handle<CanvasInterface>(this));
385 param_list.add("canvas",get_canvas());
387 std::list<synfigapp::ValueDesc>::const_iterator iter;
388 for(iter=value_desc_list.begin();iter!=value_desc_list.end();++iter)
390 param_list.add("value_desc",*iter);
391 if(iter->is_value_node())
393 param_list.add("value_node",iter->get_value_node());
402 CanvasInterface::set_rend_desc(const synfig::RendDesc &rend_desc)
404 Action::Handle action(Action::create("canvas_rend_desc_set"));
410 action->set_param("canvas",get_canvas());
411 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
412 action->set_param("rend_desc",rend_desc);
414 if(!get_instance()->perform_action(action))
415 get_ui_interface()->error(_("Action Failed."));
419 CanvasInterface::set_name(const String &x)
421 //! \todo This needs to be converted into an action
422 get_canvas()->set_name(x);
423 signal_id_changed_();
428 CanvasInterface::set_description(const String &x)
430 //! \todo This needs to be converted into an action
431 get_canvas()->set_description(x);
436 CanvasInterface::set_id(const String &x)
438 //! \todo This needs to be converted into an action
439 get_canvas()->set_id(x);
440 signal_id_changed_();
446 CanvasInterface::jump_to_next_keyframe()
448 synfig::info("Current time: %s",get_time().get_string().c_str());
451 synfig::Keyframe keyframe(*get_canvas()->keyframe_list().find_next(get_time()));
452 synfig::info("Jumping to keyframe \"%s\" at %s",keyframe.get_description().c_str(),keyframe.get_time().get_string().c_str());
453 set_time(keyframe.get_time());
455 catch(...) { synfig::warning("Unable to find next keyframe"); }
459 CanvasInterface::jump_to_prev_keyframe()
461 synfig::info("Current time: %s",get_time().get_string().c_str());
464 synfig::Keyframe keyframe(*get_canvas()->keyframe_list().find_prev(get_time()));
465 synfig::info("Jumping to keyframe \"%s\" at %s",keyframe.get_description().c_str(),keyframe.get_time().get_string().c_str());
466 set_time(keyframe.get_time());
468 catch(...) { synfig::warning("Unable to find prev keyframe"); }
472 CanvasInterface::import(const synfig::String &filename, bool /*copy*/)
474 Action::PassiveGrouper group(get_instance().get(),_("Import Image"));
476 synfig::info("Attempting to import "+filename);
479 if(find(filename.begin(),filename.end(),'.')==filename.end())
481 get_ui_interface()->error("Filename must have an extension!");
485 String ext(String(filename.begin()+filename.find_last_of('.')+1,filename.end()));
486 std::transform(ext.begin(),ext.end(),ext.begin(),&::tolower);
488 // If this is a SIF file, then we need to do things slightly differently
489 if(ext=="sif" || ext=="sifz")try
492 Canvas::Handle outside_canvas(synfig::open_canvas(filename));
494 throw String(_("Unable to open this composition"));
496 Layer::Handle layer(add_layer_to("PasteCanvas",get_canvas()));
498 throw String(_("Unable to create \"Paste Canvas\" layer"));
499 if(!layer->set_param("canvas",ValueBase(outside_canvas)))
502 //layer->set_description(basename(filename));
503 signal_layer_new_description()(layer,filename);
508 get_ui_interface()->error(x+" -- "+filename);
513 get_ui_interface()->error(_("Uncaught exception when attempting\nto open this composition -- ")+filename);
517 if(!Importer::book().count(ext))
519 get_ui_interface()->error(_("I don't know how to open images of this type -- ")+ext);
525 Layer::Handle layer(add_layer_to("Import",get_canvas()));
529 if(!layer->set_param("filename",ValueBase(filename)))
531 w=layer->get_param("_width").get(int());
532 h=layer->get_param("_height").get(int());
535 Vector size=ValueBase(get_canvas()->rend_desc().get_br()-get_canvas()->rend_desc().get_tl());
541 if(size[0]<0 ^ size[1]<0)
548 if(size[0]<0 ^ size[1]<0)
551 if(!layer->set_param("tl",ValueBase(-x/2)))
553 if(!layer->set_param("br",ValueBase(x/2)))
558 if(!layer->set_param("tl",ValueBase(get_canvas()->rend_desc().get_tl())))
560 if(!layer->set_param("br",ValueBase(get_canvas()->rend_desc().get_br())))
564 layer->set_description(basename(filename));
565 signal_layer_new_description()(layer,filename);
571 get_ui_interface()->error("Unable to import "+filename);
579 CanvasInterface::waypoint_duplicate(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
581 Action::Handle action(Action::create("waypoint_set_smart"));
587 waypoint.make_unique();
588 waypoint.set_time(get_time());
590 ValueNode::Handle value_node(value_desc.get_value_node());
592 action->set_param("canvas",get_canvas());
593 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
594 action->set_param("waypoint",waypoint);
595 action->set_param("time",get_time());
596 action->set_param("value_node",value_node);
598 if(!get_instance()->perform_action(action))
599 get_ui_interface()->error(_("Action Failed."));
603 CanvasInterface::waypoint_remove(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
605 Action::Handle action(Action::create("waypoint_remove"));
611 ValueNode::Handle value_node(value_desc.get_value_node());
613 action->set_param("canvas",get_canvas());
614 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
615 action->set_param("waypoint",waypoint);
616 action->set_param("value_node",value_node);
618 if(!get_instance()->perform_action(action))
619 get_ui_interface()->error(_("Action Failed."));
624 CanvasInterface::auto_export(ValueNode::Handle /*value_node*/)
627 // Check to see if we are already exported.
628 if(value_node->is_exported())
631 Action::Handle action(Action::create("value_node_add"));
637 String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
639 action->set_param("canvas",get_canvas());
640 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
641 action->set_param("new",value_node);
642 action->set_param("name",name);
644 if(!get_instance()->perform_action(action))
645 get_ui_interface()->error(_("Action Failed."));
650 CanvasInterface::auto_export(const ValueDesc& /*value_desc*/)
652 // THIS FUNCTION IS DEPRECATED, AND IS NOW A STUB.
654 // Check to see if we are already exported.
655 if(value_desc.is_exported())
658 Action::Handle action(Action::create("value_desc_export"));
664 String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
666 action->set_param("canvas",get_canvas());
667 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
668 action->set_param("value_desc",value_desc);
669 action->set_param("name",name);
671 if(!get_instance()->perform_action(action))
672 get_ui_interface()->error(_("Action Failed."));
677 CanvasInterface::change_value(synfigapp::ValueDesc value_desc,synfig::ValueBase new_value)
679 // If this isn't really a change, then don't bother
680 if(new_value==value_desc.get_value(get_time()))
683 // If this change needs to take place elsewhere, then so be it.
684 if(value_desc.get_canvas() && value_desc.get_canvas()->get_root()!=get_canvas()->get_root())do
686 etl::handle<Instance> instance;
687 instance=find_instance(value_desc.get_canvas()->get_root());
690 return instance->find_canvas_interface(value_desc.get_canvas())->change_value(value_desc,new_value);
693 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."));
699 { synfig::warning("Can't get canvas from value desc...?"); }
702 synfigapp::Action::Handle action(synfigapp::Action::create("value_desc_set"));
708 action->set_param("canvas",get_canvas());
709 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
710 action->set_param("time",get_time());
711 action->set_param("value_desc",value_desc);
712 action->set_param("new_value",new_value);
714 return get_instance()->perform_action(action);
718 CanvasInterface::set_meta_data(const synfig::String& key,const synfig::String& data)
720 get_canvas()->set_meta_data(key,data);
724 // this function goes with find_important_value_descs()
726 _process_value_desc(const synfigapp::ValueDesc& value_desc,std::vector<synfigapp::ValueDesc>& out, synfig::GUIDSet& guid_set)
730 if(value_desc.get_value_type()==ValueBase::TYPE_CANVAS)
732 Canvas::Handle canvas;
733 canvas=value_desc.get_value().get(canvas);
734 if(!canvas || !canvas->is_inline())
736 ret+=CanvasInterface::find_important_value_descs(canvas,out,guid_set);
739 if(value_desc.is_value_node())
741 ValueNode::Handle value_node(value_desc.get_value_node());
743 if(guid_set.count(value_node->get_guid()))
745 guid_set.insert(value_node->get_guid());
747 if(LinkableValueNode::Handle::cast_dynamic(value_node))
749 if(ValueNode_DynamicList::Handle::cast_dynamic(value_node))
751 out.push_back(value_desc);
754 // Process the linkable ValueNode's children
755 LinkableValueNode::Handle value_node_copy(LinkableValueNode::Handle::cast_dynamic(value_node));
757 for(i=0;i<value_node_copy->link_count();i++)
759 ValueNode::Handle link(value_node_copy->get_link(i));
760 if(!link->is_exported())
761 ret+=_process_value_desc(ValueDesc(value_node_copy,i),out,guid_set);
764 else if(ValueNode_Animated::Handle::cast_dynamic(value_node))
766 out.push_back(value_desc);
775 CanvasInterface::find_important_value_descs(synfig::Canvas::Handle canvas,std::vector<synfigapp::ValueDesc>& out,synfig::GUIDSet& guid_set)
778 if(!canvas->is_inline())
780 ValueNodeList::const_iterator iter;
783 iter=canvas->value_node_list().begin();
784 iter!=canvas->value_node_list().end();
786 ret+=_process_value_desc(ValueDesc(canvas,(*iter)->get_id()),out,guid_set);
789 Canvas::const_iterator iter;
791 for(iter=canvas->begin();iter!=canvas->end();++iter)
793 Layer::Handle layer(*iter);
795 Layer::DynamicParamList::const_iterator iter;
797 iter=layer->dynamic_param_list().begin();
798 iter!=layer->dynamic_param_list().end();
801 if(!iter->second->is_exported())
802 ret+=_process_value_desc(ValueDesc(layer,iter->first),out,guid_set);
804 ValueBase value(layer->get_param("canvas"));
806 ret+=_process_value_desc(ValueDesc(layer,"canvas"),out,guid_set);
813 CanvasInterface::find_important_value_descs(std::vector<synfigapp::ValueDesc>& out)
816 return find_important_value_descs(get_canvas(),out,tmp);
820 CanvasInterface::seek_frame(int frames)
824 float fps(get_canvas()->rend_desc().get_frame_rate());
825 Time newtime(get_time()+(float)frames/fps);
826 newtime=newtime.round(fps);
828 if(newtime<=get_canvas()->rend_desc().get_time_start())
829 newtime=get_canvas()->rend_desc().get_time_start();
830 if(newtime>=get_canvas()->rend_desc().get_time_end())
831 newtime=get_canvas()->rend_desc().get_time_end();
836 CanvasInterface::seek_time(synfig::Time time)
841 float fps(get_canvas()->rend_desc().get_frame_rate());
843 if(time>=synfig::Time::end())
845 set_time(get_canvas()->rend_desc().get_time_end());
848 if(time<=synfig::Time::begin())
850 set_time(get_canvas()->rend_desc().get_time_start());
854 Time newtime(get_time()+time);
855 newtime=newtime.round(fps);
857 if(newtime<=get_canvas()->rend_desc().get_time_start())
858 newtime=get_canvas()->rend_desc().get_time_start();
859 if(newtime>=get_canvas()->rend_desc().get_time_end())
860 newtime=get_canvas()->rend_desc().get_time_end();