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

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file valuenodedynamiclistremovesmart.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 "valuenodedynamiclistremovesmart.h"
  33 #include "valuenodedynamiclistremove.h"
  34 #include <synfigapp/canvasinterface.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::ValueNodeDynamicListRemoveSmart);
  49 ACTION_SET_NAME(Action::ValueNodeDynamicListRemoveSmart,"value_node_dynamic_list_remove_smart");
  50 ACTION_SET_LOCAL_NAME(Action::ValueNodeDynamicListRemoveSmart,N_("Remove Item (Smart)"));
  51 ACTION_SET_TASK(Action::ValueNodeDynamicListRemoveSmart,"remove");
  52 ACTION_SET_CATEGORY(Action::ValueNodeDynamicListRemoveSmart,Action::CATEGORY_VALUEDESC|Action::CATEGORY_VALUENODE);
  53 ACTION_SET_PRIORITY(Action::ValueNodeDynamicListRemoveSmart,-19);
  54 ACTION_SET_VERSION(Action::ValueNodeDynamicListRemoveSmart,"0.0");
  55 ACTION_SET_CVS_ID(Action::ValueNodeDynamicListRemoveSmart,"$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::ValueNodeDynamicListRemoveSmart::ValueNodeDynamicListRemoveSmart()
  64 {
  65         index=0;
  66         time=0;
  67         origin=0.5f;
  68         set_dirty(true);
  69 }
  70
  71 Action::ParamVocab
  72 Action::ValueNodeDynamicListRemoveSmart::get_param_vocab()
  73 {
  74         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
  75
  76         ret.push_back(ParamDesc("value_desc",Param::TYPE_VALUEDESC)
  77                 .set_local_name(_("ValueDesc"))
  78         );
  79         ret.push_back(ParamDesc("time",Param::TYPE_TIME)
  80                 .set_local_name(_("Time"))
  81                 .set_optional()
  82         );
  83         ret.push_back(ParamDesc("origin",Param::TYPE_REAL)
  84                 .set_local_name(_("Origin"))
  85                 .set_optional()
  86         );
  87
  88         return ret;
  89 }
  90
  91 bool
  92 Action::ValueNodeDynamicListRemoveSmart::is_candidate(const ParamList &x)
  93 {
  94         if (!candidate_check(get_param_vocab(),x))
  95                 return false;
  96
  97         ValueDesc value_desc(x.find("value_desc")->second.get_value_desc());
  98
  99         return (value_desc.parent_is_value_node() &&
 100                         // We need a dynamic list.
 101                         ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node()));
 102 }
 103
 104 bool
 105 Action::ValueNodeDynamicListRemoveSmart::set_param(const synfig::String& name, const Action::Param &param)
 106 {
 107         if(name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
 108         {
 109                 ValueDesc value_desc(param.get_value_desc());
 110
 111                 if(!value_desc.parent_is_value_node())
 112                         return false;
 113
 114                 value_node=ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node());
 115
 116                 if(!value_node)
 117                         return false;
 118
 119                 index=value_desc.get_index();
 120
 121                 return true;
 122         }
 123         if(name=="time" && param.get_type()==Param::TYPE_TIME)
 124         {
 125                 time=param.get_time();
 126
 127                 return true;
 128         }
 129         if(name=="origin" && param.get_type()==Param::TYPE_REAL)
 130         {
 131                 origin=param.get_real();
 132
 133                 return true;
 134         }
 135
 136         return Action::CanvasSpecific::set_param(name,param);
 137 }
 138
 139 bool
 140 Action::ValueNodeDynamicListRemoveSmart::is_ready()const
 141 {
 142         if(!value_node)
 143                 return false;
 144         return Action::CanvasSpecific::is_ready();
 145 }
 146
 147 void
 148 Action::ValueNodeDynamicListRemoveSmart::prepare()
 149 {
 150         clear();
 151
 152         // If we are in animate editing mode
 153         if(get_edit_mode()&MODE_ANIMATE)
 154         {
 155                 Action::Handle action(Action::create("activepoint_set_off"));
 156
 157                 if(!action)
 158                         throw Error(_("Unable to find action (bug)"));
 159
 160                 action->set_param("canvas",get_canvas());
 161                 action->set_param("canvas_interface",get_canvas_interface());
 162                 action->set_param("time",time);
 163                 action->set_param("origin",origin);
 164                 action->set_param("value_desc",ValueDesc(value_node,index));
 165
 166                 if(!action->is_ready())
 167                         throw Error(Error::TYPE_NOTREADY);
 168
 169                 add_action(action);
 170         }
 171         else
 172         {
 173                 Action::Handle action(Action::create("value_node_dynamic_list_remove"));
 174
 175                 if(!action)
 176                         throw Error(_("Unable to find action (bug)"));
 177
 178                 action->set_param("canvas",get_canvas());
 179                 action->set_param("canvas_interface",get_canvas_interface());
 180                 action->set_param("time",time);
 181                 action->set_param("origin",origin);
 182                 action->set_param("value_desc",ValueDesc(value_node,index));
 183
 184                 if(!action->is_ready())
 185                         throw Error(Error::TYPE_NOTREADY);
 186
 187                 add_action(action);
 188         }
 189 }