2 cluster.cc -- implement Cluster
4 source file of the GNU LilyPond music typesetter
6 (c) 2002--2005 Juergen Reuter <reuter@ipd.uka.de>
8 Han-Wen Nienhuys <hanwen@cs.uu.nl>
18 #include "staff-symbol-referencer.hh"
20 #include "output-def.hh"
22 #include "pointer-group-interface.hh"
25 TODO: Add support for cubic spline segments.
28 brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_points)
30 Real blotdiameter = Staff_symbol_referencer::staff_space (me) / 2;
32 Real padding = robust_scm2double (me->get_property ("padding"), 0.0);
34 Offset vpadding = Offset (0, padding);
35 Offset hpadding = Offset (0.5 * blotdiameter, 0);
36 Offset hvpadding = 0.5 * hpadding + vpadding;
38 SCM shape_scm = me->get_property ("style");
41 if (scm_is_symbol (shape_scm))
43 shape = ly_symbol2string (shape_scm);
47 programming_error ("#'style should be symbol.");
55 int size = bottom_points.size ();
56 if (String::compare (shape, "leftsided-stairs") == 0)
58 for (int i = 0; i < size - 1; i++)
61 box.add_point (bottom_points[i] - hvpadding);
62 box.add_point (Offset (top_points[i + 1][X_AXIS],
63 top_points[i][Y_AXIS]) + hvpadding);
64 out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
67 else if (String::compare (shape, "rightsided-stairs") == 0)
69 for (int i = 0; i < size - 1; i++)
72 box.add_point (Offset (bottom_points[i][X_AXIS],
73 bottom_points[i + 1][Y_AXIS]) - hvpadding);
74 box.add_point (top_points[i + 1] + hvpadding);
75 out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
78 else if (String::compare (shape, "centered-stairs") == 0)
80 Real left_xmid = bottom_points[0][X_AXIS];
81 for (int i = 0; i < size - 1; i++)
84 = 0.5 * (bottom_points[i][X_AXIS] + bottom_points[i + 1][X_AXIS]);
86 box.add_point (Offset (left_xmid, bottom_points[i][Y_AXIS])
88 box.add_point (Offset (right_xmid, top_points[i][Y_AXIS])
90 out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
91 left_xmid = right_xmid;
93 Real right_xmid = bottom_points[size - 1][X_AXIS];
95 box.add_point (Offset (left_xmid, bottom_points[size - 1][Y_AXIS])
97 box.add_point (Offset (right_xmid, top_points[size - 1][Y_AXIS])
99 out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
101 else if (String::compare (shape, "ramp") == 0)
103 points.push (bottom_points[0] - vpadding + hpadding);
104 for (int i = 1; i < size - 1; i++)
106 points.push (bottom_points[i] - vpadding);
108 points.push (bottom_points[size - 1] - vpadding - hpadding);
109 points.push (top_points[size - 1] + vpadding - hpadding);
110 for (int i = size - 2; i > 0; i--)
112 points.push (top_points[i] + vpadding);
114 points.push (top_points[0] + vpadding + hpadding);
115 out.add_stencil (Lookup::round_filled_polygon (points, blotdiameter));
119 me->warning (_f ("unknown cluster style `%s'", shape.to_str0 ()));
124 MAKE_SCHEME_CALLBACK (Cluster, print, 1);
126 Cluster::print (SCM smob)
128 Grob *me = unsmob_grob (smob);
130 Spanner *spanner = dynamic_cast<Spanner *> (me);
133 me->programming_error ("Cluster::print (): not a spanner");
137 Item *left_bound = spanner->get_bound (LEFT);
138 Item *right_bound = spanner->get_bound (RIGHT);
140 Grob *commonx = left_bound->common_refpoint (right_bound, X_AXIS);
142 Link_array<Grob> const &cols = extract_grob_array (me, "columns");
143 if (cols.is_empty ())
145 me->warning (_ ("junking empty cluster"));
151 commonx = common_refpoint_of_array (cols, commonx, X_AXIS);
152 Grob *commony = common_refpoint_of_array (cols, me, Y_AXIS);
153 Array<Offset> bottom_points;
154 Array<Offset> top_points;
156 Real left_coord = left_bound->relative_coordinate (commonx, X_AXIS);
159 TODO: should we move the cluster a little to the right to be in
160 line with the center of the note heads?
163 for (int i = 0; i < cols.size (); i++)
167 Interval yext = col->extent (commony, Y_AXIS);
169 Real x = col->relative_coordinate (commonx, X_AXIS) - left_coord;
170 bottom_points.push (Offset (x, yext[DOWN]));
171 top_points.push (Offset (x, yext[UP]));
175 Across a line break we anticipate on the next pitches.
177 if (spanner->original_)
179 Spanner *orig = dynamic_cast<Spanner *> (spanner->original_);
181 if (spanner->get_break_index () < orig->broken_intos_.size () - 1)
183 Spanner *next = orig->broken_intos_[spanner->get_break_index () + 1];
184 Link_array<Grob> const &next_cols = extract_grob_array (next, "columns");
185 if (next_cols.size() > 0)
187 Grob *next_commony = common_refpoint_of_array (next_cols, next, Y_AXIS);
188 Grob *col = next_cols[0];
190 Interval v = col->extent (next_commony, Y_AXIS);
191 Real x = right_bound->relative_coordinate (commonx, X_AXIS) - left_coord;
193 bottom_points.insert (Offset (x, v[DOWN]), 0);
194 top_points.insert (Offset (x, v[UP]), 0);
199 bottom_points.reverse ();
200 top_points.reverse ();
202 Stencil out = brew_cluster_piece (me, bottom_points, top_points);
203 out.translate_axis (- me->relative_coordinate (commony, Y_AXIS), Y_AXIS);
204 return out.smobbed_copy ();
207 ADD_INTERFACE (Cluster, "cluster-interface",
208 "A graphically drawn musical cluster. "
210 "@code{padding} adds to the vertical extent of the shape (top and "
212 "The property @code{style} controls the shape of cluster segments. Valid values "
213 "include @code{leftsided-stairs}, @code{rightsided-stairs}, @code{centered-stairs}, "
214 "and @code{ramp}.\n",
215 "style padding columns");
217 struct Cluster_beacon
220 DECLARE_SCHEME_CALLBACK (height, (SCM, SCM));
221 static bool has_interface (Grob *);
224 MAKE_SCHEME_CALLBACK (Cluster_beacon, height, 2);
226 Cluster_beacon::height (SCM g, SCM)
228 Grob *me = unsmob_grob (g);
229 Interval v = robust_scm2interval (me->get_property ("positions"),
231 return ly_interval2scm (Staff_symbol_referencer::staff_space (me) * 0.5 * v);
234 ADD_INTERFACE (Cluster_beacon,
235 "cluster-beacon-interface",
236 "A place holder for the cluster spanner to determine the vertical "
237 "extents of a cluster spanner at this X position.",