Add an 'invert' checkbox to the polygon tool's 'Tool Options' panel.
[synfig.git] / synfig-studio / trunk / src / gtkmm / state_polygon.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file state_polygon.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) 2007, 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 <gtkmm/dialog.h>
34 #include <gtkmm/entry.h>
35
36 #include <synfig/valuenode_dynamiclist.h>
37 #include <synfigapp/action_system.h>
38
39 #include "state_polygon.h"
40 #include "canvasview.h"
41 #include "workarea.h"
42 #include "app.h"
43
44 #include <synfigapp/action.h>
45 #include "event_mouse.h"
46 #include "event_layerclick.h"
47 #include "toolbox.h"
48 #include "dialog_tooloptions.h"
49 #include <synfigapp/main.h>
50
51 #include "general.h"
52
53 #endif
54
55 /* === U S I N G =========================================================== */
56
57 using namespace std;
58 using namespace etl;
59 using namespace synfig;
60 using namespace studio;
61
62 /* === M A C R O S ========================================================= */
63
64 /* === G L O B A L S ======================================================= */
65
66 StatePolygon studio::state_polygon;
67
68 /* === C L A S S E S & S T R U C T S ======================================= */
69
70 class studio::StatePolygon_Context : public sigc::trackable
71 {
72         etl::handle<CanvasView> canvas_view_;
73         CanvasView::IsWorking is_working;
74
75         bool prev_table_status;
76         bool prev_workarea_layer_status_;
77
78         Gtk::Menu menu;
79
80         Duckmatic::Push duckmatic_push;
81
82         std::list<synfig::Point> polygon_point_list;
83         synfigapp::Settings& settings;
84
85
86         bool on_polygon_duck_change(const synfig::Point &point, std::list<synfig::Point>::iterator iter);
87
88
89         void popup_handle_menu(synfigapp::ValueDesc value_desc);
90
91
92         void refresh_ducks();
93
94         Gtk::Table options_table;
95         Gtk::CheckButton checkbutton_invert;
96         Gtk::Entry entry_id;
97         Gtk::Button button_make;
98
99 public:
100         synfig::String get_id()const { return entry_id.get_text(); }
101         void set_id(const synfig::String& x) { return entry_id.set_text(x); }
102
103         bool get_invert()const { return checkbutton_invert.get_active(); }
104         void set_invert(bool i) { checkbutton_invert.set_active(i); }
105
106         Smach::event_result event_stop_handler(const Smach::event& x);
107
108         Smach::event_result event_refresh_handler(const Smach::event& x);
109
110         Smach::event_result event_mouse_click_handler(const Smach::event& x);
111         Smach::event_result event_refresh_tool_options(const Smach::event& x);
112         void refresh_tool_options();
113
114         StatePolygon_Context(CanvasView* canvas_view);
115
116         ~StatePolygon_Context();
117
118         const etl::handle<CanvasView>& get_canvas_view()const{return canvas_view_;}
119         etl::handle<synfigapp::CanvasInterface> get_canvas_interface()const{return canvas_view_->canvas_interface();}
120         synfig::Canvas::Handle get_canvas()const{return canvas_view_->get_canvas();}
121         WorkArea * get_work_area()const{return canvas_view_->get_work_area();}
122
123         //void on_user_click(synfig::Point point);
124         void load_settings();
125         void save_settings();
126         void reset();
127         void increment_id();
128         bool egress_on_selection_change;
129         Smach::event_result event_layer_selection_changed_handler(const Smach::event& /*x*/)
130         {
131                 if(egress_on_selection_change)
132                         throw Smach::egress_exception();
133                 return Smach::RESULT_OK;
134         }
135
136         void run();
137 };      // END of class StatePolygon_Context
138
139 /* === M E T H O D S ======================================================= */
140
141 StatePolygon::StatePolygon():
142         Smach::state<StatePolygon_Context>("polygon")
143 {
144         insert(event_def(EVENT_LAYER_SELECTION_CHANGED,&StatePolygon_Context::event_layer_selection_changed_handler));
145         insert(event_def(EVENT_STOP,&StatePolygon_Context::event_stop_handler));
146         insert(event_def(EVENT_REFRESH,&StatePolygon_Context::event_refresh_handler));
147         insert(event_def(EVENT_REFRESH_DUCKS,&StatePolygon_Context::event_refresh_handler));
148         insert(event_def(EVENT_WORKAREA_MOUSE_BUTTON_DOWN,&StatePolygon_Context::event_mouse_click_handler));
149         insert(event_def(EVENT_REFRESH_TOOL_OPTIONS,&StatePolygon_Context::event_refresh_tool_options));
150 }
151
152 StatePolygon::~StatePolygon()
153 {
154 }
155
156 void
157 StatePolygon_Context::load_settings()
158 {
159         String value;
160
161         if(settings.get_value("polygon.id",value))
162                 set_id(value);
163         else
164                 set_id("Polygon");
165
166         if(settings.get_value("polygon.invert",value) && value != "0")
167                 set_invert(true);
168         else
169                 set_invert(false);
170 }
171
172 void
173 StatePolygon_Context::save_settings()
174 {
175         settings.set_value("polygon.id",get_id().c_str());
176         settings.set_value("polygon.invert",get_invert()?"1":"0");
177 }
178
179 void
180 StatePolygon_Context::reset()
181 {
182         polygon_point_list.clear();
183         refresh_ducks();
184 }
185
186 void
187 StatePolygon_Context::increment_id()
188 {
189         String id(get_id());
190         int number=1;
191         int digits=0;
192
193         if(id.empty())
194                 id="Polygon";
195
196         // If there is a number
197         // already at the end of the
198         // id, then remove it.
199         if(id[id.size()-1]<='9' && id[id.size()-1]>='0')
200         {
201                 // figure out how many digits it is
202                 for (digits = 0;
203                          (int)id.size()-1 >= digits && id[id.size()-1-digits] <= '9' && id[id.size()-1-digits] >= '0';
204                          digits++)
205                         ;
206
207                 String str_number;
208                 str_number=String(id,id.size()-digits,id.size());
209                 id=String(id,0,id.size()-digits);
210
211                 number=atoi(str_number.c_str());
212         }
213         else
214         {
215                 number=1;
216                 digits=3;
217         }
218
219         number++;
220
221         // Add the number back onto the id
222         {
223                 const String format(strprintf("%%0%dd",digits));
224                 id+=strprintf(format.c_str(),number);
225         }
226
227         // Set the ID
228         set_id(id);
229 }
230
231 StatePolygon_Context::StatePolygon_Context(CanvasView* canvas_view):
232         canvas_view_(canvas_view),
233         is_working(*canvas_view),
234         prev_workarea_layer_status_(get_work_area()->get_allow_layer_clicks()),
235         duckmatic_push(get_work_area()),
236         settings(synfigapp::Main::get_selected_input_device()->settings()),
237         entry_id(),
238         checkbutton_invert(_("Invert")),
239         button_make(_("Make"))
240 {
241         egress_on_selection_change=true;
242         load_settings();
243
244         // Set up the tool options dialog
245         options_table.attach(*manage(new Gtk::Label(_("Polygon Tool"))),        0, 2, 0, 1, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
246         options_table.attach(entry_id,                                                                          0, 2, 1, 2, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
247
248         //invert flag
249         options_table.attach(checkbutton_invert,                                                        0, 2, 2, 3, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
250
251         //options_table.attach(button_make, 0, 2, 4, 5, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
252         button_make.signal_pressed().connect(sigc::mem_fun(*this,&StatePolygon_Context::run));
253         options_table.show_all();
254         refresh_tool_options();
255         App::dialog_tool_options->present();
256
257
258         // Turn off layer clicking
259         get_work_area()->set_allow_layer_clicks(false);
260
261         // clear out the ducks
262         get_work_area()->clear_ducks();
263
264         // Refresh the work area
265         get_work_area()->queue_draw();
266
267         get_canvas_view()->work_area->set_cursor(Gdk::CROSSHAIR);
268
269         // Hide the tables if they are showing
270         prev_table_status=get_canvas_view()->tables_are_visible();
271         if(prev_table_status)get_canvas_view()->hide_tables();
272
273         // Disable the time bar
274         get_canvas_view()->set_sensitive_timebar(false);
275
276         // Connect a signal
277         //get_work_area()->signal_user_click().connect(sigc::mem_fun(*this,&studio::StatePolygon_Context::on_user_click));
278
279         App::toolbox->refresh();
280 }
281
282 void
283 StatePolygon_Context::refresh_tool_options()
284 {
285         App::dialog_tool_options->clear();
286         App::dialog_tool_options->set_widget(options_table);
287
288         App::dialog_tool_options->set_local_name(_("Polygon Tool"));
289         App::dialog_tool_options->set_name("polygon");
290
291         App::dialog_tool_options->add_button(
292                 Gtk::StockID("gtk-execute"),
293                 _("Make Polygon")
294         )->signal_clicked().connect(
295                 sigc::mem_fun(
296                         *this,
297                         &StatePolygon_Context::run
298                 )
299         );
300
301         App::dialog_tool_options->add_button(
302                 Gtk::StockID("gtk-clear"),
303                 _("Clear current Polygon")
304         )->signal_clicked().connect(
305                 sigc::mem_fun(
306                         *this,
307                         &StatePolygon_Context::reset
308                 )
309         );
310 }
311
312 Smach::event_result
313 StatePolygon_Context::event_refresh_tool_options(const Smach::event& /*x*/)
314 {
315         refresh_tool_options();
316         return Smach::RESULT_ACCEPT;
317 }
318
319 StatePolygon_Context::~StatePolygon_Context()
320 {
321         run();
322
323         save_settings();
324         // Restore layer clicking
325         get_work_area()->set_allow_layer_clicks(prev_workarea_layer_status_);
326
327         App::dialog_tool_options->clear();
328
329         get_canvas_view()->work_area->reset_cursor();
330
331         // Enable the time bar
332         get_canvas_view()->set_sensitive_timebar(true);
333
334         // Bring back the tables if they were out before
335         if(prev_table_status)get_canvas_view()->show_tables();
336
337         // Refresh the work area
338         get_work_area()->queue_draw();
339
340         App::toolbox->refresh();
341 }
342
343 Smach::event_result
344 StatePolygon_Context::event_stop_handler(const Smach::event& /*x*/)
345 {
346         synfig::info("STATE RotoPolygon: Received Stop Event");
347         //throw Smach::egress_exception();
348         reset();
349         return Smach::RESULT_ACCEPT;
350
351 }
352
353 Smach::event_result
354 StatePolygon_Context::event_refresh_handler(const Smach::event& /*x*/)
355 {
356         synfig::info("STATE RotoPolygon: Received Refresh Event");
357         refresh_ducks();
358         return Smach::RESULT_ACCEPT;
359 }
360
361 void
362 StatePolygon_Context::run()
363 {
364         if(polygon_point_list.empty())
365                 return;
366
367         if(polygon_point_list.size()<3)
368         {
369                 get_canvas_view()->get_ui_interface()->error("You need at least 3 points to create a polygon");
370                 return;
371         }
372                 Layer::Handle layer;
373                 Canvas::Handle canvas(get_canvas_view()->get_canvas());
374                 int depth(0);
375
376                 // we are temporarily using the layer to hold something
377                 layer=get_canvas_view()->get_selection_manager()->get_selected_layer();
378                 if(layer)
379                 {
380                         depth=layer->get_depth();
381                         canvas=layer->get_canvas();
382                 }
383
384                 {
385                         synfigapp::Action::PassiveGrouper group(get_canvas_interface()->get_instance().get(),_("New Polygon"));
386                         synfigapp::PushMode push_mode(get_canvas_interface(),synfigapp::MODE_NORMAL);
387
388                         Layer::Handle layer(get_canvas_interface()->add_layer_to("polygon",canvas,depth));
389
390                         layer->set_param("invert",get_invert());
391                         get_canvas_interface()->signal_layer_param_changed()(layer,"invert");
392
393                         layer->set_description(get_id());
394                         get_canvas_interface()->signal_layer_new_description()(layer,layer->get_description());
395
396                         layer->disconnect_dynamic_param("vector_list");
397                         if(!layer->set_param("vector_list",polygon_point_list))
398                         {
399                                 group.cancel();
400                                 get_canvas_view()->get_ui_interface()->error("Unable to set layer parameter");
401                                 return;
402                         }
403
404                         {
405                                 synfigapp::Action::Handle action(synfigapp::Action::create("value_desc_convert"));
406                                 synfigapp::ValueDesc value_desc(layer,"vector_list");
407                                 action->set_param("canvas",get_canvas());
408                                 action->set_param("canvas_interface",get_canvas_interface());
409                                 action->set_param("value_desc",value_desc);
410                                 action->set_param("type","dynamic_list");
411                                 action->set_param("time",get_canvas_interface()->get_time());
412                                 if(!get_canvas_interface()->get_instance()->perform_action(action))
413                                 {
414                                         group.cancel();
415                                         get_canvas_view()->get_ui_interface()->error("Unable to execute action \"value_desc_convert\"");
416                                         return;
417                                 }
418                         }
419                         egress_on_selection_change=false;
420                         synfigapp::SelectionManager::LayerList layer_selection;
421                         if (!getenv("SYNFIG_TOOLS_CLEAR_SELECTION"))
422                                 layer_selection = get_canvas_view()->get_selection_manager()->get_selected_layers();
423                         get_canvas_interface()->get_selection_manager()->clear_selected_layers();
424                         layer_selection.push_back(layer);
425                         get_canvas_interface()->get_selection_manager()->set_selected_layers(layer_selection);
426                         egress_on_selection_change=true;
427                         //get_canvas_interface()->signal_dirty_preview()();
428                 }
429 /*
430                 else
431                 {
432                         ValueNode::Handle value_node=(ValueNode_Const::create(polygon_point_list));
433                         std::string valuenode_name="Poly";
434                         while(studio::App::dialog_entry("New Polygon", "Please enter the new ID for this value_node",valuenode_name))
435                                 if(get_canvas_interface()->add_value_node(value_node,valuenode_name))
436                                         return true;
437                 }
438 */
439         reset();
440         increment_id();
441 }
442
443 Smach::event_result
444 StatePolygon_Context::event_mouse_click_handler(const Smach::event& x)
445 {
446         synfig::info("STATE ROTOPOLYGON: Received mouse button down Event");
447         const EventMouse& event(*reinterpret_cast<const EventMouse*>(&x));
448         switch(event.button)
449         {
450         case BUTTON_LEFT:
451                 polygon_point_list.push_back(get_work_area()->snap_point_to_grid(event.pos));
452                 refresh_ducks();
453                 return Smach::RESULT_ACCEPT;
454
455         case BUTTON_RIGHT: // Intercept the right-button click to short-circuit the pop-up menu
456                 if (!getenv("SYNFIG_ENABLE_POPUP_MENU_IN_ALL_TOOLS"))
457                         return Smach::RESULT_ACCEPT;
458
459         default:
460                 return Smach::RESULT_OK;
461         }
462 }
463
464
465 void
466 StatePolygon_Context::refresh_ducks()
467 {
468         get_work_area()->clear_ducks();
469
470         if(polygon_point_list.empty()) return;
471
472         std::list<synfig::Point>::iterator iter=polygon_point_list.begin();
473
474         etl::handle<WorkArea::Duck> duck;
475         duck=new WorkArea::Duck(*iter);
476         duck->set_editable(true);
477         duck->signal_edited().connect(
478                 sigc::bind(sigc::mem_fun(*this,&studio::StatePolygon_Context::on_polygon_duck_change),iter)
479         );
480         duck->signal_user_click(0).connect(sigc::mem_fun(*this,&StatePolygon_Context::run));
481
482         get_work_area()->add_duck(duck);
483
484         for(++iter;iter!=polygon_point_list.end();++iter)
485         {
486                 etl::handle<WorkArea::Bezier> bezier(new WorkArea::Bezier());
487                 bezier->p1=bezier->c1=duck;
488
489                 duck=new WorkArea::Duck(*iter);
490                 duck->set_editable(true);
491                 duck->set_name(strprintf("%x",&*iter));
492                 duck->signal_edited().connect(
493                         sigc::bind(sigc::mem_fun(*this,&studio::StatePolygon_Context::on_polygon_duck_change),iter)
494                 );
495
496                 get_work_area()->add_duck(duck);
497
498                 bezier->p2=bezier->c2=duck;
499                 get_work_area()->add_bezier(bezier);
500         }
501         get_work_area()->queue_draw();
502 }
503
504
505 bool
506 StatePolygon_Context::on_polygon_duck_change(const synfig::Point &point, std::list<synfig::Point>::iterator iter)
507 {
508         *iter=point;
509         return true;
510 }