Code

LPE: add on-canvas editing of path parameters!
[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 <glibmm/i18n.h>
17 #include "sp-object.h"
18 #include "sp-item.h"
19 #include "live_effects/lpeobject.h"
20 #include "selection.h"
21 #include "desktop.h"
22 #include "desktop-handles.h"
23 #include "knotholder.h"
24 #include "node-context.h"
25 #include "xml/node-event-vector.h"
26 #include "prefs-utils.h"
27 #include "object-edit.h"
28 #include "splivarot.h"
29 #include "style.h"
31 #include "shape-editor.h"
34 ShapeEditorsCollective::ShapeEditorsCollective(SPDesktop *dt) {
35 }
37 ShapeEditorsCollective::~ShapeEditorsCollective() {
38 }
41 void ShapeEditorsCollective::update_statusbar() {
43 //!!! move from nodepath: sp_nodepath_update_statusbar but summing for all nodepaths
45 }
47 ShapeEditor::ShapeEditor(SPDesktop *dt) {
48     this->desktop = dt;
49     this->grab_node = -1;
50     this->nodepath = NULL;
51     this->knotholder = NULL;
52     this->hit = false;
53 }
55 ShapeEditor::~ShapeEditor() {
56     unset_item();
57 }
59 void ShapeEditor::unset_item() {
61     Inkscape::XML::Node *old_repr = NULL;
63     if (this->nodepath) {
64         old_repr = this->nodepath->repr;
65     }
67     if (!old_repr && this->knotholder) {
68         old_repr = this->knotholder->repr;
69     }
71     if (old_repr) { // remove old listener
72         sp_repr_remove_listener_by_data(old_repr, this);
73         Inkscape::GC::release(old_repr);
74     }
76     if (this->nodepath) {
77         this->grab_node = -1;
78         sp_nodepath_destroy(this->nodepath);
79         this->nodepath = NULL;
80     }
82     if (this->knotholder) {
83         sp_knot_holder_destroy(this->knotholder);
84         this->knotholder = NULL;
85     }
86 }
88 bool ShapeEditor::has_nodepath () {
89     return (this->nodepath != NULL);
90 }
92 bool ShapeEditor::has_knotholder () {
93     return (this->knotholder != NULL);
94 }
96 bool ShapeEditor::has_local_change () {
97     if (this->nodepath) 
98         return (this->nodepath->local_change != 0);
99     else if (this->knotholder) 
100         return (this->knotholder->local_change != 0);
101     else
102         return false;
105 void ShapeEditor::decrement_local_change () {
106     if (this->nodepath) {
107         if (this->nodepath->local_change > 0)
108             this->nodepath->local_change--;
109     } else if (this->knotholder) {
110         this->knotholder->local_change = FALSE;
111     }
114 SPItem *ShapeEditor::get_item () {
115     SPItem *item = NULL;
116     if (this->has_nodepath()) {
117         item = this->nodepath->item;
118     } else if (this->has_knotholder()) {
119         item = SP_ITEM(this->knotholder->item);
120     }
121     return item;
124 GList *ShapeEditor::save_nodepath_selection () {
125     if (this->nodepath)
126         return ::save_nodepath_selection (this->nodepath);
127     return NULL;
130 void ShapeEditor::restore_nodepath_selection (GList *saved) {
131     if (this->nodepath && saved)
132         ::restore_nodepath_selection (this->nodepath, saved);
136 static void shapeeditor_event_attr_changed(Inkscape::XML::Node *repr, gchar const *name,
137                                            gchar const *old_value, gchar const *new_value,
138                                            bool is_interactive, gpointer data)
140     SPItem *item = NULL;
141     gboolean changed = FALSE;
143     g_assert(data);
144     ShapeEditor *sh = ((ShapeEditor *) data);
146     item = sh->get_item();
148     if ( ( (sh->has_nodepath())
149            && (  !strcmp(name, "d") // With paths, we only need to act if one of the path-affecting attributes has changed.
150                  || !strcmp(name, "sodipodi:nodetypes")
151                  || !strcmp(name, "inkscape:original-d") ) )
152           || sh->has_knotholder() )
153     {
154         changed = !sh->has_local_change(); 
155         sh->decrement_local_change();
156     }
158     if (changed) {
159         GList *saved = NULL;
160         if (sh->has_nodepath()) {
161             saved = sh->save_nodepath_selection();
162         }
164         sh->set_item (item);
166         if (sh->has_nodepath() && saved) {
167             sh->restore_nodepath_selection(saved);
168             g_list_free (saved);
169         }
170     }
172     sh->update_statusbar(); //TODO: sh->get_container()->update_statusbar();
175 static Inkscape::XML::NodeEventVector shapeeditor_repr_events = {
176     NULL, /* child_added */
177     NULL, /* child_removed */
178     shapeeditor_event_attr_changed,
179     NULL, /* content_changed */
180     NULL  /* order_changed */
181 };
184 void ShapeEditor::set_item(SPItem *item) {
186     unset_item();
188     this->grab_node = -1;
190     if (item) {
191         this->nodepath = sp_nodepath_new(desktop, item, (prefs_get_int_attribute("tools.nodes", "show_handles", 1) != 0));
192         if (this->nodepath) {
193             this->nodepath->shape_editor = this; 
194         }
195         this->knotholder = sp_item_knot_holder(item, desktop);
197         if (this->nodepath || this->knotholder) {
198             // setting new listener
199             Inkscape::XML::Node *repr;
200             if (this->knotholder)
201                 repr = this->knotholder->repr;
202             else
203                 repr = SP_OBJECT_REPR(item);
204             if (repr) {
205                 Inkscape::GC::anchor(repr);
206                 sp_repr_add_listener(repr, &shapeeditor_repr_events, this);
207             }
208         }
209     }
212 /** Please note that this function only works for path parameters.
213 *  All other parameters probably will crash Inkscape!
214 *  Fortunately, there are no other on-canvas edittable objects at this moment :)
215 */
216 void ShapeEditor::set_item_livepatheffect_parameter(SPItem *item, SPObject *lpeobject, const char * key) {
218     unset_item();
220     this->grab_node = -1;
222     if (lpeobject) {
223         this->knotholder = NULL; // it's a path, no special knotholder needed.
224         this->nodepath = sp_nodepath_new( desktop, lpeobject, 
225                                           (prefs_get_int_attribute("tools.nodes", "show_handles", 1) != 0),
226                                           key, item);
227         if (this->nodepath) {
228             this->nodepath->shape_editor = this; 
230             // setting new listener
231             Inkscape::XML::Node *repr = SP_OBJECT_REPR(lpeobject);
232             if (repr) {
233                 Inkscape::GC::anchor(repr);
234                 sp_repr_add_listener(repr, &shapeeditor_repr_events, this);
235             }
236         }
237     }
240 void ShapeEditor::nodepath_destroyed () {
241     this->nodepath = NULL;
244 void ShapeEditor::update_statusbar () {
245     if (this->nodepath)
246         sp_nodepath_update_statusbar(this->nodepath);
249 bool ShapeEditor::is_over_stroke (NR::Point event_p, bool remember) {
251     if (!this->nodepath) 
252         return false; // no stroke in knotholder
254     SPItem *item = get_item();
256     //Translate click point into proper coord system
257     this->curvepoint_doc = desktop->w2d(event_p);
258     this->curvepoint_doc *= sp_item_dt2i_affine(item);
260     sp_nodepath_ensure_livarot_path(this->nodepath);
262     NR::Maybe<Path::cut_position> position = get_nearest_position_on_Path(this->nodepath->livarot_path, this->curvepoint_doc);
263     if (!position) {
264         return false;
265     }
267     NR::Point nearest = get_point_on_Path(this->nodepath->livarot_path, position->piece, position->t);
268     NR::Point delta = nearest - this->curvepoint_doc;
270     delta = desktop->d2w(delta);
272     double stroke_tolerance =
273         ( !SP_OBJECT_STYLE(item)->stroke.isNone() ?
274          desktop->current_zoom() *
275          SP_OBJECT_STYLE (item)->stroke_width.computed *
276          sp_item_i2d_affine (item).expansion() * 0.5
277          : 0.0)
278         + prefs_get_int_attribute_limited("options.dragtolerance", "value", 0, 0, 100); //(double) SP_EVENT_CONTEXT(nc)->tolerance;
280     bool close = (NR::L2 (delta) < stroke_tolerance);
282     if (remember && close) {
283         this->curvepoint_event[NR::X] = (gint) event_p [NR::X];
284         this->curvepoint_event[NR::Y] = (gint) event_p [NR::Y];
285         this->hit = true;
286         this->grab_t = position->t;
287         this->grab_node = position->piece;
288     }
290     return close;
293 void ShapeEditor::add_node_near_point() {
294     if (this->nodepath) {
295         sp_nodepath_add_node_near_point(this->nodepath, this->curvepoint_doc);
296     } else if (this->knotholder) {
297         // we do not add nodes in knotholder... yet
298     }
301 void ShapeEditor::select_segment_near_point(bool toggle) {
302     if (this->nodepath) {
303         sp_nodepath_select_segment_near_point(this->nodepath, this->curvepoint_doc, toggle);
304     } else if (this->knotholder) {
305         // we do not select segments in knotholder... yet?
306     }
309 void ShapeEditor::cancel_hit() {
310     this->hit = false;
313 bool ShapeEditor::hits_curve() {
314     return (this->hit);
318 void ShapeEditor::curve_drag(gdouble eventx, gdouble eventy) {
319     if (this->nodepath && !this->nodepath->straight_path) {
321         if (this->grab_node == -1) // don't know which segment to drag
322             return;
324         // We round off the extra precision in the motion coordinates provided
325         // by some input devices (like tablets). As we'll store the coordinates
326         // as integers in curvepoint_event we need to do this rounding before
327         // comparing them with the last coordinates from curvepoint_event.
328         // See bug #1593499 for details.
330         gint x = (gint) Inkscape::round(eventx);
331         gint y = (gint) Inkscape::round(eventy);
334         // The coordinates hasn't changed since the last motion event, abort
335         if (this->curvepoint_event[NR::X] == x &&
336             this->curvepoint_event[NR::Y] == y)
337             return;
339         NR::Point const delta_w(eventx - this->curvepoint_event[NR::X],
340                                 eventy - this->curvepoint_event[NR::Y]);
341         NR::Point const delta_dt(this->desktop->w2d(delta_w));
343         sp_nodepath_curve_drag (this->grab_node, this->grab_t, delta_dt); //!!! FIXME: which nodepath?!!! also uses current!!!
344         this->curvepoint_event[NR::X] = x;
345         this->curvepoint_event[NR::Y] = y;
347     } else if (this->knotholder) {
348         // we do not drag curve in knotholder
349     }
353 void ShapeEditor::finish_drag() {
354     if (this->nodepath && this->hit) {
355         sp_nodepath_update_repr (this->nodepath, _("Drag curve"));
356     }
359 void ShapeEditor::select_rect(NR::Rect const &rect, bool add) {
360     if (this->nodepath) {
361         sp_nodepath_select_rect(this->nodepath, rect, add);
362     }
365 bool ShapeEditor::has_selection() {
366     if (this->nodepath)
367         return this->nodepath->selected;
368     return false; //  so far, knotholder cannot have selection
371 void ShapeEditor::deselect() {
372     if (this->nodepath)
373         sp_nodepath_deselect(this->nodepath);
376 void ShapeEditor::add_node () {
377     sp_node_selected_add_node(this->nodepath);
380 void ShapeEditor::delete_nodes () {
381     sp_node_selected_delete(this->nodepath);
384 void ShapeEditor::delete_nodes_preserving_shape () {
385     if (this->nodepath && this->nodepath->selected) {
386         sp_node_delete_preserve(g_list_copy(this->nodepath->selected));
387     }
390 void ShapeEditor::delete_segment () {
391     sp_node_selected_delete_segment(this->nodepath);
394 void ShapeEditor::set_node_type(int type) {
395     sp_node_selected_set_type(this->nodepath, (Inkscape::NodePath::NodeType) type);
398 void ShapeEditor::break_at_nodes() {
399     sp_node_selected_break(this->nodepath);
402 void ShapeEditor::join_nodes() {
403     sp_node_selected_join(this->nodepath);
406 void ShapeEditor::join_segments() {
407     sp_node_selected_join_segment(this->nodepath);
410 void ShapeEditor::duplicate_nodes() {
411     sp_node_selected_duplicate(this->nodepath);
414 void ShapeEditor::set_type_of_segments(NRPathcode code) {
415     sp_node_selected_set_line_type(this->nodepath, code);
418 void ShapeEditor::move_nodes_screen(gdouble dx, gdouble dy) {
419     sp_node_selected_move_screen(this->nodepath, dx, dy);
421 void ShapeEditor::move_nodes(gdouble dx, gdouble dy) {
422     sp_node_selected_move(this->nodepath, dx, dy);
425 void ShapeEditor::rotate_nodes(gdouble angle, int which, bool screen) {
426     if (this->nodepath)
427         sp_nodepath_selected_nodes_rotate (this->nodepath, angle, which, screen);
430 void ShapeEditor::scale_nodes(gdouble const grow, int const which) {
431     sp_nodepath_selected_nodes_scale(this->nodepath, grow, which);
433 void ShapeEditor::scale_nodes_screen(gdouble const grow, int const which) {
434     sp_nodepath_selected_nodes_scale_screen(this->nodepath, grow, which);
437 void ShapeEditor::select_all (bool invert) {
438     if (this->nodepath) 
439         sp_nodepath_select_all (this->nodepath, invert);
441 void ShapeEditor::select_all_from_subpath (bool invert) {
442     if (this->nodepath) 
443         sp_nodepath_select_all_from_subpath (this->nodepath, invert);
445 void ShapeEditor::select_next () {
446     if (this->nodepath) {
447         sp_nodepath_select_next (this->nodepath);
448         if (this->nodepath->numSelected() >= 1) {
449             this->desktop->scroll_to_point(&(this->nodepath->singleSelectedCoords()), 1.0);
450         }
451     }
453 void ShapeEditor::select_prev () {
454     if (this->nodepath) {
455         sp_nodepath_select_prev (this->nodepath);
456         if (this->nodepath->numSelected() >= 1) {
457             this->desktop->scroll_to_point(&(this->nodepath->singleSelectedCoords()), 1.0);
458         }
459     }
462 void ShapeEditor::show_handles (bool show) {
463     if (this->nodepath) 
464         sp_nodepath_show_handles (this->nodepath, show);
468 void ShapeEditor::flip (NR::Dim2 axis, NR::Maybe<NR::Point> center) {
469     if (this->nodepath) 
470         sp_nodepath_flip (this->nodepath, axis, center);
473 void ShapeEditor::distribute (NR::Dim2 axis) {
474     if (this->nodepath) 
475         sp_nodepath_selected_distribute (this->nodepath, axis);
477 void ShapeEditor::align (NR::Dim2 axis) {
478     if (this->nodepath) 
479         sp_nodepath_selected_align (this->nodepath, axis);
483 /*
484   Local Variables:
485   mode:c++
486   c-file-style:"stroustrup"
487   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
488   indent-tabs-mode:nil
489   fill-column:99
490   End:
491 */
492 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :