Use get_layer_descriptions() to format the layer list rather than including a copy...
[synfig.git] / synfig-studio / trunk / src / synfigapp / actions / activepointadd.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file activepointadd.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 "activepointadd.h"
33 #include <synfigapp/canvasinterface.h>
34
35 #include <synfigapp/general.h>
36
37 #endif
38
39 using namespace std;
40 using namespace etl;
41 using namespace synfig;
42 using namespace synfigapp;
43 using namespace Action;
44
45 /* === M A C R O S ========================================================= */
46
47 ACTION_INIT(Action::ActivepointAdd);
48 ACTION_SET_NAME(Action::ActivepointAdd,"activepoint_add");
49 ACTION_SET_LOCAL_NAME(Action::ActivepointAdd,N_("Add Activepoint"));
50 ACTION_SET_TASK(Action::ActivepointAdd,"add");
51 ACTION_SET_CATEGORY(Action::ActivepointAdd,Action::CATEGORY_ACTIVEPOINT);
52 ACTION_SET_PRIORITY(Action::ActivepointAdd,0);
53 ACTION_SET_VERSION(Action::ActivepointAdd,"0.0");
54 ACTION_SET_CVS_ID(Action::ActivepointAdd,"$Id$");
55
56 /* === G L O B A L S ======================================================= */
57
58 /* === P R O C E D U R E S ================================================= */
59
60 /* === M E T H O D S ======================================================= */
61
62 Action::ActivepointAdd::ActivepointAdd()
63 {
64         activepoint.set_time(Time::begin()-1);
65         time_set=false;
66         set_dirty(true);
67 }
68
69 Action::ParamVocab
70 Action::ActivepointAdd::get_param_vocab()
71 {
72         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
73
74         ret.push_back(ParamDesc("value_desc",Param::TYPE_VALUEDESC)
75                 .set_local_name(_("ValueDesc"))
76         );
77
78         ret.push_back(ParamDesc("activepoint",Param::TYPE_ACTIVEPOINT)
79                 .set_local_name(_("New Activepoint"))
80                 .set_desc(_("Activepoint to be added"))
81                 .set_optional()
82         );
83
84         ret.push_back(ParamDesc("time",Param::TYPE_TIME)
85                 .set_local_name(_("Time"))
86                 .set_desc(_("Time where activepoint is to be added"))
87                 .set_optional()
88         );
89
90         return ret;
91 }
92
93 bool
94 Action::ActivepointAdd::is_candidate(const ParamList &x)
95 {
96         if(candidate_check(get_param_vocab(),x))
97         {
98                 ValueDesc value_desc(x.find("value_desc")->second.get_value_desc());
99                 if(!value_desc.parent_is_value_node() || !ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node()))
100                         return false;
101
102                 // We need either a activepoint or a time.
103                 if(x.count("activepoint") || x.count("time"))
104                         return true;
105         }
106         return false;
107 }
108
109 bool
110 Action::ActivepointAdd::set_param(const synfig::String& name, const Action::Param &param)
111 {
112         if(name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
113         {
114                 ValueDesc value_desc(param.get_value_desc());
115
116                 if(!value_desc.parent_is_value_node())
117                         return false;
118
119                 value_node=ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node());
120
121                 if(!value_node)
122                         return false;
123
124                 index=value_desc.get_index();
125
126                 if(time_set)
127                         calc_activepoint();
128
129                 return true;
130         }
131         if(name=="activepoint" && param.get_type()==Param::TYPE_ACTIVEPOINT && !time_set)
132         {
133                 activepoint=param.get_activepoint();
134
135                 return true;
136         }
137         if(name=="time" && param.get_type()==Param::TYPE_TIME && activepoint.get_time()==Time::begin()-1)
138         {
139                 activepoint.set_time(param.get_time());
140                 time_set=true;
141
142                 if(value_node)
143                         calc_activepoint();
144
145                 return true;
146         }
147
148         return Action::CanvasSpecific::set_param(name,param);
149 }
150
151 bool
152 Action::ActivepointAdd::is_ready()const
153 {
154         if(!value_node || activepoint.get_time()==(Time::begin()-1))
155                 return false;
156         return Action::CanvasSpecific::is_ready();
157 }
158
159 // This function is called if a time is specified, but not
160 // a activepoint. In this case, we need to calculate the value
161 // of the activepoint
162 void
163 Action::ActivepointAdd::calc_activepoint()
164 {
165         const Time time(activepoint.get_time());
166         activepoint.set_state(value_node->list[index].status_at_time(time));
167         activepoint.set_priority(0);
168
169         // In this case, nothing is really changing, so there will be
170         // no need to redraw the window
171         set_dirty(false);
172 }
173
174 void
175 Action::ActivepointAdd::perform()
176 {
177         try { value_node->list[index].find(activepoint.get_time()); throw Error(_("A Activepoint already exists at this point in time"));}
178         catch(synfig::Exception::NotFound) { }
179
180         try { if(value_node->list[index].find(activepoint)!=value_node->list[index].timing_info.end()) throw Error(_("This activepoint is already in the ValueNode"));}
181         catch(synfig::Exception::NotFound) { }
182
183         value_node->list[index].add(activepoint);
184         value_node->changed();
185
186         /*if(get_canvas_interface())
187         {
188                 get_canvas_interface()->signal_value_node_changed()(value_node);
189         }
190         else synfig::warning("CanvasInterface not set on action");
191         */
192 }
193
194 void
195 Action::ActivepointAdd::undo()
196 {
197         value_node->list[index].erase(activepoint);
198         value_node->changed();
199         /*
200         // Signal that a layer has been inserted
201         if(get_canvas_interface())
202         {
203                 get_canvas_interface()->signal_value_node_changed()(value_node);
204         }
205         else synfig::warning("CanvasInterface not set on action");
206         */
207 }