source file of the GNU LilyPond music typesetter
- (c) 1998--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
+#include <math.h> // ceil.
+#include "note-head.hh"
#include "side-position-interface.hh"
-#include "staff-symbol.hh"
-#include "debug.hh"
+#include "warn.hh"
#include "warn.hh"
#include "dimensions.hh"
-#include "dimension-cache.hh"
#include "staff-symbol-referencer.hh"
-
-Side_position_interface::Side_position_interface (Score_element const *e)
-{
- elt_l_ = (Score_element*)e;
-}
-
+#include "group-interface.hh"
+#include "directional-element-interface.hh"
+#include "staff-symbol-referencer.hh"
void
-Side_position_interface::add_support (Score_element*e)
+Side_position_interface::add_support (Grob*me, Grob*e)
{
- SCM sup = elt_l_->get_elt_property ("side-support");
- elt_l_->set_elt_property ("side-support",
- gh_cons (e->self_scm_,sup));
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("side-support-elements"), e);
}
-
-
Direction
-Side_position_interface::get_direction () const
+Side_position_interface::get_direction (Grob*me)
{
- SCM d = elt_l_->get_elt_property ("direction");
- if (isdir_b (d))
- return to_dir (d) ? to_dir (d) : DOWN;
+ SCM d = me->get_property ("direction");
+ if (is_direction (d) && to_dir (d))
+ return to_dir (d);
- Direction relative_dir = UP;
- SCM reldir = elt_l_->get_elt_property ("side-relative-direction"); // should use a lambda.
- if (isdir_b (reldir))
+ Direction relative_dir = Direction (1);
+ SCM reldir = me->get_property ("side-relative-direction"); // should use a lambda.
+ if (is_direction (reldir))
{
relative_dir = to_dir (reldir);
}
- SCM other_elt = elt_l_->get_elt_property ("direction-source");
- Score_element * e = unsmob_element(other_elt);
+ SCM other_elt = me->get_property ("direction-source");
+ Grob * e = unsmob_grob (other_elt);
if (e)
{
- return (Direction)(relative_dir * Side_position_interface (e).get_direction ());
+ return (Direction) (relative_dir * get_grob_direction (e));
}
- return DOWN;
+ return CENTER;
}
-/**
- Callback that does the aligning.
- */
-Real
-Side_position_interface::side_position (Dimension_cache const * c)
+
+MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_support_extents, 2);
+SCM
+Side_position_interface::aligned_on_support_extents (SCM element_smob, SCM axis)
+{
+ Grob *me = unsmob_grob (element_smob);
+ Axis a = (Axis) gh_scm2int (axis);
+
+ return general_side_position (me, a, true);
+}
+
+
+/*
+ Puts the element next to the support, optionally taking in
+ account the extent of the support.
+*/
+SCM
+Side_position_interface::general_side_position (Grob * me, Axis a, bool use_extents)
{
- Score_element * me = dynamic_cast<Score_element*> (c->element_l ());
+ Real ss = Staff_symbol_referencer::staff_space (me);
+ SCM support = me->get_property ("side-support-elements");
+ Grob *common = common_refpoint_of_list (support, me->get_parent (a), a);
+ Grob * st = Staff_symbol_referencer::get_staff_symbol (me);
+ bool include_staff = (st
+ && a == Y_AXIS
+ && gh_number_p (me->get_property ("staff-padding")));
Interval dim;
- Axis axis = c->axis ();
- Score_element *common = me->parent_l (axis);
- SCM support = me->get_elt_property ("side-support");
- for (SCM s = support; s != SCM_EOL; s = gh_cdr (s))
+ if (include_staff)
{
- Score_element * e = unsmob_element ( gh_car (s));
- if (e)
- common = common->common_refpoint (e, axis);
+ common = st->common_refpoint (common, Y_AXIS);
+ dim = st->extent (common, Y_AXIS);
}
-
- for (SCM s = support; s != SCM_EOL; s = gh_cdr (s))
+
+ for (SCM s = support; s != SCM_EOL; s = ly_cdr (s))
{
-
- Score_element * e = unsmob_element ( gh_car (s));
+ Grob * e = unsmob_grob (ly_car (s));
if (e)
- {
- Real coord = e->relative_coordinate (common, axis);
-
- dim.unite (coord + e->extent (axis));
- }
+ if (use_extents)
+ dim.unite (e->extent (common, a));
+ else
+ {
+ Real x = e->relative_coordinate (common, a);
+ dim.unite (Interval (x,x));
+ }
}
- if (dim.empty_b ())
+ if (dim.is_empty ())
{
- dim = Interval(0,0);
+ dim = Interval (0,0);
}
- Real off = me->parent_l (axis)->relative_coordinate (common, axis);
+ Direction dir = Side_position_interface::get_direction (me);
+
+ Real off = me->get_parent (a)->relative_coordinate (common, a);
+ Real minimum_space = ss * robust_scm2double (me->get_property ("minimum-space"), -1);
+ Real total_off = dim.linear_combination (dir) - off;
+ total_off += dir * ss * robust_scm2double (me->get_property ("padding"), 0);
- Direction dir = Side_position_interface (me).get_direction ();
-
- SCM pad = me->remove_elt_property ("padding");
- if (gh_number_p (pad))
+ if (minimum_space >= 0
+ && dir
+ && total_off * dir < minimum_space)
{
- off += gh_scm2double (pad) * dir;
+ total_off = minimum_space * dir;
}
- Real total_off = dim[dir] + off;
if (fabs (total_off) > 100 CM)
programming_error ("Huh ? Improbable staff side dim.");
- return total_off;
+
+
+
+ return gh_double2scm (total_off);
}
-Real
-Side_position_interface::self_alignment (Dimension_cache const *c)
+/*
+ Cut & paste (ugh.)
+ */
+MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_support_refpoints,2);
+SCM
+Side_position_interface::aligned_on_support_refpoints (SCM smob, SCM axis)
{
- String s ("self-alignment-");
- Axis ax = c->axis ();
- s += (ax == X_AXIS) ? "X" : "Y";
- Score_element *elm = dynamic_cast<Score_element*> (c->element_l ());
- SCM align (elm->get_elt_property (s));
- if (isdir_b (align))
- {
- Direction d = to_dir (align);
- Interval ext(elm->extent (ax));
- if (d)
- {
- return - ext[d];
- }
- return - ext.center ();
- }
- else
- return 0.0;
+ Grob *me = unsmob_grob (smob);
+ Axis a = (Axis) gh_scm2int (axis);
+
+ return general_side_position (me, a, false);
}
+
+
Real
directed_round (Real f, Direction d)
{
return ceil (f);
}
-Real
-Side_position_interface::quantised_position (Dimension_cache const *c)
+/*
+ Callback that quantises in staff-spaces, rounding in the direction
+ of the elements "direction" elt property.
+
+ Only rounds when we're inside the staff, as determined by
+ Staff_symbol_referencer::staff_radius () */
+MAKE_SCHEME_CALLBACK (Side_position_interface,quantised_position,2);
+SCM
+Side_position_interface::quantised_position (SCM element_smob, SCM)
{
- Score_element * me = dynamic_cast<Score_element*> (c->element_l ());
- Side_position_interface s(me);
- Direction d = s.get_direction ();
- Staff_symbol_referencer_interface si (me);
+ Grob *me = unsmob_grob (element_smob);
+
+ Direction d = Side_position_interface::get_direction (me);
- if (si.has_interface_b ())
+ Grob * stsym = Staff_symbol_referencer::get_staff_symbol (me);
+ if (stsym)
{
- Real p = si.position_f ();
+ Real p = Staff_symbol_referencer::get_position (me);
Real rp = directed_round (p, d);
-
- int ip = int (rp);
- if ((ip % 2) == 0)
+ Real rad = Staff_symbol_referencer::staff_radius (me) *2 ;
+ int ip = int (rp);
+
+ Grob *head = me->get_parent (X_AXIS);
+
+ if (Staff_symbol_referencer::on_staffline (me,ip)
+ && ((abs (ip) <= rad)
+ || (Note_head::has_interface (head)
+ && sign (Staff_symbol_referencer::get_position (head))
+ == -d)
+ ))
{
ip += d;
rp += d;
}
-
- return (rp - p) * si.staff_space () / 2.0;
+
+ return gh_double2scm ((rp - p) * Staff_symbol_referencer::staff_space (me) / 2.0);
}
- return 0.0;
+ return gh_double2scm (0.0);
}
-Real
-Side_position_interface::aligned_side (Dimension_cache const *c)
+/*
+ Position next to support, taking into account my own dimensions and padding.
+ */
+MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_side,2);
+SCM
+Side_position_interface::aligned_side (SCM element_smob, SCM axis)
{
- Score_element * me = dynamic_cast<Score_element*> (c->element_l ());
- Side_position_interface s(me);
- Direction d = s.get_direction ();
- Axis ax = c->axis ();
- Real o = side_position (c);
+ Grob *me = unsmob_grob (element_smob);
+ Axis a = (Axis) gh_scm2int (axis);
+
+ Direction d = Side_position_interface::get_direction (me);
+
+ Real o = gh_scm2double (aligned_on_support_extents (element_smob,axis));
- Interval iv = me->extent (ax);
+ Interval iv = me->extent (me, a);
- if (!iv.empty_b ())
+ if (!iv.is_empty ())
{
+ if (!d)
+ {
+ programming_error ("Direction unknown, but aligned-side wanted.");
+ d = DOWN;
+ }
o += - iv[-d];
+ }
- SCM pad = me->get_elt_property ("padding");
- if (gh_number_p (pad))
- o += d *gh_scm2double (pad) ;
+ /*
+ Maintain a minimum distance to the staff. This is similar to side
+ position with padding, but it will put adjoining objects on a row if
+ stuff sticks out of the staff a little.
+ */
+ Grob * st = Staff_symbol_referencer::get_staff_symbol (me);
+ if (st && a == Y_AXIS
+ && gh_number_p (me->get_property ("staff-padding")))
+ {
+ Real padding=
+ Staff_symbol_referencer::staff_space (me)
+ * gh_scm2double (me->get_property ("staff-padding"));
+
+ Grob *common = me->common_refpoint (st, Y_AXIS);
+
+ Interval staff_size = st->extent (common, Y_AXIS);
+ Interval me_ext = me->extent (common, a);
+ Real diff = d*staff_size[d] + padding - d*(o + iv[-d]);
+ o += (d* (diff >? 0));
}
- return o;
+
+ return gh_double2scm (o);
}
-
-
void
-Side_position_interface::set_axis (Axis a)
+Side_position_interface::set_axis (Grob*me, Axis a)
{
- // prop transparent ?
- if (elt_l_->get_elt_property ("side-support") == SCM_UNDEFINED)
- elt_l_->set_elt_property ("side-support" ,SCM_EOL);
-
- elt_l_->dim_cache_[a]->off_callbacks_.push (aligned_side);
+ me->add_offset_callback (Side_position_interface::aligned_side_proc, a);
}
-void
-Side_position_interface::set_quantised (Axis a)
-{
- Dimension_cache * c = elt_l_->dim_cache_[a];
-
- c->off_callbacks_.push (quantised_position);
-}
+// ugh. doesn't catch all variants.
Axis
-Side_position_interface::get_axis () const
+Side_position_interface::get_axis (Grob*me)
{
- Dimension_cache * c = elt_l_->dim_cache_[X_AXIS];
- for (int i=0 ; i < c->off_callbacks_.size();i ++)
- if (c->off_callbacks_[i] == side_position
- ||c->off_callbacks_[i] == aligned_side)
- return X_AXIS;
+ if (me->has_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS)
+ || me->has_offset_callback (Side_position_interface::aligned_side_proc , X_AXIS))
+ return X_AXIS;
return Y_AXIS;
}
-void
-Side_position_interface::set_direction (Direction d)
-{
- elt_l_->set_elt_property ("direction", gh_int2scm (d));
-}
-bool
-Side_position_interface::has_interface_b () const
-{
- return elt_l_->get_elt_property ("side-support") != SCM_UNDEFINED;
-}
-bool
-Side_position_interface::supported_b () const
-{
- SCM s =elt_l_->get_elt_property ("side-support");
- return s != SCM_UNDEFINED && s != SCM_EOL;
-}
+
+ADD_INTERFACE (Side_position_interface,"side-position-interface",
+ "Position a victim object (this one) next to other objects (the "
+ "support). In this case, the property @code{direction} signifies where to put the "
+ "victim object relative to the support (left or right, up or down?)\n\n "
+ "The routine also takes the size the staff into account if "
+ "@code{staff-padding} is set. If undefined, the staff symbol is ignored."
+ ,
+ "staff-padding side-support-elements direction-source "
+ "direction side-relative-direction minimum-space padding");
projects / lilypond.git / blobdiff