Code

fix parameter ranges, copyedit
[inkscape.git] / src / shape-editor.cpp
1 #define __SHAPE_EDITOR_CPP__
3 /*
4  * Inkscape::ShapeEditor
5  *
6  * Authors:
7  *   bulia byak <buliabyak@users.sf.net>
8  *
9  */
11 #ifdef HAVE_CONFIG_H
12 #include "config.h"
13 #endif
15 #include <string.h>
16 #include <glibmm/i18n.h>
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/point.h"
26 #include "nodepath.h"
27 #include "xml/node-event-vector.h"
28 #include "preferences.h"
29 #include "object-edit.h"
30 #include "style.h"
31 #include "display/curve.h"
32 #include <2geom/pathvector.h>
34 #include "shape-editor.h"
37 ShapeEditorsCollective::ShapeEditorsCollective(SPDesktop */*dt*/) {
38 }
40 ShapeEditorsCollective::~ShapeEditorsCollective() {
41 }
44 void ShapeEditorsCollective::update_statusbar() {
46 //!!! move from nodepath: sp_nodepath_update_statusbar but summing for all nodepaths
48 }
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 }
59 ShapeEditor::~ShapeEditor() {
60     unset_item(SH_KNOTHOLDER);
61     unset_item(SH_NODEPATH);
62 }
64 void ShapeEditor::unset_item(SubType type, bool keep_knotholder) {
65     Inkscape::XML::Node *old_repr = NULL;
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                 }
77                 this->grab_node = -1;
78                 delete 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                 }
91                 if (!keep_knotholder) {
92                     delete this->knotholder;
93                     this->knotholder = NULL;
94                 }
95             }
96             break;
97     }
98 }
100 bool ShapeEditor::has_nodepath () {
101     return (this->nodepath != NULL);
104 bool ShapeEditor::has_knotholder () {
105     return (this->knotholder != NULL);
108 void ShapeEditor::update_knotholder () {
109     if (this->knotholder)
110         this->knotholder->update_knots();
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     }
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     }
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;
158 GList *ShapeEditor::save_nodepath_selection () {
159     if (this->nodepath)
160         return ::save_nodepath_selection (this->nodepath);
161     return NULL;
164 void ShapeEditor::restore_nodepath_selection (GList *saved) {
165     if (this->nodepath && saved)
166         ::restore_nodepath_selection (this->nodepath, saved);
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     }
174     return false;
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)
181     gboolean changed_np = FALSE;
182     gboolean changed_kh = FALSE;
184     g_assert(data);
185     ShapeEditor *sh = ((ShapeEditor *) data);
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);
192     }
194     if (changed_np) {
195         GList *saved = NULL;
196         if (sh->has_nodepath()) {
197             saved = sh->save_nodepath_selection();
198         }
200         sh->reset_item(SH_NODEPATH);
202         if (sh->has_nodepath() && saved) {
203             sh->restore_nodepath_selection(saved);
204             g_list_free (saved);
205         }
206     }
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     }
220     sh->update_statusbar(); //TODO: sh->get_container()->update_statusbar();
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 };
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);
237     this->grab_node = -1;
239     if (item) {
240         Inkscape::XML::Node *repr;
241         switch(type) {
242             case SH_NODEPATH:
243                 if (SP_IS_LPE_ITEM(item)) {
244                     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
245                     this->nodepath = sp_nodepath_new(desktop, item, (prefs->getBool("/tools/nodes/show_handles", true)));
246                 }
247                 if (this->nodepath) {
248                     this->nodepath->shape_editor = this;
250                     // setting new listener
251                     repr = SP_OBJECT_REPR(item);
252                     if (repr != listener_attached_for) {
253                         Inkscape::GC::anchor(repr);
254                         sp_repr_add_listener(repr, &shapeeditor_repr_events, this);
255                         listener_attached_for = repr;
256                     }
257                 }
258                 break;
260             case SH_KNOTHOLDER:
261                 if (!this->knotholder) {
262                     // only recreate knotholder if none is present
263                     this->knotholder = sp_item_knot_holder(item, desktop);
264                 }
265                 if (this->knotholder) {
266                     this->knotholder->update_knots();
267                     // setting new listener
268                     repr = this->knotholder->repr;
269                     if (repr != listener_attached_for) {
270                         Inkscape::GC::anchor(repr);
271                         sp_repr_add_listener(repr, &shapeeditor_repr_events, this);
272                         listener_attached_for = repr;
273                     }
274                 }
275                 break;
276         }
277     }
280 /** Please note that this function only works for path parameters.
281 *  All other parameters probably will crash Inkscape!
282 */
283 void ShapeEditor::set_item_lpe_path_parameter(SPItem *item, SPObject *lpeobject, const char * key)
285     unset_item(SH_NODEPATH);
287     this->grab_node = -1;
289     if (lpeobject) {
290         Inkscape::Preferences *prefs = Inkscape::Preferences::get();
291         this->nodepath = sp_nodepath_new( desktop, lpeobject,
292                                           (prefs->getInt("/tools/nodes/show_handles", true)),
293                                           key, item);
294         if (this->nodepath) {
295             this->nodepath->shape_editor = this;
297             // setting new listener
298             Inkscape::XML::Node *repr = SP_OBJECT_REPR(lpeobject);
299             if (repr && repr != listener_attached_for) {
300                 Inkscape::GC::anchor(repr);
301                 sp_repr_add_listener(repr, &shapeeditor_repr_events, this);
302                 listener_attached_for = repr;
303             }
304         }
305     }
308 /** 
309 *  pass a new knotholder to ShapeEditor to manage (and delete)
310 */
311 void
312 ShapeEditor::set_knotholder(KnotHolder * knot_holder)
314     unset_item(SH_KNOTHOLDER);
316     this->grab_node = -1;
318     if (knot_holder) {
319         this->knotholder = knot_holder;
320     }
324 /** FIXME: think about this. Is this thing only called when the item needs to be updated?
325    Why not make a reload function in NodePath and in KnotHolder? */
326 void ShapeEditor::reset_item (SubType type, bool keep_knotholder)
328     switch (type) {
329         case SH_NODEPATH:
330             if ( (this->nodepath) && (IS_LIVEPATHEFFECT(this->nodepath->object)) ) {
331                 SPItem * item = this->nodepath->item;
332                 SPObject *obj = this->nodepath->object;
333                 char * key = g_strdup(this->nodepath->repr_key);
334                 set_item_lpe_path_parameter(item, obj, key); // the above checks for nodepath, so it is indeed a path that we are editing
335                 g_free(key);
336             } else {
337                 SPItem * item = (SPItem *) get_item(SH_NODEPATH);
338                 set_item(item, SH_NODEPATH);
339             }                
340             break;
341         case SH_KNOTHOLDER:
342             if (this->knotholder) {
343                 SPItem * item = (SPItem *) get_item(SH_KNOTHOLDER);
344                 set_item(item, SH_KNOTHOLDER, keep_knotholder);
345             }
346             break;
347     }
350 void ShapeEditor::nodepath_destroyed () {
351     this->nodepath = NULL;
354 void ShapeEditor::update_statusbar () {
355     if (this->nodepath)
356         sp_nodepath_update_statusbar(this->nodepath);
359 bool ShapeEditor::is_over_stroke (Geom::Point event_p, bool remember) {
360     if (!this->nodepath)
361         return false; // no stroke in knotholder
363     const SPItem *item = get_item(SH_NODEPATH);
365     //Translate click point into proper coord system
366     this->curvepoint_doc = desktop->w2d(event_p);
367     this->curvepoint_doc *= sp_item_dt2i_affine(item);
369     SPCurve *curve = this->nodepath->curve;   // not sure if np->curve is always up to date...
370     Geom::PathVector const &pathv = curve->get_pathvector();
371     boost::optional<Geom::PathVectorPosition> pvpos = Geom::nearestPoint(pathv, this->curvepoint_doc);
372     if (!pvpos) {
373         g_print("Warning! Possible error?\n");
374         return false;
375     }
377     Geom::Point nearest = pathv[pvpos->path_nr].pointAt(pvpos->t);
378     Geom::Point delta = nearest - this->curvepoint_doc;
380     delta = desktop->d2w(delta);
382     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
383     double stroke_tolerance =
384         (( !SP_OBJECT_STYLE(item)->stroke.isNone() ?
385            desktop->current_zoom() *
386            SP_OBJECT_STYLE (item)->stroke_width.computed * 0.5 *
387            to_2geom(sp_item_i2d_affine(item)).descrim()
388          : 0.0)
389          + prefs->getIntLimited("/options/dragtolerance/value", 0, 0, 100)) / to_2geom(sp_item_i2d_affine(item)).descrim();
390     bool close = (Geom::L2 (delta) < stroke_tolerance);
392     if (remember && close) {
393         // calculate index for nodepath's representation.
394         double int_part;
395         double t = std::modf(pvpos->t, &int_part);
396         unsigned int segment_index = (unsigned int)int_part + 1;
397         for (unsigned int i = 0; i < pvpos->path_nr; ++i) {
398             segment_index += pathv[i].size() + 1;
399             if (pathv[i].closed())
400                 segment_index += 1;
401         }
403         this->curvepoint_event[Geom::X] = (gint) event_p [Geom::X];
404         this->curvepoint_event[Geom::Y] = (gint) event_p [Geom::Y];
405         this->hit = true;
406         this->grab_t = t;
407         this->grab_node = segment_index;
408     }
410     return close;
413 void ShapeEditor::add_node_near_point() {
414     if (this->nodepath) {
415         sp_nodepath_add_node_near_point(this->nodepath, this->curvepoint_doc);
416     } else if (this->knotholder) {
417         // we do not add nodes in knotholder... yet
418     }
421 void ShapeEditor::select_segment_near_point(bool toggle) {
422     if (this->nodepath) {
423         sp_nodepath_select_segment_near_point(this->nodepath, this->curvepoint_doc, toggle);
424     }
425     if (this->knotholder) {
426         // we do not select segments in knotholder... yet?
427     }
430 void ShapeEditor::cancel_hit() {
431     this->hit = false;
434 bool ShapeEditor::hits_curve() {
435     return (this->hit);
439 void ShapeEditor::curve_drag(gdouble eventx, gdouble eventy) {
440     if (this->nodepath && !this->nodepath->straight_path) {
442         if (this->grab_node == -1) // don't know which segment to drag
443             return;
445         // We round off the extra precision in the motion coordinates provided
446         // by some input devices (like tablets). As we'll store the coordinates
447         // as integers in curvepoint_event we need to do this rounding before
448         // comparing them with the last coordinates from curvepoint_event.
449         // See bug #1593499 for details.
451         gint x = (gint) Inkscape::round(eventx);
452         gint y = (gint) Inkscape::round(eventy);
455         // The coordinates hasn't changed since the last motion event, abort
456         if (this->curvepoint_event[Geom::X] == x &&
457             this->curvepoint_event[Geom::Y] == y)
458             return;
460         Geom::Point const delta_w(eventx - this->curvepoint_event[Geom::X],
461                                   eventy - this->curvepoint_event[Geom::Y]);
462         Geom::Point const delta_dt(this->desktop->w2d(delta_w));
464         sp_nodepath_curve_drag (this->nodepath, this->grab_node, this->grab_t, delta_dt);
465         this->curvepoint_event[Geom::X] = x;
466         this->curvepoint_event[Geom::Y] = y;
468     }
469     if (this->knotholder) {
470         // we do not drag curve in knotholder
471     }
475 void ShapeEditor::finish_drag() {
476     if (this->nodepath && this->hit) {
477         sp_nodepath_update_repr (this->nodepath, _("Drag curve"));
478     }
481 void ShapeEditor::select_rect(Geom::Rect const &rect, bool add) {
482     if (this->nodepath) {
483         sp_nodepath_select_rect(this->nodepath, rect, add);
484     }
487 bool ShapeEditor::has_selection() {
488     if (this->nodepath)
489         return this->nodepath->selected;
490     return false; //  so far, knotholder cannot have selection
493 void ShapeEditor::deselect() {
494     if (this->nodepath)
495         sp_nodepath_deselect(this->nodepath);
498 void ShapeEditor::add_node () {
499     sp_node_selected_add_node(this->nodepath);
502 void ShapeEditor::delete_nodes () {
503     sp_node_selected_delete(this->nodepath);
506 void ShapeEditor::delete_nodes_preserving_shape () {
507     if (this->nodepath && this->nodepath->selected) {
508         sp_node_delete_preserve(g_list_copy(this->nodepath->selected));
509     }
512 void ShapeEditor::delete_segment () {
513     sp_node_selected_delete_segment(this->nodepath);
516 void ShapeEditor::set_node_type(int type) {
517     sp_node_selected_set_type(this->nodepath, (Inkscape::NodePath::NodeType) type);
520 void ShapeEditor::break_at_nodes() {
521     sp_node_selected_break(this->nodepath);
524 void ShapeEditor::join_nodes() {
525     sp_node_selected_join(this->nodepath);
528 void ShapeEditor::join_segments() {
529     sp_node_selected_join_segment(this->nodepath);
532 void ShapeEditor::duplicate_nodes() {
533     sp_node_selected_duplicate(this->nodepath);
536 void ShapeEditor::set_type_of_segments(NRPathcode code) {
537     sp_node_selected_set_line_type(this->nodepath, code);
540 void ShapeEditor::move_nodes_screen(SPDesktop *desktop, gdouble dx, gdouble dy) {
541     sp_node_selected_move_screen(desktop, this->nodepath, dx, dy);
543 void ShapeEditor::move_nodes(gdouble dx, gdouble dy) {
544     sp_node_selected_move(this->nodepath, dx, dy);
547 void ShapeEditor::rotate_nodes(gdouble angle, int which, bool screen) {
548     if (this->nodepath)
549         sp_nodepath_selected_nodes_rotate (this->nodepath, angle, which, screen);
552 void ShapeEditor::scale_nodes(gdouble const grow, int const which) {
553     sp_nodepath_selected_nodes_scale(this->nodepath, grow, which);
555 void ShapeEditor::scale_nodes_screen(gdouble const grow, int const which) {
556     sp_nodepath_selected_nodes_scale_screen(this->nodepath, grow, which);
559 void ShapeEditor::select_all (bool invert) {
560     if (this->nodepath)
561         sp_nodepath_select_all (this->nodepath, invert);
563 void ShapeEditor::select_all_from_subpath (bool invert) {
564     if (this->nodepath)
565         sp_nodepath_select_all_from_subpath (this->nodepath, invert);
567 void ShapeEditor::select_next () {
568     if (this->nodepath) {
569         sp_nodepath_select_next (this->nodepath);
570         if (this->nodepath->numSelected() >= 1) {
571             this->desktop->scroll_to_point(this->nodepath->singleSelectedCoords(), 1.0);
572         }
573     }
575 void ShapeEditor::select_prev () {
576     if (this->nodepath) {
577         sp_nodepath_select_prev (this->nodepath);
578         if (this->nodepath->numSelected() >= 1) {
579             this->desktop->scroll_to_point(this->nodepath->singleSelectedCoords(), 1.0);
580         }
581     }
584 void ShapeEditor::show_handles (bool show) {
585     if (this->nodepath && !this->nodepath->straight_path)
586         sp_nodepath_show_handles (this->nodepath, show);
589 void ShapeEditor::show_helperpath (bool show) {
590     if (this->nodepath)
591         sp_nodepath_show_helperpath (this->nodepath, show);
594 void ShapeEditor::flip (Geom::Dim2 axis, boost::optional<Geom::Point> center) {
595     if (this->nodepath)
596         sp_nodepath_flip (this->nodepath, axis, center);
599 void ShapeEditor::distribute (Geom::Dim2 axis) {
600     if (this->nodepath)
601         sp_nodepath_selected_distribute (this->nodepath, axis);
603 void ShapeEditor::align (Geom::Dim2 axis) {
604     if (this->nodepath)
605         sp_nodepath_selected_align (this->nodepath, axis);
609 /*
610   Local Variables:
611   mode:c++
612   c-file-style:"stroustrup"
613   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
614   indent-tabs-mode:nil
615   fill-column:99
616   End:
617 */
618 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :