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
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 ======================================================= */
32 #include "keyframetreestore.h"
33 #include <synfig/valuenode.h>
34 #include "iconcontroler.h"
35 #include <synfig/valuenode_timedswap.h>
36 #include <gtkmm/button.h>
37 #include <gtkmm/treerowreference.h>
38 #include <synfig/canvas.h>
39 #include <synfig/keyframe.h>
42 #include <ETL/smart_ptr>
43 #include <synfigapp/action.h>
44 #include <synfigapp/instance.h>
45 #include "onemoment.h"
46 #include <synfig/exception.h>
50 /* === U S I N G =========================================================== */
54 using namespace synfig;
55 using namespace studio;
57 /* === M A C R O S ========================================================= */
59 /* === G L O B A L S ======================================================= */
61 KeyframeTreeStore_Class KeyframeTreeStore::keyframe_tree_store_class_;
63 /* === C L A S S E S & S T R U C T S ======================================= */
65 struct _keyframe_iterator
67 synfig::KeyframeList::iterator iter;
73 Gtk::TreeModel::iterator keyframe_iter_2_model_iter(synfig::KeyframeList::iterator iter,int index)
75 Gtk::TreeModel::iterator ret;
77 _keyframe_iterator*& data(static_cast<_keyframe_iterator*&>(ret->gobj()->user_data));
78 data=new _keyframe_iterator();
87 synfig::KeyframeList::iterator model_iter_2_keyframe_iter(Gtk::TreeModel::iterator iter)
89 _keyframe_iterator* data(static_cast<_keyframe_iterator*>(iter->gobj()->user_data));
91 throw std::runtime_error("bad data");
95 int get_index_from_model_iter(Gtk::TreeModel::iterator iter)
97 _keyframe_iterator* data(static_cast<_keyframe_iterator*>(iter->gobj()->user_data));
99 throw std::runtime_error("bad data");
105 #ifndef TreeRowReferenceHack
106 class TreeRowReferenceHack
108 GtkTreeRowReference *gobject_;
110 TreeRowReferenceHack():
115 TreeRowReferenceHack(const Glib::RefPtr<Gtk::TreeModel>& model, const Gtk::TreeModel::Path& path):
116 gobject_ ( gtk_tree_row_reference_new(model->gobj(), const_cast<GtkTreePath*>(path.gobj())) )
120 TreeRowReferenceHack(const TreeRowReferenceHack &x):
121 gobject_ ( x.gobject_?gtk_tree_row_reference_copy(x.gobject_):0 )
126 void swap(TreeRowReferenceHack & other)
128 GtkTreeRowReference *const temp = gobject_;
129 gobject_ = other.gobject_;
130 other.gobject_ = temp;
133 const TreeRowReferenceHack &
134 operator=(const TreeRowReferenceHack &rhs)
136 TreeRowReferenceHack temp (rhs);
141 ~TreeRowReferenceHack()
144 gtk_tree_row_reference_free(gobject_);
147 Gtk::TreeModel::Path get_path() { return Gtk::TreeModel::Path(gtk_tree_row_reference_get_path(gobject_),false); }
148 GtkTreeRowReference *gobj() { return gobject_; }
153 /* === P R O C E D U R E S ================================================= */
155 void clear_iterator(GtkTreeIter* iter)
158 iter->user_data=iter->user_data2=iter->user_data3=0;
161 /* === M E T H O D S ======================================================= */
164 KeyframeTreeStore_Class::init()
168 class_init_func_ = &KeyframeTreeStore_Class::class_init_function;
170 const GTypeInfo derived_info =
172 sizeof(GObjectClass),
184 gtype_ = g_type_register_static(G_TYPE_OBJECT, "KeyframeTreeStore", &derived_info, GTypeFlags(0));
185 Gtk::TreeModel::add_interface(get_type());
191 KeyframeTreeStore_Class::class_init_function(gpointer /*g_class*/, gpointer /*class_data*/)
196 KeyframeTreeStore::KeyframeTreeStore(etl::loose_handle<synfigapp::CanvasInterface> canvas_interface_):
197 Glib::ObjectBase ("KeyframeTreeStore"),
198 Glib::Object (Glib::ConstructParams(keyframe_tree_store_class_.init(), (char*) 0)),
199 canvas_interface_ (canvas_interface_)
202 //reset_path_table();
204 canvas_interface()->signal_keyframe_added().connect(sigc::mem_fun(*this,&studio::KeyframeTreeStore::add_keyframe));
205 canvas_interface()->signal_keyframe_removed().connect(sigc::mem_fun(*this,&studio::KeyframeTreeStore::remove_keyframe));
206 canvas_interface()->signal_keyframe_changed().connect(sigc::mem_fun(*this,&studio::KeyframeTreeStore::change_keyframe));
209 KeyframeTreeStore::~KeyframeTreeStore()
211 synfig::info("KeyframeTreeStore::~KeyframeTreeStore(): Deleted");
214 Glib::RefPtr<KeyframeTreeStore>
215 KeyframeTreeStore::create(etl::loose_handle<synfigapp::CanvasInterface> canvas_interface_)
217 KeyframeTreeStore *store(new KeyframeTreeStore(canvas_interface_));
218 Glib::RefPtr<KeyframeTreeStore> ret(store);
224 KeyframeTreeStore::reset_stamp()
226 stamp_=time(0)+reinterpret_cast<long>(this);
231 KeyframeTreeStore::reset_path_table()
233 Gtk::TreeModel::Children::iterator iter;
234 const Gtk::TreeModel::Children children(children());
236 for(iter = children.begin(); iter != children.end(); ++iter)
238 Gtk::TreeModel::Row row(*iter);
239 path_table_[(Keyframe)row[model.keyframe]]=TreeRowReferenceHack(Glib::RefPtr<KeyframeTreeStore>(this),Gtk::TreePath(row));
246 KeyframeTreeStore::iterator_sane(const GtkTreeIter* iter)const
248 if(iter && iter->stamp==stamp_)
250 g_warning("KeyframeTreeStore::iterator_sane(): Bad iterator stamp");
255 KeyframeTreeStore::iterator_sane(const Gtk::TreeModel::iterator& iter)const
257 return iterator_sane(iter->gobj());
261 KeyframeTreeStore::dump_iterator(const GtkTreeIter* /*gtk_iter*/, const Glib::ustring &/*name*/)const
266 g_warning("KeyframeTreeStore::dump_iterator: \"%s\" is NULL (Root?)",name.c_str());
270 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
272 if(gtk_iter->stamp!=stamp_ || !iter)
274 g_warning("KeyframeTreeStore::dump_iterator: \"%s\" is INVALID",name.c_str());
278 if((unsigned)iter->index>=canvas_interface()->get_canvas()->keyframe_list().size())
279 g_warning("KeyframeTreeStore::dump_iterator: \"%s\"(%p) has bad index(index:%d)",name.c_str(),gtk_iter,iter->index);
281 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());
286 KeyframeTreeStore::dump_iterator(const Gtk::TreeModel::iterator& iter, const Glib::ustring &name)const
288 dump_iterator(iter->gobj(),name);
292 KeyframeTreeStore::time_sorter(const Gtk::TreeModel::iterator &rhs,const Gtk::TreeModel::iterator &lhs)
296 _keyframe_iterator *rhs_iter(static_cast<_keyframe_iterator*>(rhs->gobj()->user_data));
297 _keyframe_iterator *lhs_iter(static_cast<_keyframe_iterator*>(lhs->gobj()->user_data));
299 Time diff(rhs_iter->iter->get_time()-lhs_iter->iter->get_time());
308 KeyframeTreeStore::set_value_impl(const Gtk::TreeModel::iterator& row, int column, const Glib::ValueBase& value)
310 if(!iterator_sane(row))
313 if(column>=get_n_columns_vfunc())
315 g_warning("KeyframeTreeStore::set_value_impl: Bad column (%d)",column);
319 if(!g_value_type_compatible(G_VALUE_TYPE(value.gobj()),get_column_type_vfunc(column)))
321 g_warning("KeyframeTreeStore::set_value_impl: Bad value type");
325 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(row.gobj()->user_data));
329 if(column==model.time_delta.index())
331 Glib::Value<synfig::Time> x;
332 g_value_init(x.gobj(),model.time.type());
333 g_value_copy(value.gobj(),x.gobj());
335 Time new_delta(x.get());
336 if(new_delta<=Time::zero()+Time::epsilon())
342 Time old_delta((*row)[model.time_delta]);
343 if(old_delta<=Time::zero()+Time::epsilon())
348 // row(row) on the next line is bad - don't use it, because it leaves 'row' uninitialised
349 //Gtk::TreeModel::iterator row(row);
353 Time change_delta(new_delta-old_delta);
355 if(change_delta<=Time::zero()+Time::epsilon() &&change_delta>=Time::zero()-Time::epsilon())
357 // Not an error, just no change
362 Keyframe keyframe((*row)[model.keyframe]);
363 synfigapp::Action::Handle action(synfigapp::Action::create("keyframe_set_delta"));
367 action->set_param("canvas",canvas_interface()->get_canvas());
368 action->set_param("canvas_interface",canvas_interface());
369 action->set_param("keyframe",keyframe);
370 action->set_param("delta",change_delta);
372 canvas_interface()->get_instance()->perform_action(action);
378 if(column==model.time.index())
380 OneMoment one_moment;
382 Glib::Value<synfig::Time> x;
383 g_value_init(x.gobj(),model.time.type());
384 g_value_copy(value.gobj(),x.gobj());
385 synfig::Keyframe keyframe(*iter->iter);
387 synfig::info("KeyframeTreeStore::set_value_impl():old_time=%s",keyframe.get_time().get_string().c_str());
388 keyframe.set_time(x.get());
389 synfig::info("KeyframeTreeStore::set_value_impl():new_time=%s",keyframe.get_time().get_string().c_str());
391 synfigapp::Action::Handle action(synfigapp::Action::create("keyframe_set"));
396 action->set_param("canvas",canvas_interface()->get_canvas());
397 action->set_param("canvas_interface",canvas_interface());
398 action->set_param("keyframe",keyframe);
400 canvas_interface()->get_instance()->perform_action(action);
402 else if(column==model.description.index())
404 Glib::Value<Glib::ustring> x;
405 g_value_init(x.gobj(),model.description.type());
406 g_value_copy(value.gobj(),x.gobj());
407 synfig::Keyframe keyframe(*iter->iter);
408 keyframe.set_description(x.get());
410 synfigapp::Action::Handle action(synfigapp::Action::create("keyframe_set"));
415 action->set_param("canvas",canvas_interface()->get_canvas());
416 action->set_param("canvas_interface",canvas_interface());
417 action->set_param("keyframe",keyframe);
419 canvas_interface()->get_instance()->perform_action(action);
421 else if(column==model.keyframe.index())
423 g_warning("KeyframeTreeStore::set_value_impl: This column is read-only");
430 catch(std::exception x)
437 KeyframeTreeStore::get_flags_vfunc ()
439 return Gtk::TREE_MODEL_LIST_ONLY;
443 KeyframeTreeStore::get_n_columns_vfunc ()
449 KeyframeTreeStore::get_column_type_vfunc (int index)
451 return model.types()[index];
455 KeyframeTreeStore::iter_next_vfunc (const iterator& xiter, iterator& iter_next) const
457 if(!iterator_sane(xiter)) return false;
459 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(xiter.gobj()->user_data));
461 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
464 _keyframe_iterator *next(new _keyframe_iterator());
465 iter_next.gobj()->user_data=static_cast<gpointer>(next);
467 next->index=iter->index+1;
468 next->iter=iter->iter;
471 if(next->iter==canvas_interface()->get_canvas()->keyframe_list().end())
474 iter_next.gobj()->stamp=stamp_;
481 KeyframeTreeStore::iter_next_vfunc (GtkTreeIter* gtk_iter)
483 if(!iterator_sane(gtk_iter)) return false;
485 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
487 // If we are already at the end, then we are very invalid
488 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
493 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
503 KeyframeTreeStore::iter_children_vfunc (GtkTreeIter* gtk_iter, const GtkTreeIter* parent)
505 dump_iterator(gtk_iter,"gtk_iter");
506 dump_iterator(parent,"parent");
508 if(!parent || !iterator_sane(parent))
510 clear_iterator(gtk_iter);
514 _keyframe_iterator *iter(new _keyframe_iterator());
517 iter->iter=canvas_interface()->get_canvas()->keyframe_list().begin();
519 gtk_iter->user_data=static_cast<gpointer>(iter);
520 gtk_iter->stamp=stamp_;
526 KeyframeTreeStore::iter_has_child_vfunc (const GtkTreeIter*parent)
528 dump_iterator(parent,"parent");
537 KeyframeTreeStore::iter_n_children_vfunc (const GtkTreeIter* parent)
539 dump_iterator(parent,"parent");
544 return canvas_interface()->get_canvas()->keyframe_list().size();
549 KeyframeTreeStore::iter_n_root_children_vfunc () const
551 return canvas_interface()->get_canvas()->keyframe_list().size();
555 KeyframeTreeStore::iter_nth_root_child_vfunc (int n, iterator& xiter)const
557 if(canvas_interface()->get_canvas()->keyframe_list().size()==0)
564 g_warning("KeyframeTreeStore::iter_nth_root_child_vfunc: Out of range (negative index)");
567 if(n && (unsigned)n>=canvas_interface()->get_canvas()->keyframe_list().size())
569 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: Out of range (large index)");
573 _keyframe_iterator *iter(new _keyframe_iterator());
576 iter->iter=canvas_interface()->get_canvas()->keyframe_list().begin();
579 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
581 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: >>>BUG<<< in %s on line %d",__FILE__,__LINE__);
587 xiter.gobj()->user_data=static_cast<gpointer>(iter);
588 xiter.gobj()->stamp=stamp_;
594 KeyframeTreeStore::iter_nth_child_vfunc (GtkTreeIter* gtk_iter, const GtkTreeIter* parent, int n)
596 dump_iterator(parent,"parent");
600 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: I am a list");
601 clear_iterator(gtk_iter);
607 _keyframe_iterator *iter(new _keyframe_iterator());
610 iter->iter=canvas_interface()->get_canvas()->keyframe_list().begin();
613 if(iter->iter==canvas_interface()->get_canvas()->keyframe_list().end())
615 g_warning("KeyframeTreeStore::iter_nth_child_vfunc: >>>BUG<<< in %s on line %d",__FILE__,__LINE__);
617 clear_iterator(gtk_iter);
623 gtk_iter->user_data=static_cast<gpointer>(iter);
624 gtk_iter->stamp=stamp_;
629 KeyframeTreeStore::iter_parent_vfunc (GtkTreeIter* gtk_iter, const GtkTreeIter* child)
631 dump_iterator(child,"child");
632 iterator_sane(child);
633 clear_iterator(gtk_iter);
639 KeyframeTreeStore::ref_node_vfunc (iterator& xiter)const
641 GtkTreeIter* gtk_iter(xiter.gobj());
642 if(!gtk_iter || !iterator_sane(gtk_iter)) return;
644 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
649 KeyframeTreeStore::unref_node_vfunc (iterator& xiter)const
651 GtkTreeIter* gtk_iter(xiter.gobj());
652 if(!gtk_iter || !iterator_sane(gtk_iter)) return;
654 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
660 // Make this iterator invalid
666 KeyframeTreeStore::get_path_vfunc (const TreeModel::iterator& gtk_iter)const
668 Gtk::TreeModel::Path path;
670 // If this is the root node, then return
672 if(!iterator_sane(gtk_iter))
675 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->gobj()->user_data));
677 path.append_index(iter->index);
683 KeyframeTreeStore::get_iter_vfunc (const Gtk::TreeModel::Path& path, iterator& iter)const
685 if(path.get_depth()>=1)
686 return iter_nth_root_child_vfunc(path.front(),iter);
689 g_warning("KeyframeTreeStore::get_iter_vfunc(): Bad path \"%s\"",path.to_string().c_str());
690 //clear_iterator(iter);
695 KeyframeTreeStore::iter_is_valid (const iterator& iter) const
697 return iterator_sane(iter);
701 KeyframeTreeStore::get_value_vfunc (const Gtk::TreeModel::iterator& gtk_iter, int column, Glib::ValueBase& value)const
703 dump_iterator(gtk_iter,"gtk_iter");
704 if(!iterator_sane(gtk_iter))
707 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->gobj()->user_data));
713 Glib::Value<synfig::Time> x;
714 g_value_init(x.gobj(),x.value_type());
715 x.set(iter->iter->get_time());
716 g_value_init(value.gobj(),x.value_type());
717 g_value_copy(x.gobj(),value.gobj());
720 case 3: // Time Delta
722 Glib::Value<synfig::Time> x;
723 g_value_init(x.gobj(),x.value_type());
725 synfig::Keyframe prev_keyframe(*iter->iter);
726 synfig::Keyframe keyframe;
728 KeyframeList::iterator tmp(iter->iter);
730 if(tmp==get_canvas()->keyframe_list().end())
733 g_value_init(value.gobj(),x.value_type());
734 g_value_copy(x.gobj(),value.gobj());
742 delta=keyframe.get_time()-prev_keyframe.get_time();
745 g_value_init(value.gobj(),x.value_type());
746 g_value_copy(x.gobj(),value.gobj());
749 case 1: // Description
751 g_value_init(value.gobj(),G_TYPE_STRING);
752 g_value_set_string(value.gobj(),iter->iter->get_description().c_str());
757 Glib::Value<synfig::Keyframe> x;
758 g_value_init(x.gobj(),x.value_type());
760 g_value_init(value.gobj(),x.value_type());
761 g_value_copy(x.gobj(),value.gobj());
770 KeyframeTreeStore::find_row(const synfig::Keyframe &keyframe)
772 Gtk::TreeModel::Row row(*(children().begin()));
773 dump_iterator(row,"find_row,begin");
774 const GtkTreeIter *gtk_iter(row.gobj());
775 if(!iterator_sane(gtk_iter))
776 throw std::runtime_error(_("Unable to find Keyframe in table"));
778 _keyframe_iterator *iter(static_cast<_keyframe_iterator*>(gtk_iter->user_data));
780 synfig::KeyframeList &keyframe_list(canvas_interface()->get_canvas()->keyframe_list());
781 if(keyframe_list.empty())
782 throw std::runtime_error(_("There are no keyframes n this canvas"));
786 for(iter->iter=keyframe_list.begin();iter->iter!=keyframe_list.end() && *iter->iter!=keyframe;++iter->iter)
790 if(iter->iter==keyframe_list.end())
791 throw std::runtime_error(_("Unable to find Keyframe in table"));
796 KeyframeTreeStore::add_keyframe(Keyframe keyframe)
800 Gtk::TreeRow row(find_row(keyframe));
801 dump_iterator(row.gobj(),"add_keyframe,row");
802 Gtk::TreePath path(get_path(row));
804 row_inserted(path,row);
806 old_keyframe_list=get_canvas()->keyframe_list();
807 //old_keyframe_list.add(keyframe);
808 //old_keyframe_list.sort();
810 catch(std::exception x)
817 KeyframeTreeStore::remove_keyframe(Keyframe keyframe)
823 Gtk::TreeRow row(find_row(keyframe));
824 dump_iterator(row,"remove_keyframe,row");
825 Gtk::TreePath path(get_path(row));
828 old_keyframe_list.erase(keyframe);
832 g_warning("KeyframeTreeStore::remove_keyframe: Keyframe not in table");
835 catch(std::exception x)
843 KeyframeTreeStore::change_keyframe(Keyframe keyframe)
847 Gtk::TreeRow row(find_row(keyframe));
849 unsigned int new_index(get_index_from_model_iter(row));
850 unsigned int old_index(0);
851 synfig::KeyframeList::iterator iter;
852 for(old_index=0,iter=old_keyframe_list.begin();iter!=old_keyframe_list.end() && (UniqueID)*iter!=(UniqueID)keyframe;++iter,old_index++);
854 if(iter!=old_keyframe_list.end() && new_index!=old_index)
857 std::vector<int> new_order;
858 for(unsigned int i=0;i<old_keyframe_list.size();i++)
860 new_order.push_back(i);
862 if(new_order.size()>new_index)
864 new_order.erase(new_order.begin()+new_index);
865 new_order.insert(new_order.begin()+old_index,new_index);
867 //new_order[old_index]=
869 rows_reordered (Path(), iterator(), &new_order[0]);
871 old_keyframe_list=get_canvas()->keyframe_list();
873 row=find_row(keyframe);
876 dump_iterator(row,"change_keyframe,row");
877 row_changed(get_path(row),row);
879 catch(std::exception x)