lily/include/tie-formatting-problem.hh

   1 /*
   2   tie-formatting-problem.hh -- declare
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2005--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8 */
   9
  10 #ifndef TIE_FORMATTING_PROBLEM_HH
  11 #define TIE_FORMATTING_PROBLEM_HH
  12
  13 #include "drul-array.hh"
  14 #include "parray.hh"
  15 #include "skyline.hh"
  16 #include "lily-proto.hh"
  17 #include "tie-configuration.hh"
  18
  19 #include <map>
  20 #include <set>
  21
  22 struct Tie_details
  23 {
  24   Real height_limit_;
  25   Real ratio_;
  26   Real staff_space_;
  27   Real x_gap_;
  28   Real stem_gap_;
  29   Real between_length_limit_;
  30   Real wrong_direction_offset_penalty_;
  31   Real length_penalty_factor_;
  32   Real min_length_;
  33   Real tip_staff_line_clearance_;
  34   Real center_staff_line_clearance_;
  35   Real staff_line_collision_penalty_;
  36   Real dot_collision_clearance_;
  37   Real dot_collision_penalty_;
  38   Real tie_column_monotonicity_penalty_;
  39   Real tie_tie_collision_penalty_;
  40   Real tie_tie_collision_distance_;
  41   Real horizontal_distance_penalty_factor_;
  42   Real vertical_distance_penalty_factor_;
  43   Real intra_space_threshold_;
  44
  45   Grob *staff_symbol_referencer_;
  46
  47   Tie_details ();
  48   void from_grob (Grob *);
  49 };
  50
  51
  52 typedef map< pair<int, int>, Tie_configuration *> Tie_configuration_map;
  53
  54 struct Tie_specification
  55 {
  56   int position_;
  57   Drul_array<Grob*> note_head_drul_;
  58
  59   bool has_manual_position_;
  60   bool has_manual_dir_;
  61
  62   Real manual_position_;
  63   Direction manual_dir_;
  64
  65   Tie_specification ();
  66 };
  67
  68 struct Tie_configuration_variation
  69 {
  70   int index_;
  71   Tie_configuration *suggestion_;
  72   Tie_configuration_variation ();
  73 };
  74
  75 class Tie_formatting_problem
  76 {
  77   Drul_array< Array<Skyline_entry> > chord_outlines_;
  78   Drul_array< Box > stem_extents_;
  79   set<int> dot_positions_;
  80   Interval dot_x_;
  81   Array<Tie_specification> specifications_;
  82
  83   Tie_configuration_map possibilities_;
  84
  85   Grob *x_refpoint_;
  86
  87
  88   Tie_configuration *get_configuration (int position, Direction dir);
  89   Tie_configuration *generate_configuration (int position, Direction dir) const;
  90   Array<Tie_configuration_variation> get_variations (Ties_configuration const &ties);
  91
  92   Real score_configuration (Tie_configuration const &) const;
  93   Real score_aptitude (Tie_configuration const &, Tie_specification const &) const;
  94   Real score_ties_aptitude (Ties_configuration const &ties) const;
  95   Real score_ties_configuration (Ties_configuration const &ties) const;
  96   void set_ties_config_standard_directions (Ties_configuration *tie_configs_ptr);
  97   Real score_ties (Ties_configuration const&) const;
  98   Ties_configuration generate_base_chord_configuration ();
  99
 100 public:
 101   Tie_details details_;
 102
 103 public:
 104   Tie_formatting_problem ();
 105   ~Tie_formatting_problem ();
 106
 107   Tie_specification get_tie_specification (int) const;
 108   Ties_configuration generate_optimal_chord_configuration ();
 109   Ties_configuration generate_ties_configuration (Ties_configuration const &);
 110   Tie_configuration find_optimal_tie_configuration (Tie_specification const &) const;
 111   void from_ties (Link_array<Grob> const &ties);
 112   void from_tie (Grob *tie);
 113   void from_lv_ties (Link_array<Grob> const &);
 114   void set_chord_outline (Link_array<Item>, Direction);
 115   void set_manual_tie_configuration (SCM);
 116   Interval get_attachment (Real) const;
 117   Grob *common_x_refpoint () const;
 118 };
 119
 120 #endif /* TIE_FORMATTING_PROBLEM_HH */