src/sp-spiral.cpp

   1 #define __SP_SPIRAL_C__
   2
   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  */
  16
  17 #include "config.h"
  18
  19
  20 #include "svg/svg.h"
  21 #include "attributes.h"
  22 #include <2geom/bezier-utils.h>
  23 #include "display/curve.h"
  24 #include <glibmm/i18n.h>
  25 #include "xml/repr.h"
  26 #include "document.h"
  27
  28 #include "sp-spiral.h"
  29
  30 static void sp_spiral_class_init (SPSpiralClass *klass);
  31 static void sp_spiral_init (SPSpiral *spiral);
  32
  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::Document *doc, 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);
  37
  38 static gchar * sp_spiral_description (SPItem * item);
  39 static void sp_spiral_snappoints(SPItem const *item, bool const target, SnapPointsWithType &p, Inkscape::SnapPreferences const *snapprefs);
  40
  41 static void sp_spiral_set_shape (SPShape *shape);
  42 static void sp_spiral_update_patheffect (SPLPEItem *lpeitem, bool write);
  43
  44 static Geom::Point sp_spiral_get_tangent (SPSpiral const *spiral, gdouble t);
  45
  46 static SPShapeClass *parent_class;
  47
  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;
  55
  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 }
  73
  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;
  85
  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;
  91
  92         parent_class = (SPShapeClass *)g_type_class_ref (SP_TYPE_SHAPE);
  93
  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;
  98
  99         item_class->description = sp_spiral_description;
 100         item_class->snappoints = sp_spiral_snappoints;
 101
 102     lpe_item_class->update_patheffect = sp_spiral_update_patheffect;
 103
 104     shape_class->set_shape = sp_spiral_set_shape;
 105 }
 106
 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 }
 121
 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);
 130
 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 }
 139
 140 /**
 141  * Virtual write: write spiral attributes to corresponding repr.
 142  */
 143 static Inkscape::XML::Node *
 144 sp_spiral_write (SPObject *object, Inkscape::XML::Document *xml_doc, Inkscape::XML::Node *repr, guint flags)
 145 {
 146         SPSpiral *spiral = SP_SPIRAL (object);
 147
 148         if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
 149                 repr = xml_doc->createElement("svg:path");
 150         }
 151
 152         if (flags & SP_OBJECT_WRITE_EXT) {
 153                 /* Fixme: we may replace these attributes by
 154                  * sodipodi:spiral="cx cy exp revo rad arg t0"
 155                  */
 156                 repr->setAttribute("sodipodi:type", "spiral");
 157                 sp_repr_set_svg_double(repr, "sodipodi:cx", spiral->cx);
 158                 sp_repr_set_svg_double(repr, "sodipodi:cy", spiral->cy);
 159                 sp_repr_set_svg_double(repr, "sodipodi:expansion", spiral->exp);
 160                 sp_repr_set_svg_double(repr, "sodipodi:revolution", spiral->revo);
 161                 sp_repr_set_svg_double(repr, "sodipodi:radius", spiral->rad);
 162                 sp_repr_set_svg_double(repr, "sodipodi:argument", spiral->arg);
 163                 sp_repr_set_svg_double(repr, "sodipodi:t0", spiral->t0);
 164         }
 165
 166      // make sure the curve is rebuilt with all up-to-date parameters
 167      sp_spiral_set_shape ((SPShape *) spiral);
 168
 169     //Duplicate the path
 170     SPCurve *curve = ((SPShape *) spiral)->curve;
 171     //Nulls might be possible if this called iteratively
 172     if ( !curve ) {
 173             //g_warning("sp_spiral_write(): No path to copy\n");
 174             return NULL;
 175     }
 176     char *d = sp_svg_write_path ( curve->get_pathvector() );
 177     repr->setAttribute("d", d);
 178     g_free (d);
 179
 180     if (((SPObjectClass *) (parent_class))->write)
 181         ((SPObjectClass *) (parent_class))->write (object, xml_doc, repr, flags | SP_SHAPE_WRITE_PATH);
 182
 183     return repr;
 184 }
 185
 186 /**
 187  * Virtual set: change spiral object attribute.
 188  */
 189 static void
 190 sp_spiral_set (SPObject *object, unsigned int key, const gchar *value)
 191 {
 192         SPSpiral *spiral;
 193         SPShape  *shape;
 194
 195         spiral = SP_SPIRAL (object);
 196         shape  = SP_SHAPE (object);
 197
 198         /// \todo fixme: we should really collect updates
 199         switch (key) {
 200         case SP_ATTR_SODIPODI_CX:
 201                 if (!sp_svg_length_read_computed_absolute (value, &spiral->cx)) {
 202                         spiral->cx = 0.0;
 203                 }
 204                 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 205                 break;
 206         case SP_ATTR_SODIPODI_CY:
 207                 if (!sp_svg_length_read_computed_absolute (value, &spiral->cy)) {
 208                         spiral->cy = 0.0;
 209                 }
 210                 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 211                 break;
 212         case SP_ATTR_SODIPODI_EXPANSION:
 213                 if (value) {
 214                         /** \todo
 215                          * FIXME: check that value looks like a (finite)
 216                          * number. Create a routine that uses strtod, and
 217                          * accepts a default value (if strtod finds an error).
 218                          * N.B. atof/sscanf/strtod consider "nan" and "inf"
 219                          * to be valid numbers.
 220                          */
 221                         spiral->exp = g_ascii_strtod (value, NULL);
 222                         spiral->exp = CLAMP (spiral->exp, 0.0, 1000.0);
 223                 } else {
 224                         spiral->exp = 1.0;
 225                 }
 226                 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 227                 break;
 228         case SP_ATTR_SODIPODI_REVOLUTION:
 229                 if (value) {
 230                         spiral->revo = g_ascii_strtod (value, NULL);
 231                         spiral->revo = CLAMP (spiral->revo, 0.05, 1024.0);
 232                 } else {
 233                         spiral->revo = 3.0;
 234                 }
 235                 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 236                 break;
 237         case SP_ATTR_SODIPODI_RADIUS:
 238                 if (!sp_svg_length_read_computed_absolute (value, &spiral->rad)) {
 239                         spiral->rad = MAX (spiral->rad, 0.001);
 240                 }
 241                 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 242                 break;
 243         case SP_ATTR_SODIPODI_ARGUMENT:
 244                 if (value) {
 245                         spiral->arg = g_ascii_strtod (value, NULL);
 246                         /** \todo
 247                          * FIXME: We still need some bounds on arg, for
 248                          * numerical reasons. E.g., we don't want inf or NaN,
 249                          * nor near-infinite numbers. I'm inclined to take
 250                          * modulo 2*pi.  If so, then change the knot editors,
 251                          * which use atan2 - revo*2*pi, which typically
 252                          * results in very negative arg.
 253                          */
 254                 } else {
 255                         spiral->arg = 0.0;
 256                 }
 257                 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 258                 break;
 259         case SP_ATTR_SODIPODI_T0:
 260                 if (value) {
 261                         spiral->t0 = g_ascii_strtod (value, NULL);
 262                         spiral->t0 = CLAMP (spiral->t0, 0.0, 0.999);
 263                         /** \todo
 264                          * Have shared constants for the allowable bounds for
 265                          * attributes. There was a bug here where we used -1.0
 266                          * as the minimum (which leads to NaN via, e.g.,
 267                          * pow(-1.0, 0.5); see sp_spiral_get_xy for
 268                          * requirements.
 269                          */
 270                 } else {
 271                         spiral->t0 = 0.0;
 272                 }
 273                 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 274                 break;
 275         default:
 276                 if (((SPObjectClass *) parent_class)->set)
 277                         ((SPObjectClass *) parent_class)->set (object, key, value);
 278                 break;
 279         }
 280 }
 281
 282 /**
 283  * Virtual update callback.
 284  */
 285 static void
 286 sp_spiral_update (SPObject *object, SPCtx *ctx, guint flags)
 287 {
 288         if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG | SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
 289                 sp_shape_set_shape ((SPShape *) object);
 290         }
 291
 292         if (((SPObjectClass *) parent_class)->update)
 293                 ((SPObjectClass *) parent_class)->update (object, ctx, flags);
 294 }
 295
 296 static void
 297 sp_spiral_update_patheffect(SPLPEItem *lpeitem, bool write)
 298 {
 299     SPShape *shape = (SPShape *) lpeitem;
 300     sp_spiral_set_shape(shape);
 301
 302     if (write) {
 303         Inkscape::XML::Node *repr = SP_OBJECT_REPR(shape);
 304         if ( shape->curve != NULL ) {
 305             gchar *str = sp_svg_write_path(shape->curve->get_pathvector());
 306             repr->setAttribute("d", str);
 307             g_free(str);
 308         } else {
 309             repr->setAttribute("d", NULL);
 310         }
 311     }
 312
 313     ((SPObject *)shape)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 314 }
 315
 316 /**
 317  * Return textual description of spiral.
 318  */
 319 static gchar *
 320 sp_spiral_description (SPItem * item)
 321 {
 322         // TRANSLATORS: since turn count isn't an integer, please adjust the
 323         // string as needed to deal with an localized plural forms.
 324         return g_strdup_printf (_("<b>Spiral</b> with %3f turns"), SP_SPIRAL(item)->revo);
 325 }
 326
 327
 328 /**
 329  * Fit beziers together to spiral and draw it.
 330  *
 331  * \pre dstep \> 0.
 332  * \pre is_unit_vector(*hat1).
 333  * \post is_unit_vector(*hat2).
 334  **/
 335 static void
 336 sp_spiral_fit_and_draw (SPSpiral const *spiral,
 337                         SPCurve  *c,
 338                         double dstep,
 339                         Geom::Point darray[],
 340                         Geom::Point const &hat1,
 341                         Geom::Point &hat2,
 342                         double *t)
 343 {
 344 #define BEZIER_SIZE   4
 345 #define FITTING_MAX_BEZIERS 4
 346 #define BEZIER_LENGTH (BEZIER_SIZE * FITTING_MAX_BEZIERS)
 347         g_assert (dstep > 0);
 348         g_assert (is_unit_vector (hat1));
 349
 350         Geom::Point bezier[BEZIER_LENGTH];
 351         double d;
 352         int depth, i;
 353
 354         for (d = *t, i = 0; i <= SAMPLE_SIZE; d += dstep, i++) {
 355                 darray[i] = sp_spiral_get_xy(spiral, d);
 356
 357                 /* Avoid useless adjacent dups.  (Otherwise we can have all of darray filled with
 358                    the same value, which upsets chord_length_parameterize.) */
 359                 if ((i != 0)
 360                     && (darray[i] == darray[i - 1])
 361                     && (d < 1.0)) {
 362                         i--;
 363                         d += dstep;
 364                         /** We mustn't increase dstep for subsequent values of
 365                          * i: for large spiral.exp values, rate of growth
 366                          * increases very rapidly.
 367                          */
 368                         /** \todo
 369                          * Get the function itself to decide what value of d
 370                          * to use next: ensure that we move at least 0.25 *
 371                          * stroke width, for example.  The derivative (as used
 372                          * for get_tangent before normalization) would be
 373                          * useful for estimating the appropriate d value.  Or
 374                          * perhaps just start with a small dstep and scale by
 375                          * some small number until we move >= 0.25 *
 376                          * stroke_width.  Must revert to the original dstep
 377                          * value for next iteration to avoid the problem
 378                          * mentioned above.
 379                          */
 380                 }
 381         }
 382
 383         double const next_t = d - 2 * dstep;
 384         /* == t + (SAMPLE_SIZE - 1) * dstep, in absence of dups. */
 385
 386         hat2 = -sp_spiral_get_tangent (spiral, next_t);
 387
 388         /** \todo
 389          * We should use better algorithm to specify maximum error.
 390          */
 391         depth = Geom::bezier_fit_cubic_full (bezier, NULL, darray, SAMPLE_SIZE,
 392                                           hat1, hat2,
 393                                           SPIRAL_TOLERANCE*SPIRAL_TOLERANCE,
 394                                           FITTING_MAX_BEZIERS);
 395         g_assert(depth * BEZIER_SIZE <= gint(G_N_ELEMENTS(bezier)));
 396 #ifdef SPIRAL_DEBUG
 397         if (*t == spiral->t0 || *t == 1.0)
 398                 g_print ("[%s] depth=%d, dstep=%g, t0=%g, t=%g, arg=%g\n",
 399                          debug_state, depth, dstep, spiral->t0, *t, spiral->arg);
 400 #endif
 401         if (depth != -1) {
 402                 for (i = 0; i < 4*depth; i += 4) {
 403                         c->curveto(bezier[i + 1],
 404                                           bezier[i + 2],
 405                                           bezier[i + 3]);
 406                 }
 407         } else {
 408 #ifdef SPIRAL_VERBOSE
 409                 g_print ("cant_fit_cubic: t=%g\n", *t);
 410 #endif
 411                 for (i = 1; i < SAMPLE_SIZE; i++)
 412                         c->lineto(darray[i]);
 413         }
 414         *t = next_t;
 415         g_assert (is_unit_vector (hat2));
 416 }
 417
 418 static void
 419 sp_spiral_set_shape (SPShape *shape)
 420 {
 421         Geom::Point darray[SAMPLE_SIZE + 1];
 422         double t;
 423
 424         SPSpiral *spiral = SP_SPIRAL(shape);
 425
 426         SP_OBJECT (spiral)->requestModified(SP_OBJECT_MODIFIED_FLAG);
 427
 428         SPCurve *c = new SPCurve ();
 429
 430 #ifdef SPIRAL_VERBOSE
 431         g_print ("cx=%g, cy=%g, exp=%g, revo=%g, rad=%g, arg=%g, t0=%g\n",
 432                  spiral->cx,
 433                  spiral->cy,
 434                  spiral->exp,
 435                  spiral->revo,
 436                  spiral->rad,
 437                  spiral->arg,
 438                  spiral->t0);
 439 #endif
 440
 441         /* Initial moveto. */
 442         c->moveto(sp_spiral_get_xy(spiral, spiral->t0));
 443
 444         double const tstep = SAMPLE_STEP / spiral->revo;
 445         double const dstep = tstep / (SAMPLE_SIZE - 1);
 446
 447         Geom::Point hat1 = sp_spiral_get_tangent (spiral, spiral->t0);
 448         Geom::Point hat2;
 449         for (t = spiral->t0; t < (1.0 - tstep);) {
 450                 sp_spiral_fit_and_draw (spiral, c, dstep, darray, hat1, hat2, &t);
 451
 452                 hat1 = -hat2;
 453         }
 454         if ((1.0 - t) > SP_EPSILON)
 455                 sp_spiral_fit_and_draw (spiral, c, (1.0 - t)/(SAMPLE_SIZE - 1.0),
 456                                         darray, hat1, hat2, &t);
 457
 458     /* Reset the shape'scurve to the "original_curve"
 459      * This is very important for LPEs to work properly! (the bbox might be recalculated depending on the curve in shape)*/
 460     sp_shape_set_curve_insync (shape, c, TRUE);
 461     if (sp_lpe_item_has_path_effect(SP_LPE_ITEM(shape)) && sp_lpe_item_path_effects_enabled(SP_LPE_ITEM(shape))) {
 462         SPCurve *c_lpe = c->copy();
 463         bool success = sp_lpe_item_perform_path_effect(SP_LPE_ITEM (shape), c_lpe);
 464         if (success) {
 465             sp_shape_set_curve_insync (shape, c_lpe, TRUE);
 466         }
 467         c_lpe->unref();
 468     }
 469     c->unref();
 470 }
 471
 472 /**
 473  * Set spiral properties and update display.
 474  */
 475 void
 476 sp_spiral_position_set       (SPSpiral          *spiral,
 477                      gdouble            cx,
 478                      gdouble            cy,
 479                      gdouble            exp,
 480                      gdouble            revo,
 481                      gdouble            rad,
 482                      gdouble            arg,
 483                      gdouble            t0)
 484 {
 485         g_return_if_fail (spiral != NULL);
 486         g_return_if_fail (SP_IS_SPIRAL (spiral));
 487
 488         /** \todo
 489          * Consider applying CLAMP or adding in-bounds assertions for
 490          * some of these parameters.
 491          */
 492         spiral->cx         = cx;
 493         spiral->cy         = cy;
 494         spiral->exp        = exp;
 495         spiral->revo       = revo;
 496         spiral->rad        = MAX (rad, 0.0);
 497         spiral->arg        = arg;
 498         spiral->t0         = CLAMP(t0, 0.0, 0.999);
 499
 500         ((SPObject *)spiral)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 501 }
 502
 503 /**
 504  * Virtual snappoints callback.
 505  */
 506 static void sp_spiral_snappoints(SPItem const *item, bool const target, SnapPointsWithType &p, Inkscape::SnapPreferences const *snapprefs)
 507 {
 508         // We will determine the spiral's midpoint ourselves, instead of trusting on the base class
 509         // Therefore setSnapObjectMidpoints() is set to false temporarily
 510         Inkscape::SnapPreferences local_snapprefs = *snapprefs;
 511         local_snapprefs.setSnapObjectMidpoints(false);
 512
 513         if (((SPItemClass *) parent_class)->snappoints) {
 514                 ((SPItemClass *) parent_class)->snappoints (item, target, p, &local_snapprefs);
 515         }
 516
 517         // Help enforcing strict snapping, i.e. only return nodes when we're snapping nodes to nodes or a guide to nodes
 518         if (!(snapprefs->getSnapModeNode() || snapprefs->getSnapModeGuide())) {
 519                 return;
 520         }
 521
 522         if (snapprefs->getSnapObjectMidpoints()) {
 523                 Geom::Matrix const i2d (sp_item_i2d_affine (item));
 524                 SPSpiral *spiral = SP_SPIRAL(item);
 525                 int type = target ? int(Inkscape::SNAPTARGET_OBJECT_MIDPOINT) : int(Inkscape::SNAPSOURCE_OBJECT_MIDPOINT);
 526                 p.push_back(std::make_pair(Geom::Point(spiral->cx, spiral->cy) * i2d, type));
 527                 // This point is the start-point of the spiral, which is also returned when _snap_to_itemnode has been set
 528                 // in the object snapper. In that case we will get a duplicate!
 529         }
 530 }
 531
 532 /**
 533  * Return one of the points on the spiral.
 534  *
 535  * \param t specifies how far along the spiral.
 536  * \pre \a t in [0.0, 2.03].  (It doesn't make sense for t to be much more
 537  * than 1.0, though some callers go slightly beyond 1.0 for curve-fitting
 538  * purposes.)
 539  */
 540 Geom::Point sp_spiral_get_xy (SPSpiral const *spiral, gdouble t)
 541 {
 542         g_assert (spiral != NULL);
 543         g_assert (SP_IS_SPIRAL(spiral));
 544         g_assert (spiral->exp >= 0.0);
 545         /* Otherwise we get NaN for t==0. */
 546         g_assert (spiral->exp <= 1000.0);
 547         /* Anything much more results in infinities.  Even allowing 1000 is somewhat overkill. */
 548         g_assert (t >= 0.0);
 549         /* Any callers passing -ve t will have a bug for non-integral values of exp. */
 550
 551         double const rad = spiral->rad * pow(t, (double) spiral->exp);
 552         double const arg = 2.0 * M_PI * spiral->revo * t + spiral->arg;
 553
 554         return Geom::Point(rad * cos (arg) + spiral->cx,
 555                            rad * sin (arg) + spiral->cy);
 556 }
 557
 558
 559 /**
 560  * Returns the derivative of sp_spiral_get_xy with respect to t,
 561  *  scaled to a unit vector.
 562  *
 563  *  \pre spiral != 0.
 564  *  \pre 0 \<= t.
 565  *  \pre p != NULL.
 566  *  \post is_unit_vector(*p).
 567  */
 568 static Geom::Point
 569 sp_spiral_get_tangent (SPSpiral const *spiral, gdouble t)
 570 {
 571         Geom::Point ret(1.0, 0.0);
 572         g_return_val_if_fail (( ( spiral != NULL )
 573                                 && SP_IS_SPIRAL(spiral) ),
 574                               ret);
 575         g_assert (t >= 0.0);
 576         g_assert (spiral->exp >= 0.0);
 577         /* See above for comments on these assertions. */
 578
 579         double const t_scaled = 2.0 * M_PI * spiral->revo * t;
 580         double const arg = t_scaled + spiral->arg;
 581         double const s = sin (arg);
 582         double const c = cos (arg);
 583
 584         if (spiral->exp == 0.0) {
 585                 ret = Geom::Point(-s, c);
 586         } else if (t_scaled == 0.0) {
 587                 ret = Geom::Point(c, s);
 588         } else {
 589                 Geom::Point unrotated(spiral->exp, t_scaled);
 590                 double const s_len = L2 (unrotated);
 591                 g_assert (s_len != 0);
 592                 /** \todo
 593                  * Check that this isn't being too hopeful of the hypot
 594                  * function.  E.g. test with numbers around 2**-1070
 595                  * (denormalized numbers), preferably on a few different
 596                  * platforms.  However, njh says that the usual implementation
 597                  * does handle both very big and very small numbers.
 598                  */
 599                 unrotated /= s_len;
 600
 601                 /* ret = spiral->exp * (c, s) + t_scaled * (-s, c);
 602                    alternatively ret = (spiral->exp, t_scaled) * (( c, s),
 603                                                                   (-s, c)).*/
 604                 ret = Geom::Point(dot(unrotated, Geom::Point(c, -s)),
 605                                   dot(unrotated, Geom::Point(s, c)));
 606                 /* ret should already be approximately normalized: the
 607                    matrix ((c, -s), (s, c)) is orthogonal (it just
 608                    rotates by arg), and unrotated has been normalized,
 609                    so ret is already of unit length other than numerical
 610                    error in the above matrix multiplication. */
 611
 612                 /** \todo
 613                  * I haven't checked how important it is for ret to be very
 614                  * near unit length; we could get rid of the below.
 615                  */
 616
 617                 ret.normalize();
 618                 /* Proof that ret length is non-zero: see above.  (Should be near 1.) */
 619         }
 620
 621         g_assert (is_unit_vector (ret));
 622         return ret;
 623 }
 624
 625 /**
 626  * Compute rad and/or arg for point on spiral.
 627  */
 628 void
 629 sp_spiral_get_polar (SPSpiral const *spiral, gdouble t, gdouble *rad, gdouble *arg)
 630 {
 631         g_return_if_fail (spiral != NULL);
 632         g_return_if_fail (SP_IS_SPIRAL(spiral));
 633
 634         if (rad)
 635                 *rad = spiral->rad * pow(t, (double) spiral->exp);
 636         if (arg)
 637                 *arg = 2.0 * M_PI * spiral->revo * t + spiral->arg;
 638 }
 639
 640 /**
 641  * Return true if spiral has properties that make it invalid.
 642  */
 643 bool
 644 sp_spiral_is_invalid (SPSpiral const *spiral)
 645 {
 646         gdouble rad;
 647
 648         sp_spiral_get_polar (spiral, 0.0, &rad, NULL);
 649         if (rad < 0.0 || rad > SP_HUGE) {
 650                 g_print ("rad(t=0)=%g\n", rad);
 651                 return TRUE;
 652         }
 653         sp_spiral_get_polar (spiral, 1.0, &rad, NULL);
 654         if (rad < 0.0 || rad > SP_HUGE) {
 655                 g_print ("rad(t=1)=%g\n", rad);
 656                 return TRUE;
 657         }
 658         return FALSE;
 659 }
 660
 661 /*
 662   Local Variables:
 663   mode:c++
 664   c-file-style:"stroustrup"
 665   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 666   indent-tabs-mode:nil
 667   fill-column:99
 668   End:
 669 */
 670 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :