Documentation/snippets/generating-custom-flags.ly

   1 % DO NOT EDIT this file manually; it is automatically
   2 % generated from Documentation/snippets/new
   3 % Make any changes in Documentation/snippets/new/
   4 % and then run scripts/auxiliar/makelsr.py
   5 %
   6 % This file is in the public domain.
   7 %% Note: this file works from version 2.16.0
   8 \version "2.16.0"
   9
  10 \header {
  11   lsrtags = "rhythms, tweaks-and-overrides"
  12
  13   texidoc = "
  14 The @code{stencil} property of the Flag grob can be set to a custom scheme
  15 function to generate the glyph for the flag.
  16
  17 "
  18   doctitle = "Generating custom flags"
  19 } % begin verbatim
  20
  21
  22 #(define-public (weight-flag grob)
  23    (let* ((stem-grob (ly:grob-parent grob X))
  24           (log (- (ly:grob-property stem-grob 'duration-log) 2))
  25           (is-up? (eqv? (ly:grob-property stem-grob 'direction) UP))
  26           (yext (if is-up? (cons (* log -0.8) 0) (cons 0 (* log 0.8))))
  27           (flag-stencil (make-filled-box-stencil '(-0.4 . 0.4) yext))
  28           (stroke-style (ly:grob-property grob 'stroke-style))
  29           (stroke-stencil (if (equal? stroke-style "grace")
  30                               (make-line-stencil 0.2 -0.9 -0.4 0.9 -0.4)
  31                               empty-stencil)))
  32      (ly:stencil-add flag-stencil stroke-stencil)))
  33
  34
  35 % Create a flag stencil by looking up the glyph from the font
  36 #(define (inverted-flag grob)
  37    (let* ((stem-grob (ly:grob-parent grob X))
  38           (dir (if (eqv? (ly:grob-property stem-grob 'direction) UP) "d" "u"))
  39           (flag (retrieve-glyph-flag "" dir "" grob))
  40           (line-thickness (ly:staff-symbol-line-thickness grob))
  41           (stem-thickness (ly:grob-property stem-grob 'thickness))
  42           (stem-width (* line-thickness stem-thickness))
  43           (stroke-style (ly:grob-property grob 'stroke-style))
  44           (stencil (if (null? stroke-style)
  45                        flag
  46                        (add-stroke-glyph flag stem-grob dir stroke-style "")))
  47           (rotated-flag (ly:stencil-rotate-absolute stencil 180 0 0)))
  48      (ly:stencil-translate rotated-flag (cons (- (/ stem-width 2)) 0))))
  49
  50 snippetexamplenotes = { \autoBeamOff c'8 d'16 c'32 d'64 \acciaccatura {c'8} d'64 }
  51
  52 {
  53   \override Score.RehearsalMark #'self-alignment-X = #LEFT
  54   \time 1/4
  55   \mark "Normal flags"
  56   \snippetexamplenotes
  57
  58   \mark "Custom flag: inverted"
  59   \override Flag #'stencil = #inverted-flag
  60   \snippetexamplenotes
  61
  62   \mark "Custom flag: weight"
  63   \override Flag #'stencil = #weight-flag
  64   \snippetexamplenotes
  65
  66   \mark "Revert to normal"
  67   \revert Flag #'stencil
  68   \snippetexamplenotes
  69 }