1 /* === S Y N F I G ========================================================= */
2 /*! \file canvasinterface.cpp
3 ** \brief Template File
5 ** $Id: canvasinterface.cpp,v 1.1.1.1 2005/01/07 03:34:37 darco Exp $
8 ** Copyright (c) 2002 Robert B. Quattlebaum Jr.
10 ** This software and associated documentation
11 ** are CONFIDENTIAL and PROPRIETARY property of
12 ** the above-mentioned copyright holder.
14 ** You may not copy, print, publish, or in any
15 ** other way distribute this software without
16 ** a prior written agreement with
17 ** the copyright holder.
20 /* ========================================================================= */
22 /* === H E A D E R S ======================================================= */
34 #include <synfig/valuenode_scale.h>
35 #include <synfig/valuenode_timedswap.h>
36 #include <synfig/valuenode_composite.h>
37 #include <synfig/valuenode_subtract.h>
38 #include <synfig/valuenode_linear.h>
39 #include <synfig/valuenode_reference.h>
40 #include <synfig/valuenode_twotone.h>
41 #include <synfig/valuenode_stripes.h>
43 #include <synfig/waypoint.h>
44 #include <synfig/loadcanvas.h>
45 #include <synfig/importer.h>
46 #include <synfig/guidset.h>
48 #include "canvasinterface.h"
51 #include "actions/layeradd.h"
52 #include "actions/valuedescconvert.h"
53 #include "actions/valuenodeadd.h"
54 #include "actions/editmodeset.h"
55 #include "action_system.h"
59 #include <synfig/gradient.h>
63 /* === U S I N G =========================================================== */
67 using namespace synfig;
68 using namespace synfigapp;
70 /* === M A C R O S ========================================================= */
72 /* === G L O B A L S ======================================================= */
74 /* === P R O C E D U R E S ================================================= */
76 /* === M E T H O D S ======================================================= */
78 CanvasInterface::CanvasInterface(loose_handle<Instance> instance,handle<Canvas> canvas):
81 cur_time_(canvas->rend_desc().get_frame_start()),
82 mode_(MODE_NORMAL|MODE_ANIMATE_PAST|MODE_ANIMATE_FUTURE)
84 set_selection_manager(get_instance()->get_selection_manager());
85 set_ui_interface(get_instance()->get_ui_interface());
88 CanvasInterface::~CanvasInterface()
90 synfig::info("synfigapp::CanvasInterface::~CanvasInterface(): Deleted");
94 CanvasInterface::set_time(synfig::Time x)
96 if(get_canvas()->rend_desc().get_frame_rate())
98 float fps(get_canvas()->rend_desc().get_frame_rate());
100 //synfig::info("CanvasInterface::set_time(): %s rounded to %s\n",x.get_string(fps).c_str(),r.get_string(fps).c_str());
103 if(cur_time_.is_equal(x))
107 signal_time_changed()();
108 signal_dirty_preview()();
112 CanvasInterface::get_time()const
118 CanvasInterface::refresh_current_values()
120 get_canvas()->set_time(cur_time_);
121 signal_time_changed()();
122 signal_dirty_preview()();
125 etl::handle<CanvasInterface>
126 CanvasInterface::create(loose_handle<Instance> instance,handle<Canvas> canvas)
128 etl::handle<CanvasInterface> intrfc;
129 intrfc=new CanvasInterface(instance,canvas);
130 instance->canvas_interface_list().push_front(intrfc);
135 CanvasInterface::set_mode(Mode x)
137 Action::Handle action(Action::EditModeSet::create());
141 action->set_param("canvas",get_canvas());
142 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
143 action->set_param("edit_mode",x);
145 if(!action->is_ready())
147 get_ui_interface()->error(_("Action Not Ready, unable to change mode"));
152 if(!get_instance()->perform_action(action))
153 get_ui_interface()->error(_("Unable to change mode"));
156 // signal_mode_changed_(x);
159 CanvasInterface::Mode
160 CanvasInterface::get_mode()const
168 CanvasInterface::add_layer_to(String name, Canvas::Handle canvas, int depth)
170 synfigapp::Action::PassiveGrouper group(get_instance().get(),_("Add Layer To"));
172 Layer::Handle layer(Layer::create(name));
179 if(canvas!=get_canvas() && !canvas->is_inline())
181 synfig::error("Bad canvas passed to \"add_layer_to\"");
185 layer->set_canvas(canvas);
187 // Apply some defaults
188 if(layer->set_param("fg",synfigapp::Main::get_foreground_color()))
189 layer->set_param("bg",synfigapp::Main::get_background_color());
191 layer->set_param("color",synfigapp::Main::get_foreground_color());
193 layer->set_param("width",synfigapp::Main::get_bline_width().units(get_canvas()->rend_desc()));
194 layer->set_param("gradient",synfigapp::Main::get_gradient());
196 layer->set_param("amount",synfigapp::Main::get_opacity());
197 layer->set_param("blend_method",synfigapp::Main::get_blend_method());
200 // Grab the layer's list pf parameters
201 Layer::ParamList paramlist=layer->get_param_list();
202 Layer::ParamList::iterator iter;
203 for(iter=paramlist.begin();iter!=paramlist.end();++iter)
205 ValueNode::Handle value_node;
207 if(iter->second.get_type()==ValueBase::TYPE_LIST)
208 value_node=LinkableValueNode::create("dynamic_list",iter->second);
209 else if(LinkableValueNode::check_type("composite",iter->second.get_type()) &&
210 (iter->second.get_type()!=ValueBase::TYPE_COLOR && iter->second.get_type()!=ValueBase::TYPE_VECTOR)
212 value_node=LinkableValueNode::create("composite",iter->second);
215 layer->connect_dynamic_param(iter->first,value_node);
219 // Action to add the layer
220 Action::Handle action(Action::LayerAdd::create());
226 action->set_param("canvas",canvas);
227 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
228 action->set_param("new",layer);
230 if(!action->is_ready())
232 get_ui_interface()->error(_("Action Not Ready"));
236 if(!get_instance()->perform_action(action))
238 get_ui_interface()->error(_("Action Failed."));
242 synfig::info("DEPTH=%d",depth);
243 // Action to move the layer (if necessary)
246 Action::Handle action(Action::create("layer_move"));
252 action->set_param("canvas",canvas);
253 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
254 action->set_param("layer",layer);
255 action->set_param("new_index",depth);
257 if(!action->is_ready())
259 get_ui_interface()->error(_("Move Action Not Ready"));
263 if(!get_instance()->perform_action(action))
265 get_ui_interface()->error(_("Move Action Failed."));
276 CanvasInterface::convert(ValueDesc value_desc, String type)
278 Action::Handle action(Action::ValueDescConvert::create());
284 action->set_param("canvas",get_canvas());
285 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
286 action->set_param("value_desc",value_desc);
287 action->set_param("type",type);
289 if(!action->is_ready())
291 get_ui_interface()->error(_("Action Not Ready"));
295 if(get_instance()->perform_action(action))
298 get_ui_interface()->error(_("Action Failed."));
303 CanvasInterface::add_value_node(synfig::ValueNode::Handle value_node, synfig::String name)
307 get_ui_interface()->error(_("Empty name!"));
311 Action::Handle action(Action::ValueNodeAdd::create());
317 action->set_param("canvas",get_canvas());
318 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
319 action->set_param("new",value_node);
320 action->set_param("name",name);
322 if(!action->is_ready())
324 get_ui_interface()->error(_("Action Not Ready"));
328 if(get_instance()->perform_action(action))
331 get_ui_interface()->error(_("Action Failed."));
336 CanvasInterface::generate_param_list(const ValueDesc &value_desc)
338 synfigapp::Action::ParamList param_list;
339 param_list.add("time",get_time());
340 param_list.add("canvas_interface",etl::handle<CanvasInterface>(this));
341 param_list.add("canvas",get_canvas());
343 param_list.add("value_desc",value_desc);
345 if(value_desc.parent_is_value_node())
346 param_list.add("parent_value_node",value_desc.get_parent_value_node());
348 if(value_desc.is_value_node())
349 param_list.add("value_node",value_desc.get_value_node());
351 if(value_desc.is_const())
352 param_list.add("value",value_desc.get_value());
354 if(value_desc.parent_is_layer_param())
356 param_list.add("parent_layer",value_desc.get_layer());
357 param_list.add("parent_layer_param",value_desc.get_param_name());
361 synfigapp::SelectionManager::ChildrenList children_list;
362 children_list=get_selection_manager()->get_selected_children();
363 if(!value_desc.parent_is_canvas() && children_list.size()==1)
365 param_list.add("dest",value_desc);
366 param_list.add("src",children_list.front().get_value_node());
373 CanvasInterface::generate_param_list(const std::list<synfigapp::ValueDesc> &value_desc_list)
375 synfigapp::Action::ParamList param_list;
376 param_list.add("time",get_time());
377 param_list.add("canvas_interface",etl::handle<CanvasInterface>(this));
378 param_list.add("canvas",get_canvas());
380 std::list<synfigapp::ValueDesc>::const_iterator iter;
381 for(iter=value_desc_list.begin();iter!=value_desc_list.end();++iter)
383 param_list.add("value_desc",*iter);
384 if(iter->is_value_node())
386 param_list.add("value_node",iter->get_value_node());
395 CanvasInterface::set_rend_desc(const synfig::RendDesc &rend_desc)
397 Action::Handle action(Action::create("canvas_rend_desc_set"));
403 action->set_param("canvas",get_canvas());
404 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
405 action->set_param("rend_desc",rend_desc);
407 if(!get_instance()->perform_action(action))
408 get_ui_interface()->error(_("Action Failed."));
412 CanvasInterface::set_name(const String &x)
414 //! \todo This needs to be converted into an action
415 get_canvas()->set_name(x);
416 signal_id_changed_();
421 CanvasInterface::set_description(const String &x)
423 //! \todo This needs to be converted into an action
424 get_canvas()->set_description(x);
429 CanvasInterface::set_id(const String &x)
431 //! \todo This needs to be converted into an action
432 get_canvas()->set_id(x);
433 signal_id_changed_();
439 CanvasInterface::jump_to_next_keyframe()
441 synfig::info("Current time: %s",get_time().get_string().c_str());
444 synfig::Keyframe keyframe(*get_canvas()->keyframe_list().find_next(get_time()));
445 synfig::info("Jumping to keyframe \"%s\" at %s",keyframe.get_description().c_str(),keyframe.get_time().get_string().c_str());
446 set_time(keyframe.get_time());
448 catch(...) { synfig::warning("Unable to find next keyframe"); }
452 CanvasInterface::jump_to_prev_keyframe()
454 synfig::info("Current time: %s",get_time().get_string().c_str());
457 synfig::Keyframe keyframe(*get_canvas()->keyframe_list().find_prev(get_time()));
458 synfig::info("Jumping to keyframe \"%s\" at %s",keyframe.get_description().c_str(),keyframe.get_time().get_string().c_str());
459 set_time(keyframe.get_time());
461 catch(...) { synfig::warning("Unable to find prev keyframe"); }
465 CanvasInterface::import(const synfig::String &filename, bool copy)
467 Action::PassiveGrouper group(get_instance().get(),_("Import Image"));
469 synfig::info("Attempting to import "+filename);
472 if(find(filename.begin(),filename.end(),'.')==filename.end())
474 get_ui_interface()->error("Filename must have an extension!");
478 String ext(String(filename.begin()+filename.find_last_of('.')+1,filename.end()));
479 std::transform(ext.begin(),ext.end(),ext.begin(),&::tolower);
481 // If this is a SIF file, then we need to do things slightly differently
482 if(ext=="sif" || ext=="sifz")try
485 Canvas::Handle outside_canvas(synfig::open_canvas(filename));
487 throw String(_("Unable to open this composition"));
489 Layer::Handle layer(add_layer_to("PasteCanvas",get_canvas()));
491 throw String(_("Unable to create \"PasteCanvas\" layer"));
492 if(!layer->set_param("canvas",ValueBase(outside_canvas)))
495 //layer->set_description(basename(filename));
496 signal_layer_new_description()(layer,filename);
501 get_ui_interface()->error(x+" -- "+filename);
506 get_ui_interface()->error(_("Uncaught exception when attempting\nto open this composition -- ")+filename);
512 if(!Importer::book().count(ext))
514 get_ui_interface()->error(_("I don't know how to open images of this type -- ")+ext);
520 Layer::Handle layer(add_layer_to("Import",get_canvas()));
524 if(!layer->set_param("filename",ValueBase(filename)))
526 w=layer->get_param("_width").get(int());
527 h=layer->get_param("_height").get(int());
530 Vector size=ValueBase(get_canvas()->rend_desc().get_br()-get_canvas()->rend_desc().get_tl());
536 if(size[0]<0 ^ size[1]<0)
543 if(size[0]<0 ^ size[1]<0)
546 if(!layer->set_param("tl",ValueBase(-x/2)))
548 if(!layer->set_param("br",ValueBase(x/2)))
553 if(!layer->set_param("tl",ValueBase(get_canvas()->rend_desc().get_tl())))
555 if(!layer->set_param("br",ValueBase(get_canvas()->rend_desc().get_br())))
559 layer->set_description(basename(filename));
560 signal_layer_new_description()(layer,filename);
566 get_ui_interface()->error("Unable to import "+filename);
574 CanvasInterface::waypoint_duplicate(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
576 Action::Handle action(Action::create("waypoint_set_smart"));
582 waypoint.make_unique();
583 waypoint.set_time(get_time());
585 ValueNode::Handle value_node(value_desc.get_value_node());
587 action->set_param("canvas",get_canvas());
588 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
589 action->set_param("waypoint",waypoint);
590 action->set_param("time",get_time());
591 action->set_param("value_node",value_node);
593 if(!get_instance()->perform_action(action))
594 get_ui_interface()->error(_("Action Failed."));
598 CanvasInterface::waypoint_remove(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint)
600 Action::Handle action(Action::create("waypoint_remove"));
606 ValueNode::Handle value_node(value_desc.get_value_node());
608 action->set_param("canvas",get_canvas());
609 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
610 action->set_param("waypoint",waypoint);
611 action->set_param("value_node",value_node);
613 if(!get_instance()->perform_action(action))
614 get_ui_interface()->error(_("Action Failed."));
619 CanvasInterface::auto_export(ValueNode::Handle value_node)
622 // Check to see if we are already exported.
623 if(value_node->is_exported())
626 Action::Handle action(Action::create("value_node_add"));
632 String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
634 action->set_param("canvas",get_canvas());
635 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
636 action->set_param("new",value_node);
637 action->set_param("name",name);
639 if(!get_instance()->perform_action(action))
640 get_ui_interface()->error(_("Action Failed."));
645 CanvasInterface::auto_export(const ValueDesc& value_desc)
647 // THIS FUNCTION IS DEPRECATED, AND IS NOW A STUB.
649 // Check to see if we are already exported.
650 if(value_desc.is_exported())
653 Action::Handle action(Action::create("value_desc_export"));
659 String name(strprintf(_("Unnamed%08d"),synfig::UniqueID().get_uid()));
661 action->set_param("canvas",get_canvas());
662 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
663 action->set_param("value_desc",value_desc);
664 action->set_param("name",name);
666 if(!get_instance()->perform_action(action))
667 get_ui_interface()->error(_("Action Failed."));
672 CanvasInterface::change_value(synfigapp::ValueDesc value_desc,synfig::ValueBase new_value)
674 // If this isn't really a change, then don't bother
675 if(new_value==value_desc.get_value(get_time()))
678 // If this change needs to take place elsewhere, then so be it.
679 if(value_desc.get_canvas() && value_desc.get_canvas()->get_root()!=get_canvas()->get_root())do
681 etl::handle<Instance> instance;
682 instance=find_instance(value_desc.get_canvas()->get_root());
685 return instance->find_canvas_interface(value_desc.get_canvas())->change_value(value_desc,new_value);
688 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."));
694 { synfig::warning("Can't get canvas from value desc...?"); }
697 synfigapp::Action::Handle action(synfigapp::Action::create("value_desc_set"));
703 action->set_param("canvas",get_canvas());
704 action->set_param("canvas_interface",etl::loose_handle<CanvasInterface>(this));
705 action->set_param("time",get_time());
706 action->set_param("value_desc",value_desc);
707 action->set_param("new_value",new_value);
709 return get_instance()->perform_action(action);
713 CanvasInterface::set_meta_data(const synfig::String& key,const synfig::String& data)
715 get_canvas()->set_meta_data(key,data);
719 // this function goes with find_important_value_descs()
721 _process_value_desc(const synfigapp::ValueDesc& value_desc,std::vector<synfigapp::ValueDesc>& out, synfig::GUIDSet& guid_set)
725 if(value_desc.get_value_type()==ValueBase::TYPE_CANVAS)
727 Canvas::Handle canvas;
728 canvas=value_desc.get_value().get(canvas);
729 if(!canvas || !canvas->is_inline())
731 ret+=CanvasInterface::find_important_value_descs(canvas,out,guid_set);
734 if(value_desc.is_value_node())
736 ValueNode::Handle value_node(value_desc.get_value_node());
738 if(guid_set.count(value_node->get_guid()))
740 guid_set.insert(value_node->get_guid());
742 if(LinkableValueNode::Handle::cast_dynamic(value_node))
744 if(ValueNode_DynamicList::Handle::cast_dynamic(value_node))
746 out.push_back(value_desc);
749 // Process the linkable ValueNode's children
750 LinkableValueNode::Handle value_node(LinkableValueNode::Handle::cast_dynamic(value_node));
752 for(i=0;i<value_node->link_count();i++)
754 ValueNode::Handle link(value_node->get_link(i));
755 if(!link->is_exported())
756 ret+=_process_value_desc(ValueDesc(value_node,i),out,guid_set);
759 else if(ValueNode_Animated::Handle::cast_dynamic(value_node))
761 out.push_back(value_desc);
770 CanvasInterface::find_important_value_descs(synfig::Canvas::Handle canvas,std::vector<synfigapp::ValueDesc>& out,synfig::GUIDSet& guid_set)
773 if(!canvas->is_inline())
775 ValueNodeList::const_iterator iter;
778 iter=canvas->value_node_list().begin();
779 iter!=canvas->value_node_list().end();
781 ret+=_process_value_desc(ValueDesc(canvas,(*iter)->get_id()),out,guid_set);
784 Canvas::const_iterator iter;
786 for(iter=canvas->begin();iter!=canvas->end();++iter)
788 Layer::Handle layer(*iter);
790 Layer::DynamicParamList::const_iterator iter;
792 iter=layer->dynamic_param_list().begin();
793 iter!=layer->dynamic_param_list().end();
796 if(!iter->second->is_exported())
797 ret+=_process_value_desc(ValueDesc(layer,iter->first),out,guid_set);
799 ValueBase value(layer->get_param("canvas"));
801 ret+=_process_value_desc(ValueDesc(layer,"canvas"),out,guid_set);
808 CanvasInterface::find_important_value_descs(std::vector<synfigapp::ValueDesc>& out)
811 return find_important_value_descs(get_canvas(),out,tmp);
815 CanvasInterface::seek_frame(int frames)
819 float fps(get_canvas()->rend_desc().get_frame_rate());
820 Time newtime(get_time()+(float)frames/fps);
821 newtime=newtime.round(fps);
823 if(newtime<=get_canvas()->rend_desc().get_frame_start())
824 newtime=get_canvas()->rend_desc().get_frame_start();
825 if(newtime>=get_canvas()->rend_desc().get_frame_end())
826 newtime=get_canvas()->rend_desc().get_frame_end();
831 CanvasInterface::seek_time(synfig::Time time)
836 float fps(get_canvas()->rend_desc().get_frame_rate());
838 if(time>=synfig::Time::end())
840 set_time(get_canvas()->rend_desc().get_time_end());
843 if(time<=synfig::Time::begin())
845 set_time(get_canvas()->rend_desc().get_time_end());
849 Time newtime(get_time()+time);
850 newtime=newtime.round(fps);
852 if(newtime<=get_canvas()->rend_desc().get_time_start())
853 newtime=get_canvas()->rend_desc().get_time_start();
854 if(newtime>=get_canvas()->rend_desc().get_time_end())
855 newtime=get_canvas()->rend_desc().get_time_end();