synfig-studio/src/gui/states/state_gradient.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file state_gradient.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 <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_gradient.h"
  40 #include "state_normal.h"
  41 #include "canvasview.h"
  42 #include "workarea.h"
  43 #include "app.h"
  44
  45 #include <synfigapp/action.h>
  46 #include "event_mouse.h"
  47 #include "event_layerclick.h"
  48 #include "toolbox.h"
  49 #include "docks/dialog_tooloptions.h"
  50 #include <gtkmm/optionmenu.h>
  51 #include "duck.h"
  52
  53 #include "widgets/widget_enum.h"
  54 #include <synfigapp/main.h>
  55
  56 #include "general.h"
  57
  58 #endif
  59
  60 /* === U S I N G =========================================================== */
  61
  62 using namespace std;
  63 using namespace etl;
  64 using namespace synfig;
  65 using namespace studio;
  66
  67 /* === M A C R O S ========================================================= */
  68
  69 enum
  70 {
  71         GRADIENT_INTERPOLATION_LINEAR=0,
  72         GRADIENT_RADIAL=1,
  73         GRADIENT_CONICAL=2,
  74         GRADIENT_SPIRAL=3
  75 };
  76
  77 /* === G L O B A L S ======================================================= */
  78
  79 StateGradient studio::state_gradient;
  80
  81 /* === C L A S S E S & S T R U C T S ======================================= */
  82
  83 class studio::StateGradient_Context : public sigc::trackable
  84 {
  85         etl::handle<CanvasView> canvas_view_;
  86         CanvasView::IsWorking is_working;
  87
  88         Duckmatic::Push duckmatic_push;
  89
  90         synfigapp::Settings& settings;
  91
  92         Point point_holder;
  93
  94         etl::handle<Duck> point2_duck;
  95
  96         void refresh_ducks();
  97
  98         bool prev_workarea_layer_status_;
  99
 100         Gtk::Table options_table;
 101         Gtk::Entry entry_id;
 102         Widget_Enum enum_type;
 103 #ifdef BLEND_METHOD_IN_TOOL_OPTIONS
 104         Widget_Enum     enum_blend;
 105 #endif  // BLEND_METHOD_IN_TOOL_OPTIONS
 106
 107 public:
 108         synfig::String get_id()const { return entry_id.get_text(); }
 109         void set_id(const synfig::String& x) { return entry_id.set_text(x); }
 110
 111         int get_type()const { return enum_type.get_value(); }
 112         void set_type(int x) { return enum_type.set_value(x); }
 113
 114 #ifdef BLEND_METHOD_IN_TOOL_OPTIONS
 115         int get_blend()const { return enum_blend.get_value(); }
 116         void set_blend(int x) { return enum_blend.set_value(x); }
 117 #endif  // BLEND_METHOD_IN_TOOL_OPTIONS
 118
 119         Smach::event_result event_stop_handler(const Smach::event& x);
 120
 121         Smach::event_result event_refresh_handler(const Smach::event& x);
 122
 123         Smach::event_result event_mouse_click_handler(const Smach::event& x);
 124         Smach::event_result event_refresh_tool_options(const Smach::event& x);
 125
 126         void refresh_tool_options();
 127
 128         StateGradient_Context(CanvasView* canvas_view);
 129
 130         ~StateGradient_Context();
 131
 132         const etl::handle<CanvasView>& get_canvas_view()const{return canvas_view_;}
 133         etl::handle<synfigapp::CanvasInterface> get_canvas_interface()const{return canvas_view_->canvas_interface();}
 134         synfig::Canvas::Handle get_canvas()const{return canvas_view_->get_canvas();}
 135         WorkArea * get_work_area()const{return canvas_view_->get_work_area();}
 136
 137         //void on_user_click(synfig::Point point);
 138         void load_settings();
 139         void save_settings();
 140         void reset();
 141         void increment_id();
 142
 143         void make_gradient(const Point& p1, const Point& p2);
 144         bool egress_on_selection_change;
 145         Smach::event_result event_layer_selection_changed_handler(const Smach::event& /*x*/)
 146         {
 147                 if(egress_on_selection_change)
 148                         throw &state_normal; //throw Smach::egress_exception();
 149                 return Smach::RESULT_OK;
 150         }
 151
 152 };      // END of class StateGradient_Context
 153
 154 /* === M E T H O D S ======================================================= */
 155
 156 StateGradient::StateGradient():
 157         Smach::state<StateGradient_Context>("gradient")
 158 {
 159         insert(event_def(EVENT_LAYER_SELECTION_CHANGED,&StateGradient_Context::event_layer_selection_changed_handler));
 160         insert(event_def(EVENT_STOP,&StateGradient_Context::event_stop_handler));
 161         insert(event_def(EVENT_TABLES_SHOW,&StateGradient_Context::event_stop_handler));
 162         insert(event_def(EVENT_REFRESH,&StateGradient_Context::event_refresh_handler));
 163         insert(event_def(EVENT_REFRESH_DUCKS,&StateGradient_Context::event_refresh_handler));
 164         insert(event_def(EVENT_WORKAREA_MOUSE_BUTTON_DOWN,&StateGradient_Context::event_mouse_click_handler));
 165         insert(event_def(EVENT_WORKAREA_MOUSE_BUTTON_DRAG,&StateGradient_Context::event_mouse_click_handler));
 166         insert(event_def(EVENT_WORKAREA_MOUSE_BUTTON_UP,&StateGradient_Context::event_mouse_click_handler));
 167         insert(event_def(EVENT_REFRESH_TOOL_OPTIONS,&StateGradient_Context::event_refresh_tool_options));
 168 }
 169
 170 StateGradient::~StateGradient()
 171 {
 172 }
 173
 174 void
 175 StateGradient_Context::load_settings()
 176 {
 177         try
 178         {
 179                 SETTINGS_LOCALE_SAFE_AND_BACKUP
 180                 String value;
 181
 182                 if(settings.get_value("gradient.id",value))
 183                         set_id(value);
 184                 else
 185                         set_id("Gradient");
 186
 187                 if(settings.get_value("gradient.type",value))
 188                         set_type(atoi(value.c_str()));
 189                 else
 190                         set_type(GRADIENT_INTERPOLATION_LINEAR);
 191
 192 #ifdef BLEND_METHOD_IN_TOOL_OPTIONS
 193                 if(settings.get_value("gradient.blend",value))
 194                         set_blend(atoi(value.c_str()));
 195                 else
 196                         set_blend(Color::BLEND_COMPOSITE);
 197 #endif  // BLEND_METHOD_IN_TOOL_OPTIONS
 198                 SETTINGS_LOCALE_RESTORE
 199         }
 200         catch(...)
 201         {
 202                 synfig::warning("State Gradient: Caught exception when attempting to load settings.");
 203         }
 204 }
 205
 206 void
 207 StateGradient_Context::save_settings()
 208 {
 209         try
 210         {
 211                 SETTINGS_LOCALE_SAFE_AND_BACKUP
 212                 settings.set_value("gradient.id",get_id().c_str());
 213                 settings.set_value("gradient.type",strprintf("%d",get_type()));
 214 #ifdef BLEND_METHOD_IN_TOOL_OPTIONS
 215                 settings.set_value("gradient.blend",strprintf("%d",get_blend()));
 216 #endif  // BLEND_METHOD_IN_TOOL_OPTIONS
 217                 SETTINGS_LOCALE_RESTORE
 218         }
 219         catch(...)
 220         {
 221                 synfig::warning("State Gradient: Caught exception when attempting to save settings.");
 222         }
 223 }
 224
 225 void
 226 StateGradient_Context::reset()
 227 {
 228         refresh_ducks();
 229 }
 230
 231 void
 232 StateGradient_Context::increment_id()
 233 {
 234         String id(get_id());
 235         int number=1;
 236         int digits=0;
 237
 238         if(id.empty())
 239                 id="Gradient";
 240
 241         // If there is a number
 242         // already at the end of the
 243         // id, then remove it.
 244         if(id[id.size()-1]<='9' && id[id.size()-1]>='0')
 245         {
 246                 // figure out how many digits it is
 247                 for (digits = 0;
 248                          (int)id.size()-1 >= digits && id[id.size()-1-digits] <= '9' && id[id.size()-1-digits] >= '0';
 249                          digits++)
 250                         ;
 251
 252                 String str_number;
 253                 str_number=String(id,id.size()-digits,id.size());
 254                 id=String(id,0,id.size()-digits);
 255
 256                 number=atoi(str_number.c_str());
 257         }
 258         else
 259         {
 260                 number=1;
 261                 digits=3;
 262         }
 263
 264         number++;
 265
 266         // Add the number back onto the id
 267         {
 268                 const String format(strprintf("%%0%dd",digits));
 269                 id+=strprintf(format.c_str(),number);
 270         }
 271
 272         // Set the ID
 273         set_id(id);
 274 }
 275
 276 StateGradient_Context::StateGradient_Context(CanvasView* canvas_view):
 277         canvas_view_(canvas_view),
 278         is_working(*canvas_view),
 279         duckmatic_push(get_work_area()),
 280         settings(synfigapp::Main::get_selected_input_device()->settings()),
 281         prev_workarea_layer_status_(get_work_area()->get_allow_layer_clicks()),
 282         entry_id()
 283 {
 284         egress_on_selection_change=true;
 285         // Set up the tool options dialog
 286         options_table.attach(*manage(new Gtk::Label(_("Gradient Tool"))),       0, 2, 0, 1, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
 287         options_table.attach(entry_id,                                                                          0, 2, 1, 2, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
 288
 289         enum_type.set_param_desc(ParamDesc("type")
 290                 .set_local_name(_("Gradient Type"))
 291                 .set_description(_("Determines the type of Gradient used"))
 292                 .set_hint("enum")
 293                 .add_enum_value(GRADIENT_INTERPOLATION_LINEAR,"linear",_("Linear"))
 294                 .add_enum_value(GRADIENT_RADIAL,"radial",_("Radial"))
 295                 .add_enum_value(GRADIENT_CONICAL,"conical",_("Conical"))
 296                 .add_enum_value(GRADIENT_SPIRAL,"spiral",_("Spiral")));
 297
 298 #ifdef BLEND_METHOD_IN_TOOL_OPTIONS
 299         enum_blend.set_param_desc(ParamDesc(Color::BLEND_COMPOSITE,"blend_method")
 300                 .set_local_name(_("Blend Method"))
 301                 .set_description(_("The blend method the gradient will use")));
 302 #endif  // BLEND_METHOD_IN_TOOL_OPTIONS
 303
 304         load_settings();
 305
 306         options_table.attach(enum_type, 0, 2, 2, 3, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
 307 #ifdef BLEND_METHOD_IN_TOOL_OPTIONS
 308         options_table.attach(enum_blend, 0, 2, 3, 4, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
 309 #endif  // BLEND_METHOD_IN_TOOL_OPTIONS
 310
 311         options_table.show_all();
 312         refresh_tool_options();
 313         App::dialog_tool_options->present();
 314
 315
 316         // Turn off layer clicking
 317         get_work_area()->set_allow_layer_clicks(false);
 318
 319         get_work_area()->set_cursor(Gdk::CROSSHAIR);
 320
 321         // clear out the ducks
 322         get_work_area()->clear_ducks();
 323
 324         // Refresh the work area
 325         get_work_area()->queue_draw();
 326
 327         get_work_area()->refresh_cursor();
 328
 329         // Hide the tables if they are showing
 330         get_canvas_view()->hide_tables();
 331
 332         // Disable the time bar
 333         //get_canvas_view()->set_sensitive_timebar(false);
 334
 335         // Connect a signal
 336         //get_work_area()->signal_user_click().connect(sigc::mem_fun(*this,&studio::StateGradient_Context::on_user_click));
 337
 338         App::toolbox->refresh();
 339 }
 340
 341 void
 342 StateGradient_Context::refresh_tool_options()
 343 {
 344         App::dialog_tool_options->clear();
 345         App::dialog_tool_options->set_widget(options_table);
 346         App::dialog_tool_options->set_local_name(_("Gradient Tool"));
 347         App::dialog_tool_options->set_name("gradient");
 348 }
 349
 350 Smach::event_result
 351 StateGradient_Context::event_refresh_tool_options(const Smach::event& /*x*/)
 352 {
 353         refresh_tool_options();
 354         return Smach::RESULT_ACCEPT;
 355 }
 356
 357 StateGradient_Context::~StateGradient_Context()
 358 {
 359         save_settings();
 360
 361         // Restore layer clicking
 362 //      get_work_area()->set_allow_layer_clicks(prev_workarea_layer_status_);
 363         get_work_area()->set_allow_layer_clicks(true);
 364         get_work_area()->reset_cursor();
 365
 366         App::dialog_tool_options->clear();
 367
 368         // Enable the time bar
 369         //get_canvas_view()->set_sensitive_timebar(true);
 370
 371         // Bring back the tables if they were out before
 372         //if(prev_table_status)get_canvas_view()->show_tables();
 373
 374         // Refresh the work area
 375         get_work_area()->queue_draw();
 376
 377         get_canvas_view()->queue_rebuild_ducks();
 378
 379         //get_canvas_view()->show_tables();
 380
 381         get_work_area()->refresh_cursor();
 382
 383         App::toolbox->refresh();
 384 }
 385
 386 Smach::event_result
 387 StateGradient_Context::event_stop_handler(const Smach::event& /*x*/)
 388 {
 389         //throw Smach::egress_exception();
 390         throw &state_normal;
 391         return Smach::RESULT_OK;
 392 }
 393
 394 Smach::event_result
 395 StateGradient_Context::event_refresh_handler(const Smach::event& /*x*/)
 396 {
 397         refresh_ducks();
 398         return Smach::RESULT_ACCEPT;
 399 }
 400
 401 void
 402 StateGradient_Context::make_gradient(const Point& _p1, const Point& _p2)
 403 {
 404         synfigapp::Action::PassiveGrouper group(get_canvas_interface()->get_instance().get(),_("New Gradient"));
 405         synfigapp::PushMode push_mode(get_canvas_interface(),synfigapp::MODE_NORMAL);
 406
 407         Layer::Handle layer;
 408
 409         Canvas::Handle canvas(get_canvas_view()->get_canvas());
 410         int depth(0);
 411
 412         // we are temporarily using the layer to hold something
 413         layer=get_canvas_view()->get_selection_manager()->get_selected_layer();
 414         if(layer)
 415         {
 416                 depth=layer->get_depth();
 417                 canvas=layer->get_canvas();
 418         }
 419         const synfig::TransformStack& transform(get_canvas_view()->get_curr_transform_stack());
 420         const Point p1(transform.unperform(_p1));
 421         const Point p2(transform.unperform(_p2));
 422
 423         switch(get_type())
 424         {
 425         case GRADIENT_INTERPOLATION_LINEAR:
 426
 427                 layer=get_canvas_interface()->add_layer_to("linear_gradient",canvas,depth);
 428                 if (!layer)
 429                 {
 430                         get_canvas_view()->get_ui_interface()->error(_("Unable to create layer"));
 431                         group.cancel();
 432                         return;
 433                 }
 434                 layer->set_param("p1",p1);
 435                 get_canvas_interface()->signal_layer_param_changed()(layer,"p1");
 436                 layer->set_param("p2",p2);
 437                 get_canvas_interface()->signal_layer_param_changed()(layer,"p2");
 438                 break;
 439         case GRADIENT_RADIAL:
 440                 layer=get_canvas_interface()->add_layer_to("radial_gradient",canvas,depth);
 441                 if (!layer)
 442                 {
 443                         get_canvas_view()->get_ui_interface()->error(_("Unable to create layer"));
 444                         group.cancel();
 445                         return;
 446                 }
 447                 layer->set_param("center",p1);
 448                 get_canvas_interface()->signal_layer_param_changed()(layer,"center");
 449                 layer->set_param("radius",(p2-p1).mag());
 450                 get_canvas_interface()->signal_layer_param_changed()(layer,"radius");
 451                 break;
 452         case GRADIENT_CONICAL:
 453                 layer=get_canvas_interface()->add_layer_to("conical_gradient",canvas,depth);
 454                 if (!layer)
 455                 {
 456                         get_canvas_view()->get_ui_interface()->error(_("Unable to create layer"));
 457                         group.cancel();
 458                         return;
 459                 }
 460                 layer->set_param("center",p1);
 461                 get_canvas_interface()->signal_layer_param_changed()(layer,"center");
 462                 {
 463                         Vector diff(p2-p1);
 464                         layer->set_param("angle",Angle::tan(diff[1],diff[0]));
 465                         get_canvas_interface()->signal_layer_param_changed()(layer,"angle");
 466                 }
 467                 break;
 468         case GRADIENT_SPIRAL:
 469                 layer=get_canvas_interface()->add_layer_to("spiral_gradient",canvas,depth);
 470                 if (!layer)
 471                 {
 472                         get_canvas_view()->get_ui_interface()->error(_("Unable to create layer"));
 473                         group.cancel();
 474                         return;
 475                 }
 476                 layer->set_param("center",p1);
 477                 get_canvas_interface()->signal_layer_param_changed()(layer,"center");
 478                 layer->set_param("radius",(p2-p1).mag());
 479                 get_canvas_interface()->signal_layer_param_changed()(layer,"radius");
 480                 {
 481                         Vector diff(p2-p1);
 482                         layer->set_param("angle",Angle::tan(diff[1],diff[0]));
 483                         get_canvas_interface()->signal_layer_param_changed()(layer,"angle");
 484                 }
 485                 break;
 486
 487         default:
 488                 return;
 489         }
 490
 491 #ifdef BLEND_METHOD_IN_TOOL_OPTIONS
 492         layer->set_param("blend_method",get_blend());
 493         get_canvas_interface()->signal_layer_param_changed()(layer,"blend_method");
 494 #endif  // BLEND_METHOD_IN_TOOL_OPTIONS
 495
 496         layer->set_description(get_id());
 497         get_canvas_interface()->signal_layer_new_description()(layer,layer->get_description());
 498
 499         egress_on_selection_change=false;
 500         synfigapp::SelectionManager::LayerList layer_selection;
 501         if (!getenv("SYNFIG_TOOLS_CLEAR_SELECTION"))
 502                 layer_selection = get_canvas_view()->get_selection_manager()->get_selected_layers();
 503         get_canvas_interface()->get_selection_manager()->clear_selected_layers();
 504         layer_selection.push_back(layer);
 505         get_canvas_interface()->get_selection_manager()->set_selected_layers(layer_selection);
 506         egress_on_selection_change=true;
 507
 508         reset();
 509         increment_id();
 510 }
 511
 512 Smach::event_result
 513 StateGradient_Context::event_mouse_click_handler(const Smach::event& x)
 514 {
 515         const EventMouse& event(*reinterpret_cast<const EventMouse*>(&x));
 516
 517         if(event.key==EVENT_WORKAREA_MOUSE_BUTTON_DOWN && event.button==BUTTON_LEFT)
 518         {
 519                 point_holder=get_work_area()->snap_point_to_grid(event.pos);
 520                 etl::handle<Duck> duck=new Duck();
 521                 duck->set_point(point_holder);
 522                 duck->set_name("p1");
 523                 duck->set_type(Duck::TYPE_POSITION);
 524                 get_work_area()->add_duck(duck);
 525
 526                 point2_duck=new Duck();
 527                 point2_duck->set_point(point_holder);
 528                 point2_duck->set_name("p2");
 529                 point2_duck->set_type(Duck::TYPE_POSITION);
 530                 get_work_area()->add_duck(point2_duck);
 531
 532                 handle<Duckmatic::Bezier> bezier(new Duckmatic::Bezier());
 533                 bezier->p1=bezier->c1=duck;
 534                 bezier->p2=bezier->c2=point2_duck;
 535                 get_work_area()->add_bezier(bezier);
 536
 537                 return Smach::RESULT_ACCEPT;
 538         }
 539
 540         if(event.key==EVENT_WORKAREA_MOUSE_BUTTON_DRAG && event.button==BUTTON_LEFT)
 541         {
 542                 if (!point2_duck) return Smach::RESULT_OK;
 543                 point2_duck->set_point(get_work_area()->snap_point_to_grid(event.pos));
 544                 get_work_area()->queue_draw();
 545                 return Smach::RESULT_ACCEPT;
 546         }
 547
 548         if(event.key==EVENT_WORKAREA_MOUSE_BUTTON_UP && event.button==BUTTON_LEFT)
 549         {
 550                 make_gradient(point_holder, get_work_area()->snap_point_to_grid(event.pos));
 551                 get_work_area()->clear_ducks();
 552                 return Smach::RESULT_ACCEPT;
 553         }
 554
 555         return Smach::RESULT_OK;
 556 }
 557
 558
 559 void
 560 StateGradient_Context::refresh_ducks()
 561 {
 562         get_work_area()->clear_ducks();
 563         get_work_area()->queue_draw();
 564 }