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 //! \todo what is going on here? why the need for this KeyframeTreeStore_Class at all?
202 // Glib::Object (Glib::ConstructParams(keyframe_tree_store_class_.init(), (char*) 0, (char*) 0)),
203 canvas_interface_ (canvas_interface_)
206 //reset_path_table();
208 canvas_interface()->signal_keyframe_added().connect(sigc::mem_fun(*this,&studio::KeyframeTreeStore::add_keyframe));
209 canvas_interface()->signal_keyframe_removed().connect(sigc::mem_fun(*this,&studio::KeyframeTreeStore::remove_keyframe));
210 canvas_interface()->signal_keyframe_changed().connect(sigc::mem_fun(*this,&studio::KeyframeTreeStore::change_keyframe));
213 KeyframeTreeStore::~KeyframeTreeStore()
215 synfig::info("KeyframeTreeStore::~KeyframeTreeStore(): Deleted");
218 Glib::RefPtr<KeyframeTreeStore>
219 KeyframeTreeStore::create(etl::loose_handle<synfigapp::CanvasInterface> canvas_interface_)
221 KeyframeTreeStore *store(new KeyframeTreeStore(canvas_interface_));
222 Glib::RefPtr<KeyframeTreeStore> ret(store);
228 KeyframeTreeStore::reset_stamp()
230 stamp_=time(0)+reinterpret_cast<long>(this);
235 KeyframeTreeStore::reset_path_table()
237 Gtk::TreeModel::Children::iterator iter;
238 const Gtk::TreeModel::Children children(children());
240 for(iter = children.begin(); iter != children.end(); ++iter)
242 Gtk::TreeModel::Row row(*iter);
243 path_table_[(Keyframe)row[model.keyframe]]=TreeRowReferenceHack(Glib::RefPtr<KeyframeTreeStore>(this),Gtk::TreePath(row));
250 KeyframeTreeStore::iterator_sane(const GtkTreeIter* iter)const
252 if(iter && iter->stamp==stamp_)
254 g_warning("KeyframeTreeStore::iterator_sane(): Bad iterator stamp");
259 KeyframeTreeStore::iterator_sane(const Gtk::TreeModel::iterator& iter)const
261 return iterator_sane(iter->gobj());
265 KeyframeTreeStore::dump_iterator(const GtkTreeIter* /*gtk_iter*/, const Glib::ustring &/*name*/)const
270 g_warning("KeyframeTreeStore::dump_iterator: \"%s\" is NULL (Root?)",name.c_str());
274 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
276 if(gtk_iter->stamp!=stamp_ || !iter)
278 g_warning("KeyframeTreeStore::dump_iterator: \"%s\" is INVALID",name.c_str());
282 if((unsigned)iter->index>=canvas_interface()->get_canvas()->keyframe_list().size())
283 g_warning("KeyframeTreeStore::dump_iterator: \"%s\"(%p) has bad index(index:%d)",name.c_str(),gtk_iter,iter->index);
285 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());
290 KeyframeTreeStore::dump_iterator(const Gtk::TreeModel::iterator& iter, const Glib::ustring &name)const
292 dump_iterator(iter->gobj(),name);
296 KeyframeTreeStore::time_sorter(const Gtk::TreeModel::iterator &rhs,const Gtk::TreeModel::iterator &lhs)
300 _keyframe_iterator *rhs_iter(static_cast<_keyframe_iterator*>(rhs->gobj()->user_data));
301 _keyframe_iterator *lhs_iter(static_cast<_keyframe_iterator*>(lhs->gobj()->user_data));
303 Time diff(rhs_iter->iter->get_time()-lhs_iter->iter->get_time());
312 KeyframeTreeStore::description_sorter(const Gtk::TreeModel::iterator &rhs,const Gtk::TreeModel::iterator &lhs)
316 _keyframe_iterator *rhs_iter(static_cast<_keyframe_iterator*>(rhs->gobj()->user_data));
317 _keyframe_iterator *lhs_iter(static_cast<_keyframe_iterator*>(lhs->gobj()->user_data));
319 int comp = rhs_iter->iter->get_description().compare(lhs_iter->iter->get_description());
320 if (comp > 0) return 1;
321 if (comp < 0) return -1;
326 KeyframeTreeStore::set_value_impl(const Gtk::TreeModel::iterator& row, int column, const Glib::ValueBase& value)
328 if(!iterator_sane(row))
331 if(column>=get_n_columns_vfunc())
333 g_warning("KeyframeTreeStore::set_value_impl: Bad column (%d)",column);
337 if(!g_value_type_compatible(G_VALUE_TYPE(value.gobj()),get_column_type_vfunc(column)))
339 g_warning("KeyframeTreeStore::set_value_impl: Bad value type");
343 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(row.gobj()->user_data));
347 if(column==model.time_delta.index())
349 Glib::Value<synfig::Time> x;
350 g_value_init(x.gobj(),model.time.type());
351 g_value_copy(value.gobj(),x.gobj());
353 Time new_delta(x.get());
354 if(new_delta<=Time::zero()+Time::epsilon())
360 Time old_delta((*row)[model.time_delta]);
361 if(old_delta<=Time::zero()+Time::epsilon())
366 // row(row) on the next line is bad - don't use it, because it leaves 'row' uninitialized
367 //Gtk::TreeModel::iterator row(row);
371 Time change_delta(new_delta-old_delta);
373 if(change_delta<=Time::zero()+Time::epsilon() &&change_delta>=Time::zero()-Time::epsilon())
375 // Not an error, just no change
380 Keyframe keyframe((*row)[model.keyframe]);
381 synfigapp::Action::Handle action(synfigapp::Action::create("keyframe_set_delta"));
385 action->set_param("canvas",canvas_interface()->get_canvas());
386 action->set_param("canvas_interface",canvas_interface());
387 action->set_param("keyframe",keyframe);
388 action->set_param("delta",change_delta);
390 canvas_interface()->get_instance()->perform_action(action);
396 if(column==model.time.index())
398 OneMoment one_moment;
400 Glib::Value<synfig::Time> x;
401 g_value_init(x.gobj(),model.time.type());
402 g_value_copy(value.gobj(),x.gobj());
403 synfig::Keyframe keyframe(*iter->iter);
405 synfig::info("KeyframeTreeStore::set_value_impl():old_time=%s",keyframe.get_time().get_string().c_str());
406 keyframe.set_time(x.get());
407 synfig::info("KeyframeTreeStore::set_value_impl():new_time=%s",keyframe.get_time().get_string().c_str());
409 synfigapp::Action::Handle action(synfigapp::Action::create("keyframe_set"));
414 action->set_param("canvas",canvas_interface()->get_canvas());
415 action->set_param("canvas_interface",canvas_interface());
416 action->set_param("keyframe",keyframe);
418 canvas_interface()->get_instance()->perform_action(action);
420 else if(column==model.description.index())
422 Glib::Value<Glib::ustring> x;
423 g_value_init(x.gobj(),model.description.type());
424 g_value_copy(value.gobj(),x.gobj());
425 synfig::Keyframe keyframe(*iter->iter);
426 keyframe.set_description(x.get());
428 synfigapp::Action::Handle action(synfigapp::Action::create("keyframe_set"));
433 action->set_param("canvas",canvas_interface()->get_canvas());
434 action->set_param("canvas_interface",canvas_interface());
435 action->set_param("keyframe",keyframe);
437 canvas_interface()->get_instance()->perform_action(action);
439 else if(column==model.keyframe.index())
441 g_warning("KeyframeTreeStore::set_value_impl: This column is read-only");
448 catch(std::exception x)
455 KeyframeTreeStore::get_flags_vfunc ()
457 return Gtk::TREE_MODEL_LIST_ONLY;
461 KeyframeTreeStore::get_n_columns_vfunc ()
467 KeyframeTreeStore::get_column_type_vfunc (int index)
469 return model.types()[index];
473 KeyframeTreeStore::iter_next_vfunc (const iterator& xiter, iterator& iter_next) const
475 if(!iterator_sane(xiter)) return false;
477 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(xiter.gobj()->user_data));
479 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
482 _keyframe_iterator *next(new _keyframe_iterator());
483 iter_next.gobj()->user_data=static_cast<gpointer>(next);
485 next->index=iter->index+1;
486 next->iter=iter->iter;
489 if(next->iter==canvas_interface()->get_canvas()->keyframe_list().end())
492 iter_next.gobj()->stamp=stamp_;
499 KeyframeTreeStore::iter_next_vfunc (GtkTreeIter* gtk_iter)
501 if(!iterator_sane(gtk_iter)) return false;
503 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
505 // If we are already at the end, then we are very invalid
506 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
511 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
521 KeyframeTreeStore::iter_children_vfunc (GtkTreeIter* gtk_iter, const GtkTreeIter* parent)
523 dump_iterator(gtk_iter,"gtk_iter");
524 dump_iterator(parent,"parent");
526 if(!parent || !iterator_sane(parent))
528 clear_iterator(gtk_iter);
532 _keyframe_iterator *iter(new _keyframe_iterator());
535 iter->iter=canvas_interface()->get_canvas()->keyframe_list().begin();
537 gtk_iter->user_data=static_cast<gpointer>(iter);
538 gtk_iter->stamp=stamp_;
544 KeyframeTreeStore::iter_has_child_vfunc (const GtkTreeIter*parent)
546 dump_iterator(parent,"parent");
555 KeyframeTreeStore::iter_n_children_vfunc (const GtkTreeIter* parent)
557 dump_iterator(parent,"parent");
562 return canvas_interface()->get_canvas()->keyframe_list().size();
567 KeyframeTreeStore::iter_n_root_children_vfunc () const
569 return canvas_interface()->get_canvas()->keyframe_list().size();
573 KeyframeTreeStore::iter_nth_root_child_vfunc (int n, iterator& xiter)const
575 if(canvas_interface()->get_canvas()->keyframe_list().size()==0)
582 g_warning("KeyframeTreeStore::iter_nth_root_child_vfunc: Out of range (negative index)");
585 if(n && (unsigned)n>=canvas_interface()->get_canvas()->keyframe_list().size())
587 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: Out of range (large index)");
591 _keyframe_iterator *iter(new _keyframe_iterator());
594 iter->iter=canvas_interface()->get_canvas()->keyframe_list().begin();
597 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
599 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: >>>BUG<<< in %s on line %d",__FILE__,__LINE__);
605 xiter.gobj()->user_data=static_cast<gpointer>(iter);
606 xiter.gobj()->stamp=stamp_;
612 KeyframeTreeStore::iter_nth_child_vfunc (GtkTreeIter* gtk_iter, const GtkTreeIter* parent, int n)
614 dump_iterator(parent,"parent");
618 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: I am a list");
619 clear_iterator(gtk_iter);
625 _keyframe_iterator *iter(new _keyframe_iterator());
628 iter->iter=canvas_interface()->get_canvas()->keyframe_list().begin();
631 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
633 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: >>>BUG<<< in %s on line %d",__FILE__,__LINE__);
635 clear_iterator(gtk_iter);
641 gtk_iter->user_data=static_cast<gpointer>(iter);
642 gtk_iter->stamp=stamp_;
647 KeyframeTreeStore::iter_parent_vfunc (GtkTreeIter* gtk_iter, const GtkTreeIter* child)
649 dump_iterator(child,"child");
650 iterator_sane(child);
651 clear_iterator(gtk_iter);
657 KeyframeTreeStore::ref_node_vfunc (iterator& xiter)const
659 GtkTreeIter* gtk_iter(xiter.gobj());
660 if(!gtk_iter || !iterator_sane(gtk_iter)) return;
662 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
667 KeyframeTreeStore::unref_node_vfunc (iterator& xiter)const
669 GtkTreeIter* gtk_iter(xiter.gobj());
670 if(!gtk_iter || !iterator_sane(gtk_iter)) return;
672 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
678 // Make this iterator invalid
684 KeyframeTreeStore::get_path_vfunc (const iterator& gtk_iter)const
686 Gtk::TreeModel::Path path;
688 // If this is the root node, then return
690 if(!iterator_sane(gtk_iter))
693 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->gobj()->user_data));
695 path.append_index(iter->index);
701 KeyframeTreeStore::get_iter_vfunc (const Gtk::TreeModel::Path& path, iterator& iter)const
703 if(path.get_depth()>=1)
704 return iter_nth_root_child_vfunc(path.front(),iter);
707 g_warning("KeyframeTreeStore::get_iter_vfunc(): Bad path \"%s\"",path.to_string().c_str());
708 //clear_iterator(iter);
713 KeyframeTreeStore::iter_is_valid (const iterator& iter) const
715 return iterator_sane(iter);
719 KeyframeTreeStore::get_value_vfunc (const Gtk::TreeModel::iterator& gtk_iter, int column, Glib::ValueBase& value)const
721 dump_iterator(gtk_iter,"gtk_iter");
722 if(!iterator_sane(gtk_iter))
725 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->gobj()->user_data));
731 Glib::Value<synfig::Time> x;
732 g_value_init(x.gobj(),x.value_type());
733 x.set(iter->iter->get_time());
734 g_value_init(value.gobj(),x.value_type());
735 g_value_copy(x.gobj(),value.gobj());
738 case 3: // Time Delta
740 Glib::Value<synfig::Time> x;
741 g_value_init(x.gobj(),x.value_type());
743 synfig::Keyframe prev_keyframe(*iter->iter);
744 synfig::Keyframe keyframe;
746 KeyframeList::iterator tmp(iter->iter);
748 if(tmp==get_canvas()->keyframe_list().end())
751 g_value_init(value.gobj(),x.value_type());
752 g_value_copy(x.gobj(),value.gobj());
760 delta=keyframe.get_time()-prev_keyframe.get_time();
763 g_value_init(value.gobj(),x.value_type());
764 g_value_copy(x.gobj(),value.gobj());
767 case 1: // Description
769 g_value_init(value.gobj(),G_TYPE_STRING);
770 g_value_set_string(value.gobj(),iter->iter->get_description().c_str());
775 Glib::Value<synfig::Keyframe> x;
776 g_value_init(x.gobj(),x.value_type());
778 g_value_init(value.gobj(),x.value_type());
779 g_value_copy(x.gobj(),value.gobj());
788 KeyframeTreeStore::find_row(const synfig::Keyframe &keyframe)
790 Gtk::TreeModel::Row row(*(children().begin()));
791 dump_iterator(row,"find_row,begin");
792 const GtkTreeIter *gtk_iter(row.gobj());
793 if(!iterator_sane(gtk_iter))
794 throw std::runtime_error(_("Unable to find Keyframe in table"));
796 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
798 synfig::KeyframeList &keyframe_list(canvas_interface()->get_canvas()->keyframe_list());
799 if(keyframe_list.empty())
800 throw std::runtime_error(_("There are no keyframes n this canvas"));
804 for(iter->iter=keyframe_list.begin();iter->iter!=keyframe_list.end() && *iter->iter!=keyframe;++iter->iter)
808 if(iter->iter==keyframe_list.end())
809 throw std::runtime_error(_("Unable to find Keyframe in table"));
814 KeyframeTreeStore::add_keyframe(synfig::Keyframe keyframe)
818 Gtk::TreeRow row(find_row(keyframe));
819 dump_iterator(row.gobj(),"add_keyframe,row");
820 Gtk::TreePath path(get_path(row));
822 row_inserted(path,row);
824 old_keyframe_list=get_canvas()->keyframe_list();
825 //old_keyframe_list.add(keyframe);
826 //old_keyframe_list.sort();
828 catch(std::exception x)
835 KeyframeTreeStore::remove_keyframe(synfig::Keyframe keyframe)
841 Gtk::TreeRow row(find_row(keyframe));
842 dump_iterator(row,"remove_keyframe,row");
843 Gtk::TreePath path(get_path(row));
846 old_keyframe_list.erase(keyframe);
850 g_warning("KeyframeTreeStore::remove_keyframe: Keyframe not in table");
853 catch(std::exception x)
860 KeyframeTreeStore::change_keyframe(synfig::Keyframe keyframe)
864 Gtk::TreeRow row(find_row(keyframe));
866 unsigned int new_index(get_index_from_model_iter(row));
867 unsigned int old_index(0);
868 synfig::KeyframeList::iterator iter;
869 for(old_index=0,iter=old_keyframe_list.begin();iter!=old_keyframe_list.end() && (UniqueID)*iter!=(UniqueID)keyframe;++iter,old_index++)
872 if(iter!=old_keyframe_list.end() && new_index!=old_index)
874 std::vector<int> new_order;
875 for(unsigned int i=0;i<old_keyframe_list.size();i++)
877 new_order.push_back(i);
879 if(new_order.size()>new_index)
881 new_order.erase(new_order.begin()+new_index);
882 new_order.insert(new_order.begin()+old_index,new_index);
884 //new_order[old_index]=
886 rows_reordered (Path(), iterator(), &new_order[0]);
888 old_keyframe_list=get_canvas()->keyframe_list();
890 row=find_row(keyframe);
893 dump_iterator(row,"change_keyframe,row");
894 row_changed(get_path(row),row);
896 catch(std::exception x)