src/shape-editor.cpp

   1 #define __SHAPE_EDITOR_CPP__
   2
   3 /*
   4  * Inkscape::ShapeEditor
   5  *
   6  * Authors:
   7  *   bulia byak <buliabyak@users.sf.net>
   8  *
   9  */
  10
  11 #ifdef HAVE_CONFIG_H
  12 #include "config.h"
  13 #endif
  14
  15 #include <string.h>
  16 #include <glibmm/i18n.h>
  17
  18 #include "sp-object.h"
  19 #include "sp-item.h"
  20 #include "live_effects/lpeobject.h"
  21 #include "selection.h"
  22 #include "desktop.h"
  23 #include "desktop-handles.h"
  24 #include "knotholder.h"
  25 #include "live_effects/parameter/pointparam-knotholder.h"
  26 #include "nodepath.h"
  27 #include "xml/node-event-vector.h"
  28 #include "prefs-utils.h"
  29 #include "object-edit.h"
  30 #include "style.h"
  31 #include "display/curve.h"
  32 #include <2geom/pathvector.h>
  33
  34 #include "shape-editor.h"
  35
  36
  37 ShapeEditorsCollective::ShapeEditorsCollective(SPDesktop */*dt*/) {
  38 }
  39
  40 ShapeEditorsCollective::~ShapeEditorsCollective() {
  41 }
  42
  43
  44 void ShapeEditorsCollective::update_statusbar() {
  45
  46 //!!! move from nodepath: sp_nodepath_update_statusbar but summing for all nodepaths
  47
  48 }
  49
  50 ShapeEditor::ShapeEditor(SPDesktop *dt) {
  51     this->desktop = dt;
  52     this->grab_node = -1;
  53     this->nodepath = NULL;
  54     this->knotholder = NULL;
  55     this->hit = false;
  56     this->listener_attached_for = NULL;
  57 }
  58
  59 ShapeEditor::~ShapeEditor() {
  60     unset_item(SH_KNOTHOLDER);
  61     unset_item(SH_NODEPATH);
  62 }
  63
  64 void ShapeEditor::unset_item(SubType type, bool keep_knotholder) {
  65     Inkscape::XML::Node *old_repr = NULL;
  66
  67     switch (type) {
  68         case SH_NODEPATH:
  69             if (this->nodepath) {
  70                 old_repr = this->nodepath->repr;
  71                 if (old_repr && old_repr == listener_attached_for) {
  72                     sp_repr_remove_listener_by_data(old_repr, this);
  73                     Inkscape::GC::release(old_repr);
  74                     listener_attached_for = NULL;
  75                 }
  76
  77                 this->grab_node = -1;
  78                 sp_nodepath_destroy(this->nodepath);
  79                 this->nodepath = NULL;
  80             }
  81             break;
  82         case SH_KNOTHOLDER:
  83             if (this->knotholder) {
  84                 old_repr = this->knotholder->repr;
  85                 if (old_repr && old_repr == listener_attached_for) {
  86                     sp_repr_remove_listener_by_data(old_repr, this);
  87                     Inkscape::GC::release(old_repr);
  88                     listener_attached_for = NULL;
  89                 }
  90
  91                 if (!keep_knotholder) {
  92                     delete this->knotholder;
  93                     this->knotholder = NULL;
  94                 }
  95             }
  96             break;
  97     }
  98 }
  99
 100 bool ShapeEditor::has_nodepath () {
 101     return (this->nodepath != NULL);
 102 }
 103
 104 bool ShapeEditor::has_knotholder () {
 105     return (this->knotholder != NULL);
 106 }
 107
 108 void ShapeEditor::update_knotholder () {
 109     if (this->knotholder)
 110         this->knotholder->update_knots();
 111 }
 112
 113 bool ShapeEditor::has_local_change (SubType type) {
 114     switch (type) {
 115         case SH_NODEPATH:
 116             return (this->nodepath && this->nodepath->local_change);
 117         case SH_KNOTHOLDER:
 118             return (this->knotholder && this->knotholder->local_change != 0);
 119         default:
 120             g_assert_not_reached();
 121     }
 122 }
 123
 124 void ShapeEditor::decrement_local_change (SubType type) {
 125     switch (type) {
 126         case SH_NODEPATH:
 127             if (this->nodepath && this->nodepath->local_change > 0) {
 128                 this->nodepath->local_change--;
 129             }
 130             break;
 131         case SH_KNOTHOLDER:
 132             if (this->knotholder) {
 133                 this->knotholder->local_change = FALSE;
 134             }
 135             break;
 136         default:
 137             g_assert_not_reached();
 138     }
 139 }
 140
 141 const SPItem *ShapeEditor::get_item (SubType type) {
 142     const SPItem *item = NULL;
 143     switch (type) {
 144         case SH_NODEPATH:
 145             if (this->has_nodepath()) {
 146                 item = this->nodepath->item;
 147             }
 148             break;
 149         case SH_KNOTHOLDER:
 150             if (this->has_knotholder()) {
 151                 item = this->knotholder->getItem();
 152             }
 153             break;
 154     }
 155     return item;
 156 }
 157
 158 GList *ShapeEditor::save_nodepath_selection () {
 159     if (this->nodepath)
 160         return ::save_nodepath_selection (this->nodepath);
 161     return NULL;
 162 }
 163
 164 void ShapeEditor::restore_nodepath_selection (GList *saved) {
 165     if (this->nodepath && saved)
 166         ::restore_nodepath_selection (this->nodepath, saved);
 167 }
 168
 169 bool ShapeEditor::nodepath_edits_repr_key(gchar const *name) {
 170     if (nodepath && name) {
 171         return ( !strcmp(name, nodepath->repr_key) || !strcmp(name, nodepath->repr_nodetypes_key) );
 172     }
 173
 174     return false;
 175 }
 176
 177 static void shapeeditor_event_attr_changed(Inkscape::XML::Node */*repr*/, gchar const *name,
 178                                            gchar const */*old_value*/, gchar const */*new_value*/,
 179                                            bool /*is_interactive*/, gpointer data)
 180 {
 181     gboolean changed_np = FALSE;
 182     gboolean changed_kh = FALSE;
 183
 184     g_assert(data);
 185     ShapeEditor *sh = ((ShapeEditor *) data);
 186
 187     if (sh->has_nodepath() && sh->nodepath_edits_repr_key(name))
 188     {
 189         changed_np = !sh->has_local_change(SH_NODEPATH);
 190         sh->decrement_local_change(SH_NODEPATH);
 191
 192     }
 193
 194     if (changed_np) {
 195         GList *saved = NULL;
 196         if (sh->has_nodepath()) {
 197             saved = sh->save_nodepath_selection();
 198         }
 199
 200         sh->reset_item(SH_NODEPATH);
 201
 202         if (sh->has_nodepath() && saved) {
 203             sh->restore_nodepath_selection(saved);
 204             g_list_free (saved);
 205         }
 206     }
 207
 208
 209     if (sh->has_knotholder())
 210     {
 211         changed_kh = !sh->has_local_change(SH_KNOTHOLDER);
 212         sh->decrement_local_change(SH_KNOTHOLDER);
 213         if (changed_kh) {
 214             // this can happen if an LPEItem's knotholder handle was dragged, in which case we want
 215             // to keep the knotholder; in all other cases (e.g., if the LPE itself changes) we delete it
 216             sh->reset_item(SH_KNOTHOLDER, !strcmp(name, "d"));
 217         }
 218     }
 219
 220     sh->update_statusbar(); //TODO: sh->get_container()->update_statusbar();
 221 }
 222
 223 static Inkscape::XML::NodeEventVector shapeeditor_repr_events = {
 224     NULL, /* child_added */
 225     NULL, /* child_removed */
 226     shapeeditor_event_attr_changed,
 227     NULL, /* content_changed */
 228     NULL  /* order_changed */
 229 };
 230
 231
 232 void ShapeEditor::set_item(SPItem *item, SubType type, bool keep_knotholder) {
 233     // this happens (and should only happen) when for an LPEItem having both knotholder and nodepath the knotholder
 234     // is adapted; in this case we don't want to delete the knotholder since this freezes the handles
 235     unset_item(type, keep_knotholder);
 236
 237     this->grab_node = -1;
 238
 239     if (item) {
 240         Inkscape::XML::Node *repr;
 241         switch(type) {
 242             case SH_NODEPATH:
 243                 if (SP_IS_LPE_ITEM(item)) {
 244                     this->nodepath = sp_nodepath_new(desktop, item, (prefs_get_int_attribute("tools.nodes", "show_handles", 1) != 0));
 245                 }
 246                 if (this->nodepath) {
 247                     this->nodepath->shape_editor = this;
 248
 249                     // setting new listener
 250                     repr = SP_OBJECT_REPR(item);
 251                     if (repr != listener_attached_for) {
 252                         Inkscape::GC::anchor(repr);
 253                         sp_repr_add_listener(repr, &shapeeditor_repr_events, this);
 254                         listener_attached_for = repr;
 255                     }
 256                 }
 257                 break;
 258
 259             case SH_KNOTHOLDER:
 260                 if (!this->knotholder) {
 261                     // only recreate knotholder if none is present
 262                     this->knotholder = sp_item_knot_holder(item, desktop);
 263                 }
 264                 if (this->knotholder) {
 265                     this->knotholder->update_knots();
 266                     // setting new listener
 267                     repr = this->knotholder->repr;
 268                     if (repr != listener_attached_for) {
 269                         Inkscape::GC::anchor(repr);
 270                         sp_repr_add_listener(repr, &shapeeditor_repr_events, this);
 271                         listener_attached_for = repr;
 272                     }
 273                 }
 274                 break;
 275         }
 276     }
 277 }
 278
 279 /** Please note that this function only works for path parameters.
 280 *  All other parameters probably will crash Inkscape!
 281 */
 282 void ShapeEditor::set_item_lpe_path_parameter(SPItem *item, SPObject *lpeobject, const char * key)
 283 {
 284     unset_item(SH_NODEPATH);
 285
 286     this->grab_node = -1;
 287
 288     if (lpeobject) {
 289         this->nodepath = sp_nodepath_new( desktop, lpeobject,
 290                                           (prefs_get_int_attribute("tools.nodes", "show_handles", 1) != 0),
 291                                           key, item);
 292         if (this->nodepath) {
 293             this->nodepath->shape_editor = this;
 294
 295             // setting new listener
 296             Inkscape::XML::Node *repr = SP_OBJECT_REPR(lpeobject);
 297             if (repr && repr != listener_attached_for) {
 298                 Inkscape::GC::anchor(repr);
 299                 sp_repr_add_listener(repr, &shapeeditor_repr_events, this);
 300                 listener_attached_for = repr;
 301             }
 302         }
 303     }
 304 }
 305
 306 /**
 307 *  pass a new knotholder to ShapeEditor to manage (and delete)
 308 */
 309 void
 310 ShapeEditor::set_knotholder(KnotHolder * knot_holder)
 311 {
 312     unset_item(SH_KNOTHOLDER);
 313
 314     this->grab_node = -1;
 315
 316     if (knot_holder) {
 317         this->knotholder = knot_holder;
 318     }
 319 }
 320
 321
 322 /** FIXME: think about this. Is this thing only called when the item needs to be updated?
 323    Why not make a reload function in NodePath and in KnotHolder? */
 324 void ShapeEditor::reset_item (SubType type, bool keep_knotholder)
 325 {
 326     switch (type) {
 327         case SH_NODEPATH:
 328             if ( (this->nodepath) && (IS_LIVEPATHEFFECT(this->nodepath->object)) ) {
 329                 SPItem * item = this->nodepath->item;
 330                 SPObject *obj = this->nodepath->object;
 331                 char * key = g_strdup(this->nodepath->repr_key);
 332                 set_item_lpe_path_parameter(item, obj, key); // the above checks for nodepath, so it is indeed a path that we are editing
 333                 g_free(key);
 334             } else {
 335                 SPItem * item = (SPItem *) get_item(SH_NODEPATH);
 336                 set_item(item, SH_NODEPATH);
 337             }
 338             break;
 339         case SH_KNOTHOLDER:
 340             if (this->knotholder) {
 341                 SPItem * item = (SPItem *) get_item(SH_KNOTHOLDER);
 342                 set_item(item, SH_KNOTHOLDER, keep_knotholder);
 343             }
 344             break;
 345     }
 346 }
 347
 348 void ShapeEditor::nodepath_destroyed () {
 349     this->nodepath = NULL;
 350 }
 351
 352 void ShapeEditor::update_statusbar () {
 353     if (this->nodepath)
 354         sp_nodepath_update_statusbar(this->nodepath);
 355 }
 356
 357 bool ShapeEditor::is_over_stroke (NR::Point event_p, bool remember) {
 358     if (!this->nodepath)
 359         return false; // no stroke in knotholder
 360
 361     const SPItem *item = get_item(SH_NODEPATH);
 362
 363     //Translate click point into proper coord system
 364     this->curvepoint_doc = desktop->w2d(event_p);
 365     this->curvepoint_doc *= sp_item_dt2i_affine(item);
 366
 367     SPCurve *curve = this->nodepath->curve;   // not sure if np->curve is always up to date...
 368     Geom::PathVector const &pathv = curve->get_pathvector();
 369     Geom::PathVectorPosition pvpos = Geom::nearestPoint(pathv, this->curvepoint_doc);
 370
 371     NR::Point nearest = pathv[pvpos.path_nr].pointAt(pvpos.t);
 372     NR::Point delta = nearest - this->curvepoint_doc;
 373
 374     delta = desktop->d2w(delta);
 375
 376     double stroke_tolerance =
 377         (( !SP_OBJECT_STYLE(item)->stroke.isNone() ?
 378            desktop->current_zoom() *
 379            SP_OBJECT_STYLE (item)->stroke_width.computed * 0.5 *
 380            NR::expansion(sp_item_i2d_affine(item))
 381          : 0.0)
 382          + prefs_get_int_attribute_limited("options.dragtolerance", "value", 0, 0, 100)) /NR::expansion(sp_item_i2d_affine(item));
 383     bool close = (NR::L2 (delta) < stroke_tolerance);
 384
 385     if (remember && close) {
 386         // calculate index for nodepath's representation.
 387         double int_part;
 388         double t = std::modf(pvpos.t, &int_part);
 389         unsigned int segment_index = (unsigned int)int_part + 1;
 390         for (unsigned int i = 0; i < pvpos.path_nr; ++i) {
 391             segment_index += pathv[i].size() + 1;
 392             if (pathv[i].closed())
 393                 segment_index += 1;
 394         }
 395
 396         this->curvepoint_event[NR::X] = (gint) event_p [NR::X];
 397         this->curvepoint_event[NR::Y] = (gint) event_p [NR::Y];
 398         this->hit = true;
 399         this->grab_t = t;
 400         this->grab_node = segment_index;
 401     }
 402
 403     return close;
 404 }
 405
 406 void ShapeEditor::add_node_near_point() {
 407     if (this->nodepath) {
 408         sp_nodepath_add_node_near_point(this->nodepath, this->curvepoint_doc);
 409     } else if (this->knotholder) {
 410         // we do not add nodes in knotholder... yet
 411     }
 412 }
 413
 414 void ShapeEditor::select_segment_near_point(bool toggle) {
 415     if (this->nodepath) {
 416         sp_nodepath_select_segment_near_point(this->nodepath, this->curvepoint_doc, toggle);
 417     }
 418     if (this->knotholder) {
 419         // we do not select segments in knotholder... yet?
 420     }
 421 }
 422
 423 void ShapeEditor::cancel_hit() {
 424     this->hit = false;
 425 }
 426
 427 bool ShapeEditor::hits_curve() {
 428     return (this->hit);
 429 }
 430
 431
 432 void ShapeEditor::curve_drag(gdouble eventx, gdouble eventy) {
 433     if (this->nodepath && !this->nodepath->straight_path) {
 434
 435         if (this->grab_node == -1) // don't know which segment to drag
 436             return;
 437
 438         // We round off the extra precision in the motion coordinates provided
 439         // by some input devices (like tablets). As we'll store the coordinates
 440         // as integers in curvepoint_event we need to do this rounding before
 441         // comparing them with the last coordinates from curvepoint_event.
 442         // See bug #1593499 for details.
 443
 444         gint x = (gint) Inkscape::round(eventx);
 445         gint y = (gint) Inkscape::round(eventy);
 446
 447
 448         // The coordinates hasn't changed since the last motion event, abort
 449         if (this->curvepoint_event[NR::X] == x &&
 450             this->curvepoint_event[NR::Y] == y)
 451             return;
 452
 453         NR::Point const delta_w(eventx - this->curvepoint_event[NR::X],
 454                                 eventy - this->curvepoint_event[NR::Y]);
 455         NR::Point const delta_dt(this->desktop->w2d(delta_w));
 456
 457         sp_nodepath_curve_drag (this->nodepath, this->grab_node, this->grab_t, delta_dt);
 458         this->curvepoint_event[NR::X] = x;
 459         this->curvepoint_event[NR::Y] = y;
 460
 461     }
 462     if (this->knotholder) {
 463         // we do not drag curve in knotholder
 464     }
 465
 466 }
 467
 468 void ShapeEditor::finish_drag() {
 469     if (this->nodepath && this->hit) {
 470         sp_nodepath_update_repr (this->nodepath, _("Drag curve"));
 471     }
 472 }
 473
 474 void ShapeEditor::select_rect(NR::Rect const &rect, bool add) {
 475     if (this->nodepath) {
 476         sp_nodepath_select_rect(this->nodepath, rect, add);
 477     }
 478 }
 479
 480 bool ShapeEditor::has_selection() {
 481     if (this->nodepath)
 482         return this->nodepath->selected;
 483     return false; //  so far, knotholder cannot have selection
 484 }
 485
 486 void ShapeEditor::deselect() {
 487     if (this->nodepath)
 488         sp_nodepath_deselect(this->nodepath);
 489 }
 490
 491 void ShapeEditor::add_node () {
 492     sp_node_selected_add_node(this->nodepath);
 493 }
 494
 495 void ShapeEditor::delete_nodes () {
 496     sp_node_selected_delete(this->nodepath);
 497 }
 498
 499 void ShapeEditor::delete_nodes_preserving_shape () {
 500     if (this->nodepath && this->nodepath->selected) {
 501         sp_node_delete_preserve(g_list_copy(this->nodepath->selected));
 502     }
 503 }
 504
 505 void ShapeEditor::delete_segment () {
 506     sp_node_selected_delete_segment(this->nodepath);
 507 }
 508
 509 void ShapeEditor::set_node_type(int type) {
 510     sp_node_selected_set_type(this->nodepath, (Inkscape::NodePath::NodeType) type);
 511 }
 512
 513 void ShapeEditor::break_at_nodes() {
 514     sp_node_selected_break(this->nodepath);
 515 }
 516
 517 void ShapeEditor::join_nodes() {
 518     sp_node_selected_join(this->nodepath);
 519 }
 520
 521 void ShapeEditor::join_segments() {
 522     sp_node_selected_join_segment(this->nodepath);
 523 }
 524
 525 void ShapeEditor::duplicate_nodes() {
 526     sp_node_selected_duplicate(this->nodepath);
 527 }
 528
 529 void ShapeEditor::set_type_of_segments(NRPathcode code) {
 530     sp_node_selected_set_line_type(this->nodepath, code);
 531 }
 532
 533 void ShapeEditor::move_nodes_screen(SPDesktop *desktop, gdouble dx, gdouble dy) {
 534     sp_node_selected_move_screen(desktop, this->nodepath, dx, dy);
 535 }
 536 void ShapeEditor::move_nodes(gdouble dx, gdouble dy) {
 537     sp_node_selected_move(this->nodepath, dx, dy);
 538 }
 539
 540 void ShapeEditor::rotate_nodes(gdouble angle, int which, bool screen) {
 541     if (this->nodepath)
 542         sp_nodepath_selected_nodes_rotate (this->nodepath, angle, which, screen);
 543 }
 544
 545 void ShapeEditor::scale_nodes(gdouble const grow, int const which) {
 546     sp_nodepath_selected_nodes_scale(this->nodepath, grow, which);
 547 }
 548 void ShapeEditor::scale_nodes_screen(gdouble const grow, int const which) {
 549     sp_nodepath_selected_nodes_scale_screen(this->nodepath, grow, which);
 550 }
 551
 552 void ShapeEditor::select_all (bool invert) {
 553     if (this->nodepath)
 554         sp_nodepath_select_all (this->nodepath, invert);
 555 }
 556 void ShapeEditor::select_all_from_subpath (bool invert) {
 557     if (this->nodepath)
 558         sp_nodepath_select_all_from_subpath (this->nodepath, invert);
 559 }
 560 void ShapeEditor::select_next () {
 561     if (this->nodepath) {
 562         sp_nodepath_select_next (this->nodepath);
 563         if (this->nodepath->numSelected() >= 1) {
 564             this->desktop->scroll_to_point(&(this->nodepath->singleSelectedCoords()), 1.0);
 565         }
 566     }
 567 }
 568 void ShapeEditor::select_prev () {
 569     if (this->nodepath) {
 570         sp_nodepath_select_prev (this->nodepath);
 571         if (this->nodepath->numSelected() >= 1) {
 572             this->desktop->scroll_to_point(&(this->nodepath->singleSelectedCoords()), 1.0);
 573         }
 574     }
 575 }
 576
 577 void ShapeEditor::show_handles (bool show) {
 578     if (this->nodepath && !this->nodepath->straight_path)
 579         sp_nodepath_show_handles (this->nodepath, show);
 580 }
 581
 582 void ShapeEditor::show_helperpath (bool show) {
 583     if (this->nodepath)
 584         sp_nodepath_show_helperpath (this->nodepath, show);
 585 }
 586
 587 void ShapeEditor::flip (NR::Dim2 axis, boost::optional<NR::Point> center) {
 588     if (this->nodepath)
 589         sp_nodepath_flip (this->nodepath, axis, center);
 590 }
 591
 592 void ShapeEditor::distribute (NR::Dim2 axis) {
 593     if (this->nodepath)
 594         sp_nodepath_selected_distribute (this->nodepath, axis);
 595 }
 596 void ShapeEditor::align (NR::Dim2 axis) {
 597     if (this->nodepath)
 598         sp_nodepath_selected_align (this->nodepath, axis);
 599 }
 600
 601
 602 /*
 603   Local Variables:
 604   mode:c++
 605   c-file-style:"stroustrup"
 606   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 607   indent-tabs-mode:nil
 608   fill-column:99
 609   End:
 610 */
 611 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :