lily/line-interface.cc

   1 /*
   2   line-interface.cc -- implement Line_interface
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2004--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "line-interface.hh"
  10
  11 #include "staff-symbol-referencer.hh"
  12 #include "lookup.hh"
  13 #include "output-def.hh"
  14
  15 Stencil
  16 Line_interface::make_arrow (Offset begin, Offset end,
  17                             Real thick,
  18                             Real length, Real width)
  19 {
  20   Real angle = (end - begin).arg();
  21   Array<Offset> points;
  22
  23   //construct the arrow
  24   points.push (Offset (0, 0));
  25   points.push (Offset (-length, width));
  26   points.push (Offset (-length, -width));
  27
  28   // rotate and translate the arrow
  29   for (int i = 0; i < points.size(); i++)
  30     points[i] = points[i] * complex_exp (Offset (0, angle)) + end;
  31
  32   return (Lookup::round_filled_polygon (points, thick));
  33 }
  34
  35 Stencil
  36 Line_interface::make_dashed_line (Real thick, Offset from, Offset to,
  37                                   Real dash_period, Real dash_fraction)
  38 {
  39   dash_fraction = (dash_fraction >? 0) <? 1.0;
  40   Real on = dash_fraction * dash_period + thick;
  41   Real off = dash_period - on;
  42
  43   SCM at = scm_list_n (ly_symbol2scm ("dashed-line"),
  44                        scm_make_real (thick),
  45                        scm_make_real (on),
  46                        scm_make_real (off),
  47                        scm_make_real (to[X_AXIS] - from[X_AXIS]),
  48                        scm_make_real (to[Y_AXIS] - from[Y_AXIS]),
  49                        SCM_UNDEFINED);
  50
  51   Box box;
  52   box.add_point (Offset (0, 0));
  53   box.add_point (to - from);
  54
  55   box[X_AXIS].widen (thick / 2);
  56   box[Y_AXIS].widen (thick / 2);
  57
  58   Stencil m = Stencil (box, at);
  59   m.translate (from);
  60   return m;
  61 }
  62
  63 Stencil
  64 Line_interface::make_line (Real th, Offset from, Offset to)
  65 {
  66   SCM at = scm_list_n (ly_symbol2scm ("draw-line"),
  67                        scm_make_real (th),
  68                        scm_make_real (from[X_AXIS]),
  69                        scm_make_real (from[Y_AXIS]),
  70                        scm_make_real (to[X_AXIS]),
  71                        scm_make_real (to[Y_AXIS]),
  72                        SCM_UNDEFINED);
  73
  74   Box box;
  75   box.add_point (from);
  76   box.add_point (to);
  77
  78   box[X_AXIS].widen (th / 2);
  79   box[Y_AXIS].widen (th / 2);
  80
  81   return Stencil (box, at);
  82 }
  83
  84 Stencil
  85 Line_interface::arrows (Grob *me, Offset from, Offset to,
  86                         bool from_arrow,
  87                         bool to_arrow)
  88 {
  89   Stencil a;
  90   if (from_arrow || to_arrow)
  91     {
  92       Real thick = Staff_symbol_referencer::line_thickness (me)
  93         * robust_scm2double (me->get_property ("thickness"), 1);
  94       Real len = robust_scm2double (me->get_property ("arrow-length"), 1.3);
  95       Real wid = robust_scm2double (me->get_property ("arrow-width"), 0.5);
  96
  97       if (to_arrow)
  98         a.add_stencil (make_arrow (from, to, thick, len, wid));
  99
 100       if (from_arrow)
 101         a.add_stencil (make_arrow (to, from, thick, len, wid));
 102     }
 103
 104   return a;
 105 }
 106
 107
 108 Stencil
 109 Line_interface::line (Grob *me, Offset from, Offset to)
 110 {
 111   Real thick = Staff_symbol_referencer::line_thickness (me)
 112     * robust_scm2double (me->get_property ("thickness"), 1);
 113
 114   SCM type = me->get_property ("style");
 115
 116   Stencil l;
 117
 118   SCM dash_fraction = me->get_property ("dash-fraction");
 119   if (scm_is_number (dash_fraction) || type == ly_symbol2scm ("dotted-line"))
 120     {
 121
 122       Real fraction
 123         = type == ly_symbol2scm ("dotted-line")
 124         ? 0.0
 125         : robust_scm2double (dash_fraction, 0.4);
 126
 127       fraction = (fraction >? 0) <? 1.0;
 128       Real period = Staff_symbol_referencer::staff_space (me)
 129         * robust_scm2double (me->get_property ("dash-period"), 1.0);
 130
 131       if (period < 0)
 132         return Stencil ();
 133
 134       l =  make_dashed_line (thick, from, to, period, fraction);
 135     }
 136   else
 137     {
 138       l =  make_line (thick, from, to);
 139     }
 140
 141   return l;
 142 }
 143
 144 ADD_INTERFACE (Line_interface, "line-interface",
 145                "Generic line objects. Any object using lines supports this.  Normally, "
 146                "you get a straight line. If @code{dash-period} is defined, a dashed line is "
 147                "produced; the length of the dashes is tuned with "
 148                "@code{dash-fraction}. If the latter is set to 0, a dotted line is "
 149                "produced. If @code{dash-fraction} is negative, the line is made "
 150                "transparent.",
 151
 152                "dash-period dash-fraction thickness style arrow-length arrow-width")