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 #define WIDGET_KEYFRAME_LIST_DEFAULT_FPS 24.0
  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         adj_default(0,0,2,1/WIDGET_KEYFRAME_LIST_DEFAULT_FPS,10/WIDGET_KEYFRAME_LIST_DEFAULT_FPS),
  62         kf_list_(&default_kf_list_),
  63         time_ratio("4f", WIDGET_KEYFRAME_LIST_DEFAULT_FPS)
  64 {
  65         adj_timescale=0;
  66         editable_=true;
  67         fps=WIDGET_KEYFRAME_LIST_DEFAULT_FPS;
  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 /*| Gdk::BUTTON3_MOTION_MASK*/);
  75         add_events(Gdk::POINTER_MOTION_MASK);
  76         set_time_adjustment(&adj_default);
  77         queue_draw();
  78 }
  79
  80 Widget_Keyframe_List::~Widget_Keyframe_List()
  81 {
  82 }
  83
  84 bool
  85 Widget_Keyframe_List::redraw(GdkEventExpose */*bleh*/)
  86 {
  87
  88         const int h(get_height());
  89         const int w(get_width());
  90
  91         //!Boundaries of the drawing area in time units.
  92         synfig::Time top(adj_timescale->get_upper());
  93         synfig::Time bottom(adj_timescale->get_lower());
  94
  95         //! The graphic context
  96         Glib::RefPtr<Gdk::GC> gc(Gdk::GC::create(get_window()));
  97         //! A rectangle that defines the drawing area.
  98         Gdk::Rectangle area(0,0,w,h);
  99
 100         //! draw a background
 101         gc->set_rgb_fg_color(Gdk::Color("#9d9d9d"));
 102         get_window()->draw_rectangle(gc, true, 0, 0, w, h);
 103
 104         if(!editable_)
 105         {
 106                 return true; //needs fixing!
 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(bool delta=false)
 186 {
 187         if(!selected_)
 188                 return false;
 189         if(dragging_kf_time == selected_kf.get_time())
 190                 return false; // change this checking if not sticked to integer frames
 191         Time selected_kf_time(selected_kf.get_time());
 192         Time prev, next;
 193         kf_list_->find_prev_next(selected_kf_time, prev, next);
 194         // Not possible to set delta to the first keyframe
 195         // perform normal movement
 196         if (prev==Time::begin()) delta = false;
 197
 198         if(!delta)
 199                 {
 200                         synfigapp::Action::Handle action(synfigapp::Action::create("KeyframeSet"));
 201                         if(!action)
 202                         return false;
 203                         selected_kf.set_time(dragging_kf_time);
 204                         action->set_param("canvas",canvas_interface_->get_canvas());
 205                         action->set_param("canvas_interface",canvas_interface_);
 206                         action->set_param("keyframe",selected_kf);
 207                         try
 208                         {
 209                                 canvas_interface_->get_instance()->perform_action(action);
 210                         }
 211                         catch(...)
 212                         {
 213                                 return false;
 214                         }
 215                 }
 216         else
 217                 {
 218                         Keyframe prev_kf(*kf_list_->find_prev(selected_kf_time));
 219                         Time prev_kf_time(prev_kf.get_time());
 220                         if (prev_kf_time >= dragging_kf_time) //Not allowed
 221                         {
 222                                 synfig::warning(_("Delta set not allowed"));
 223                                 synfig::info(_("Widget_Keyframe_List::perform_move_kf(%i)::prev_kf_time=%s"), delta, prev_kf_time.get_string().c_str());
 224                                 synfig::info(_("Widget_Keyframe_List::perform_move_kf(%i)::dragging_kf_time=%s"), delta, dragging_kf_time.get_string().c_str());
 225                                 return false;
 226                         }
 227                         else
 228                         {
 229                                 Time old_delta_time(selected_kf_time-prev_kf_time);
 230                                 Time new_delta_time(dragging_kf_time-prev_kf_time);
 231                                 Time change_delta(new_delta_time-old_delta_time);
 232                                 synfigapp::Action::Handle action(synfigapp::Action::create("KeyframeSetDelta"));
 233                                 if(!action)
 234                                         return false;
 235                                 action->set_param("canvas",canvas_interface_->get_canvas());
 236                                 action->set_param("canvas_interface",canvas_interface_);
 237                                 action->set_param("keyframe",prev_kf);
 238                                 action->set_param("delta",change_delta);
 239                                 canvas_interface_->get_instance()->perform_action(action);
 240                         }
 241                 }
 242         queue_draw();
 243         return true;
 244 }
 245
 246 bool
 247 Widget_Keyframe_List::on_event(GdkEvent *event)
 248 {
 249         const int x(static_cast<int>(event->button.x));
 250         //const int y(static_cast<int>(event->button.y));
 251         //!Boundaries of the drawing area in time units.
 252         synfig::Time top(adj_timescale->get_upper());
 253         synfig::Time bottom(adj_timescale->get_lower());
 254         //!pos is the [0,1] relative horizontal place on the widget
 255         float pos((float)x/(get_width()));
 256         if(pos<0.0f)pos=0.0f;
 257         if(pos>1.0f)pos=1.0f;
 258         //! The time where the event x is
 259         synfig::Time t((float)(bottom+pos*(top-bottom)));
 260         //Do not respond mouse events if the list is empty
 261         if(!kf_list_->size())
 262                 return true;
 263
 264         //! here the guts of the event
 265         switch(event->type)
 266         {
 267         case GDK_MOTION_NOTIFY:
 268                 if(editable_)
 269                 {
 270                         // here is captured mouse motion
 271                         // AND left or right mouse button pressed
 272                         if (event->motion.state & (GDK_BUTTON1_MASK /*| GDK_BUTTON3_MASK*/))
 273                         {
 274                                 // stick to integer frames. It can be optional in the future
 275                                 if(fps) t = floor(t*fps + 0.5)/fps;
 276                                 dragging_kf_time=t;
 277                                 dragging_=true;
 278                                 queue_draw();
 279                                 return true;
 280                         }
 281                         // here is captured mouse motion
 282                         // AND NOT left or right mouse button pressed
 283                         else
 284                         {
 285                                 synfig::Time p_t,n_t;
 286                                 kf_list_->find_prev_next(t, p_t, n_t);
 287                                 if( (p_t==Time::begin()         &&      n_t==Time::end())
 288                                 ||
 289                                 ((t-p_t)>time_ratio     && (n_t-t)>time_ratio)
 290                                 )
 291                                 {
 292                                         Glib::ustring ttip = _("Click and drag keyframes");
 293                                         set_tooltip_text(ttip);
 294                                 }
 295                                 else if ((t-p_t)<(n_t-t))
 296                                 {
 297                                         synfig::Keyframe kf(*kf_list_->find_prev(t));
 298                                         synfig::String kf_name(kf.get_description().c_str());
 299                                         Glib::ustring ttip = kf_name.c_str();
 300                                         set_tooltip_text(ttip);
 301                                 }
 302                                 else
 303                                 {
 304                                         synfig::Keyframe kf(*kf_list_->find_next(t));
 305                                         synfig::String kf_name(kf.get_description().c_str());
 306                                         Glib::ustring ttip = kf_name.c_str();
 307                                         set_tooltip_text(ttip);
 308                                 }
 309                                 dragging_=false;
 310                                 queue_draw();
 311                                 return true;
 312                         }
 313                 }
 314                 break;
 315         case GDK_BUTTON_PRESS:
 316                 changed_=false;
 317                 dragging_=false;
 318                 if(event->button.button==1 /*|| event->button.button==3*/)
 319                 {
 320                         if(editable_)
 321                         {
 322                                 synfig::Time prev_t,next_t;
 323                                 kf_list_->find_prev_next(t, prev_t, next_t);
 324                                 if( (prev_t==Time::begin()      &&      next_t==Time::end())
 325                                 ||
 326                                 ((t-prev_t)>time_ratio  && (next_t-t)>time_ratio)
 327                                 )
 328                                 {
 329                                         set_selected_keyframe(selected_none);
 330                                         selected_=false;
 331                                         queue_draw();
 332                                 }
 333                                 else if ((t-prev_t)<(next_t-t))
 334                                 {
 335                                         set_selected_keyframe(*(kf_list_->find_prev(t)));
 336                                         queue_draw();
 337                                         selected_=true;
 338                                 }
 339                                 else
 340                                 {
 341                                         set_selected_keyframe(*(kf_list_->find_next(t)));
 342                                         queue_draw();
 343                                         selected_=true;
 344                                 }
 345                                 return true;
 346                         }
 347                         else
 348                         {
 349                                 return false;
 350                         }
 351                 }
 352
 353                 break;
 354         case GDK_BUTTON_RELEASE:
 355                 if(editable_ && (event->button.button==1 /*|| event->button.button==3*/))
 356                 {
 357                         // stick to integer frames.
 358                         if(fps) t = floor(t*fps + 0.5)/fps;
 359                         bool stat=false;
 360                         if(dragging_)
 361                                 {
 362                                         //if (event->button.button==3)
 363                                         if(event->button.state & GDK_MOD1_MASK)
 364                                         {
 365                                                 stat=perform_move_kf(true);
 366                                         }
 367                                         else
 368                                         {
 369                                                 stat=perform_move_kf(false);
 370                                         }
 371                                 }
 372                         dragging_=false;
 373                         return stat;
 374                 }
 375                 break;
 376         default:
 377                 break;
 378         }
 379         return false;
 380 }
 381
 382
 383 void Widget_Keyframe_List::set_time_adjustment(Gtk::Adjustment *x)
 384 {
 385         //disconnect old connections
 386         time_value_change.disconnect();
 387         time_other_change.disconnect();
 388
 389         //connect update function to new adjustment
 390         adj_timescale = x;
 391
 392         if(x)
 393         {
 394                 time_value_change = x->signal_value_changed().connect(sigc::mem_fun(*this,&Widget_Keyframe_List::queue_draw));
 395                 time_other_change = x->signal_changed().connect(sigc::mem_fun(*this,&Widget_Keyframe_List::queue_draw));
 396         }
 397 }
 398
 399 void
 400 Widget_Keyframe_List::set_fps(float d)
 401 {
 402         if(fps != d)
 403         {
 404                 fps = d;
 405                 //update everything since we need to redraw already
 406                 queue_draw();
 407         }
 408 }
 409
 410 void
 411 Widget_Keyframe_List::set_canvas_interface(etl::loose_handle<synfigapp::CanvasInterface> h)
 412 {
 413         canvas_interface_=h;
 414         // Store the values used fomr the canvas interface.
 415         if (canvas_interface_)
 416         {
 417                 set_fps(canvas_interface_->get_canvas()->rend_desc().get_frame_rate());
 418                 set_kf_list(&canvas_interface_->get_canvas()->keyframe_list());
 419         }
 420 }
 421
 422