source file of the GNU LilyPond music typesetter
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
+#include <math.h>
+
+#include "spanner.hh"
#include "lookup.hh"
#include "paper-def.hh"
#include "tie.hh"
-#include "note-head.hh"
+#include "rhythmic-head.hh"
#include "bezier.hh"
#include "paper-column.hh"
-#include "debug.hh"
+#include "warn.hh"
#include "staff-symbol-referencer.hh"
#include "directional-element-interface.hh"
#include "molecule.hh"
#include "bezier-bow.hh"
+#include "stem.hh"
+#include "note-head.hh"
+#include "tie-column.hh"
+
+/*
+ tie: Connect two noteheads.
+
+ What if we have
+
+ c4 ~ \clef bass ; c4 or
+
+ c4 \staffchange c4
+
+ do we have non-horizontal ties then?
+ */
+
void
-Tie::set_head (Direction d, Item * head_l)
+Tie::set_head (Grob*me,Direction d, Grob * h)
{
- assert (!head (d));
- index_set_cell (get_elt_property ("heads"), d, head_l->self_scm_);
+ assert (!head (me,d));
+ index_set_cell (me->get_grob_property ("head-pair"), d, h->self_scm ());
- set_bounds (d, head_l);
- add_dependency (head_l);
+ dynamic_cast<Spanner*> (me)->set_bound (d, h);
+ me->add_dependency (h);
}
-Tie::Tie()
+void
+Tie::set_interface (Grob*me)
{
- set_elt_property ("heads", gh_cons (SCM_EOL, SCM_EOL));
- dy_f_drul_[LEFT] = dy_f_drul_[RIGHT] = 0.0;
- dx_f_drul_[LEFT] = dx_f_drul_[RIGHT] = 0.0;
-
+ me->set_grob_property ("head-pair", gh_cons (SCM_EOL, SCM_EOL));
}
-Note_head*
-Tie::head (Direction d) const
+
+Grob*
+Tie::head (Grob*me, Direction d)
{
- SCM c = get_elt_property ("heads");
- c = index_cell (c, d);
+ SCM c = me->get_grob_property ("head-pair");
- return dynamic_cast<Note_head*> (unsmob_element (c));
+ if (gh_pair_p)
+ return unsmob_grob (index_get_cell (c, d));
+ else
+ return 0;
+}
+
+Real
+Tie::get_position (Grob*me)
+{
+ Direction d = head (me,LEFT) ? LEFT:RIGHT;
+ return Staff_symbol_referencer::get_position (head (me,d));
}
/*
- ugh: direction of the Tie is more complicated. See [Ross] p136 and further
- */
+ Default: Put the tie oppositie of the stem [Wanske p231]
+
+ In case of chords: Tie_column takes over
+
+ The direction of the Tie is more complicated (See [Ross] p136 and
+ further).
+
+ (what about linebreaks? )
+
+*/
Direction
-Tie::get_default_dir () const
+Tie::get_default_dir (Grob*me)
{
- Real p1 = Staff_symbol_referencer_interface (head (LEFT)).position_f () ;
- Real p2 = Staff_symbol_referencer_interface (head (RIGHT)).position_f () ;
-
- int m = int (p1 + p2);
+ Item * sl = head (me,LEFT) ? Rhythmic_head::get_stem (head (me,LEFT)) :0;
+ Item * sr = head (me,RIGHT) ? Rhythmic_head::get_stem (head (me,RIGHT)) :0;
+ if (sl && sr)
+ {
+ if (get_grob_direction (sl) == UP
+ && get_grob_direction (sr) == UP)
+ return DOWN;
+ }
+ else if (sl || sr)
+ {
+ Item *s = sl ? sl : sr;
+ return - get_grob_direction (s);
+ }
- /*
- If dir is not determined: inverse of stem: down
- (see stem::get_default_dir ())
- */
- Direction neutral_dir = (Direction)(int)paper_l ()->get_var ("stem_default_neutral_direction");
- return (m == 0) ? other_dir (neutral_dir) : (m < 0) ? DOWN : UP;
+
+ return UP;
}
+
void
-Tie::do_add_processing()
+Tie::set_direction (Grob*me)
{
- if (!(head (LEFT) && head (RIGHT)))
- warning (_ ("lonely tie"));
-
- Direction d = LEFT;
- Drul_array<Note_head *> new_head_drul;
- new_head_drul[LEFT] = head(LEFT);
- new_head_drul[RIGHT] = head(RIGHT);
- do {
- if (!head (d))
- new_head_drul[d] = head((Direction)-d);
- } while (flip(&d) != LEFT);
-
- index_set_cell (get_elt_property ("heads"), LEFT, new_head_drul[LEFT]->self_scm_ );
- index_set_cell (get_elt_property ("heads"), RIGHT, new_head_drul[LEFT]->self_scm_ );
-
+ if (!get_grob_direction (me))
+ {
+ if (Tie_column::has_interface (me->get_parent (Y_AXIS)))
+ Tie_column::set_directions (me->get_parent (Y_AXIS));
+ else
+ set_grob_direction (me, Tie::get_default_dir (me));
+ }
}
-void
-Tie::do_post_processing()
-{
- if (!head (LEFT) && !head (RIGHT))
+/*
+ TODO: we should also use thickness for computing the clearance
+ between head and tie. Very thick ties will now touch the note head.
+
+ */
+SCM
+Tie::get_control_points (SCM smob)
+{
+ Spanner*me = unsmob_spanner (smob);
+ Direction headdir = CENTER;
+ if (head (me,LEFT))
+ headdir = LEFT;
+ else if (head (me,RIGHT))
+ headdir = RIGHT;
+ else
{
programming_error ("Tie without heads.");
- set_elt_property ("transparent", SCM_BOOL_T);
- set_empty (X_AXIS);
- set_empty (Y_AXIS);
- return;
+ me->suicide ();
+ return SCM_EOL;
}
- Real staff_space = paper_l ()->get_var ("interline");
- Real half_staff_space = staff_space / 2;
- Real x_gap_f = paper_l ()->get_var ("tie_x_gap");
- Real y_gap_f = paper_l ()->get_var ("tie_y_gap");
-
- /*
- Slur and tie placement [OSU]
+ set_direction (me);
- Ties:
+ Direction dir = get_grob_direction (me);
+
+ Real staff_space = Staff_symbol_referencer::staff_space (me);
- * x = inner vertical tangent - d * gap
+ Real x_gap_f = robust_scm2double (me->get_grob_property ("x-gap"), 0);
- */
+ Grob* l = me->get_bound (LEFT);
+ Grob* r = me->get_bound (RIGHT);
+ Grob* commonx = me->common_refpoint (l, X_AXIS);
+ commonx = me->common_refpoint (r, X_AXIS);
+
+ Real left_x;
/*
- OSU: not different for outer notes, so why all this code?
- ie, can we drop this, or should it be made switchable.
+ the tie has to be long enough to be visible, but should not go
+ through key sigs. In the 1.5 series the pref.matter - note
+ distance is fixed , so this won't be a problem anymore.
*/
-#if 0
- Direction d = LEFT;
- do
+ Real lambda = 0.9;
+
+ if (Note_head::has_interface (l))
{
- Real head_width_f = head (d)
- ? head (d)->extent (X_AXIS).length ()
- : 0;
- /*
- side attached to outer (upper or lower) notehead of chord
- */
- if (head (d)
- /*
-
- a~a~a;
-
- to second tie, middle notehead seems not extremal
+ Real where = RIGHT;
- Getting scared a bit by score-element's comment:
- // is this a good idea?
- */
- // FIXME extremal deprecated
- && (head (d)->get_elt_property ("extremal")
- != SCM_UNDEFINED))
- {
- if (d == LEFT)
- dx_f_drul_[d] += head_width_f;
- dx_f_drul_[d] += -d * x_gap_f;
- }
/*
- side attached to inner notehead
- */
- else
- {
- dx_f_drul_[d] += -d * head_width_f;
- }
- } while (flip (&d) != LEFT);
-
-#else
-
- if (head (LEFT))
- dx_f_drul_[LEFT] = head (LEFT)->extent (X_AXIS).length ();
+ This correction is due te the shape of the black note head.
+ */
+ if (Rhythmic_head::duration_log (l) == 2)
+ where += dir* 0.2;
+ left_x = l->extent (l, X_AXIS).linear_combination (where)
+ + x_gap_f;
+ }
else
- dx_f_drul_[LEFT] = get_broken_left_end_align ();
- dx_f_drul_[LEFT] += x_gap_f;
- dx_f_drul_[RIGHT] -= x_gap_f;
-
-#endif
-
- /*
- Slur and tie placement [OSU] -- check this
-
- Ties:
-
- * y = dx < 5ss: horizontal tangent
- y = dx >= 5ss: y next interline - d * 0.25 ss
-
- which probably means that OSU assumes that
-
- dy <= 5 dx
-
- for smal slurs
- */
-
-
- Real ypos = head (LEFT)
- ? Staff_symbol_referencer_interface (head (LEFT)).position_f ()
- : Staff_symbol_referencer_interface (head (RIGHT)).position_f () ;
+ left_x = l->extent (l, X_AXIS).linear_combination (lambda);
+
- Real y_f = half_staff_space * ypos;
- int ypos_i = int (ypos);
-
- Real dx_f = extent (X_AXIS).length () + dx_f_drul_[RIGHT] - dx_f_drul_[LEFT];
- Direction dir = directional_element (this).get();
- if (dx_f < paper_l ()->get_var ("tie_staffspace_length"))
+ Real width;
+ if (Note_head::has_interface (l) && Note_head::has_interface (r))
{
- if (abs (ypos_i) % 2)
- y_f += dir * half_staff_space;
- y_f += dir * y_gap_f;
+ width =
+ + r->extent (commonx,X_AXIS)[LEFT]
+ - l->extent (commonx, X_AXIS)[RIGHT]
+ -2 * x_gap_f;
}
else
{
- if (! (abs (ypos_i) % 2))
- y_f += dir * half_staff_space;
- y_f += dir * half_staff_space;
- y_f -= dir * y_gap_f;
+ if (Note_head::has_interface (l))
+ width = r->relative_coordinate (commonx, X_AXIS)
+ - l->extent (commonx, X_AXIS)[RIGHT]
+ - 2 * x_gap_f;
+ else
+ width =
+ - l->extent (commonx, X_AXIS).linear_combination (lambda)
+ + r->extent (commonx, X_AXIS)[LEFT]
+ - 2 * x_gap_f;
}
- dy_f_drul_[LEFT] = dy_f_drul_[RIGHT] = y_f;
-}
-
-
-Array<Rod>
-Tie::get_rods () const
-{
- Array<Rod> a;
- Rod r;
- r.item_l_drul_ = spanned_drul_;
- r.distance_f_ = paper_l ()->get_var ("tie_x_minimum");
- a.push (r);
- return a;
-}
+ SCM details = me->get_grob_property ("details");
+ SCM lim // groetjes aan de chirurgendochter.
+ = scm_assq (ly_symbol2scm ("height-limit"),details);
+
+ Real h_inf = gh_scm2double (ly_cdr (lim)) * staff_space;
+ Real r_0 = gh_scm2double (ly_cdr (scm_assq (ly_symbol2scm ("ratio"),details)));
+ Bezier b = slur_shape (width, h_inf, r_0);
+
+ /*
+ I think this better, particularly for small ties. It always allows the user to move ties if
+ they seem in the wrong place
-Molecule*
-Tie::do_brew_molecule_p () const
-{
- Real thick = paper_l ()->get_var ("slur_thickness");
- Bezier one = get_curve ();
+ TODO: what if 2 heads have different size.
- Molecule a;
- SCM d = get_elt_property ("dashed");
- if (gh_number_p (d))
- a = lookup_l ()->dashed_slur (one, thick, gh_scm2int (d));
- else
- a = lookup_l ()->slur (one, directional_element (this).get () * thick, thick);
-
- return new Molecule (a);
-}
+ */
+ Real ypos = Tie::get_position (me) * staff_space/2
+ + dir * gh_scm2double (me->get_grob_property ("y-offset"));;
+ /*
+ Make sure we don't start on a dots
+ */
+ if (Note_head::has_interface (l) && Rhythmic_head::get_dots (l))
+ {
+ Grob* dots = Rhythmic_head::get_dots (l);
+ if(fabs (staff_space * Staff_symbol_referencer::get_position (dots) /2
+ - ypos) < 0.5)
+ {
+ ypos += 0.5 * dir ;
+ }
+ }
-Bezier
-Tie::get_curve () const
-{
- Bezier_bow b (get_encompass_offset_arr (), directional_element (this).get ());
+
+ /*
+ todo: prevent ending / staffline collision.
- b.ratio_ = paper_l ()->get_var ("slur_ratio");
- b.height_limit_ = paper_l ()->get_var ("slur_height_limit");
- b.rc_factor_ = paper_l ()->get_var ("slur_rc_factor");
+ todo: tie / stem collision
+ */
- b.calculate ();
- return b.get_curve ();
-}
+ b = slur_shape (width,h_inf, r_0);
+ b.scale (1, dir);
+ b.translate (Offset (left_x, ypos));
+
-#if 0
+ /*
+ Avoid colliding of the horizontal part with stafflines.
-/*
- TODO: FIXME.
- */
+
+ TODO: redo this, heuristic is half-baken, and ties often look ugly
+ as a result.
-/*
- Clipping
+ TODO: doesn't work when on staff with even number of lines.
+ */
+ Array<Real> horizontal (b.solve_derivative (Offset (1,0)));
+ if (horizontal.size ())
+ {
+ /*
+ ugh. Doesnt work for non-horizontal curves.
+ */
+ Real y = b.curve_point (horizontal[0])[Y_AXIS];
- This function tries to address two issues:
- * the tangents of the slur should always point inwards
- in the actual slur, i.e. *after rotating back*.
+ Real ry = rint (y/staff_space) * staff_space;
+ Real diff = ry - y;
+ Real newy = y;
- * slurs shouldn't be too high
- let's try : h <= 1.2 b && h <= 3 staffheight?
+ Real clear = staff_space * gh_scm2double (me->get_grob_property ("staffline-clearance"));
- We could calculate the tangent of the bezier curve from
- both ends going inward, and clip the slur at the point
- where the tangent (after rotation) points up (or inward
- with a certain maximum angle).
-
- However, we assume that real clipping is not the best
- answer. We expect that moving the outer control point up
- if the slur becomes too high will result in a nicer slur
- after recalculation.
-
- Knowing that the tangent is the line through the first
- two control points, we'll clip (move the outer control
- point upwards) too if the tangent points outwards.
- */
-
-bool
-Bezier_Tie::calc_clipping ()
-{
- Real clip_height = paper_l_->get_var ("slur_clip_height");
- Real clip_ratio = paper_l_->get_var ("slur_clip_ratio");
- Real clip_angle = paper_l_->get_var ("slur_clip_angle");
-
- Real b = curve_.control_[3][X_AXIS] - curve_.control_[0][X_AXIS];
- Real clip_h = clip_ratio * b <? clip_height;
- Real begin_h = curve_.control_[1][Y_AXIS] - curve_.control_[0][Y_AXIS];
- Real end_h = curve_.control_[2][Y_AXIS] - curve_.control_[3][Y_AXIS];
- Real begin_dy = 0 >? begin_h - clip_h;
- Real end_dy = 0 >? end_h - clip_h;
-
- Real pi = M_PI;
- Real begin_alpha = (curve_.control_[1] - curve_.control_[0]).arg () + dir_ * alpha_;
- Real end_alpha = pi - (curve_.control_[2] - curve_.control_[3]).arg () - dir_ * alpha_;
+ if (fabs (y) <=
+ Staff_symbol_referencer::staff_radius (me) * staff_space + clear
+ && fabs (diff) < clear)
+ {
+ Real y1 = ry + clear;
+ Real y2 = ry - clear;
- Real max_alpha = clip_angle / 90 * pi / 2;
- if ((begin_dy < 0) && (end_dy < 0)
- && (begin_alpha < max_alpha) && (end_alpha < max_alpha))
- return false;
+ /*
+ ugh, we shove the 0.5 out of our sleeves.
+
+ Any way. This test is to make sure that staffline
+ collision avoidance does not result in completely flat
+ ties.
+ */
+ if (fabs (y1 - ypos) < 0.5)
+ y1 = y2;
+ else if (fabs (y2 - ypos) < 0.5)
+ y2 = y1;
+
+ newy = (fabs (y1 - y) < fabs (y2 - y)) ? y1 : y2;
+
+ // newy = ry - 0.5 * staff_space * sign (diff) ;
- transform_back ();
+ /*
+ we don't want horizontal ties
+ */
+ if (fabs (newy - b.control_[0][Y_AXIS]) < 1e-2)
+ {
+ newy = newy + dir * staff_space;
+ }
+ }
- if ((begin_dy > 0) || (end_dy > 0))
- {
- Real dy = (begin_dy + end_dy) / 4;
- dy *= cos (alpha_);
- encompass_[0][Y_AXIS] += dir_ * dy;
- encompass_.top ()[Y_AXIS] += dir_ * dy;
+ Real y0 = b.control_ [0][Y_AXIS];
+ b.control_[2][Y_AXIS] =
+ b.control_[1][Y_AXIS] =
+ (b.control_[1][Y_AXIS] - y0) * ((newy - y0) / (y - y0)) + y0;
}
else
- {
- //ugh
- Real c = 0.4;
- if (begin_alpha >= max_alpha)
- begin_dy = 0 >? c * begin_alpha / max_alpha * begin_h;
- if (end_alpha >= max_alpha)
- end_dy = 0 >? c * end_alpha / max_alpha * end_h;
-
- encompass_[0][Y_AXIS] += dir_ * begin_dy;
- encompass_.top ()[Y_AXIS] += dir_ * end_dy;
-
- Offset delta = encompass_.top () - encompass_[0];
- alpha_ = delta.arg ();
- }
+ programming_error ("Tie is nowhere horizontal");
- to_canonic_form ();
- return true;
-}
-#endif
+ SCM controls = SCM_EOL;
+ for (int i= 4; i--;)
+ controls = gh_cons (ly_offset2scm (b.control_[i]), controls);
+ return controls;
+}
-Array<Offset>
-Tie::get_encompass_offset_arr () const
+MAKE_SCHEME_CALLBACK (Tie,brew_molecule,1);
+SCM
+Tie::brew_molecule (SCM smob)
{
- Array<Offset> offset_arr;
- offset_arr.push (Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]));
- offset_arr.push (Offset (spanner_length () + dx_f_drul_[RIGHT],
- dy_f_drul_[RIGHT]));
-
- return offset_arr;
+ Grob*me = unsmob_grob (smob);
+
+ SCM cp = me->get_grob_property ("control-points");
+ if (!gh_pair_p (cp)) // list is more accurate
+ {
+ cp = get_control_points (smob);
+ me->set_grob_property ("control-points", cp);
+ }
+
+ if (!gh_pair_p (cp))
+ return Molecule ().smobbed_copy ();
+
+ Real thick
+ = Staff_symbol_referencer::line_thickness (me)
+ * robust_scm2double (me->get_grob_property ("thickness"), 1);
+
+ Bezier b;
+ int i = 0;
+ for (SCM s= cp; s != SCM_EOL; s = ly_cdr (s))
+ {
+ b.control_[i] = ly_scm2offset (ly_car (s));
+ i++;
+ }
+
+ Molecule a = Lookup::slur (b, get_grob_direction (me) * thick, thick);
+
+ return a.smobbed_copy ();
}
+
+ADD_INTERFACE (Tie,"tie-interface",
+ "A tie connecting two noteheads.\n"
+"direction = Forced direction for all ties",
+ "y-offset staffline-clearance control-points head-pair details thickness x-gap direction minimum-length");