Don't allow the Index parameter of the Duplicate layer to be disconnected.
[synfig.git] / synfig-studio / trunk / src / synfigapp / actions / valuedescdisconnect.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file valuedescdisconnect.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 "layerparamdisconnect.h"
33 #include "valuenodelinkdisconnect.h"
34 #include "valuenodereplace.h"
35
36 #include "valuedescdisconnect.h"
37 #include <synfigapp/canvasinterface.h>
38 #include <synfig/valuenode_const.h>
39
40 #include <synfigapp/general.h>
41
42 #endif
43
44 using namespace std;
45 using namespace etl;
46 using namespace synfig;
47 using namespace synfigapp;
48 using namespace Action;
49
50 /* === M A C R O S ========================================================= */
51
52 ACTION_INIT(Action::ValueDescDisconnect);
53 ACTION_SET_NAME(Action::ValueDescDisconnect,"value_desc_disconnect");
54 ACTION_SET_LOCAL_NAME(Action::ValueDescDisconnect,N_("Disconnect"));
55 ACTION_SET_TASK(Action::ValueDescDisconnect,"disconnect");
56 ACTION_SET_CATEGORY(Action::ValueDescDisconnect,Action::CATEGORY_VALUEDESC);
57 ACTION_SET_PRIORITY(Action::ValueDescDisconnect,-100);
58 ACTION_SET_VERSION(Action::ValueDescDisconnect,"0.0");
59 ACTION_SET_CVS_ID(Action::ValueDescDisconnect,"$Id$");
60
61 /* === G L O B A L S ======================================================= */
62
63 /* === P R O C E D U R E S ================================================= */
64
65 /* === M E T H O D S ======================================================= */
66
67 Action::ValueDescDisconnect::ValueDescDisconnect():
68         time(0)
69 {
70 }
71
72 Action::ParamVocab
73 Action::ValueDescDisconnect::get_param_vocab()
74 {
75         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
76
77         ret.push_back(ParamDesc("value_desc",Param::TYPE_VALUEDESC)
78                 .set_local_name(_("ValueDesc"))
79         );
80
81         ret.push_back(ParamDesc("time",Param::TYPE_TIME)
82                 .set_local_name(_("Time"))
83                 .set_optional()
84         );
85
86         return ret;
87 }
88
89 bool
90 Action::ValueDescDisconnect::is_candidate(const ParamList &x)
91 {
92         if(candidate_check(get_param_vocab(),x))
93         {
94                 ValueDesc value_desc(x.find("value_desc")->second.get_value_desc());
95
96                 // don't allow the Index parameter of the Duplicate layer to be disconnected
97                 if(value_desc.parent_is_layer_param() && value_desc.get_layer()->get_name() == "duplicate" && value_desc.get_param_name() == "index")
98                         return false;
99                 if(!value_desc.parent_is_canvas() && value_desc.is_value_node() && value_desc.get_value_node()->rcount()>1)
100                         return true;
101                 if(value_desc.is_const())
102                         return false;
103                 if(value_desc.is_value_node() && ValueNode_Const::Handle::cast_dynamic(value_desc.get_value_node()))
104                         return false;
105                 return true;
106         }
107         return false;
108 }
109
110 bool
111 Action::ValueDescDisconnect::set_param(const synfig::String& name, const Action::Param &param)
112 {
113         if(name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
114         {
115                 value_desc=param.get_value_desc();
116
117                 return true;
118         }
119
120         if(name=="time" && param.get_type()==Param::TYPE_TIME)
121         {
122                 time=param.get_time();
123
124                 return true;
125         }
126
127         return Action::CanvasSpecific::set_param(name,param);
128 }
129
130 bool
131 Action::ValueDescDisconnect::is_ready()const
132 {
133         if(!value_desc)
134                 return false;
135         return Action::CanvasSpecific::is_ready();
136 }
137
138 void
139 Action::ValueDescDisconnect::prepare()
140 {
141         clear();
142
143         if(value_desc.parent_is_canvas())
144         {
145                 ValueNode::Handle src_value_node;
146                 src_value_node=ValueNode_Const::create((*value_desc.get_value_node())(time));
147
148                 Action::Handle action(ValueNodeReplace::create());
149
150                 action->set_param("canvas",get_canvas());
151                 action->set_param("canvas_interface",get_canvas_interface());
152                 action->set_param("src",src_value_node);
153                 action->set_param("dest",value_desc.get_value_node());
154
155                 assert(action->is_ready());
156                 if(!action->is_ready())
157                         throw Error(Error::TYPE_NOTREADY);
158
159                 add_action_front(action);
160                 return;
161         }
162         else
163         if(value_desc.parent_is_linkable_value_node())
164         {
165                 Action::Handle action(ValueNodeLinkDisconnect::create());
166
167                 action->set_param("canvas",get_canvas());
168                 action->set_param("canvas_interface",get_canvas_interface());
169                 action->set_param("parent_value_node",value_desc.get_parent_value_node());
170                 action->set_param("index",value_desc.get_index());
171                 action->set_param("time",time);
172
173                 assert(action->is_ready());
174                 if(!action->is_ready())
175                         throw Error(Error::TYPE_NOTREADY);
176
177                 add_action_front(action);
178                 return;
179         }
180         else
181         if(value_desc.parent_is_layer_param())
182         {
183                 Action::Handle action(LayerParamDisconnect::create());
184
185                 action->set_param("canvas",get_canvas());
186                 action->set_param("canvas_interface",get_canvas_interface());
187                 action->set_param("layer",value_desc.get_layer());
188                 action->set_param("param",value_desc.get_param_name());
189                 action->set_param("time",time);
190
191                 assert(action->is_ready());
192                 if(!action->is_ready())
193                         throw Error(Error::TYPE_NOTREADY);
194
195                 add_action_front(action);
196                 return;
197         }
198
199         throw Error(_("ValueDesc is not recognized or supported."));
200 }