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