6bd7a90e479fb44b4d3d023268874c39b07b012b
[synfig.git] /
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 **  Copyright (c) 2008 Chris Moore
10 **
11 **      This package is free software; you can redistribute it and/or
12 **      modify it under the terms of the GNU General Public License as
13 **      published by the Free Software Foundation; either version 2 of
14 **      the License, or (at your option) any later version.
15 **
16 **      This package is distributed in the hope that it will be useful,
17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 **      General Public License for more details.
20 **      \endlegal
21 */
22 /* ========================================================================= */
23
24 /* === H E A D E R S ======================================================= */
25
26 #ifdef USING_PCH
27 #       include "pch.h"
28 #else
29 #ifdef HAVE_CONFIG_H
30 #       include <config.h>
31 #endif
32
33 #include "valuenodedynamiclistremovesmart.h"
34 #include "valuenodedynamiclistremove.h"
35 #include <synfigapp/canvasinterface.h>
36
37 #include <synfigapp/general.h>
38
39 #endif
40
41 using namespace std;
42 using namespace etl;
43 using namespace synfig;
44 using namespace synfigapp;
45 using namespace Action;
46
47 /* === M A C R O S ========================================================= */
48
49 ACTION_INIT(Action::ValueNodeDynamicListRemoveSmart);
50 ACTION_SET_NAME(Action::ValueNodeDynamicListRemoveSmart,"value_node_dynamic_list_remove_smart");
51 ACTION_SET_LOCAL_NAME(Action::ValueNodeDynamicListRemoveSmart,N_("Remove Item (Smart)"));
52 ACTION_SET_TASK(Action::ValueNodeDynamicListRemoveSmart,"remove");
53 ACTION_SET_CATEGORY(Action::ValueNodeDynamicListRemoveSmart,Action::CATEGORY_VALUEDESC|Action::CATEGORY_VALUENODE);
54 ACTION_SET_PRIORITY(Action::ValueNodeDynamicListRemoveSmart,-19);
55 ACTION_SET_VERSION(Action::ValueNodeDynamicListRemoveSmart,"0.0");
56 ACTION_SET_CVS_ID(Action::ValueNodeDynamicListRemoveSmart,"$Id$");
57
58 /* === G L O B A L S ======================================================= */
59
60 /* === P R O C E D U R E S ================================================= */
61
62 /* === M E T H O D S ======================================================= */
63
64 Action::ValueNodeDynamicListRemoveSmart::ValueNodeDynamicListRemoveSmart()
65 {
66         index=0;
67         time=0;
68         origin=0.5f;
69         set_dirty(true);
70 }
71
72 Action::ParamVocab
73 Action::ValueNodeDynamicListRemoveSmart::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         ret.push_back(ParamDesc("time",Param::TYPE_TIME)
81                 .set_local_name(_("Time"))
82                 .set_optional()
83         );
84         ret.push_back(ParamDesc("origin",Param::TYPE_REAL)
85                 .set_local_name(_("Origin"))
86                 .set_optional()
87         );
88
89         return ret;
90 }
91
92 bool
93 Action::ValueNodeDynamicListRemoveSmart::is_candidate(const ParamList &x)
94 {
95         if (!candidate_check(get_param_vocab(),x))
96                 return false;
97
98         ValueDesc value_desc(x.find("value_desc")->second.get_value_desc());
99
100         return (value_desc.parent_is_value_node() &&
101                         // We need a dynamic list.
102                         ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node()));
103 }
104
105 bool
106 Action::ValueNodeDynamicListRemoveSmart::set_param(const synfig::String& name, const Action::Param &param)
107 {
108         if(name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
109         {
110                 ValueDesc value_desc(param.get_value_desc());
111
112                 if(!value_desc.parent_is_value_node())
113                         return false;
114
115                 value_node=ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node());
116
117                 if(!value_node)
118                         return false;
119
120                 index=value_desc.get_index();
121
122                 return true;
123         }
124         if(name=="time" && param.get_type()==Param::TYPE_TIME)
125         {
126                 time=param.get_time();
127
128                 return true;
129         }
130         if(name=="origin" && param.get_type()==Param::TYPE_REAL)
131         {
132                 origin=param.get_real();
133
134                 return true;
135         }
136
137         return Action::CanvasSpecific::set_param(name,param);
138 }
139
140 bool
141 Action::ValueNodeDynamicListRemoveSmart::is_ready()const
142 {
143         if(!value_node)
144                 return false;
145         return Action::CanvasSpecific::is_ready();
146 }
147
148 void
149 Action::ValueNodeDynamicListRemoveSmart::prepare()
150 {
151         clear();
152
153         // If we are in animate editing mode
154         if(get_edit_mode()&MODE_ANIMATE)
155         {
156                 Action::Handle action(Action::create("activepoint_set_off"));
157
158                 if(!action)
159                         throw Error(_("Unable to find action (bug)"));
160
161                 action->set_param("canvas",get_canvas());
162                 action->set_param("canvas_interface",get_canvas_interface());
163                 action->set_param("time",time);
164                 action->set_param("origin",origin);
165                 action->set_param("value_desc",ValueDesc(value_node,index));
166
167                 if(!action->is_ready())
168                         throw Error(Error::TYPE_NOTREADY);
169
170                 add_action(action);
171         }
172         else
173         {
174                 Action::Handle action(Action::create("value_node_dynamic_list_remove"));
175
176                 if(!action)
177                         throw Error(_("Unable to find action (bug)"));
178
179                 action->set_param("canvas",get_canvas());
180                 action->set_param("canvas_interface",get_canvas_interface());
181                 action->set_param("time",time);
182                 action->set_param("origin",origin);
183                 action->set_param("value_desc",ValueDesc(value_node,index));
184
185                 if(!action->is_ready())
186                         throw Error(Error::TYPE_NOTREADY);
187
188                 add_action(action);
189         }
190 }