2 lookup.cc -- implement simple Lookup methods.
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
8 Jan Nieuwenhuizen <janneke@gnu.org>
16 #include "line-interface.hh"
18 #include "dimensions.hh"
20 #include "string-convert.hh"
21 #include "file-path.hh"
23 #include "lily-guile.hh"
24 #include "font-metric.hh"
27 Lookup::dot (Offset p, Real radius)
29 SCM at = (scm_list_n (ly_symbol2scm ("dot"),
30 scm_make_real (p[X_AXIS]),
31 scm_make_real (p[Y_AXIS]),
32 scm_make_real (radius),
35 box.add_point (p - Offset (radius, radius));
36 box.add_point (p + Offset (radius, radius));
37 return Stencil (box, at);
50 * (0, 0)x /slope = dy/dx
58 Lookup::beam (Real slope, Real width, Real thick, Real blot)
60 Real height = slope * width;
61 Real min_y = min (0., height) - thick / 2;
62 Real max_y = max (0., height) + thick / 2;
64 Box b (Interval (0, width),
65 Interval (min_y, max_y));
67 SCM at = scm_list_n (ly_symbol2scm ("beam"),
68 scm_make_real (width),
69 scm_make_real (slope),
70 scm_make_real (thick),
73 return Stencil (b, at);
77 Lookup::dashed_slur (Bezier b, Real thick, Real dash_period, Real dash_fraction)
81 Real on = dash_fraction * dash_period;
82 Real off = dash_period - on;
86 l = scm_cons (ly_offset2scm (b.control_[i]), l);
89 SCM at = (scm_list_n (ly_symbol2scm ("dashed-slur"),
90 scm_make_real (thick),
96 Box box (Interval (0, 0), Interval (0, 0));
97 return Stencil (box, at);
101 Lookup::horizontal_line (Interval w, Real th)
103 SCM at = scm_list_n (ly_symbol2scm ("draw-line"),
105 scm_make_real (w[LEFT]),
107 scm_make_real (w[RIGHT]),
113 box[Y_AXIS] = Interval (-th / 2, th / 2);
115 return Stencil (box, at);
119 Lookup::blank (Box b)
121 return Stencil (b, scm_makfrom0str (""));
125 Lookup::filled_box (Box b)
127 return round_filled_box (b, 0.0);
133 * __________________________________
138 * |\ _ _ / v \ _ _ /| |
141 * | <------>| | extent
142 * | blot | | (Y_AXIS)
150 * x\_____/______________\_____/|_____v
154 * |<-------------------------->|
155 * Box extent (X_AXIS)
158 Lookup::round_filled_box (Box b, Real blotdiameter)
160 if (b.x ().length () < blotdiameter)
162 blotdiameter = b.x ().length ();
164 if (b.y ().length () < blotdiameter)
166 blotdiameter = b.y ().length ();
169 SCM at = (scm_list_n (ly_symbol2scm ("round-filled-box"),
170 scm_make_real (-b[X_AXIS][LEFT]),
171 scm_make_real (b[X_AXIS][RIGHT]),
172 scm_make_real (-b[Y_AXIS][DOWN]),
173 scm_make_real (b[Y_AXIS][UP]),
174 scm_make_real (blotdiameter),
177 return Stencil (b, at);
181 * Create Stencil that represents a filled polygon with round edges.
185 * (a) Only outer (convex) edges are rounded.
187 * (b) This algorithm works as expected only for polygons whose edges
188 * do not intersect. For example, the polygon ((0, 0), (q, 0), (0,
189 * q), (q, q)) has an intersection at point (q/2, q/2) and therefore
190 * will give a strange result. Even non-adjacent edges that just
191 * touch each other will in general not work as expected for non-null
194 * (c) Given a polygon ((x0, y0), (x1, y1), ... , (x (n-1), y (n-1))),
195 * if there is a natural number k such that blotdiameter is greater
196 * than the maximum of { | (x (k mod n), y (k mod n)) - (x ((k+1) mod n),
197 * y ((k+1) mod n)) |, | (x (k mod n), y (k mod n)) - (x ((k+2) mod n),
198 * y ((k+2) mod n)) |, | (x ((k+1) mod n), y ((k+1) mod n)) - (x ((k+2)
199 * mod n), y ((k+2) mod n)) | }, then the outline of the rounded
200 * polygon will exceed the outline of the core polygon. In other
201 * words: Do not draw rounded polygons that have a leg smaller or
202 * thinner than blotdiameter (or set blotdiameter to a sufficiently
203 * small value -- maybe even 0.0)!
205 * NOTE: Limitations (b) and (c) arise from the fact that round edges
206 * are made by moulding sharp edges to round ones rather than adding
207 * to a core filled polygon. For details of these two different
208 * approaches, see the thread upon the ledger lines patch that started
209 * on March 25, 2002 on the devel mailing list. The below version of
210 * round_filled_polygon () sticks to the moulding model, which the
211 * majority of the list participants finally voted for. This,
212 * however, results in the above limitations and a much increased
213 * complexity of the algorithm, since it has to compute a shrinked
214 * polygon -- which is not trivial define precisely and unambigously.
215 * With the other approach, one simply could move a circle of size
216 * blotdiameter along all edges of the polygon (which is what the
217 * postscript routine in the backend effectively does, but on the
218 * shrinked polygon). --jr
221 Lookup::round_filled_polygon (Array<Offset> points, Real blotdiameter)
223 /* TODO: Maybe print a warning if one of the above limitations
224 applies to the given polygon. However, this is quite complicated
227 /* remove consecutive duplicate points */
228 const Real epsilon = 0.01;
229 for (int i = 0; i < points.size ();)
231 int next_i = (i + 1) % points.size ();
232 Real d = (points[i] - points[next_i]).length ();
239 /* special cases: degenerated polygons */
240 if (points.size () == 0)
242 if (points.size () == 1)
243 return dot (points[0], 0.5 * blotdiameter);
244 if (points.size () == 2)
245 return Line_interface::make_line (blotdiameter, points[0], points[1]);
247 /* shrink polygon in size by 0.5 * blotdiameter */
248 Array<Offset> shrinked_points;
249 shrinked_points.set_size (points.size ());
250 bool ccw = 1; // true, if three adjacent points are counterclockwise ordered
251 for (int i = 0; i < points.size (); i++)
254 int i1 = (i + 1) % points.size ();
255 int i2 = (i + 2) % points.size ();
256 Offset p0 = points[i0];
257 Offset p1 = points[i1];
258 Offset p2 = points[i2];
259 Offset p10 = p0 - p1;
260 Offset p12 = p2 - p1;
261 if (p10.length () != 0.0)
263 Real phi = p10.arg ();
264 // rotate (p2 - p0) by (-phi)
265 Offset q = complex_multiply (p2 - p0, complex_exp (Offset (1.0, -phi)));
269 else if (q[Y_AXIS] < 0)
271 else {} // keep ccw unchanged
273 else {} // keep ccw unchanged
274 Offset p10n = (1.0 / p10.length ()) * p10; // normalize length to 1.0
275 Offset p12n = (1.0 / p12.length ()) * p12;
276 Offset p13n = 0.5 * (p10n + p12n);
277 Offset p14n = 0.5 * (p10n - p12n);
279 Real d = p13n.length () * p14n.length (); // distance p3n to line (p1..p0)
281 // special case: p0, p1, p2 are on a single line => build
282 // vector orthogonal to (p2-p0) of length 0.5 blotdiameter
284 p13[X_AXIS] = p10[Y_AXIS];
285 p13[Y_AXIS] = -p10[X_AXIS];
286 p13 = (0.5 * blotdiameter / p13.length ()) * p13;
289 p13 = (0.5 * blotdiameter / d) * p13n;
290 shrinked_points[i1] = p1 + ((ccw) ? p13 : -p13);
293 /* build scm expression and bounding box */
294 SCM shrinked_points_scm = SCM_EOL;
296 for (int i = 0; i < shrinked_points.size (); i++)
298 SCM x = scm_make_real (shrinked_points[i][X_AXIS]);
299 SCM y = scm_make_real (shrinked_points[i][Y_AXIS]);
300 shrinked_points_scm = scm_cons (x, scm_cons (y, shrinked_points_scm));
301 box.add_point (points[i]);
303 SCM polygon_scm = scm_list_n (ly_symbol2scm ("polygon"),
304 ly_quote_scm (shrinked_points_scm),
305 scm_make_real (blotdiameter),
309 Stencil polygon = Stencil (box, polygon_scm);
310 shrinked_points.clear ();
318 Lookup::frame (Box b, Real thick, Real blot)
322 for (Axis a = X_AXIS; a < NO_AXES; a = Axis (a + 1))
324 Axis o = Axis ((a + 1)%NO_AXES);
328 edges[a] = b[a][d] + 0.5 * thick * Interval (-1, 1);
329 edges[o][DOWN] = b[o][DOWN] - thick / 2;
330 edges[o][UP] = b[o][UP] + thick / 2;
332 m.add_stencil (round_filled_box (edges, blot));
334 while (flip (&d) != LEFT);
340 Make a smooth curve along the points
343 Lookup::slur (Bezier curve, Real curvethick, Real linethick)
345 Real alpha = (curve.control_[3] - curve.control_[0]).arg ();
347 Offset perp = curvethick * complex_exp (Offset (0, alpha + M_PI / 2)) * 0.5;
349 back.control_[1] += perp;
350 back.control_[2] += perp;
352 curve.control_[1] -= perp;
353 curve.control_[2] -= perp;
357 for (int i = 4; i--;)
358 scontrols[ i ] = ly_offset2scm (back.control_[i]);
359 for (int i = 4; i--;)
360 scontrols[i + 4] = ly_offset2scm (curve.control_[i]);
363 Need the weird order b.o. the way PS want its arguments
365 int indices[] = {5, 6, 7, 4, 1, 2, 3, 0};
367 for (int i = 8; i--;)
369 list = scm_cons (scontrols[indices[i]], list);
372 SCM at = (scm_list_n (ly_symbol2scm ("bezier-sandwich"),
374 scm_make_real (linethick),
376 Box b (curve.extent (X_AXIS),
377 curve.extent (Y_AXIS));
379 b[X_AXIS].unite (back.extent (X_AXIS));
380 b[Y_AXIS].unite (back.extent (Y_AXIS));
382 return Stencil (b, at);
409 Lookup::bezier_sandwich (Bezier top_curve, Bezier bottom_curve)
412 Need the weird order b.o. the way PS want its arguments
415 list = scm_cons (ly_offset2scm (bottom_curve.control_[3]), list);
416 list = scm_cons (ly_offset2scm (bottom_curve.control_[0]), list);
417 list = scm_cons (ly_offset2scm (bottom_curve.control_[1]), list);
418 list = scm_cons (ly_offset2scm (bottom_curve.control_[2]), list);
419 list = scm_cons (ly_offset2scm (top_curve.control_[0]), list);
420 list = scm_cons (ly_offset2scm (top_curve.control_[3]), list);
421 list = scm_cons (ly_offset2scm (top_curve.control_[2]), list);
422 list = scm_cons (ly_offset2scm (top_curve.control_[1]), list);
424 SCM horizontal_bend = scm_list_n (ly_symbol2scm ("bezier-sandwich"),
429 Interval x_extent = top_curve.extent (X_AXIS);
430 x_extent.unite (bottom_curve.extent (X_AXIS));
431 Interval y_extent = top_curve.extent (Y_AXIS);
432 y_extent.unite (bottom_curve.extent (Y_AXIS));
433 Box b (x_extent, y_extent);
435 return Stencil (b, horizontal_bend);
442 Lookup::accordion (SCM s, Real staff_space, Font_metric *fm)
445 String sym = ly_scm2string (scm_car (s));
446 String reg = ly_scm2string (scm_car (scm_cdr (s)));
448 if (sym == "Discant")
450 Stencil r = fm->find_by_name ("accordion.accDiscant");
452 if (reg.left_string (1) == "F")
454 Stencil d = fm->find_by_name ("accordion.accDot");
455 d.translate_axis (staff_space * 2.5 PT, Y_AXIS);
457 reg = reg.right_string (reg.length () - 1);
460 if (reg.left_string (3) == "EEE")
463 reg = reg.right_string (reg.length () - 3);
465 else if (reg.left_string (2) == "EE")
468 reg = reg.right_string (reg.length () - 2);
470 else if (reg.left_string (2) == "Eh")
473 reg = reg.right_string (reg.length () - 2);
475 else if (reg.left_string (1) == "E")
478 reg = reg.right_string (reg.length () - 1);
482 Stencil d = fm->find_by_name ("accordion.accDot");
483 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
488 Stencil d = fm->find_by_name ("accordion.accDot");
489 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
490 d.translate_axis (0.8 * staff_space PT, X_AXIS);
495 Stencil d = fm->find_by_name ("accordion.accDot");
496 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
497 d.translate_axis (-0.8 * staff_space PT, X_AXIS);
500 if (reg.left_string (2) == "SS")
502 Stencil d = fm->find_by_name ("accordion.accDot");
503 d.translate_axis (0.5 * staff_space PT, Y_AXIS);
504 d.translate_axis (0.4 * staff_space PT, X_AXIS);
506 d.translate_axis (-0.8 * staff_space PT, X_AXIS);
508 reg = reg.right_string (reg.length () - 2);
510 if (reg.left_string (1) == "S")
512 Stencil d = fm->find_by_name ("accordion.accDot");
513 d.translate_axis (0.5 * staff_space PT, Y_AXIS);
515 reg = reg.right_string (reg.length () - 1);
518 else if (sym == "Freebase")
520 Stencil r = fm->find_by_name ("accordion.accFreebase");
522 if (reg.left_string (1) == "F")
524 Stencil d = fm->find_by_name ("accordion.accDot");
525 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
527 reg = reg.right_string (reg.length () - 1);
531 Stencil d = fm->find_by_name ("accordion.accDot");
532 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
536 else if (sym == "Bayanbase")
538 Stencil r = fm->find_by_name ("accordion.accBayanbase");
540 if (reg.left_string (1) == "T")
542 Stencil d = fm->find_by_name ("accordion.accDot");
543 d.translate_axis (staff_space * 2.5 PT, Y_AXIS);
545 reg = reg.right_string (reg.length () - 1);
547 /* include 4' reed just for completeness. You don't want to use this. */
548 if (reg.left_string (1) == "F")
550 Stencil d = fm->find_by_name ("accordion.accDot");
551 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
553 reg = reg.right_string (reg.length () - 1);
555 if (reg.left_string (2) == "EE")
557 Stencil d = fm->find_by_name ("accordion.accDot");
558 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
559 d.translate_axis (0.4 * staff_space PT, X_AXIS);
561 d.translate_axis (-0.8 * staff_space PT, X_AXIS);
563 reg = reg.right_string (reg.length () - 2);
565 if (reg.left_string (1) == "E")
567 Stencil d = fm->find_by_name ("accordion.accDot");
568 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
570 reg = reg.right_string (reg.length () - 1);
573 else if (sym == "Stdbase")
575 Stencil r = fm->find_by_name ("accordion.accStdbase");
577 if (reg.left_string (1) == "T")
579 Stencil d = fm->find_by_name ("accordion.accDot");
580 d.translate_axis (staff_space * 3.5 PT, Y_AXIS);
582 reg = reg.right_string (reg.length () - 1);
584 if (reg.left_string (1) == "F")
586 Stencil d = fm->find_by_name ("accordion.accDot");
587 d.translate_axis (staff_space * 2.5 PT, Y_AXIS);
589 reg = reg.right_string (reg.length () - 1);
591 if (reg.left_string (1) == "M")
593 Stencil d = fm->find_by_name ("accordion.accDot");
594 d.translate_axis (staff_space * 2 PT, Y_AXIS);
595 d.translate_axis (staff_space PT, X_AXIS);
597 reg = reg.right_string (reg.length () - 1);
599 if (reg.left_string (1) == "E")
601 Stencil d = fm->find_by_name ("accordion.accDot");
602 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
604 reg = reg.right_string (reg.length () - 1);
606 if (reg.left_string (1) == "S")
608 Stencil d = fm->find_by_name ("accordion.accDot");
609 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
611 reg = reg.right_string (reg.length () - 1);
614 /* ugh maybe try to use regular font for S.B. and B.B and only use one font
616 else if (sym == "SB")
618 Stencil r = fm->find_by_name ("accordion.accSB");
621 else if (sym == "BB")
623 Stencil r = fm->find_by_name ("accordion.accBB");
626 else if (sym == "OldEE")
628 Stencil r = fm->find_by_name ("accordion.accOldEE");
631 else if (sym == "OldEES")
633 Stencil r = fm->find_by_name ("accordion.accOldEES");
640 Lookup::repeat_slash (Real w, Real s, Real t)
644 Array<Offset> points ;
645 Real blotdiameter = 0.0;
652 return Lookup::round_filled_polygon (points, blotdiameter);
655 SCM wid = scm_make_real (w);
656 SCM sl = scm_make_real (s);
657 SCM thick = scm_make_real (t);
658 SCM slashnodot = scm_list_n (ly_symbol2scm ("repeat-slash"),
659 wid, sl, thick, SCM_UNDEFINED);
661 Box b (Interval (0, w + sqrt (sqr (t / s) + sqr (t))),
662 Interval (0, w * s));
664 return Stencil (b, slashnodot); // http://slashnodot.org
668 Lookup::bracket (Axis a, Interval iv, Real thick, Real protude, Real blot)
671 Axis other = Axis ((a + 1)%2);
673 b[other] = Interval (-1, 1) * thick * 0.5;
675 Stencil m = round_filled_box (b, blot);
677 b[a] = Interval (iv[UP] - thick, iv[UP]);
678 Interval oi = Interval (-thick / 2, thick / 2 + fabs (protude));
679 oi *= sign (protude);
681 m.add_stencil (round_filled_box (b, blot));
682 b[a] = Interval (iv[DOWN], iv[DOWN] + thick);
683 m.add_stencil (round_filled_box (b, blot));
689 Lookup::triangle (Interval iv, Real thick, Real protude)
692 b[X_AXIS] = Interval (0, iv.length ());
693 b[Y_AXIS] = Interval (min (0., protude), max (0.0, protude));
695 Offset z1 (iv[LEFT], 0);
696 Offset z2 (iv[RIGHT], 0);
697 Offset z3 ((z1 + z2)[X_AXIS] / 2, protude);
700 TODO: move Triangle to Line_interface ?
702 Stencil tri = Line_interface::make_line (thick, z1, z2);
703 tri.add_stencil (Line_interface::make_line (thick, z2, z3));
704 tri.add_stencil (Line_interface::make_line (thick, z3, z1));