1 /* === S Y N F I G ========================================================= */
2 /*! \file keyframetreestore.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 ======================================================= */
33 #include "keyframetreestore.h"
34 #include <synfig/valuenode.h>
35 #include "iconcontroller.h"
36 #include <synfig/valuenode_timedswap.h>
37 #include <gtkmm/button.h>
38 #include <gtkmm/treerowreference.h>
39 #include <synfig/canvas.h>
40 #include <synfig/keyframe.h>
43 #include <ETL/smart_ptr>
44 #include <synfigapp/action.h>
45 #include <synfigapp/instance.h>
46 #include "onemoment.h"
47 #include <synfig/exception.h>
53 /* === U S I N G =========================================================== */
57 using namespace synfig;
58 using namespace studio;
60 /* === M A C R O S ========================================================= */
62 /* === G L O B A L S ======================================================= */
64 KeyframeTreeStore_Class KeyframeTreeStore::keyframe_tree_store_class_;
66 /* === C L A S S E S & S T R U C T S ======================================= */
68 struct _keyframe_iterator
70 synfig::KeyframeList::iterator iter;
76 Gtk::TreeModel::iterator keyframe_iter_2_model_iter(synfig::KeyframeList::iterator iter,int index)
78 Gtk::TreeModel::iterator ret;
80 _keyframe_iterator*& data(static_cast<_keyframe_iterator*&>(ret->gobj()->user_data));
81 data=new _keyframe_iterator();
90 synfig::KeyframeList::iterator model_iter_2_keyframe_iter(Gtk::TreeModel::iterator iter)
92 _keyframe_iterator* data(static_cast<_keyframe_iterator*>(iter->gobj()->user_data));
94 throw std::runtime_error("bad data");
98 int get_index_from_model_iter(Gtk::TreeModel::iterator iter)
100 _keyframe_iterator* data(static_cast<_keyframe_iterator*>(iter->gobj()->user_data));
102 throw std::runtime_error("bad data");
108 #ifndef TreeRowReferenceHack
109 class TreeRowReferenceHack
111 GtkTreeRowReference *gobject_;
113 TreeRowReferenceHack():
118 TreeRowReferenceHack(const Glib::RefPtr<Gtk::TreeModel>& model, const Gtk::TreeModel::Path& path):
119 gobject_ ( gtk_tree_row_reference_new(model->gobj(), const_cast<GtkTreePath*>(path.gobj())) )
123 TreeRowReferenceHack(const TreeRowReferenceHack &x):
124 gobject_ ( x.gobject_?gtk_tree_row_reference_copy(x.gobject_):0 )
129 void swap(TreeRowReferenceHack & other)
131 GtkTreeRowReference *const temp = gobject_;
132 gobject_ = other.gobject_;
133 other.gobject_ = temp;
136 const TreeRowReferenceHack &
137 operator=(const TreeRowReferenceHack &rhs)
139 TreeRowReferenceHack temp (rhs);
144 ~TreeRowReferenceHack()
147 gtk_tree_row_reference_free(gobject_);
150 Gtk::TreeModel::Path get_path() { return Gtk::TreeModel::Path(gtk_tree_row_reference_get_path(gobject_),false); }
151 GtkTreeRowReference *gobj() { return gobject_; }
156 /* === P R O C E D U R E S ================================================= */
158 void clear_iterator(GtkTreeIter* iter)
161 iter->user_data=iter->user_data2=iter->user_data3=0;
164 /* === M E T H O D S ======================================================= */
167 KeyframeTreeStore_Class::init()
171 class_init_func_ = &KeyframeTreeStore_Class::class_init_function;
173 const GTypeInfo derived_info =
175 sizeof(GObjectClass),
187 gtype_ = g_type_register_static(G_TYPE_OBJECT, "KeyframeTreeStore", &derived_info, GTypeFlags(0));
188 Gtk::TreeModel::add_interface(get_type());
194 KeyframeTreeStore_Class::class_init_function(gpointer /*g_class*/, gpointer /*class_data*/)
199 KeyframeTreeStore::KeyframeTreeStore(etl::loose_handle<synfigapp::CanvasInterface> canvas_interface_):
200 Glib::ObjectBase ("KeyframeTreeStore"),
201 Glib::Object (Glib::ConstructParams(keyframe_tree_store_class_.init(), (char*) 0)),
202 canvas_interface_ (canvas_interface_)
205 //reset_path_table();
207 canvas_interface()->signal_keyframe_added().connect(sigc::mem_fun(*this,&studio::KeyframeTreeStore::add_keyframe));
208 canvas_interface()->signal_keyframe_removed().connect(sigc::mem_fun(*this,&studio::KeyframeTreeStore::remove_keyframe));
209 canvas_interface()->signal_keyframe_changed().connect(sigc::mem_fun(*this,&studio::KeyframeTreeStore::change_keyframe));
212 KeyframeTreeStore::~KeyframeTreeStore()
214 synfig::info("KeyframeTreeStore::~KeyframeTreeStore(): Deleted");
217 Glib::RefPtr<KeyframeTreeStore>
218 KeyframeTreeStore::create(etl::loose_handle<synfigapp::CanvasInterface> canvas_interface_)
220 KeyframeTreeStore *store(new KeyframeTreeStore(canvas_interface_));
221 Glib::RefPtr<KeyframeTreeStore> ret(store);
227 KeyframeTreeStore::reset_stamp()
229 stamp_=time(0)+reinterpret_cast<long>(this);
234 KeyframeTreeStore::reset_path_table()
236 Gtk::TreeModel::Children::iterator iter;
237 const Gtk::TreeModel::Children children(children());
239 for(iter = children.begin(); iter != children.end(); ++iter)
241 Gtk::TreeModel::Row row(*iter);
242 path_table_[(Keyframe)row[model.keyframe]]=TreeRowReferenceHack(Glib::RefPtr<KeyframeTreeStore>(this),Gtk::TreePath(row));
249 KeyframeTreeStore::iterator_sane(const GtkTreeIter* iter)const
251 if(iter && iter->stamp==stamp_)
253 g_warning("KeyframeTreeStore::iterator_sane(): Bad iterator stamp");
258 KeyframeTreeStore::iterator_sane(const Gtk::TreeModel::iterator& iter)const
260 return iterator_sane(iter->gobj());
264 KeyframeTreeStore::dump_iterator(const GtkTreeIter* /*gtk_iter*/, const Glib::ustring &/*name*/)const
269 g_warning("KeyframeTreeStore::dump_iterator: \"%s\" is NULL (Root?)",name.c_str());
273 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
275 if(gtk_iter->stamp!=stamp_ || !iter)
277 g_warning("KeyframeTreeStore::dump_iterator: \"%s\" is INVALID",name.c_str());
281 if((unsigned)iter->index>=canvas_interface()->get_canvas()->keyframe_list().size())
282 g_warning("KeyframeTreeStore::dump_iterator: \"%s\"(%p) has bad index(index:%d)",name.c_str(),gtk_iter,iter->index);
284 g_warning("KeyframeTreeStore::dump_iterator: \"%s\"(%p) ref:%d, index:%d, time:%s",name.c_str(),gtk_iter,iter->ref_count,iter->index,iter->iter->get_time().get_string().c_str());
289 KeyframeTreeStore::dump_iterator(const Gtk::TreeModel::iterator& iter, const Glib::ustring &name)const
291 dump_iterator(iter->gobj(),name);
295 KeyframeTreeStore::time_sorter(const Gtk::TreeModel::iterator &rhs,const Gtk::TreeModel::iterator &lhs)
299 _keyframe_iterator *rhs_iter(static_cast<_keyframe_iterator*>(rhs->gobj()->user_data));
300 _keyframe_iterator *lhs_iter(static_cast<_keyframe_iterator*>(lhs->gobj()->user_data));
302 Time diff(rhs_iter->iter->get_time()-lhs_iter->iter->get_time());
311 KeyframeTreeStore::set_value_impl(const Gtk::TreeModel::iterator& row, int column, const Glib::ValueBase& value)
313 if(!iterator_sane(row))
316 if(column>=get_n_columns_vfunc())
318 g_warning("KeyframeTreeStore::set_value_impl: Bad column (%d)",column);
322 if(!g_value_type_compatible(G_VALUE_TYPE(value.gobj()),get_column_type_vfunc(column)))
324 g_warning("KeyframeTreeStore::set_value_impl: Bad value type");
328 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(row.gobj()->user_data));
332 if(column==model.time_delta.index())
334 Glib::Value<synfig::Time> x;
335 g_value_init(x.gobj(),model.time.type());
336 g_value_copy(value.gobj(),x.gobj());
338 Time new_delta(x.get());
339 if(new_delta<=Time::zero()+Time::epsilon())
345 Time old_delta((*row)[model.time_delta]);
346 if(old_delta<=Time::zero()+Time::epsilon())
351 // row(row) on the next line is bad - don't use it, because it leaves 'row' uninitialized
352 //Gtk::TreeModel::iterator row(row);
356 Time change_delta(new_delta-old_delta);
358 if(change_delta<=Time::zero()+Time::epsilon() &&change_delta>=Time::zero()-Time::epsilon())
360 // Not an error, just no change
365 Keyframe keyframe((*row)[model.keyframe]);
366 synfigapp::Action::Handle action(synfigapp::Action::create("keyframe_set_delta"));
370 action->set_param("canvas",canvas_interface()->get_canvas());
371 action->set_param("canvas_interface",canvas_interface());
372 action->set_param("keyframe",keyframe);
373 action->set_param("delta",change_delta);
375 canvas_interface()->get_instance()->perform_action(action);
381 if(column==model.time.index())
383 OneMoment one_moment;
385 Glib::Value<synfig::Time> x;
386 g_value_init(x.gobj(),model.time.type());
387 g_value_copy(value.gobj(),x.gobj());
388 synfig::Keyframe keyframe(*iter->iter);
390 synfig::info("KeyframeTreeStore::set_value_impl():old_time=%s",keyframe.get_time().get_string().c_str());
391 keyframe.set_time(x.get());
392 synfig::info("KeyframeTreeStore::set_value_impl():new_time=%s",keyframe.get_time().get_string().c_str());
394 synfigapp::Action::Handle action(synfigapp::Action::create("keyframe_set"));
399 action->set_param("canvas",canvas_interface()->get_canvas());
400 action->set_param("canvas_interface",canvas_interface());
401 action->set_param("keyframe",keyframe);
403 canvas_interface()->get_instance()->perform_action(action);
405 else if(column==model.description.index())
407 Glib::Value<Glib::ustring> x;
408 g_value_init(x.gobj(),model.description.type());
409 g_value_copy(value.gobj(),x.gobj());
410 synfig::Keyframe keyframe(*iter->iter);
411 keyframe.set_description(x.get());
413 synfigapp::Action::Handle action(synfigapp::Action::create("keyframe_set"));
418 action->set_param("canvas",canvas_interface()->get_canvas());
419 action->set_param("canvas_interface",canvas_interface());
420 action->set_param("keyframe",keyframe);
422 canvas_interface()->get_instance()->perform_action(action);
424 else if(column==model.keyframe.index())
426 g_warning("KeyframeTreeStore::set_value_impl: This column is read-only");
433 catch(std::exception x)
440 KeyframeTreeStore::get_flags_vfunc ()
442 return Gtk::TREE_MODEL_LIST_ONLY;
446 KeyframeTreeStore::get_n_columns_vfunc ()
452 KeyframeTreeStore::get_column_type_vfunc (int index)
454 return model.types()[index];
458 KeyframeTreeStore::iter_next_vfunc (const iterator& xiter, iterator& iter_next) const
460 if(!iterator_sane(xiter)) return false;
462 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(xiter.gobj()->user_data));
464 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
467 _keyframe_iterator *next(new _keyframe_iterator());
468 iter_next.gobj()->user_data=static_cast<gpointer>(next);
470 next->index=iter->index+1;
471 next->iter=iter->iter;
474 if(next->iter==canvas_interface()->get_canvas()->keyframe_list().end())
477 iter_next.gobj()->stamp=stamp_;
484 KeyframeTreeStore::iter_next_vfunc (GtkTreeIter* gtk_iter)
486 if(!iterator_sane(gtk_iter)) return false;
488 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
490 // If we are already at the end, then we are very invalid
491 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
496 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
506 KeyframeTreeStore::iter_children_vfunc (GtkTreeIter* gtk_iter, const GtkTreeIter* parent)
508 dump_iterator(gtk_iter,"gtk_iter");
509 dump_iterator(parent,"parent");
511 if(!parent || !iterator_sane(parent))
513 clear_iterator(gtk_iter);
517 _keyframe_iterator *iter(new _keyframe_iterator());
520 iter->iter=canvas_interface()->get_canvas()->keyframe_list().begin();
522 gtk_iter->user_data=static_cast<gpointer>(iter);
523 gtk_iter->stamp=stamp_;
529 KeyframeTreeStore::iter_has_child_vfunc (const GtkTreeIter*parent)
531 dump_iterator(parent,"parent");
540 KeyframeTreeStore::iter_n_children_vfunc (const GtkTreeIter* parent)
542 dump_iterator(parent,"parent");
547 return canvas_interface()->get_canvas()->keyframe_list().size();
552 KeyframeTreeStore::iter_n_root_children_vfunc () const
554 return canvas_interface()->get_canvas()->keyframe_list().size();
558 KeyframeTreeStore::iter_nth_root_child_vfunc (int n, iterator& xiter)const
560 if(canvas_interface()->get_canvas()->keyframe_list().size()==0)
567 g_warning("KeyframeTreeStore::iter_nth_root_child_vfunc: Out of range (negative index)");
570 if(n && (unsigned)n>=canvas_interface()->get_canvas()->keyframe_list().size())
572 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: Out of range (large index)");
576 _keyframe_iterator *iter(new _keyframe_iterator());
579 iter->iter=canvas_interface()->get_canvas()->keyframe_list().begin();
582 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
584 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: >>>BUG<<< in %s on line %d",__FILE__,__LINE__);
590 xiter.gobj()->user_data=static_cast<gpointer>(iter);
591 xiter.gobj()->stamp=stamp_;
597 KeyframeTreeStore::iter_nth_child_vfunc (GtkTreeIter* gtk_iter, const GtkTreeIter* parent, int n)
599 dump_iterator(parent,"parent");
603 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: I am a list");
604 clear_iterator(gtk_iter);
610 _keyframe_iterator *iter(new _keyframe_iterator());
613 iter->iter=canvas_interface()->get_canvas()->keyframe_list().begin();
616 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
618 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: >>>BUG<<< in %s on line %d",__FILE__,__LINE__);
620 clear_iterator(gtk_iter);
626 gtk_iter->user_data=static_cast<gpointer>(iter);
627 gtk_iter->stamp=stamp_;
632 KeyframeTreeStore::iter_parent_vfunc (GtkTreeIter* gtk_iter, const GtkTreeIter* child)
634 dump_iterator(child,"child");
635 iterator_sane(child);
636 clear_iterator(gtk_iter);
642 KeyframeTreeStore::ref_node_vfunc (iterator& xiter)const
644 GtkTreeIter* gtk_iter(xiter.gobj());
645 if(!gtk_iter || !iterator_sane(gtk_iter)) return;
647 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
652 KeyframeTreeStore::unref_node_vfunc (iterator& xiter)const
654 GtkTreeIter* gtk_iter(xiter.gobj());
655 if(!gtk_iter || !iterator_sane(gtk_iter)) return;
657 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
663 // Make this iterator invalid
669 KeyframeTreeStore::get_path_vfunc (const iterator& gtk_iter)const
671 Gtk::TreeModel::Path path;
673 // If this is the root node, then return
675 if(!iterator_sane(gtk_iter))
678 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->gobj()->user_data));
680 path.append_index(iter->index);
686 KeyframeTreeStore::get_iter_vfunc (const Gtk::TreeModel::Path& path, iterator& iter)const
688 if(path.get_depth()>=1)
689 return iter_nth_root_child_vfunc(path.front(),iter);
692 g_warning("KeyframeTreeStore::get_iter_vfunc(): Bad path \"%s\"",path.to_string().c_str());
693 //clear_iterator(iter);
698 KeyframeTreeStore::iter_is_valid (const iterator& iter) const
700 return iterator_sane(iter);
704 KeyframeTreeStore::get_value_vfunc (const Gtk::TreeModel::iterator& gtk_iter, int column, Glib::ValueBase& value)const
706 dump_iterator(gtk_iter,"gtk_iter");
707 if(!iterator_sane(gtk_iter))
710 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->gobj()->user_data));
716 Glib::Value<synfig::Time> x;
717 g_value_init(x.gobj(),x.value_type());
718 x.set(iter->iter->get_time());
719 g_value_init(value.gobj(),x.value_type());
720 g_value_copy(x.gobj(),value.gobj());
723 case 3: // Time Delta
725 Glib::Value<synfig::Time> x;
726 g_value_init(x.gobj(),x.value_type());
728 synfig::Keyframe prev_keyframe(*iter->iter);
729 synfig::Keyframe keyframe;
731 KeyframeList::iterator tmp(iter->iter);
733 if(tmp==get_canvas()->keyframe_list().end())
736 g_value_init(value.gobj(),x.value_type());
737 g_value_copy(x.gobj(),value.gobj());
745 delta=keyframe.get_time()-prev_keyframe.get_time();
748 g_value_init(value.gobj(),x.value_type());
749 g_value_copy(x.gobj(),value.gobj());
752 case 1: // Description
754 g_value_init(value.gobj(),G_TYPE_STRING);
755 g_value_set_string(value.gobj(),iter->iter->get_description().c_str());
760 Glib::Value<synfig::Keyframe> x;
761 g_value_init(x.gobj(),x.value_type());
763 g_value_init(value.gobj(),x.value_type());
764 g_value_copy(x.gobj(),value.gobj());
773 KeyframeTreeStore::find_row(const synfig::Keyframe &keyframe)
775 Gtk::TreeModel::Row row(*(children().begin()));
776 dump_iterator(row,"find_row,begin");
777 const GtkTreeIter *gtk_iter(row.gobj());
778 if(!iterator_sane(gtk_iter))
779 throw std::runtime_error(_("Unable to find Keyframe in table"));
781 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
783 synfig::KeyframeList &keyframe_list(canvas_interface()->get_canvas()->keyframe_list());
784 if(keyframe_list.empty())
785 throw std::runtime_error(_("There are no keyframes n this canvas"));
789 for(iter->iter=keyframe_list.begin();iter->iter!=keyframe_list.end() && *iter->iter!=keyframe;++iter->iter)
793 if(iter->iter==keyframe_list.end())
794 throw std::runtime_error(_("Unable to find Keyframe in table"));
799 KeyframeTreeStore::add_keyframe(synfig::Keyframe keyframe)
803 Gtk::TreeRow row(find_row(keyframe));
804 dump_iterator(row.gobj(),"add_keyframe,row");
805 Gtk::TreePath path(get_path(row));
807 row_inserted(path,row);
809 old_keyframe_list=get_canvas()->keyframe_list();
810 //old_keyframe_list.add(keyframe);
811 //old_keyframe_list.sort();
813 catch(std::exception x)
820 KeyframeTreeStore::remove_keyframe(synfig::Keyframe keyframe)
826 Gtk::TreeRow row(find_row(keyframe));
827 dump_iterator(row,"remove_keyframe,row");
828 Gtk::TreePath path(get_path(row));
831 old_keyframe_list.erase(keyframe);
835 g_warning("KeyframeTreeStore::remove_keyframe: Keyframe not in table");
838 catch(std::exception x)
845 KeyframeTreeStore::change_keyframe(synfig::Keyframe keyframe)
849 Gtk::TreeRow row(find_row(keyframe));
851 unsigned int new_index(get_index_from_model_iter(row));
852 unsigned int old_index(0);
853 synfig::KeyframeList::iterator iter;
854 for(old_index=0,iter=old_keyframe_list.begin();iter!=old_keyframe_list.end() && (UniqueID)*iter!=(UniqueID)keyframe;++iter,old_index++);
856 if(iter!=old_keyframe_list.end() && new_index!=old_index)
858 std::vector<int> new_order;
859 for(unsigned int i=0;i<old_keyframe_list.size();i++)
861 new_order.push_back(i);
863 if(new_order.size()>new_index)
865 new_order.erase(new_order.begin()+new_index);
866 new_order.insert(new_order.begin()+old_index,new_index);
868 //new_order[old_index]=
870 rows_reordered (Path(), iterator(), &new_order[0]);
872 old_keyframe_list=get_canvas()->keyframe_list();
874 row=find_row(keyframe);
877 dump_iterator(row,"change_keyframe,row");
878 row_changed(get_path(row),row);
880 catch(std::exception x)