2 cluster.cc -- implement Cluster
4 source file of the GNU LilyPond music typesetter
6 (c) 2002--2006 Juergen Reuter <reuter@ipd.uka.de>
8 Han-Wen Nienhuys <hanwen@xs4all.nl>
16 #include "international.hh"
19 #include "output-def.hh"
21 #include "pointer-group-interface.hh"
23 #include "staff-symbol-referencer.hh"
27 TODO: Add support for cubic spline segments.
30 brew_cluster_piece (Grob *me, std::vector<Offset> bottom_points, std::vector<Offset> top_points)
32 Real blotdiameter = Staff_symbol_referencer::staff_space (me) / 2;
34 Real padding = robust_scm2double (me->get_property ("padding"), 0.0);
36 Offset vpadding = Offset (0, padding);
37 Offset hpadding = Offset (0.5 * blotdiameter, 0);
38 Offset hvpadding = 0.5 * hpadding + vpadding;
40 SCM shape_scm = me->get_property ("style");
43 if (scm_is_symbol (shape_scm))
44 shape = ly_symbol2string (shape_scm);
47 programming_error ("#'style should be symbol.");
53 std::vector<Offset> points;
55 int size = bottom_points.size ();
56 if (shape == "leftsided-stairs")
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 (shape == "rightsided-stairs")
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 (shape == "centered-stairs")
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 (shape == "ramp")
103 points.push_back (bottom_points[0] - vpadding + hpadding);
104 for (int i = 1; i < size - 1; i++)
105 points.push_back (bottom_points[i] - vpadding);
106 points.push_back (bottom_points[size - 1] - vpadding - hpadding);
107 points.push_back (top_points[size - 1] + vpadding - hpadding);
108 for (int i = size - 2; i > 0; i--)
109 points.push_back (top_points[i] + vpadding);
110 points.push_back (top_points[0] + vpadding + hpadding);
111 out.add_stencil (Lookup::round_filled_polygon (points, blotdiameter));
114 me->warning (_f ("unknown cluster style `%s'", shape.c_str ()));
118 MAKE_SCHEME_CALLBACK (Cluster, print, 1);
120 Cluster::print (SCM smob)
122 Grob *me = unsmob_grob (smob);
124 Spanner *spanner = dynamic_cast<Spanner *> (me);
127 me->programming_error ("Cluster::print (): not a spanner");
131 Item *left_bound = spanner->get_bound (LEFT);
132 Item *right_bound = spanner->get_bound (RIGHT);
134 Grob *commonx = left_bound->common_refpoint (right_bound, X_AXIS);
136 Link_array<Grob> const &cols = extract_grob_array (me, "columns");
139 me->warning (_ ("junking empty cluster"));
145 commonx = common_refpoint_of_array (cols, commonx, X_AXIS);
146 Grob *commony = common_refpoint_of_array (cols, me, Y_AXIS);
147 std::vector<Offset> bottom_points;
148 std::vector<Offset> top_points;
150 Real left_coord = left_bound->relative_coordinate (commonx, X_AXIS);
153 TODO: should we move the cluster a little to the right to be in
154 line with the center of the note heads?
157 for (vsize i = 0; i < cols.size (); i++)
161 Interval yext = col->extent (commony, Y_AXIS);
163 Real x = col->relative_coordinate (commonx, X_AXIS) - left_coord;
164 bottom_points.push_back (Offset (x, yext[DOWN]));
165 top_points.push_back (Offset (x, yext[UP]));
169 Across a line break we anticipate on the next pitches.
171 if (spanner->original ())
173 Spanner *orig = dynamic_cast<Spanner *> (spanner->original ());
175 if (spanner->get_break_index () < orig->broken_intos_.size () - 1)
177 Spanner *next = orig->broken_intos_[spanner->get_break_index () + 1];
178 Link_array<Grob> const &next_cols = extract_grob_array (next, "columns");
179 if (next_cols.size () > 0)
181 Grob *next_commony = common_refpoint_of_array (next_cols, next, Y_AXIS);
182 Grob *col = next_cols[0];
184 Interval v = col->extent (next_commony, Y_AXIS);
185 Real x = right_bound->relative_coordinate (commonx, X_AXIS) - left_coord;
187 bottom_points.insert (bottom_points.begin (),
188 Offset (x, v[DOWN]));
189 top_points.insert (top_points.begin (), Offset (x, v[UP]));
194 bottom_points.reverse ();
195 top_points.reverse ();
197 Stencil out = brew_cluster_piece (me, bottom_points, top_points);
198 out.translate_axis (- me->relative_coordinate (commony, Y_AXIS), Y_AXIS);
199 return out.smobbed_copy ();
202 ADD_INTERFACE (Cluster, "cluster-interface",
203 "A graphically drawn musical cluster. "
205 "@code{padding} adds to the vertical extent of the shape (top and "
207 "The property @code{style} controls the shape of cluster segments. Valid values "
208 "include @code{leftsided-stairs}, @code{rightsided-stairs}, @code{centered-stairs}, "
209 "and @code{ramp}.\n",
210 "style padding columns");
212 struct Cluster_beacon
215 DECLARE_SCHEME_CALLBACK (height, (SCM));
216 static bool has_interface (Grob *);
219 MAKE_SCHEME_CALLBACK (Cluster_beacon, height, 1);
221 Cluster_beacon::height (SCM g)
223 Grob *me = unsmob_grob (g);
224 Interval v = robust_scm2interval (me->get_property ("positions"),
226 return ly_interval2scm (Staff_symbol_referencer::staff_space (me) * 0.5 * v);
229 ADD_INTERFACE (Cluster_beacon,
230 "cluster-beacon-interface",
231 "A place holder for the cluster spanner to determine the vertical "
232 "extents of a cluster spanner at this X position.",