2 vaticana-ligature.cc -- implement Vaticana_ligature
4 source file of the GNU LilyPond music typesetter
6 (c) 2003--2007 Juergen Reuter <reuter@ipd.uka.de>
9 #include "vaticana-ligature.hh"
12 #include "font-interface.hh"
13 #include "international.hh"
16 #include "note-head.hh"
17 #include "output-def.hh"
18 #include "staff-symbol-referencer.hh"
22 vaticana_brew_cauda (Grob
*me
,
28 bool on_staffline
= Staff_symbol_referencer::on_line (me
, pos
);
29 int interspaces
= Staff_symbol_referencer::line_count (me
) - 1;
30 bool above_staff
= pos
> interspaces
;
34 me
->programming_error ("flexa cauda: invalid delta_pitch; assuming -1");
40 if (delta_pitch
>= -1)
42 else if (delta_pitch
>= -2)
49 if (delta_pitch
>= -1)
54 else if (delta_pitch
>= -2)
56 else if (delta_pitch
>= -3)
61 Box
cauda_box (Interval (0, thickness
), Interval (-length
, 0));
62 return Lookup::round_filled_box (cauda_box
, blotdiameter
);
66 * TODO: move this function to class Lookup?
69 vaticana_brew_flexa (Grob
*me
,
73 Real staff_space
= Staff_symbol_referencer::staff_space (me
);
75 Real right_height
= 0.6 * staff_space
;
78 SCM flexa_height_scm
= me
->get_property ("flexa-height");
79 if (flexa_height_scm
!= SCM_EOL
)
80 interval
= scm_to_int (flexa_height_scm
);
83 me
->warning ("Vaticana_ligature: "
84 + _ ("flexa-height undefined; assuming 0"));
89 me
->warning (_ ("ascending vaticana style flexa"));
91 Real width
= robust_scm2double (me
->get_property ("flexa-width"), 2);
94 * Compensate curve thickness that appears to be smaller in steep
99 + min (0.12 * abs (interval
), 0.3) * staff_space
;
102 * Compensate optical illusion regarding vertical position of left
103 * and right endings due to curved shape.
105 Real ypos_correction
= -0.1 * staff_space
* sign (interval
);
106 Real interval_correction
= 0.2 * staff_space
* sign (interval
);
107 Real corrected_interval
= interval
* staff_space
+ interval_correction
;
110 * middle curve of flexa shape
113 curve
.control_
[0] = Offset (0.00 * width
, 0.0);
114 curve
.control_
[1] = Offset (0.33 * width
, corrected_interval
/ 2.0);
115 curve
.control_
[2] = Offset (0.66 * width
, corrected_interval
/ 2.0);
116 curve
.control_
[3] = Offset (1.00 * width
, corrected_interval
/ 2.0);
118 Bezier top_curve
= curve
, bottom_curve
= curve
;
119 for (int i
= 0; i
< 4; i
++)
121 Real curve_thickness
= 0.33 * ((3 - i
) * left_height
+ i
* right_height
);
122 top_curve
.control_
[i
] += Offset (0, 0.5 * curve_thickness
);
123 bottom_curve
.control_
[i
] -= Offset (0, 0.5 * curve_thickness
);
129 = Lookup::bezier_sandwich (top_curve
, bottom_curve
);
130 stencil
.add_stencil (solid_head
);
134 Bezier inner_top_curve
= top_curve
;
135 inner_top_curve
.translate (Offset (0.0, -line_thickness
));
137 = Lookup::bezier_sandwich (top_curve
, inner_top_curve
);
138 stencil
.add_stencil (top_edge
);
140 Bezier inner_bottom_curve
= bottom_curve
;
141 inner_bottom_curve
.translate (Offset (0.0, +line_thickness
));
143 = Lookup::bezier_sandwich (bottom_curve
, inner_bottom_curve
);
144 stencil
.add_stencil (bottom_edge
);
147 * TODO: Use horizontal slope with proper slope value rather
148 * than filled box for left edge, since the filled box stands
149 * out from the flexa shape if the interval is big and the line
150 * thickness small. The difficulty here is to compute a proper
151 * slope value, as it should roughly be equal with the slope of
152 * the left end of the bezier curve.
154 Box
left_edge_box (Interval (0, line_thickness
),
155 Interval (-0.5 * left_height
, +0.5 * left_height
));
156 Stencil left_edge
= Lookup::filled_box (left_edge_box
);
157 stencil
.add_stencil (left_edge
);
159 Box
right_edge_box (Interval (-line_thickness
, 0),
160 Interval (-0.5 * right_height
, +0.5 * right_height
));
161 Stencil right_edge
= Lookup::filled_box (right_edge_box
);
162 right_edge
.translate_axis (width
, X_AXIS
);
163 right_edge
.translate_axis (corrected_interval
/ 2.0, Y_AXIS
);
164 stencil
.add_stencil (right_edge
);
166 stencil
.translate_axis (ypos_correction
, Y_AXIS
);
171 vaticana_brew_join (Grob
*me
, int delta_pitch
,
172 Real join_thickness
, Real blotdiameter
)
174 Real staff_space
= Staff_symbol_referencer::staff_space (me
);
177 me
->programming_error (_f ("Vaticana_ligature: "
178 "zero join (delta_pitch == 0)"));
179 return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
181 Interval x_extent
= Interval (0, join_thickness
);
182 Interval y_extent
= (delta_pitch
> 0)
183 ? Interval (0, delta_pitch
* 0.5 * staff_space
) : // ascending join
184 Interval (delta_pitch
* 0.5 * staff_space
, 0); // descending join
185 Box
join_box (x_extent
, y_extent
);
186 return Lookup::round_filled_box (join_box
, blotdiameter
);
190 vaticana_brew_primitive (Grob
*me
)
192 SCM glyph_name_scm
= me
->get_property ("glyph-name");
193 if (glyph_name_scm
== SCM_EOL
)
195 me
->programming_error ("Vaticana_ligature: "
196 "undefined glyph-name -> ignoring grob");
197 return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
200 string glyph_name
= ly_scm2string (glyph_name_scm
);
203 Real thickness
= robust_scm2double (me
->get_property ("thickness"), 1);
206 = thickness
* me
->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
209 = (me
->layout ()->get_dimension (ly_symbol2scm ("blot-diameter")));
211 int pos
= Staff_symbol_referencer::get_rounded_position (me
);
213 SCM delta_pitch_scm
= me
->get_property ("delta-position");
215 if (delta_pitch_scm
!= SCM_EOL
)
216 delta_pitch
= scm_to_int (delta_pitch_scm
);
220 Real x_offset
= robust_scm2double (me
->get_property ("x-offset"), 0);
222 bool add_stem
= to_boolean (me
->get_property ("add-stem"));
223 bool add_cauda
= to_boolean (me
->get_property ("add-cauda"));
224 bool add_join
= to_boolean (me
->get_property ("add-join"));
226 if (glyph_name
== "")
229 * This is an empty head. This typically applies for the right
230 * side of a curved flexa shape, which is already typeset by the
231 * associated left side head. The only possible thing left to
232 * do is to draw a vertical join to the next head. (Urgh: need
235 Real staff_space
= Staff_symbol_referencer::staff_space (me
);
236 Real flexa_width
= robust_scm2double (me
->get_property ("flexa-width"), 2) * staff_space
;
238 = Lookup::blank (Box (Interval (0, 0.5 * flexa_width
), Interval (0, 0)));
240 else if (glyph_name
== "flexa")
241 out
= vaticana_brew_flexa (me
, true, line_thickness
);
245 = Font_interface::get_default_font (me
)->
246 find_by_name ("noteheads.s" + glyph_name
);
248 out
.translate_axis (x_offset
, X_AXIS
);
249 Real head_width
= out
.extent (X_AXIS
).length ();
254 = vaticana_brew_cauda (me
, pos
, delta_pitch
,
255 line_thickness
, blotdiameter
);
256 out
.add_stencil (cauda
);
262 = vaticana_brew_cauda (me
, pos
, -1,
263 line_thickness
, blotdiameter
);
264 stem
.translate_axis (head_width
- line_thickness
, X_AXIS
);
265 out
.add_stencil (stem
);
271 = vaticana_brew_join (me
, delta_pitch
, line_thickness
, blotdiameter
);
272 join
.translate_axis (head_width
- line_thickness
, X_AXIS
);
273 out
.add_stencil (join
);
279 MAKE_SCHEME_CALLBACK (Vaticana_ligature
, brew_ligature_primitive
, 1);
281 Vaticana_ligature::brew_ligature_primitive (SCM smob
)
283 Grob
*me
= unsmob_grob (smob
);
284 SCM primitive
= vaticana_brew_primitive (me
).smobbed_copy ();
288 MAKE_SCHEME_CALLBACK (Vaticana_ligature
, print
, 1);
290 Vaticana_ligature::print (SCM
)
295 ADD_INTERFACE (Vaticana_ligature
,
296 "A vaticana style gregorian ligature",