<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <!-- header_tag --> <html lang="en"> <head> <title>beam-interface - LilyPond program-reference</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="description" content="LilyPond program-reference"> <meta name="generator" content="makeinfo 4.11"> <link title="Top" rel="start" href="index.html#Top"> <link rel="up" href="Graphical-Object-Interfaces.html#Graphical-Object-Interfaces" title="Graphical Object Interfaces"> <link rel="prev" href="bass_002dfigure_002dinterface.html#bass_002dfigure_002dinterface" title="bass-figure-interface"> <link rel="next" href="bend_002dafter_002dinterface.html#bend_002dafter_002dinterface" title="bend-after-interface"> <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> <meta http-equiv="Content-Style-Type" content="text/css"> <style type="text/css"><!-- pre.display { font-family:inherit } pre.format { font-family:inherit } pre.smalldisplay { font-family:inherit; font-size:smaller } pre.smallformat { font-family:inherit; font-size:smaller } pre.smallexample { font-size:smaller } pre.smalllisp { font-size:smaller } span.sc { font-variant:small-caps } span.roman { font-family:serif; font-weight:normal; } span.sansserif { font-family:sans-serif; font-weight:normal; } hr { border:0; height:1; color: #000000; background-color: #000000; } /* hr { border: none; height: 1px; color: #666666; background-color: #666666; } body { border-left: 1px solid #666666; border-right: 1px solid #666666; color: #332d28; margin-right: auto; margin-left: auto; width: 60em; list-style-type: square; font-family: Arial,Helvetica,sans-serif; padding-right: 1em; padding-left: 1em; } a { border-bottom: 1px dashed #344242; text-decoration: none; color: #344242; } a:link { text-decoration: none; } a:visited { border-bottom: 1px dashed #666666; color: #666666; } a:active { border-bottom: 1px solid #00cccc; color: #00cccc; } a:hover { border-bottom: 1px solid #1d7b85; color: #1d7b85; } blockquote { border: 1px solid #cccccc; padding: 3px; width: 40em; } .node { border-left: 1px solid #666666; margin: -0.5em 0px 1em; padding: 2px 1px 0px; font-style: italic; } .node a { border: none; text-decoration: underline; font-style: normal; font-weight: bold; } .verbatim { font-family: "Courier New",Courier,monospace; } .unnumberedsubsubsec { font-size: large; color: #1d7b85; } .subsubheading { font-size: large; color: #3b220d; } .contents { border: 1px dashed #339999; margin: 3px 2em; list-style-type: square; padding-right: 1em; width: 40em; background-color: #fcfff9; } .contents a { border-bottom: 1px dashed #423d34; text-decoration: none; color: #423d34; } .contents a:visited { border-bottom: 1px dashed #666666; color: #666666; } .contents a:active { border-bottom: 1px solid #f0d86d; color: #f0d86d; } .contents a:hover { border-bottom: 1px solid #3b220d; color: #3b220d; } .menu { border-left: 1px dashed #339999; margin: 3px 2em 1em; list-style-type: square; padding-left: 1.4em; width: 40em; } .unnumbered { } h2 { font-size: x-large; color: #1d7b85; } */ --></style> </head> <BODY BGCOLOR=WHITE TEXT=BLACK> <div class="node"> <p> <a name="beam-interface"></a> <a name="beam_002dinterface"></a> Next: <a rel="next" accesskey="n" href="bend_002dafter_002dinterface.html#bend_002dafter_002dinterface">bend-after-interface</a>, Previous: <a rel="previous" accesskey="p" href="bass_002dfigure_002dinterface.html#bass_002dfigure_002dinterface">bass-figure-interface</a>, Up: <a rel="up" accesskey="u" href="Graphical-Object-Interfaces.html#Graphical-Object-Interfaces">Graphical Object Interfaces</a> <hr> </div> <h4 class="unnumberedsubsec">beam-interface</h4> <p>A beam. <p>The <code>thickness</code> property is the weight of beams, measured in staffspace. The <code>direction</code> property is not user-serviceable. Use the <code>direction</code> property of <code>Stem</code> instead. <h5 class="unnumberedsubsubsec">User settable properties:</h5> <blockquote> <dl> <dt><code>annotation</code> (string)<dd>Annotate a grob for debug purposes. <br><dt><code>auto-knee-gap</code> (dimension, in staff space)<dd>If a gap is found between note heads where a horizontal beam fits that is larger than this number, make a kneed beam. <br><dt><code>beamed-stem-shorten</code> (list)<dd>How much to shorten beamed stems, when their direction is forced. It is a list, since the value is different depending on the number of flags and beams. <br><dt><code>beaming</code> (pair)<dd>Pair of number lists. Each number list specifies which beams to make. <code>0</code> is the central beam, <code>1</code> is the next beam toward the note, etc. This information is used to determine how to connect the beaming patterns from stem to stem inside a beam. <br><dt><code>break-overshoot</code> (pair of numbers)<dd>How much does a broken spanner stick out of its bounds? <br><dt><code>clip-edges</code> (boolean)<dd>Allow outward pointing beamlets at the edges of beams? <br><dt><code>concaveness</code> (number)<dd>A beam is concave if its inner stems are closer to the beam than the two outside stems. This number is a measure of the closeness of the inner stems. It is used for damping the slope of the beam. <br><dt><code>damping</code> (number)<dd>Amount of beam slope damping. <br><dt><code>direction</code> (direction)<dd>If <code>side-axis</code> is <code>0</code> (or <code>#X</code>), then this property determines whether the object is placed <code>#LEFT</code>, <code>#CENTER</code> or <code>#RIGHT</code> with respect to the other object. Otherwise, it determines whether the object is placed <code>#UP</code>, <code>#CENTER</code> or <code>#DOWN</code>. Numerical values may also be used: <code>#UP</code>=<code>1</code>, <code>#DOWN</code>=<code>-1</code>, <code>#LEFT</code>=<code>-1</code>, <code>#RIGHT</code>=<code>1</code>, <code>#CENTER</code>=<code>0</code>. <br><dt><code>gap</code> (dimension, in staff space)<dd>Size of a gap in a variable symbol. <br><dt><code>gap-count</code> (integer)<dd>Number of gapped beams for tremolo. <br><dt><code>grow-direction</code> (direction)<dd>Crescendo or decrescendo? <br><dt><code>inspect-quants</code> (pair of numbers)<dd>If debugging is set, set beam and slur quants to this position, and print the respective scores. <br><dt><code>knee</code> (boolean)<dd>Is this beam kneed? <br><dt><code>length-fraction</code> (number)<dd>Multiplier for lengths. Used for determining ledger lines and stem lengths. <br><dt><code>neutral-direction</code> (direction)<dd>Which direction to take in the center of the staff. <br><dt><code>positions</code> (pair of numbers)<dd>Pair of staff coordinates <code>(</code><var>left</var><code> . </code><var>right</var><code>)</code>, where both <var>left</var> and <var>right</var> are in <code>staff-space</code> units of the current staff. For slurs, this value selects which slur candidate to use; if extreme positions are requested, the closest one is taken. <br><dt><code>thickness</code> (number)<dd>Line thickness, generally measured in <code>line-thickness</code>. </dl> </blockquote> <h5 class="unnumberedsubsubsec">Internal properties:</h5> <blockquote> <dl> <dt><code>details</code> (list)<dd>Alist of parameters for detailed grob behavior. <p>More information on the allowed parameters can be found by inspecting <samp><span class="file">lily/slur-scoring.cc</span></samp>, <samp><span class="file">lily/beam-quanting.cc</span></samp>, and <samp><span class="file">lily/tie-formatting-problem.cc</span></samp>. Setting <code>debug-tie-scoring</code>, <code>debug-beam-scoring</code> or <code>debug-slur-scoring</code> also provides useful clues. <br><dt><code>least-squares-dy</code> (number)<dd>The ideal beam slope, without damping. <br><dt><code>normal-stems</code> (unknown)<dd>An array of visible stems. <br><dt><code>quant-score</code> (string)<dd>The beam quanting score; stored for debugging. <br><dt><code>quantized-positions</code> (pair of numbers)<dd>The beam positions after quanting. <br><dt><code>shorten</code> (dimension, in staff space)<dd>The amount of space that a stem is shortened. Internally used to distribute beam shortening over stems. <br><dt><code>stems</code> (unknown)<dd>A list of stem objects, corresponding to the notes that the arpeggio has to be before. </dl> </blockquote> <p>This grob interface is used in the following graphical object(s): <a href="Beam.html#Beam">Beam</a>. <!-- footer_tag --><br><hr> <div class="node"> <p> <a name="beam_002dinterface"></a> Next: <a rel="next" accesskey="n" href="bend_002dafter_002dinterface.html#bend_002dafter_002dinterface">bend-after-interface</a>, Previous: <a rel="previous" accesskey="p" href="bass_002dfigure_002dinterface.html#bass_002dfigure_002dinterface">bass-figure-interface</a>, Up: <a rel="up" accesskey="u" href="Graphical-Object-Interfaces.html#Graphical-Object-Interfaces">Graphical Object Interfaces</a> </div> <div style="background-color: #e8ffe8; padding: 2; border: #c0ffc0 1px solid;"> <p> <font size="-1"> This page is for LilyPond-2.11.57 (development-branch). <br> <address> Report errors to <a href="http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs">http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs</a>. </address> <br> Your <a href="http://lilypond.org/web/devel/participating/documentation-adding">suggestions for the documentation</a> are welcome. </font> </p> </div> </BODY></html>