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

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file valuedescconnect.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 "layerparamconnect.h"
  33 #include "valuenodelinkconnect.h"
  34 #include "valuenodereplace.h"
  35
  36 #include "valuedescconnect.h"
  37 #include <synfigapp/canvasinterface.h>
  38
  39 #include <synfigapp/general.h>
  40
  41 #endif
  42
  43 using namespace std;
  44 using namespace etl;
  45 using namespace synfig;
  46 using namespace synfigapp;
  47 using namespace Action;
  48
  49 /* === M A C R O S ========================================================= */
  50
  51 ACTION_INIT(Action::ValueDescConnect);
  52 ACTION_SET_NAME(Action::ValueDescConnect,"value_desc_connect");
  53 ACTION_SET_LOCAL_NAME(Action::ValueDescConnect,N_("Connect"));
  54 ACTION_SET_TASK(Action::ValueDescConnect,"connect");
  55 ACTION_SET_CATEGORY(Action::ValueDescConnect,Action::CATEGORY_VALUEDESC|Action::CATEGORY_VALUENODE);
  56 ACTION_SET_PRIORITY(Action::ValueDescConnect,0);
  57 ACTION_SET_VERSION(Action::ValueDescConnect,"0.0");
  58 ACTION_SET_CVS_ID(Action::ValueDescConnect,"$Id$");
  59
  60 /* === G L O B A L S ======================================================= */
  61
  62 /* === P R O C E D U R E S ================================================= */
  63
  64 /* === M E T H O D S ======================================================= */
  65
  66 Action::ValueDescConnect::ValueDescConnect()
  67 {
  68 }
  69
  70 Action::ParamVocab
  71 Action::ValueDescConnect::get_param_vocab()
  72 {
  73         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
  74
  75         ret.push_back(ParamDesc("dest",Param::TYPE_VALUEDESC)
  76                 .set_local_name(_("Destination ValueDesc"))
  77         );
  78
  79         ret.push_back(ParamDesc("src",Param::TYPE_VALUENODE)
  80                 .set_local_name(_("Source ValueNode"))
  81                 .set_mutual_exclusion("src_name")
  82         );
  83
  84         ret.push_back(ParamDesc("src_name",Param::TYPE_STRING)
  85                 .set_local_name(_("Source ValueNode Name"))
  86                 .set_mutual_exclusion("src")
  87                 .set_user_supplied()
  88         );
  89
  90         return ret;
  91 }
  92
  93 bool
  94 Action::ValueDescConnect::is_candidate(const ParamList &x)
  95 {
  96         if(candidate_check(get_param_vocab(),x))
  97         {
  98                 // don't show the option of connecting to an existing Index parameter of the Duplicate layer
  99                 if(x.count("dest"))
 100                 {
 101                         ValueDesc value_desc=x.find("dest")->second.get_value_desc();
 102
 103                         if (value_desc.parent_is_layer_param() &&
 104                                 value_desc.get_layer()->get_name() == "duplicate" &&
 105                                 value_desc.get_param_name() == "index")
 106                                 return false;
 107                 }
 108
 109                 if(x.count("src"))
 110                 {
 111                         ValueDesc value_desc=x.find("dest")->second.get_value_desc();
 112                         ValueNode::Handle value_node=x.find("src")->second.get_value_node();
 113                         if(value_desc.get_value_type()==value_node->get_type())
 114                                 return true;
 115                 }
 116                 return true;
 117         }
 118         return false;
 119 }
 120
 121 bool
 122 Action::ValueDescConnect::set_param(const synfig::String& name, const Action::Param &param)
 123 {
 124         if(name=="dest" && param.get_type()==Param::TYPE_VALUEDESC)
 125         {
 126                 value_desc=param.get_value_desc();
 127
 128                 return true;
 129         }
 130
 131         if(name=="src" && param.get_type()==Param::TYPE_VALUENODE)
 132         {
 133                 value_node=param.get_value_node();
 134
 135                 return true;
 136         }
 137
 138         if(!value_node_name.empty() && !value_node && name=="canvas" && param.get_type()==Param::TYPE_CANVAS)
 139         {
 140                 value_node=param.get_canvas()->find_value_node(value_node_name);
 141         }
 142
 143         if(name=="src_name" && param.get_type()==Param::TYPE_STRING)
 144         {
 145                 value_node_name=param.get_string();
 146
 147                 if(get_canvas())
 148                 {
 149                         value_node=get_canvas()->find_value_node(value_node_name);
 150                         if(!value_node)
 151                                 return false;
 152                 }
 153
 154                 return true;
 155         }
 156
 157         return Action::CanvasSpecific::set_param(name,param);
 158 }
 159
 160 bool
 161 Action::ValueDescConnect::is_ready()const
 162 {
 163         if(!value_desc || !value_node)
 164                 return false;
 165         return Action::CanvasSpecific::is_ready();
 166 }
 167
 168 void
 169 Action::ValueDescConnect::prepare()
 170 {
 171         clear();
 172
 173         if(value_desc.parent_is_canvas())
 174         {
 175                 ValueNode::Handle dest_value_node;
 176                 dest_value_node=value_desc.get_value_node();
 177
 178                 Action::Handle action(ValueNodeReplace::create());
 179
 180                 action->set_param("canvas",get_canvas());
 181                 action->set_param("canvas_interface",get_canvas_interface());
 182                 action->set_param("src",value_node);
 183                 action->set_param("dest",value_desc.get_value_node());
 184
 185                 assert(action->is_ready());
 186                 if(!action->is_ready())
 187                         throw Error(Error::TYPE_NOTREADY);
 188
 189                 add_action_front(action);
 190                 return;
 191         }
 192         else
 193         if(value_desc.parent_is_linkable_value_node())
 194         {
 195                 Action::Handle action(ValueNodeLinkConnect::create());
 196
 197                 action->set_param("canvas",get_canvas());
 198                 action->set_param("canvas_interface",get_canvas_interface());
 199                 action->set_param("parent_value_node",value_desc.get_parent_value_node());
 200                 action->set_param("value_node", value_node);
 201                 action->set_param("index",value_desc.get_index());
 202
 203                 assert(action->is_ready());
 204                 if(!action->is_ready())
 205                         throw Error(Error::TYPE_NOTREADY);
 206
 207                 add_action_front(action);
 208                 return;
 209         }
 210         else
 211         if(value_desc.parent_is_layer_param())
 212         {
 213                 Action::Handle action(LayerParamConnect::create());
 214
 215                 action->set_param("canvas",get_canvas());
 216                 action->set_param("canvas_interface",get_canvas_interface());
 217                 action->set_param("layer",value_desc.get_layer());
 218                 action->set_param("param",value_desc.get_param_name());
 219                 action->set_param("value_node",value_node);
 220
 221                 assert(action->is_ready());
 222                 if(!action->is_ready())
 223                         throw Error(Error::TYPE_NOTREADY);
 224
 225                 add_action_front(action);
 226                 return;
 227         }
 228
 229         throw Error(_("ValueDesc is not recognized or supported."));
 230 }