synfig-studio/trunk/src/gtkmm/widget_keyframe_list.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file widget_keyframe_list.cpp
   3 **      \brief A custom widget to manage keyframes in the timeline.
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007 Chris Moore
  10 **      Copyright (c) 2009 Carlos López
  11 **
  12 **      This package is free software; you can redistribute it and/or
  13 **      modify it under the terms of the GNU General Public License as
  14 **      published by the Free Software Foundation; either version 2 of
  15 **      the License, or (at your option) any later version.
  16 **
  17 **      This package is distributed in the hope that it will be useful,
  18 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20 **      General Public License for more details.
  21 **      \endlegal
  22 */
  23 /* ========================================================================= */
  24
  25 /* === H E A D E R S ======================================================= */
  26
  27 #ifdef USING_PCH
  28 #       include "pch.h"
  29 #else
  30 #ifdef HAVE_CONFIG_H
  31 #       include <config.h>
  32 #endif
  33
  34 #include "widget_keyframe_list.h"
  35 #include "app.h"
  36 #include <gtkmm/menu.h>
  37 #include <synfig/exception.h>
  38 #include <ETL/misc>
  39
  40 #include "general.h"
  41
  42 #endif
  43
  44 /* === U S I N G =========================================================== */
  45
  46 using namespace std;
  47 using namespace etl;
  48 using namespace synfig;
  49 using namespace studio;
  50
  51
  52 /* === M A C R O S ========================================================= */
  53
  54 /* === G L O B A L S ======================================================= */
  55
  56 /* === P R O C E D U R E S ================================================= */
  57
  58 /* === M E T H O D S ======================================================= */
  59
  60 Widget_Keyframe_List::Widget_Keyframe_List():
  61         editable_(true),
  62         adj_default(0,0,2,1/24,10/24),
  63         adj_timescale(0),
  64         fps(24),
  65         kf_list_(&default_kf_list_),
  66         time_ratio("4f", fps)
  67 {
  68         set_size_request(-1,64);
  69         //!This signal is called when the widget need to be redrawn
  70         signal_expose_event().connect(sigc::mem_fun(*this, &studio::Widget_Keyframe_List::redraw));
  71         //! The widget respond to mouse button press and release and to
  72         //! left button motion
  73         add_events(Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK);
  74         add_events(Gdk::BUTTON1_MOTION_MASK);
  75         set_time_adjustment(&adj_default);
  76
  77 }
  78
  79 Widget_Keyframe_List::~Widget_Keyframe_List()
  80 {
  81 }
  82
  83 bool
  84 Widget_Keyframe_List::redraw(GdkEventExpose */*bleh*/)
  85 {
  86
  87         const int h(get_height());
  88         const int w(get_width());
  89
  90         //!Boundaries of the drawing area in time units.
  91         synfig::Time top(adj_timescale->get_upper());
  92         synfig::Time bottom(adj_timescale->get_lower());
  93
  94         //! The graphic context
  95         Glib::RefPtr<Gdk::GC> gc(Gdk::GC::create(get_window()));
  96         //! A rectangle that defines the drawing area.
  97         Gdk::Rectangle area(0,0,w,h);
  98
  99         if(!editable_)
 100         {
 101                 return true; //needs fixing!
 102         }
 103
 104         //! draw a background
 105         gc->set_rgb_fg_color(Gdk::Color("#7f7f7f"));
 106         get_window()->draw_rectangle(gc, true, 0, 0, w, h);
 107
 108         //!Returns if there are not keyframes to draw.
 109         if (kf_list_->empty()) return false;
 110
 111         //!Loop all the keyframes
 112         synfig::KeyframeList::iterator iter,selected_iter;
 113         bool show_selected(false);
 114         for(iter=kf_list_->begin();iter!=kf_list_->end();iter++)
 115         {
 116                 //!do not draw keyframes out of the widget boundaries
 117                 if (iter->get_time()>top || iter->get_time()<bottom)
 118                         continue;
 119                 //! If the keyframe is not the selected one
 120                 if(*iter!=selected_kf)
 121                 {
 122                         const int x((int)((float)(iter->get_time()-bottom) * (w/(top-bottom)) ) );
 123                         get_style()->paint_arrow(get_window(), Gtk::STATE_NORMAL,
 124                         Gtk::SHADOW_OUT, area, *this, " ", Gtk::ARROW_DOWN, 1,
 125                         x-h/2+1, 0, h, h );
 126                 }
 127                 else
 128                 {
 129                         selected_iter=iter;
 130                         show_selected=true;
 131                 }
 132         }
 133
 134         // we do this so that we can be sure that
 135         // the selected keyframe is shown on top
 136         if(show_selected)
 137         {
 138                 // If not dragging just show the selected keyframe
 139                 if (!dragging_)
 140                 {
 141                         int x((int)((float)(selected_iter->get_time()-bottom) * (w/(top-bottom)) ) );
 142                         get_style()->paint_arrow(get_window(), Gtk::STATE_SELECTED,
 143                         Gtk::SHADOW_OUT, area, *this, " ", Gtk::ARROW_DOWN, 1,
 144                         x-h/2+1, 0, h, h );
 145                 }
 146                 // If dragging then show the selected as insensitive and the
 147                 // dragged as selected
 148                 else
 149                 {
 150                         int x((int)((float)(selected_iter->get_time()-bottom) * (w/(top-bottom)) ) );
 151                         get_style()->paint_arrow(get_window(), Gtk::STATE_INSENSITIVE,
 152                         Gtk::SHADOW_OUT, area, *this, " ", Gtk::ARROW_DOWN, 1,
 153                         x-h/2, 0, h, h );
 154                         x=(int)((float)(dragging_kf_time-bottom) * (w/(top-bottom)) ) ;
 155                         get_style()->paint_arrow(get_window(), Gtk::STATE_SELECTED,
 156                         Gtk::SHADOW_OUT, area, *this, " ", Gtk::ARROW_DOWN, 1,
 157                         x-h/2+1, 0, h, h );
 158                 }
 159         }
 160         return true;
 161 }
 162
 163
 164 void
 165 Widget_Keyframe_List::set_kf_list(synfig::KeyframeList* x)
 166 {
 167         kf_list_=x;
 168         set_selected_keyframe(selected_none);
 169         selected_=false;
 170         dragging_=false;
 171 }
 172
 173 void
 174 Widget_Keyframe_List::set_selected_keyframe(const synfig::Keyframe &x)
 175 {
 176         selected_kf=x;
 177         selected_=true;
 178         dragging_kf_time=selected_kf.get_time();
 179         //signal_keyframe_selected_(selected_kf);
 180         dragging_=false;
 181         queue_draw();
 182 }
 183
 184 bool
 185 Widget_Keyframe_List::perform_move_kf()
 186 {
 187         if(!selected_)
 188                 return false;
 189         if(dragging_kf_time == selected_kf.get_time())
 190                 return false;
 191         synfigapp::Action::Handle action(synfigapp::Action::create("KeyframeSet"));
 192         if(!action)
 193                 return false;
 194         selected_kf.set_time(dragging_kf_time);
 195         action->set_param("canvas",canvas_interface_->get_canvas());
 196         action->set_param("canvas_interface",canvas_interface_);
 197         action->set_param("keyframe",selected_kf);
 198         try
 199         {
 200                 canvas_interface_->get_instance()->perform_action(action);
 201         }
 202         catch(...)
 203         {
 204                         return false;
 205         }
 206         queue_draw();
 207         return true;
 208 }
 209
 210 bool
 211 Widget_Keyframe_List::on_event(GdkEvent *event)
 212 {
 213         const int x(static_cast<int>(event->button.x));
 214         const int y(static_cast<int>(event->button.y));
 215         //!Boundaries of the drawing area in time units.
 216         synfig::Time top(adj_timescale->get_upper());
 217         synfig::Time bottom(adj_timescale->get_lower());
 218         //!pos is the [0,1] relative horizontal place on the widget
 219         float pos((float)x/(get_width()));
 220         if(pos<0.0f)pos=0.0f;
 221         if(pos>1.0f)pos=1.0f;
 222         //! The time where the event x is
 223         synfig::Time t((float)(bottom+pos*(top-bottom)));
 224
 225         //Do not respond mouse events if the list is empty
 226         if(!kf_list_->size())
 227         {
 228         //      synfig::info("Keyframe list empty");
 229                 return true;
 230         }
 231
 232         //! here the guts of the event
 233         switch(event->type)
 234         {
 235         case GDK_MOTION_NOTIFY:
 236                 if(editable_)
 237                 {
 238                         // stick to integer frames. It can be optional in the future
 239                         if(fps)
 240                                 {
 241                                         t = floor(t*fps + 0.5)/fps;
 242                                 }
 243                         dragging_kf_time=t;
 244                         dragging_=true;
 245                         queue_draw();
 246                         return true;
 247                 }
 248                 break;
 249         case GDK_BUTTON_PRESS:
 250                 changed_=false;
 251                 dragging_=false;
 252                 if(event->button.button==1)
 253                 {
 254                         /*synfig::info("Looking keyframe at  %s", t.get_string().c_str());
 255                         synfig::info("Total amount of keyframes %i", kf_list_->size());
 256                         synfig::info("Time ratio %s",time_ratio.get_string().c_str());
 257                         synfig::info("Bottom %s",bottom.get_string().c_str());
 258                         synfig::info("Top %s",top.get_string().c_str());*/
 259                         if(editable_)
 260                         {
 261                                 synfig::Time prev_t,next_t;
 262                                 kf_list_->find_prev_next(t, prev_t, next_t);
 263                                 if( (prev_t==Time::begin()      &&      next_t==Time::end())
 264                                         ||
 265                                         ((t-prev_t)>time_ratio  && (next_t-t)>time_ratio)
 266                                         )
 267                                 {
 268                                         set_selected_keyframe(selected_none);
 269                                         selected_=false;
 270                                         /*synfig::info("Selected keyframe set to none");
 271                                         synfig::info("Distance to prev %s", (t-prev_t).get_string().c_str());
 272                                         synfig::info("Distance to next %s", (next_t-t).get_string().c_str());*/
 273                                         queue_draw();
 274                                         return true;
 275                                 }
 276                                 else if ((t-prev_t)<(next_t-t))
 277                                 {
 278                                         set_selected_keyframe(*(kf_list_->find_prev(t)));
 279                                         //synfig::info("Selected keyframe set to previous");
 280                                         queue_draw();
 281                                         selected_=true;
 282                                         return true;
 283                                 }
 284                                 else
 285                                 {
 286                                         set_selected_keyframe(*(kf_list_->find_next(t)));
 287                                         //synfig::info("Selected keyframe set to next");
 288                                         queue_draw();
 289                                         selected_=true;
 290                                         return true;
 291                                 }
 292
 293                                 return false;
 294                         }
 295                         else
 296                         {
 297                                 return false;
 298                         }
 299                 }
 300                 break;
 301         case GDK_BUTTON_RELEASE:
 302                 if(editable_ && event->button.button==1)
 303                 {
 304                 // stick to integer frames.
 305                 if(fps)
 306                         {
 307                                 t = floor(t*fps + 0.5)/fps;
 308                         }
 309                 bool stat=false;
 310                 if(dragging_)
 311                         stat=perform_move_kf();
 312                 dragging_=false;
 313                 //synfig::info("Dropping keyframe time at: %s", t.get_string().c_str());
 314                 //synfig::info("perform move result: %i", stat);
 315                 return stat;
 316                 }
 317         default:
 318                 break;
 319         }
 320
 321
 322         return false;
 323 }
 324
 325
 326 void Widget_Keyframe_List::set_time_adjustment(Gtk::Adjustment *x)
 327 {
 328         //disconnect old connections
 329         time_value_change.disconnect();
 330         time_other_change.disconnect();
 331
 332         //connect update function to new adjustment
 333         adj_timescale = x;
 334
 335         if(x)
 336         {
 337                 time_value_change = x->signal_value_changed().connect(sigc::mem_fun(*this,&Widget_Keyframe_List::queue_draw));
 338                 time_other_change = x->signal_changed().connect(sigc::mem_fun(*this,&Widget_Keyframe_List::queue_draw));
 339         }
 340 }
 341
 342 void
 343 Widget_Keyframe_List::set_fps(float d)
 344 {
 345         if(fps != d)
 346         {
 347                 fps = d;
 348                 //update everything since we need to redraw already
 349                 queue_draw();
 350         }
 351 }
 352
 353 void
 354 Widget_Keyframe_List::set_canvas_interface(etl::loose_handle<synfigapp::CanvasInterface> h)
 355 {
 356         canvas_interface_=h;
 357         // Store the values used fomr the canvas interface.
 358         if (canvas_interface_)
 359         {
 360                 set_fps(canvas_interface_->get_canvas()->rend_desc().get_frame_rate());
 361                 set_kf_list(&canvas_interface_->get_canvas()->keyframe_list());
 362         }
 363 }
 364
 365