synfig-studio/trunk/src/synfigapp/actions/waypointadd.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file waypointadd.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 "waypointadd.h"
  33 #include <synfigapp/canvasinterface.h>
  34 #include <synfigapp/main.h>
  35
  36 #include <synfigapp/general.h>
  37
  38 #endif
  39
  40 using namespace std;
  41 using namespace etl;
  42 using namespace synfig;
  43 using namespace synfigapp;
  44 using namespace Action;
  45
  46 /* === M A C R O S ========================================================= */
  47
  48 ACTION_INIT(Action::WaypointAdd);
  49 ACTION_SET_NAME(Action::WaypointAdd,"waypoint_add");
  50 ACTION_SET_LOCAL_NAME(Action::WaypointAdd,N_("Add Waypoint"));
  51 ACTION_SET_TASK(Action::WaypointAdd,"add");
  52 ACTION_SET_CATEGORY(Action::WaypointAdd,Action::CATEGORY_WAYPOINT);
  53 ACTION_SET_PRIORITY(Action::WaypointAdd,0);
  54 ACTION_SET_VERSION(Action::WaypointAdd,"0.0");
  55 ACTION_SET_CVS_ID(Action::WaypointAdd,"$Id$");
  56
  57 /* === G L O B A L S ======================================================= */
  58
  59 /* === P R O C E D U R E S ================================================= */
  60
  61 /* === M E T H O D S ======================================================= */
  62
  63 Action::WaypointAdd::WaypointAdd()
  64 {
  65         waypoint.set_time(Time::begin()-1);
  66         time_set=false;
  67         set_dirty(true);
  68 }
  69
  70 Action::ParamVocab
  71 Action::WaypointAdd::get_param_vocab()
  72 {
  73         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
  74
  75         ret.push_back(ParamDesc("value_node",Param::TYPE_VALUENODE)
  76                 .set_local_name(_("Destination ValueNode (Animated)"))
  77         );
  78
  79         ret.push_back(ParamDesc("waypoint",Param::TYPE_WAYPOINT)
  80                 .set_local_name(_("New Waypoint"))
  81                 .set_desc(_("Waypoint to be added"))
  82                 .set_optional()
  83         );
  84
  85         ret.push_back(ParamDesc("time",Param::TYPE_TIME)
  86                 .set_local_name(_("Time"))
  87                 .set_desc(_("Time where waypoint is to be added"))
  88                 .set_optional()
  89         );
  90
  91         return ret;
  92 }
  93
  94 bool
  95 Action::WaypointAdd::is_candidate(const ParamList &x)
  96 {
  97         return (candidate_check(get_param_vocab(),x) &&
  98                         // We need an animated valuenode.
  99                         ValueNode_Animated::Handle::cast_dynamic(x.find("value_node")->second.get_value_node()) &&
 100                         // We need either a waypoint or a time.
 101                         (x.count("waypoint") || x.count("time")));
 102 }
 103
 104 bool
 105 Action::WaypointAdd::set_param(const synfig::String& name, const Action::Param &param)
 106 {
 107         if(name=="value_node" && param.get_type()==Param::TYPE_VALUENODE)
 108         {
 109                 value_node=ValueNode_Animated::Handle::cast_dynamic(param.get_value_node());
 110                 if(time_set)
 111                         calc_waypoint();
 112
 113                 return static_cast<bool>(value_node);
 114         }
 115         if(name=="waypoint" && param.get_type()==Param::TYPE_WAYPOINT && !time_set)
 116         {
 117                 waypoint=param.get_waypoint();
 118
 119                 return true;
 120         }
 121         if(name=="time" && param.get_type()==Param::TYPE_TIME && waypoint.get_time()==Time::begin()-1)
 122         {
 123                 waypoint.set_time(param.get_time());
 124                 time_set=true;
 125
 126                 if(value_node)
 127                         calc_waypoint();
 128
 129                 return true;
 130         }
 131
 132         return Action::CanvasSpecific::set_param(name,param);
 133 }
 134
 135 bool
 136 Action::WaypointAdd::is_ready()const
 137 {
 138         if(!value_node || waypoint.get_time()==(Time::begin()-1))
 139                 return false;
 140         return Action::CanvasSpecific::is_ready();
 141 }
 142
 143 // This function is called if a time is specified, but not
 144 // a waypoint. In this case, we need to calculate the value
 145 // of the waypoint
 146 void
 147 Action::WaypointAdd::calc_waypoint()
 148 {
 149         Time time=waypoint.get_time();
 150         Waypoint original(waypoint);
 151         waypoint=value_node->new_waypoint_at_time(time);
 152         waypoint.mimic(original);
 153         waypoint.set_before(synfigapp::Main::get_interpolation());
 154         waypoint.set_after(synfigapp::Main::get_interpolation());
 155
 156 /*
 157         ValueNode_Animated::WaypointList &waypoint_list(value_node->waypoint_list());
 158         ValueNode_Animated::WaypointList::iterator iter;
 159
 160         if(waypoint_list.empty())
 161         {
 162                 waypoint.set_value((*value_node)(time));
 163                 return;
 164         }
 165
 166         ValueNode_Animated::WaypointList::iterator closest=waypoint_list.begin();
 167
 168         for(iter=waypoint_list.begin();iter!=waypoint_list.end();++iter)
 169         {
 170                 const Real dist(abs(iter->get_time()-time));
 171                 if(dist<abs(closest->get_time()-time))
 172                         closest=iter;
 173         }
 174         if(!closest->is_static())
 175                 waypoint.set_value_node(closest->get_value_node());
 176         else
 177                 waypoint.set_value((*value_node)(time));
 178         */
 179 }
 180
 181 void
 182 Action::WaypointAdd::perform()
 183 {
 184         try { value_node->find(waypoint.get_time()); throw Error(_("A Waypoint already exists at this point in time (%s)"),waypoint.get_time().get_string().c_str());}
 185         catch(synfig::Exception::NotFound) { }
 186
 187         try { if(value_node->find(waypoint)!=value_node->waypoint_list().end()) throw Error(_("This waypoint is already in the ValueNode"));}
 188         catch(synfig::Exception::NotFound) { }
 189
 190         value_node->add(waypoint);
 191
 192         value_node->changed();
 193 /*_if(get_canvas_interface())
 194         {
 195                 get_canvas_interface()->signal_value_node_changed()(value_node);
 196         }
 197         else synfig::warning("CanvasInterface not set on action");*/
 198 }
 199
 200 void
 201 Action::WaypointAdd::undo()
 202 {
 203         value_node->erase(waypoint);
 204
 205         value_node->changed();
 206 /*_if(get_canvas_interface())
 207         {
 208                 get_canvas_interface()->signal_value_node_changed()(value_node);
 209         }
 210         else synfig::warning("CanvasInterface not set on action");*/
 211 }