1 #define __SP_SPIRAL_C__
3 /** \file
4 * <sodipodi:spiral> implementation
5 */
6 /*
7 * Authors:
8 * Mitsuru Oka <oka326@parkcity.ne.jp>
9 * Lauris Kaplinski <lauris@kaplinski.com>
10 *
11 * Copyright (C) 1999-2002 Lauris Kaplinski
12 * Copyright (C) 2000-2001 Ximian, Inc.
13 *
14 * Released under GNU GPL, read the file 'COPYING' for more information
15 */
17 #include "config.h"
20 #include "svg/svg.h"
21 #include "attributes.h"
22 #include "display/bezier-utils.h"
23 #include "display/curve.h"
24 #include <glibmm/i18n.h>
25 #include "xml/repr.h"
26 #include "document.h"
28 #include "sp-spiral.h"
30 static void sp_spiral_class_init (SPSpiralClass *klass);
31 static void sp_spiral_init (SPSpiral *spiral);
33 static void sp_spiral_build (SPObject * object, SPDocument * document, Inkscape::XML::Node * repr);
34 static Inkscape::XML::Node *sp_spiral_write (SPObject *object, Inkscape::XML::Node *repr, guint flags);
35 static void sp_spiral_set (SPObject *object, unsigned int key, const gchar *value);
36 static void sp_spiral_update (SPObject *object, SPCtx *ctx, guint flags);
38 static gchar * sp_spiral_description (SPItem * item);
39 static void sp_spiral_snappoints(SPItem const *item, SnapPointsIter p);
41 static void sp_spiral_set_shape (SPShape *shape);
42 static void sp_spiral_update_patheffect (SPLPEItem *lpeitem, bool write);
44 static NR::Point sp_spiral_get_tangent (SPSpiral const *spiral, gdouble t);
46 static SPShapeClass *parent_class;
48 /**
49 * Register SPSpiral class and return its type number.
50 */
51 GType
52 sp_spiral_get_type (void)
53 {
54 static GType spiral_type = 0;
56 if (!spiral_type) {
57 GTypeInfo spiral_info = {
58 sizeof (SPSpiralClass),
59 NULL, /* base_init */
60 NULL, /* base_finalize */
61 (GClassInitFunc) sp_spiral_class_init,
62 NULL, /* class_finalize */
63 NULL, /* class_data */
64 sizeof (SPSpiral),
65 16, /* n_preallocs */
66 (GInstanceInitFunc) sp_spiral_init,
67 NULL, /* value_table */
68 };
69 spiral_type = g_type_register_static (SP_TYPE_SHAPE, "SPSpiral", &spiral_info, (GTypeFlags)0);
70 }
71 return spiral_type;
72 }
74 /**
75 * SPSpiral vtable initialization.
76 */
77 static void
78 sp_spiral_class_init (SPSpiralClass *klass)
79 {
80 GObjectClass * gobject_class;
81 SPObjectClass * sp_object_class;
82 SPItemClass * item_class;
83 SPLPEItemClass * lpe_item_class;
84 SPShapeClass *shape_class;
86 gobject_class = (GObjectClass *) klass;
87 sp_object_class = (SPObjectClass *) klass;
88 item_class = (SPItemClass *) klass;
89 lpe_item_class = (SPLPEItemClass *) klass;
90 shape_class = (SPShapeClass *) klass;
92 parent_class = (SPShapeClass *)g_type_class_ref (SP_TYPE_SHAPE);
94 sp_object_class->build = sp_spiral_build;
95 sp_object_class->write = sp_spiral_write;
96 sp_object_class->set = sp_spiral_set;
97 sp_object_class->update = sp_spiral_update;
99 item_class->description = sp_spiral_description;
100 item_class->snappoints = sp_spiral_snappoints;
102 lpe_item_class->update_patheffect = sp_spiral_update_patheffect;
104 shape_class->set_shape = sp_spiral_set_shape;
105 }
107 /**
108 * Callback for SPSpiral object initialization.
109 */
110 static void
111 sp_spiral_init (SPSpiral * spiral)
112 {
113 spiral->cx = 0.0;
114 spiral->cy = 0.0;
115 spiral->exp = 1.0;
116 spiral->revo = 3.0;
117 spiral->rad = 1.0;
118 spiral->arg = 0.0;
119 spiral->t0 = 0.0;
120 }
122 /**
123 * Virtual build: set spiral properties from corresponding repr.
124 */
125 static void
126 sp_spiral_build (SPObject * object, SPDocument * document, Inkscape::XML::Node * repr)
127 {
128 if (((SPObjectClass *) parent_class)->build)
129 ((SPObjectClass *) parent_class)->build (object, document, repr);
131 sp_object_read_attr (object, "sodipodi:cx");
132 sp_object_read_attr (object, "sodipodi:cy");
133 sp_object_read_attr (object, "sodipodi:expansion");
134 sp_object_read_attr (object, "sodipodi:revolution");
135 sp_object_read_attr (object, "sodipodi:radius");
136 sp_object_read_attr (object, "sodipodi:argument");
137 sp_object_read_attr (object, "sodipodi:t0");
138 }
140 /**
141 * Virtual write: write spiral attributes to corresponding repr.
142 */
143 static Inkscape::XML::Node *
144 sp_spiral_write (SPObject *object, Inkscape::XML::Node *repr, guint flags)
145 {
146 SPSpiral *spiral = SP_SPIRAL (object);
148 if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
149 Inkscape::XML::Document *xml_doc = sp_document_repr_doc(SP_OBJECT_DOCUMENT(object));
150 repr = xml_doc->createElement("svg:path");
151 }
153 if (flags & SP_OBJECT_WRITE_EXT) {
154 /* Fixme: we may replace these attributes by
155 * sodipodi:spiral="cx cy exp revo rad arg t0"
156 */
157 repr->setAttribute("sodipodi:type", "spiral");
158 sp_repr_set_svg_double(repr, "sodipodi:cx", spiral->cx);
159 sp_repr_set_svg_double(repr, "sodipodi:cy", spiral->cy);
160 sp_repr_set_svg_double(repr, "sodipodi:expansion", spiral->exp);
161 sp_repr_set_svg_double(repr, "sodipodi:revolution", spiral->revo);
162 sp_repr_set_svg_double(repr, "sodipodi:radius", spiral->rad);
163 sp_repr_set_svg_double(repr, "sodipodi:argument", spiral->arg);
164 sp_repr_set_svg_double(repr, "sodipodi:t0", spiral->t0);
165 }
167 // make sure the curve is rebuilt with all up-to-date parameters
168 sp_spiral_set_shape ((SPShape *) spiral);
170 //Duplicate the path
171 SPCurve *curve = ((SPShape *) spiral)->curve;
172 //Nulls might be possible if this called iteratively
173 if ( !curve ) {
174 //g_warning("sp_spiral_write(): No path to copy\n");
175 return NULL;
176 }
177 char *d = sp_svg_write_path ( curve->get_pathvector() );
178 repr->setAttribute("d", d);
179 g_free (d);
181 if (((SPObjectClass *) (parent_class))->write)
182 ((SPObjectClass *) (parent_class))->write (object, repr, flags | SP_SHAPE_WRITE_PATH);
184 return repr;
185 }
187 /**
188 * Virtual set: change spiral object attribute.
189 */
190 static void
191 sp_spiral_set (SPObject *object, unsigned int key, const gchar *value)
192 {
193 SPSpiral *spiral;
194 SPShape *shape;
196 spiral = SP_SPIRAL (object);
197 shape = SP_SHAPE (object);
199 /// \todo fixme: we should really collect updates
200 switch (key) {
201 case SP_ATTR_SODIPODI_CX:
202 if (!sp_svg_length_read_computed_absolute (value, &spiral->cx)) {
203 spiral->cx = 0.0;
204 }
205 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
206 break;
207 case SP_ATTR_SODIPODI_CY:
208 if (!sp_svg_length_read_computed_absolute (value, &spiral->cy)) {
209 spiral->cy = 0.0;
210 }
211 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
212 break;
213 case SP_ATTR_SODIPODI_EXPANSION:
214 if (value) {
215 /** \todo
216 * FIXME: check that value looks like a (finite)
217 * number. Create a routine that uses strtod, and
218 * accepts a default value (if strtod finds an error).
219 * N.B. atof/sscanf/strtod consider "nan" and "inf"
220 * to be valid numbers.
221 */
222 spiral->exp = g_ascii_strtod (value, NULL);
223 spiral->exp = CLAMP (spiral->exp, 0.0, 1000.0);
224 } else {
225 spiral->exp = 1.0;
226 }
227 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
228 break;
229 case SP_ATTR_SODIPODI_REVOLUTION:
230 if (value) {
231 spiral->revo = g_ascii_strtod (value, NULL);
232 spiral->revo = CLAMP (spiral->revo, 0.05, 1024.0);
233 } else {
234 spiral->revo = 3.0;
235 }
236 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
237 break;
238 case SP_ATTR_SODIPODI_RADIUS:
239 if (!sp_svg_length_read_computed_absolute (value, &spiral->rad)) {
240 spiral->rad = MAX (spiral->rad, 0.001);
241 }
242 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
243 break;
244 case SP_ATTR_SODIPODI_ARGUMENT:
245 if (value) {
246 spiral->arg = g_ascii_strtod (value, NULL);
247 /** \todo
248 * FIXME: We still need some bounds on arg, for
249 * numerical reasons. E.g., we don't want inf or NaN,
250 * nor near-infinite numbers. I'm inclined to take
251 * modulo 2*pi. If so, then change the knot editors,
252 * which use atan2 - revo*2*pi, which typically
253 * results in very negative arg.
254 */
255 } else {
256 spiral->arg = 0.0;
257 }
258 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
259 break;
260 case SP_ATTR_SODIPODI_T0:
261 if (value) {
262 spiral->t0 = g_ascii_strtod (value, NULL);
263 spiral->t0 = CLAMP (spiral->t0, 0.0, 0.999);
264 /** \todo
265 * Have shared constants for the allowable bounds for
266 * attributes. There was a bug here where we used -1.0
267 * as the minimum (which leads to NaN via, e.g.,
268 * pow(-1.0, 0.5); see sp_spiral_get_xy for
269 * requirements.
270 */
271 } else {
272 spiral->t0 = 0.0;
273 }
274 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
275 break;
276 default:
277 if (((SPObjectClass *) parent_class)->set)
278 ((SPObjectClass *) parent_class)->set (object, key, value);
279 break;
280 }
281 }
283 /**
284 * Virtual update callback.
285 */
286 static void
287 sp_spiral_update (SPObject *object, SPCtx *ctx, guint flags)
288 {
289 if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG | SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
290 sp_shape_set_shape ((SPShape *) object);
291 }
293 if (((SPObjectClass *) parent_class)->update)
294 ((SPObjectClass *) parent_class)->update (object, ctx, flags);
295 }
297 static void
298 sp_spiral_update_patheffect(SPLPEItem *lpeitem, bool write)
299 {
300 SPShape *shape = (SPShape *) lpeitem;
301 sp_spiral_set_shape(shape);
303 if (write) {
304 Inkscape::XML::Node *repr = SP_OBJECT_REPR(shape);
305 if ( shape->curve != NULL ) {
306 gchar *str = sp_svg_write_path(shape->curve->get_pathvector());
307 repr->setAttribute("d", str);
308 g_free(str);
309 } else {
310 repr->setAttribute("d", NULL);
311 }
312 }
314 ((SPObject *)shape)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
315 }
317 /**
318 * Return textual description of spiral.
319 */
320 static gchar *
321 sp_spiral_description (SPItem * item)
322 {
323 // TRANSLATORS: since turn count isn't an integer, please adjust the
324 // string as needed to deal with an localized plural forms.
325 return g_strdup_printf (_("<b>Spiral</b> with %3f turns"), SP_SPIRAL(item)->revo);
326 }
329 /**
330 * Fit beziers together to spiral and draw it.
331 *
332 * \pre dstep \> 0.
333 * \pre is_unit_vector(*hat1).
334 * \post is_unit_vector(*hat2).
335 **/
336 static void
337 sp_spiral_fit_and_draw (SPSpiral const *spiral,
338 SPCurve *c,
339 double dstep,
340 NR::Point darray[],
341 NR::Point const &hat1,
342 NR::Point &hat2,
343 double *t)
344 {
345 #define BEZIER_SIZE 4
346 #define FITTING_MAX_BEZIERS 4
347 #define BEZIER_LENGTH (BEZIER_SIZE * FITTING_MAX_BEZIERS)
348 g_assert (dstep > 0);
349 g_assert (is_unit_vector (hat1));
351 NR::Point bezier[BEZIER_LENGTH];
352 double d;
353 int depth, i;
355 for (d = *t, i = 0; i <= SAMPLE_SIZE; d += dstep, i++) {
356 darray[i] = sp_spiral_get_xy(spiral, d);
358 /* Avoid useless adjacent dups. (Otherwise we can have all of darray filled with
359 the same value, which upsets chord_length_parameterize.) */
360 if ((i != 0)
361 && (darray[i] == darray[i - 1])
362 && (d < 1.0)) {
363 i--;
364 d += dstep;
365 /** We mustn't increase dstep for subsequent values of
366 * i: for large spiral.exp values, rate of growth
367 * increases very rapidly.
368 */
369 /** \todo
370 * Get the function itself to decide what value of d
371 * to use next: ensure that we move at least 0.25 *
372 * stroke width, for example. The derivative (as used
373 * for get_tangent before normalization) would be
374 * useful for estimating the appropriate d value. Or
375 * perhaps just start with a small dstep and scale by
376 * some small number until we move >= 0.25 *
377 * stroke_width. Must revert to the original dstep
378 * value for next iteration to avoid the problem
379 * mentioned above.
380 */
381 }
382 }
384 double const next_t = d - 2 * dstep;
385 /* == t + (SAMPLE_SIZE - 1) * dstep, in absence of dups. */
387 hat2 = -sp_spiral_get_tangent (spiral, next_t);
389 /** \todo
390 * We should use better algorithm to specify maximum error.
391 */
392 depth = sp_bezier_fit_cubic_full (bezier, NULL, darray, SAMPLE_SIZE,
393 hat1, hat2,
394 SPIRAL_TOLERANCE*SPIRAL_TOLERANCE,
395 FITTING_MAX_BEZIERS);
396 g_assert(depth * BEZIER_SIZE <= gint(G_N_ELEMENTS(bezier)));
397 #ifdef SPIRAL_DEBUG
398 if (*t == spiral->t0 || *t == 1.0)
399 g_print ("[%s] depth=%d, dstep=%g, t0=%g, t=%g, arg=%g\n",
400 debug_state, depth, dstep, spiral->t0, *t, spiral->arg);
401 #endif
402 if (depth != -1) {
403 for (i = 0; i < 4*depth; i += 4) {
404 c->curveto(bezier[i + 1],
405 bezier[i + 2],
406 bezier[i + 3]);
407 }
408 } else {
409 #ifdef SPIRAL_VERBOSE
410 g_print ("cant_fit_cubic: t=%g\n", *t);
411 #endif
412 for (i = 1; i < SAMPLE_SIZE; i++)
413 c->lineto(darray[i]);
414 }
415 *t = next_t;
416 g_assert (is_unit_vector (hat2));
417 }
419 static void
420 sp_spiral_set_shape (SPShape *shape)
421 {
422 NR::Point darray[SAMPLE_SIZE + 1];
423 double t;
425 SPSpiral *spiral = SP_SPIRAL(shape);
427 SP_OBJECT (spiral)->requestModified(SP_OBJECT_MODIFIED_FLAG);
429 SPCurve *c = new SPCurve ();
431 #ifdef SPIRAL_VERBOSE
432 g_print ("cx=%g, cy=%g, exp=%g, revo=%g, rad=%g, arg=%g, t0=%g\n",
433 spiral->cx,
434 spiral->cy,
435 spiral->exp,
436 spiral->revo,
437 spiral->rad,
438 spiral->arg,
439 spiral->t0);
440 #endif
442 /* Initial moveto. */
443 c->moveto(sp_spiral_get_xy(spiral, spiral->t0));
445 double const tstep = SAMPLE_STEP / spiral->revo;
446 double const dstep = tstep / (SAMPLE_SIZE - 1);
448 NR::Point hat1 = sp_spiral_get_tangent (spiral, spiral->t0);
449 NR::Point hat2;
450 for (t = spiral->t0; t < (1.0 - tstep);) {
451 sp_spiral_fit_and_draw (spiral, c, dstep, darray, hat1, hat2, &t);
453 hat1 = -hat2;
454 }
455 if ((1.0 - t) > SP_EPSILON)
456 sp_spiral_fit_and_draw (spiral, c, (1.0 - t)/(SAMPLE_SIZE - 1.0),
457 darray, hat1, hat2, &t);
459 sp_lpe_item_perform_path_effect(SP_LPE_ITEM (spiral), c);
460 sp_shape_set_curve_insync ((SPShape *) spiral, c, TRUE);
461 c->unref();
462 }
464 /**
465 * Set spiral properties and update display.
466 */
467 void
468 sp_spiral_position_set (SPSpiral *spiral,
469 gdouble cx,
470 gdouble cy,
471 gdouble exp,
472 gdouble revo,
473 gdouble rad,
474 gdouble arg,
475 gdouble t0)
476 {
477 g_return_if_fail (spiral != NULL);
478 g_return_if_fail (SP_IS_SPIRAL (spiral));
480 /** \todo
481 * Consider applying CLAMP or adding in-bounds assertions for
482 * some of these parameters.
483 */
484 spiral->cx = cx;
485 spiral->cy = cy;
486 spiral->exp = exp;
487 spiral->revo = revo;
488 spiral->rad = MAX (rad, 0.001);
489 spiral->arg = arg;
490 spiral->t0 = CLAMP(t0, 0.0, 0.999);
492 ((SPObject *)spiral)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
493 }
495 /**
496 * Virtual snappoints callback.
497 */
498 static void sp_spiral_snappoints(SPItem const *item, SnapPointsIter p)
499 {
500 if (((SPItemClass *) parent_class)->snappoints) {
501 ((SPItemClass *) parent_class)->snappoints (item, p);
502 }
503 }
505 /**
506 * Return one of the points on the spiral.
507 *
508 * \param t specifies how far along the spiral.
509 * \pre \a t in [0.0, 2.03]. (It doesn't make sense for t to be much more
510 * than 1.0, though some callers go slightly beyond 1.0 for curve-fitting
511 * purposes.)
512 */
513 NR::Point sp_spiral_get_xy (SPSpiral const *spiral, gdouble t)
514 {
515 g_assert (spiral != NULL);
516 g_assert (SP_IS_SPIRAL(spiral));
517 g_assert (spiral->exp >= 0.0);
518 /* Otherwise we get NaN for t==0. */
519 g_assert (spiral->exp <= 1000.0);
520 /* Anything much more results in infinities. Even allowing 1000 is somewhat overkill. */
521 g_assert (t >= 0.0);
522 /* Any callers passing -ve t will have a bug for non-integral values of exp. */
524 double const rad = spiral->rad * pow(t, (double) spiral->exp);
525 double const arg = 2.0 * M_PI * spiral->revo * t + spiral->arg;
527 return NR::Point(rad * cos (arg) + spiral->cx,
528 rad * sin (arg) + spiral->cy);
529 }
532 /**
533 * Returns the derivative of sp_spiral_get_xy with respect to t,
534 * scaled to a unit vector.
535 *
536 * \pre spiral != 0.
537 * \pre 0 \<= t.
538 * \pre p != NULL.
539 * \post is_unit_vector(*p).
540 */
541 static NR::Point
542 sp_spiral_get_tangent (SPSpiral const *spiral, gdouble t)
543 {
544 NR::Point ret(1.0, 0.0);
545 g_return_val_if_fail (( ( spiral != NULL )
546 && SP_IS_SPIRAL(spiral) ),
547 ret);
548 g_assert (t >= 0.0);
549 g_assert (spiral->exp >= 0.0);
550 /* See above for comments on these assertions. */
552 double const t_scaled = 2.0 * M_PI * spiral->revo * t;
553 double const arg = t_scaled + spiral->arg;
554 double const s = sin (arg);
555 double const c = cos (arg);
557 if (spiral->exp == 0.0) {
558 ret = NR::Point(-s, c);
559 } else if (t_scaled == 0.0) {
560 ret = NR::Point(c, s);
561 } else {
562 NR::Point unrotated(spiral->exp, t_scaled);
563 double const s_len = L2 (unrotated);
564 g_assert (s_len != 0);
565 /** \todo
566 * Check that this isn't being too hopeful of the hypot
567 * function. E.g. test with numbers around 2**-1070
568 * (denormalized numbers), preferably on a few different
569 * platforms. However, njh says that the usual implementation
570 * does handle both very big and very small numbers.
571 */
572 unrotated /= s_len;
574 /* ret = spiral->exp * (c, s) + t_scaled * (-s, c);
575 alternatively ret = (spiral->exp, t_scaled) * (( c, s),
576 (-s, c)).*/
577 ret = NR::Point(dot(unrotated, NR::Point(c, -s)),
578 dot(unrotated, NR::Point(s, c)));
579 /* ret should already be approximately normalized: the
580 matrix ((c, -s), (s, c)) is orthogonal (it just
581 rotates by arg), and unrotated has been normalized,
582 so ret is already of unit length other than numerical
583 error in the above matrix multiplication. */
585 /** \todo
586 * I haven't checked how important it is for ret to be very
587 * near unit length; we could get rid of the below.
588 */
590 ret.normalize();
591 /* Proof that ret length is non-zero: see above. (Should be near 1.) */
592 }
594 g_assert (is_unit_vector (ret));
595 return ret;
596 }
598 /**
599 * Compute rad and/or arg for point on spiral.
600 */
601 void
602 sp_spiral_get_polar (SPSpiral const *spiral, gdouble t, gdouble *rad, gdouble *arg)
603 {
604 g_return_if_fail (spiral != NULL);
605 g_return_if_fail (SP_IS_SPIRAL(spiral));
607 if (rad)
608 *rad = spiral->rad * pow(t, (double) spiral->exp);
609 if (arg)
610 *arg = 2.0 * M_PI * spiral->revo * t + spiral->arg;
611 }
613 /**
614 * Return true if spiral has properties that make it invalid.
615 */
616 bool
617 sp_spiral_is_invalid (SPSpiral const *spiral)
618 {
619 gdouble rad;
621 sp_spiral_get_polar (spiral, 0.0, &rad, NULL);
622 if (rad < 0.0 || rad > SP_HUGE) {
623 g_print ("rad(t=0)=%g\n", rad);
624 return TRUE;
625 }
626 sp_spiral_get_polar (spiral, 1.0, &rad, NULL);
627 if (rad < 0.0 || rad > SP_HUGE) {
628 g_print ("rad(t=1)=%g\n", rad);
629 return TRUE;
630 }
631 return FALSE;
632 }
634 /*
635 Local Variables:
636 mode:c++
637 c-file-style:"stroustrup"
638 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
639 indent-tabs-mode:nil
640 fill-column:99
641 End:
642 */
643 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :