Added a \todo note questioning a part of the code.
[synfig.git] / synfig-studio / trunk / src / synfigapp / actions / valuenodedynamiclistinsert.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file valuenodedynamiclistinsert.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 "valuenodedynamiclistinsert.h"
33 #include <synfigapp/canvasinterface.h>
34
35 #endif
36
37 using namespace std;
38 using namespace etl;
39 using namespace synfig;
40 using namespace synfigapp;
41 using namespace Action;
42
43 /* === M A C R O S ========================================================= */
44
45 ACTION_INIT(Action::ValueNodeDynamicListInsert);
46 ACTION_SET_NAME(Action::ValueNodeDynamicListInsert,"value_node_dynamic_list_insert");
47 ACTION_SET_LOCAL_NAME(Action::ValueNodeDynamicListInsert,"Insert Item");
48 ACTION_SET_TASK(Action::ValueNodeDynamicListInsert,"insert");
49 ACTION_SET_CATEGORY(Action::ValueNodeDynamicListInsert,Action::CATEGORY_VALUEDESC|Action::CATEGORY_VALUENODE|Action::CATEGORY_HIDDEN);
50 ACTION_SET_PRIORITY(Action::ValueNodeDynamicListInsert,-20);
51 ACTION_SET_VERSION(Action::ValueNodeDynamicListInsert,"0.0");
52 ACTION_SET_CVS_ID(Action::ValueNodeDynamicListInsert,"$Id$");
53
54 /* === G L O B A L S ======================================================= */
55
56 /* === P R O C E D U R E S ================================================= */
57
58 /* === M E T H O D S ======================================================= */
59
60 Action::ValueNodeDynamicListInsert::ValueNodeDynamicListInsert()
61 {
62         index=0;
63         time=0;
64         origin=0.5f;
65         set_dirty(true);
66 }
67
68 Action::ParamVocab
69 Action::ValueNodeDynamicListInsert::get_param_vocab()
70 {
71         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
72
73         ret.push_back(ParamDesc("value_desc",Param::TYPE_VALUEDESC)
74                 .set_local_name(_("ValueDesc"))
75         );
76         ret.push_back(ParamDesc("time",Param::TYPE_TIME)
77                 .set_local_name(_("Time"))
78                 .set_optional()
79         );
80         ret.push_back(ParamDesc("origin",Param::TYPE_REAL)
81                 .set_local_name(_("Origin"))
82                 .set_optional()
83         );
84         ret.push_back(ParamDesc("item",Param::TYPE_VALUENODE)
85                 .set_local_name(_("ValueNode to insert"))
86                 .set_optional()
87         );
88
89         return ret;
90 }
91
92 bool
93 Action::ValueNodeDynamicListInsert::is_candidate(const ParamList &x)
94 {
95         if(candidate_check(get_param_vocab(),x))
96         {
97                 ValueDesc value_desc(x.find("value_desc")->second.get_value_desc());
98                 if(!value_desc.parent_is_value_node() || !ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node()))
99                         return false;
100
101                 return true;
102         }
103         return false;
104 }
105
106 bool
107 Action::ValueNodeDynamicListInsert::set_param(const synfig::String& name, const Action::Param &param)
108 {
109         if(name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
110         {
111                 ValueDesc value_desc(param.get_value_desc());
112
113                 if(!value_desc.parent_is_value_node())
114                         return false;
115
116                 value_node=ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node());
117
118                 if(!value_node)
119                         return false;
120
121                 index=value_desc.get_index();
122
123                 value_node_bline=ValueNode_BLine::Handle::cast_dynamic(value_desc.get_parent_value_node());
124
125                 list_entry=value_node->create_list_entry(index,time,origin);
126                 if(item)
127                         list_entry.value_node=item;
128
129                 assert(list_entry.value_node.rcount()==1);
130
131                 return true;
132         }
133         if(name=="time" && param.get_type()==Param::TYPE_TIME)
134         {
135                 time=param.get_time();
136
137                 return true;
138         }
139         if(name=="item" && param.get_type()==Param::TYPE_VALUENODE)
140         {
141                 item=param.get_value_node();
142                 if(item)
143                         list_entry.value_node=item;
144
145                 return true;
146         }
147         if(name=="origin" && param.get_type()==Param::TYPE_REAL)
148         {
149                 origin=param.get_real();
150
151                 return true;
152         }
153
154         return Action::CanvasSpecific::set_param(name,param);
155 }
156
157 bool
158 Action::ValueNodeDynamicListInsert::is_ready()const
159 {
160         if(!value_node)
161                 return false;
162         return Action::CanvasSpecific::is_ready();
163 }
164
165 void
166 Action::ValueNodeDynamicListInsert::perform()
167 {
168         if(index>value_node->link_count())
169                 index=value_node->link_count();
170
171         value_node->add(list_entry,index);
172         assert(list_entry.value_node.rcount()>=2);
173
174         // Signal that a layer has been inserted
175         value_node->changed();
176 /*_if(get_canvas_interface())
177         {
178                 get_canvas_interface()->signal_value_node_changed()(value_node);
179         }
180         else synfig::warning("CanvasInterface not set on action");*/
181 }
182
183 void
184 Action::ValueNodeDynamicListInsert::undo()
185 {
186         assert(list_entry.value_node.rcount()>=2);
187         value_node->erase((value_node->list.begin()+index)->value_node);
188         assert(list_entry.value_node.rcount()>=1);
189
190         // Signal that a layer has been inserted
191         value_node->changed();
192 /*_if(get_canvas_interface())
193         {
194                 get_canvas_interface()->signal_value_node_changed()(value_node);
195         }
196         else synfig::warning("CanvasInterface not set on action");*/
197 }