release: 1.3.90

[lilypond.git] / lily / include / beam.hh

diff --git a/lily/include/beam.hh b/lily/include/beam.hh
index 55fbc8a6730405574c5d209a83fdbf651ec42455..3ed32fae68a1cdd4928890ba64e511ecd93649b9 100644 (file)
--- a/lily/include/beam.hh
+++ b/lily/include/beam.hh
@@ -1,50 +1,92 @@
 /*
   beam.hh -- part of GNU LilyPond
 
-  (c) 1996,97 Han-Wen Nienhuys
+  (c) 1996--2000 Han-Wen Nienhuys
 */
 
 #ifndef BEAM_HH
 #define BEAM_HH
+
 #include "lily-proto.hh"
-#include "directional-spanner.hh"
-#include "plist.hh"
+#include "lily-guile.hh"
 
-/** a beam connects multiple stems Beam adjusts the stems its owns to
-  make sure that they reach the beam and that point in the correct
-  direction */
-class Beam:  public Directional_spanner {
-public:
-    Link_array<Stem> stems;
-    /// the slope of the beam in posns / point (dimension)   
-    Real slope;
 
-    /// position of leftmost end of beam  
-    Real left_pos;
+/** a beam connects multiple stems.
+
+  Beam adjusts the stems its owns to make sure that they reach the
+  beam and that point in the correct direction (urg?)
+
+   elt_properties:
+   
+   y-position -- real  (position of left edge)
+
+   height -- real  (dy)
+
+
+   Read-only
+   =========
+   
+   flag-width-function --
+
+   damping -- amount of beam slope damping. (int)
+     should beam slope be damped? 0: no, 1: yes, 100000: horizontal beams 
+
+   default-neutral-direction -- which direction to choose if we're in
+     the middle of the staff
    
+   thickness -- weight of beams, in staffspace
+
+   space-function -- function of type multiplicity -> real (in staffspace)
 
-    /* *************** */
-    NAME_MEMBERS();
-    Beam();
-    void add(Stem*);
+   beamed-stem-shorten --
 
-    void set_grouping(Rhythmic_grouping def, Rhythmic_grouping current);
-    void set_stemlens();
-    SCORE_ELEM_CLONE(Beam);
-protected:
-    virtual Interval do_width()const;    
-    virtual Offset center() const;
-    virtual void set_default_dir();
-    virtual void do_pre_processing();
-    virtual void do_post_processing();
-    virtual void do_substitute_dependency(Score_elem*, Score_elem*);
+   height-quants --
 
-    virtual void do_print() const;
+   vertical-position-quant-function --
+
+   dir-function --
+   
+   damping -- damping factor (real).
+
+   outer-stem-length-limit -- catch suspect beam slopes, set slope to zero if
+     outer stem is lengthened more than this (in staffspace)
+
+   slope-limit -- set slope to zero if slope is running away steeper than this.
+*/
+class Beam
+{
+public:
+  static int visible_stem_count (Score_element*);
+  static  Item* first_visible_stem (Score_element*);
+  static  Item* last_visible_stem (Score_element*);
+  static bool has_interface (Score_element*);
+  static void set_interface (Score_element*);  
+  static Real rest_collision_callback (Score_element *,Axis);
+  Beam (SCM);
+  static void add_stem (Score_element*,Score_element*);
+  static void set_beaming (Score_element*,Beaming_info_list *);
+  static void set_stemlens (Score_element*);
+  static int get_multiplicity (Score_element*me);
+  static SCM brew_molecule (SCM);
+  static SCM before_line_breaking (SCM);
+  static SCM after_line_breaking (SCM);
+  static Molecule stem_beams (Score_element*,Item *here, Item *next, Item *prev);
 
 private:
-    Molecule stem_beams(Stem *here, Stem *next, Stem *prev)const;
-    void solve_slope();
-    Molecule*brew_molecule_p()const;
+  static Direction get_default_dir (Score_element*);
+  static  void set_stem_directions (Score_element*);
+  static  void auto_knees (Score_element*);
+  static  bool auto_knee (Score_element*,String gap_str, bool interstaff_b);
+  static void set_stem_shorten (Score_element*);
+  static  void calc_default_position_and_height (Score_element*,Real* y, Real* dy);
+  static  bool suspect_slope_b (Score_element*, Real y, Real dy);
+  static  Real calc_slope_damping_f (Score_element*, Real dy);
+  static  Real calc_stem_y_f (Score_element*, Item* s, Real y, Real dy);
+  static  Real check_stem_length_f (Score_element*, Real y, Real dy);
+  static  void set_stem_length (Score_element*, Real y, Real dy);
+  static   Real quantise_dy_f (Score_element*, Real dy);
+  static  Real quantise_y_f (Score_element*, Real y, Real dy, int quant_dir);
+  static int forced_stem_count (Score_element*);
 };
 
 #endif // BEAM_HH