2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 Jan Nieuwenhuizen <janneke@gnu.org>
8 LilyPond is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 LilyPond is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
28 #include "line-interface.hh"
30 #include "international.hh"
31 #include "dimensions.hh"
33 #include "file-path.hh"
35 #include "lily-guile.hh"
38 Lookup::beam (Real slope, Real width, Real thick, Real blot)
44 p = Offset (0, thick / 2);
46 p += Offset (1, -1) * (blot / 2);
50 points = scm_cons (scm_from_double (p[X_AXIS]),
51 scm_cons (scm_from_double (p[Y_AXIS]),
54 p = Offset (0, -thick / 2);
56 p += Offset (1, 1) * (blot / 2);
58 points = scm_cons (scm_from_double (p[X_AXIS]),
59 scm_cons (scm_from_double (p[Y_AXIS]),
62 p = Offset (width, width * slope - thick / 2);
64 p += Offset (-1, 1) * (blot / 2);
66 points = scm_cons (scm_from_double (p[X_AXIS]),
67 scm_cons (scm_from_double (p[Y_AXIS]),
70 p = Offset (width, width * slope + thick / 2);
72 p += Offset (-1, -1) * (blot / 2);
74 points = scm_cons (scm_from_double (p[X_AXIS]),
75 scm_cons (scm_from_double (p[Y_AXIS]),
78 SCM expr = scm_list_n (ly_symbol2scm ("polygon"),
79 ly_quote_scm (points),
80 scm_from_double (blot),
84 return Stencil (b, expr);
88 Lookup::rotated_box (Real slope, Real width, Real thick, Real blot)
91 Offset rot (1, slope);
95 rot /= sqrt (1 + slope * slope);
96 pts.push_back (Offset (0, -thick / 2) * rot);
97 pts.push_back (Offset (width, -thick / 2) * rot);
98 pts.push_back (Offset (width, thick / 2) * rot);
99 pts.push_back (Offset (0, thick / 2) * rot);
100 return Lookup::round_filled_polygon (pts, blot);
104 Lookup::horizontal_line (Interval w, Real th)
106 SCM at = scm_list_n (ly_symbol2scm ("draw-line"),
107 scm_from_double (th),
108 scm_from_double (w[LEFT]),
110 scm_from_double (w[RIGHT]),
116 box[Y_AXIS] = Interval (-th / 2, th / 2);
118 return Stencil (box, at);
122 Lookup::blank (Box b)
124 return Stencil (b, scm_string (SCM_EOL));
128 Lookup::circle (Real rad, Real thick, bool filled)
130 Box b (Interval (-rad, rad), Interval (-rad, rad));
131 return Stencil (b, scm_list_4 (ly_symbol2scm ("circle"),
132 scm_from_double (rad),
133 scm_from_double (thick),
134 scm_from_bool (filled)));
138 Lookup::filled_box (Box b)
140 return round_filled_box (b, 0.0);
146 * __________________________________
151 * |\ _ _ / v \ _ _ /| |
154 * | <------>| | extent
155 * | blot | | (Y_AXIS)
163 * x\_____/______________\_____/|_____v
167 * |<-------------------------->|
168 * Box extent (X_AXIS)
171 Lookup::round_filled_box (Box b, Real blotdiameter)
173 Real width = b.x ().delta ();
174 blotdiameter = min (blotdiameter, width);
175 Real height = b.y ().delta ();
176 blotdiameter = min (blotdiameter, height);
178 if (blotdiameter < 0.0)
180 if (!isinf (blotdiameter))
181 warning (_f ("Not drawing a box with negative dimension, %.2f by %.2f.",
183 return Stencil (b, SCM_EOL);
186 SCM at = (scm_list_n (ly_symbol2scm ("round-filled-box"),
187 scm_from_double (-b[X_AXIS][LEFT]),
188 scm_from_double (b[X_AXIS][RIGHT]),
189 scm_from_double (-b[Y_AXIS][DOWN]),
190 scm_from_double (b[Y_AXIS][UP]),
191 scm_from_double (blotdiameter),
194 return Stencil (b, at);
198 * Create Stencil that represents a filled polygon with round edges.
202 * (a) Only outer (convex) edges are rounded.
204 * (b) This algorithm works as expected only for polygons whose edges
205 * do not intersect. For example, the polygon ((0, 0), (q, 0), (0,
206 * q), (q, q)) has an intersection at point (q/2, q/2) and therefore
207 * will give a strange result. Even non-adjacent edges that just
208 * touch each other will in general not work as expected for non-null
211 * (c) Given a polygon ((x0, y0), (x1, y1), ... , (x (n-1), y (n-1))),
212 * if there is a natural number k such that blotdiameter is greater
213 * than the maximum of { | (x (k mod n), y (k mod n)) - (x ((k+1) mod n),
214 * y ((k+1) mod n)) |, | (x (k mod n), y (k mod n)) - (x ((k+2) mod n),
215 * y ((k+2) mod n)) |, | (x ((k+1) mod n), y ((k+1) mod n)) - (x ((k+2)
216 * mod n), y ((k+2) mod n)) | }, then the outline of the rounded
217 * polygon will exceed the outline of the core polygon. In other
218 * words: Do not draw rounded polygons that have a leg smaller or
219 * thinner than blotdiameter (or set blotdiameter to a sufficiently
220 * small value -- maybe even 0.0)!
222 * NOTE: Limitations (b) and (c) arise from the fact that round edges
223 * are made by moulding sharp edges to round ones rather than adding
224 * to a core filled polygon. For details of these two different
225 * approaches, see the thread upon the ledger lines patch that started
226 * on March 25, 2002 on the devel mailing list. The below version of
227 * round_filled_polygon () sticks to the moulding model, which the
228 * majority of the list participants finally voted for. This,
229 * however, results in the above limitations and a much increased
230 * complexity of the algorithm, since it has to compute a shrinked
231 * polygon -- which is not trivial define precisely and unambigously.
232 * With the other approach, one simply could move a circle of size
233 * blotdiameter along all edges of the polygon (which is what the
234 * postscript routine in the backend effectively does, but on the
235 * shrinked polygon). --jr
238 Lookup::round_filled_polygon (vector<Offset> const &points,
241 /* TODO: Maybe print a warning if one of the above limitations
242 applies to the given polygon. However, this is quite complicated
245 const Real epsilon = 0.01;
248 /* remove consecutive duplicate points */
249 for (vsize i = 0; i < points.size (); i++)
251 int next = (i + 1) % points.size ();
252 Real d = (points[i] - points[next]).length ();
254 programming_error ("Polygon should not have duplicate points");
258 /* special cases: degenerated polygons */
259 if (points.size () == 0)
261 if (points.size () == 1)
263 Stencil circ = circle (0.5 * blotdiameter, 0, true);
264 circ.translate (points[0]);
267 if (points.size () == 2)
268 return Line_interface::make_line (blotdiameter, points[0], points[1]);
270 /* shrink polygon in size by 0.5 * blotdiameter */
272 // first we need to determine the orientation of the polygon in
273 // order to decide whether shrinking means moving the polygon to the
274 // left or to the right of the outline. We do that by calculating
275 // (double) the oriented area of the polygon. We first determine the
276 // center and do the area calculations relative to it.
277 // Mathematically, the result is not affected by this shift, but
278 // numerically a lot of cancellation is going on and this keeps its
282 for (vsize i = 0; i < points.size (); i++)
284 center /= points.size ();
287 Offset last = points.back () - center;
289 for (vsize i = 0; i < points.size (); i++)
291 Offset here = points[i] - center;
292 area += cross_product (last, here);
296 bool ccw = area >= 0.0; // true if whole shape is counterclockwise oriented
298 vector<Offset> shrunk_points;
299 shrunk_points.resize (points.size ());
301 for (vsize i = 0; i < points.size (); i++)
304 int i1 = (i + 1) % points.size ();
305 int i2 = (i + 2) % points.size ();
306 Offset p0 = points[i0];
307 Offset p1 = points[i1];
308 Offset p2 = points[i2];
309 Offset p01 = p1 - p0;
310 Offset p12 = p2 - p1;
311 Offset inward0 = Offset(-p01[Y_AXIS], p01[X_AXIS]).direction ();
312 Offset inward2 = Offset(-p12[Y_AXIS], p12[X_AXIS]).direction ();
320 Offset middle = 0.5*(inward0 + inward2);
322 // "middle" now is a vector in the right direction for the
323 // shrinkage. Its size needs to be large enough that the
324 // projection on either of the inward vectors has a size of 1.
326 Real proj = dot_product (middle, inward0);
328 // What's the size of proj? Assuming that we have a corner
329 // angle of phi where 0 corresponds to a continuing line, the
330 // length of middle is 0.5 |(1+cos phi, sin phi)| = cos (phi/2),
331 // so its projection has length
332 // cos^2 (phi/2) = 0.5 + 0.5 cos (phi).
333 // We don't really want to move inwards more than 3 blob
334 // diameters corresponding to 6 blob radii. So
335 // cos (phi/2) = 1/6 gives phi ~ 161, meaning that a 20 degree
336 // corner necessitates moving 3 blob diameters from the corner
337 // in order to stay inside the lines. Ruler and circle agree.
338 // 0.03 is close enough to 1/36. Basically we want to keep the
339 // shape from inverting from pulling too far inward.
340 // 3 diameters is pretty much a handwaving guess.
342 if (abs (proj) < 0.03)
343 proj = proj < 0 ? -0.03 : 0.03;
345 shrunk_points[i1] = p1 + (0.5 * blotdiameter / proj) * middle;
348 /* build scm expression and bounding box */
349 SCM shrunk_points_scm = SCM_EOL;
351 for (vsize i = 0; i < shrunk_points.size (); i++)
353 SCM x = scm_from_double (shrunk_points[i][X_AXIS]);
354 SCM y = scm_from_double (shrunk_points[i][Y_AXIS]);
355 shrunk_points_scm = scm_cons (x, scm_cons (y, shrunk_points_scm));
356 box.add_point (points[i]);
358 SCM polygon_scm = scm_list_n (ly_symbol2scm ("polygon"),
359 ly_quote_scm (shrunk_points_scm),
360 scm_from_double (blotdiameter),
364 Stencil polygon = Stencil (box, polygon_scm);
365 shrunk_points.clear ();
373 Lookup::frame (Box b, Real thick, Real blot)
376 for (Axis a = X_AXIS; a < NO_AXES; a = Axis (a + 1))
378 Axis o = Axis ((a + 1) % NO_AXES);
379 for (LEFT_and_RIGHT (d))
382 edges[a] = b[a][d] + 0.5 * thick * Interval (-1, 1);
383 edges[o][DOWN] = b[o][DOWN] - thick / 2;
384 edges[o][UP] = b[o][UP] + thick / 2;
386 m.add_stencil (round_filled_box (edges, blot));
393 Make a smooth curve along the points
396 Lookup::slur (Bezier curve, Real curvethick, Real linethick,
399 Stencil return_value;
402 calculate the offset for the two beziers that make the sandwich
405 Real alpha = (curve.control_[3] - curve.control_[0]).arg ();
407 Offset perp = curvethick * complex_exp (Offset (0, alpha + M_PI / 2)) * 0.5;
408 back.control_[1] += perp;
409 back.control_[2] += perp;
411 curve.control_[1] -= perp;
412 curve.control_[2] -= perp;
414 if (!scm_is_pair (dash_details))
417 return_value = bezier_sandwich (back, curve, linethick);
421 /* dashed or combination slur */
422 int num_segments = scm_to_int (scm_length (dash_details));
423 for (int i = 0; i < num_segments; i++)
425 SCM dash_pattern = scm_list_ref (dash_details, scm_from_int (i));
426 Real t_min = robust_scm2double (scm_car (dash_pattern), 0);
427 Real t_max = robust_scm2double (scm_cadr (dash_pattern), 1.0);
429 = robust_scm2double (scm_caddr (dash_pattern), 1.0);
431 = robust_scm2double (scm_cadddr (dash_pattern), 0.75);
432 Bezier back_segment = back.extract (t_min, t_max);
433 Bezier curve_segment = curve.extract (t_min, t_max);
434 if (dash_fraction == 1.0)
435 return_value.add_stencil (bezier_sandwich (back_segment,
440 Bezier back_dash, curve_dash;
441 Real seg_length = (back_segment.control_[3]
442 - back_segment.control_[0]).length ();
443 int pattern_count = (int) (seg_length / dash_period);
444 Real pattern_length = 1.0 / (pattern_count + dash_fraction);
446 for (int p = 0; p <= pattern_count; p++)
448 start_t = p * pattern_length;
449 end_t = (p + dash_fraction) * pattern_length;
451 = back_segment.extract (start_t, end_t);
453 = curve_segment.extract (start_t, end_t);
454 return_value.add_stencil (bezier_sandwich (back_dash,
488 Lookup::bezier_sandwich (Bezier top_curve, Bezier bottom_curve, Real thickness)
490 SCM commands = scm_list_n (ly_symbol2scm ("moveto"),
491 scm_from_double (top_curve.control_[0][X_AXIS]),
492 scm_from_double (top_curve.control_[0][Y_AXIS]),
493 ly_symbol2scm ("curveto"),
494 scm_from_double (top_curve.control_[1][X_AXIS]),
495 scm_from_double (top_curve.control_[1][Y_AXIS]),
496 scm_from_double (top_curve.control_[2][X_AXIS]),
497 scm_from_double (top_curve.control_[2][Y_AXIS]),
498 scm_from_double (top_curve.control_[3][X_AXIS]),
499 scm_from_double (top_curve.control_[3][Y_AXIS]),
500 ly_symbol2scm ("lineto"),
501 scm_from_double (bottom_curve.control_[3][X_AXIS]),
502 scm_from_double (bottom_curve.control_[3][Y_AXIS]),
503 ly_symbol2scm ("curveto"),
504 scm_from_double (bottom_curve.control_[2][X_AXIS]),
505 scm_from_double (bottom_curve.control_[2][Y_AXIS]),
506 scm_from_double (bottom_curve.control_[1][X_AXIS]),
507 scm_from_double (bottom_curve.control_[1][Y_AXIS]),
508 scm_from_double (bottom_curve.control_[0][X_AXIS]),
509 scm_from_double (bottom_curve.control_[0][Y_AXIS]),
510 ly_symbol2scm ("closepath"),
513 SCM horizontal_bend = scm_list_n (ly_symbol2scm ("path"),
514 scm_from_double (thickness),
515 ly_quote_scm (commands),
516 ly_quote_scm (ly_symbol2scm ("round")),
517 ly_quote_scm (ly_symbol2scm ("round")),
521 Interval x_extent = top_curve.extent (X_AXIS);
522 x_extent.unite (bottom_curve.extent (X_AXIS));
523 Interval y_extent = top_curve.extent (Y_AXIS);
524 y_extent.unite (bottom_curve.extent (Y_AXIS));
525 Box b (x_extent, y_extent);
527 b.widen (0.5 * thickness, 0.5 * thickness);
528 return Stencil (b, horizontal_bend);
532 Lookup::repeat_slash (Real w, Real s, Real t)
535 Real x_width = sqrt ((t * t) + ((t / s) * (t / s)));
538 SCM controls = scm_list_n (ly_symbol2scm ("moveto"),
541 ly_symbol2scm ("rlineto"),
542 scm_from_double (x_width),
544 ly_symbol2scm ("rlineto"),
546 scm_from_double (height),
547 ly_symbol2scm ("rlineto"),
548 scm_from_double (-x_width),
550 ly_symbol2scm ("closepath"),
553 SCM slashnodot = scm_list_n (ly_symbol2scm ("path"),
555 ly_quote_scm (controls),
556 ly_quote_scm (ly_symbol2scm ("round")),
557 ly_quote_scm (ly_symbol2scm ("round")),
561 Box b (Interval (0, w + sqrt (sqr (t / s) + sqr (t))),
562 Interval (0, w * s));
564 return Stencil (b, slashnodot); // http://slashnodot.org
568 Lookup::bracket (Axis a, Interval iv, Real thick, Real protrude, Real blot)
571 Axis other = Axis ((a + 1) % 2);
573 b[other] = Interval (-1, 1) * thick * 0.5;
575 Stencil m = round_filled_box (b, blot);
577 b[a] = Interval (iv[UP] - thick, iv[UP]);
578 Interval oi = Interval (-thick / 2, thick / 2 + fabs (protrude));
579 oi *= sign (protrude);
581 m.add_stencil (round_filled_box (b, blot));
582 b[a] = Interval (iv[DOWN], iv[DOWN] + thick);
583 m.add_stencil (round_filled_box (b, blot));
589 Lookup::triangle (Interval iv, Real thick, Real protrude)
592 b[X_AXIS] = Interval (0, iv.length ());
593 b[Y_AXIS] = Interval (min (0., protrude), max (0.0, protrude));
595 vector<Offset> points;
596 points.push_back (Offset (iv[LEFT], 0));
597 points.push_back (Offset (iv[RIGHT], 0));
598 points.push_back (Offset (iv.center (), protrude));
599 points.push_back (Offset (iv[LEFT], 0)); // close triangle
601 return points_to_line_stencil (thick, points);
606 Lookup::points_to_line_stencil (Real thick, vector<Offset> const &points)
609 for (vsize i = 1; i < points.size (); i++)
611 if (points[i - 1].is_sane () && points[i].is_sane ())
614 = Line_interface::make_line (thick, points[i - 1], points[i]);
615 ret.add_stencil (line);