* lily/break-substitution.cc (fast_fubstitute_grob_list): use

[lilypond.git] / scm / grob-property-description.scm

diff --git a/scm/grob-property-description.scm b/scm/grob-property-description.scm
index ab79c1ce4e99726b6a632bd6723c0d459b42a7a2..bf9637f67f52e2af57776dc16b4c0977ec9fbb76 100644 (file)
--- a/scm/grob-property-description.scm
+++ b/scm/grob-property-description.scm
@@ -100,7 +100,8 @@ In the case of alignment grobs, this should contain only one number.")
 (grob-property-description 'beam-thickness number? "thickness, measured in staffspace.")
 (grob-property-description 'beam-width number? "width of the tremolo sign.")
 (grob-property-description 'beamed-lengths list? "list of stem lengths given beam multiplicity .")
-(grob-property-description 'beamed-minimum-lengths list? "list of minimum stem lengths given beam multiplicity.")
+(grob-property-description 'beamed-minimum-free-lengths list? "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.")
+(grob-property-description 'beamed-extreme-minimum-free-lengths list? "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.")
 (grob-property-description 'beamed-stem-shorten list? "shorten beamed stems in forced direction.")
 (grob-property-description 'beaming pair?
                           "Pair of number lists. Each number list
@@ -123,6 +124,8 @@ column as start/begin point. Only columns that have grobs or act as bounds are s
 (grob-property-description 'breakable boolean? "boolean indicating if this is a breakable item (clef, barline, key sig, etc.).")
 (grob-property-description 'c0-position integer? "integer indicating the position of central C.")
 (grob-property-description 'cautionary-style symbol? "style  of cautionary accidentals. Choices are 'smaller (one size smaller) or 'parentheses.")
+(grob-property-description 'cautionary boolean? "is this a cautionary accidentals.?")
+
 (grob-property-description 'center-element ly-grob? "grob which will
 be at the center of the group after aligning (when using
 Align_interface::center_on_element). .")
@@ -225,6 +228,31 @@ beaming style: stems stop at innermost beams.")
 (grob-property-description 'hair-thickness number? "thickness, measured in stafflinethickness.")
 (grob-property-description 'heads pair? "Pair of grob pointers, pointing to the two heads of the  tie.")
 (grob-property-description 'height number? "in staffspace.")
+(grob-property-description 'height-limit number? "Maximum slur height,
+  long slurs approach this height.
+
+  For small width w, the height should be proportional to w, for w ->
+  infinity, the height should rise to limit h_infinity asymptotically.
+
+  Hence we take F (x) such that
+@quotation
+@example  
+  F (0) = 0 , F' (0) = 1, and F (infinity) = 1
+@end example
+@end quotation
+  where
+@quotation
+@example  
+  h = height-limit * F (x * ratio / height-limit)
+@end example
+@end quotation
+  Currently, for F we use
+@quotation
+@example  
+  F (x) = 2/pi * atan (pi * x/2)
+@end example
+@end quotation
+")
 (grob-property-description 'horizontal-shift integer? "integer that identifies ranking of note-column for horizontal shifting. This is used by @ref{note-collision-interface}.")
 (grob-property-description 'ideal-distances list? "(OBJ . (DIST . STRENGTH)) pairs.")
 (grob-property-description 'interfaces list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
@@ -236,6 +264,7 @@ beaming style: stems stop at innermost beams.")
 For text,  this is `relative'(?) to the current alignment.
 
 For barline, space after a thick line.")
+(grob-property-description 'knee boolean? "Is this beam a knee?")
 (grob-property-description 'knee-spacing-correction number? "optical correction amount for knees. 0: no correction; 1: full correction.")
 (grob-property-description 'layer number? "The output layer [0..2].  The default is 1.")
 
@@ -332,6 +361,7 @@ as a real penalty.")
 (grob-property-description 'pitches list? "list of musical-pitch.")
 (grob-property-description 'positions pair? "cons of staff positions (LEFT . RIGHT")
 (grob-property-description 'raise number? "height for text to be raised (a negative value lowers the text.")
+(grob-property-description 'ratio number? "Slur parameter.  See height-limit.")
 (grob-property-description 'right-padding number? "space right of accs.")
 (grob-property-description 'right-trim-amount number? "shortening of the lyric extender on the right.")
 (grob-property-description 'right-widen boolean? "Whether the right edge of a piano pedal bracket should be widened by the second element of edge-widen")