synfig-studio/src/synfigapp/actions/keyframeadd.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file keyframeadd.cpp
   3 **      \brief Template File
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **
  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.
  14 **
  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.
  19 **      \endlegal
  20 */
  21 /* ========================================================================= */
  22
  23 /* === H E A D E R S ======================================================= */
  24
  25 #ifdef USING_PCH
  26 #       include "pch.h"
  27 #else
  28 #ifdef HAVE_CONFIG_H
  29 #       include <config.h>
  30 #endif
  31
  32 #include "keyframeadd.h"
  33 #include <synfigapp/canvasinterface.h>
  34
  35 #include <synfigapp/general.h>
  36
  37 #endif
  38
  39 using namespace std;
  40 using namespace etl;
  41 using namespace synfig;
  42 using namespace synfigapp;
  43 using namespace Action;
  44
  45 /* === M A C R O S ========================================================= */
  46
  47 ACTION_INIT(Action::KeyframeAdd);
  48 ACTION_SET_NAME(Action::KeyframeAdd,"KeyframeAdd");
  49 ACTION_SET_LOCAL_NAME(Action::KeyframeAdd,N_("Add Keyframe"));
  50 ACTION_SET_TASK(Action::KeyframeAdd,"add");
  51 ACTION_SET_CATEGORY(Action::KeyframeAdd,Action::CATEGORY_KEYFRAME);
  52 ACTION_SET_PRIORITY(Action::KeyframeAdd,0);
  53 ACTION_SET_VERSION(Action::KeyframeAdd,"0.0");
  54 ACTION_SET_CVS_ID(Action::KeyframeAdd,"$Id$");
  55
  56 /* === G L O B A L S ======================================================= */
  57
  58 /* === P R O C E D U R E S ================================================= */
  59
  60 /* === M E T H O D S ======================================================= */
  61
  62 Action::KeyframeAdd::KeyframeAdd()
  63 {
  64         keyframe.set_time(Time::begin()-1);
  65         set_dirty(false);
  66 }
  67
  68 Action::ParamVocab
  69 Action::KeyframeAdd::get_param_vocab()
  70 {
  71         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
  72
  73         ret.push_back(ParamDesc("keyframe",Param::TYPE_KEYFRAME)
  74                 .set_local_name(_("New Keyframe"))
  75                 .set_desc(_("Keyframe to be added"))
  76         );
  77
  78         return ret;
  79 }
  80
  81 bool
  82 Action::KeyframeAdd::is_candidate(const ParamList &x)
  83 {
  84         if(!candidate_check(get_param_vocab(),x))
  85                 return false;
  86
  87         return true;
  88 }
  89
  90 bool
  91 Action::KeyframeAdd::set_param(const synfig::String& name, const Action::Param &param)
  92 {
  93         if(name=="keyframe" && param.get_type()==Param::TYPE_KEYFRAME)
  94         {
  95                 keyframe=param.get_keyframe();
  96
  97                 return true;
  98         }
  99
 100         return Action::CanvasSpecific::set_param(name,param);
 101 }
 102
 103 bool
 104 Action::KeyframeAdd::is_ready()const
 105 {
 106         if(keyframe.get_time()==(Time::begin()-1))
 107                 return false;
 108         return Action::CanvasSpecific::is_ready();
 109 }
 110
 111 void
 112 Action::KeyframeAdd::perform()
 113 {
 114         try { get_canvas()->keyframe_list().find(keyframe.get_time()); throw Error(_("A Keyframe already exists at this point in time"));}
 115         catch(synfig::Exception::NotFound) { }
 116
 117         try { get_canvas()->keyframe_list().find(keyframe); throw Error(_("This keyframe is already in the ValueNode"));}
 118         catch(synfig::Exception::NotFound) { }
 119
 120         get_canvas()->keyframe_list().add(keyframe);
 121
 122         if(get_canvas_interface())
 123         {
 124                 get_canvas_interface()->signal_keyframe_added()(keyframe);
 125         }
 126         else synfig::warning("CanvasInterface not set on action");
 127 }
 128
 129 void
 130 Action::KeyframeAdd::undo()
 131 {
 132         if(get_canvas_interface())
 133         {
 134                 get_canvas_interface()->signal_keyframe_removed()(keyframe);
 135         }
 136         else synfig::warning("CanvasInterface not set on action");
 137
 138         get_canvas()->keyframe_list().erase(keyframe);
 139 }