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 "std-vector.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 min_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   Real outer_tie_length_symmetry_penalty_factor_;
  45   Real outer_tie_vertical_distance_symmetry_penalty_factor_;
  46
  47   Grob *staff_symbol_referencer_;
  48
  49   Tie_details ();
  50   void from_grob (Grob *);
  51 };
  52
  53
  54 typedef map< pair<int, int>, Tie_configuration *> Tie_configuration_map;
  55
  56 struct Tie_specification
  57 {
  58   int position_;
  59   Drul_array<Grob*> note_head_drul_;
  60
  61   bool has_manual_position_;
  62   bool has_manual_dir_;
  63
  64   Real manual_position_;
  65   Direction manual_dir_;
  66
  67   Tie_specification ();
  68 };
  69
  70 struct Tie_configuration_variation
  71 {
  72   int index_;
  73   Tie_configuration *suggestion_;
  74   Tie_configuration_variation ();
  75 };
  76
  77 class Tie_formatting_problem
  78 {
  79   Drul_array< vector<Skyline_entry> > chord_outlines_;
  80   Drul_array< Box > stem_extents_;
  81   set<int> dot_positions_;
  82   Interval dot_x_;
  83   vector<Tie_specification> specifications_;
  84
  85   Tie_configuration_map possibilities_;
  86
  87   Grob *x_refpoint_;
  88
  89
  90   Tie_configuration *get_configuration (int position, Direction dir);
  91   Tie_configuration *generate_configuration (int position, Direction dir) const;
  92   vector<Tie_configuration_variation> get_variations (Ties_configuration const &ties);
  93
  94   Real score_configuration (Tie_configuration const &) const;
  95   Real score_aptitude (Tie_configuration const &, Tie_specification const &) const;
  96   Real score_ties_aptitude (Ties_configuration const &ties) const;
  97   Real score_ties_configuration (Ties_configuration const &ties) const;
  98   void set_ties_config_standard_directions (Ties_configuration *tie_configs_ptr);
  99   Real score_ties (Ties_configuration const&) const;
 100   Ties_configuration generate_base_chord_configuration ();
 101
 102 public:
 103   Tie_details details_;
 104
 105 public:
 106   Tie_formatting_problem ();
 107   ~Tie_formatting_problem ();
 108
 109   Tie_specification get_tie_specification (int) const;
 110   Ties_configuration generate_optimal_chord_configuration ();
 111   Ties_configuration generate_ties_configuration (Ties_configuration const &);
 112   Tie_configuration find_optimal_tie_configuration (Tie_specification const &) const;
 113   void from_ties (vector<Grob*> const &ties);
 114   void from_tie (Grob *tie);
 115   void from_lv_ties (vector<Grob*> const &);
 116   void set_chord_outline (vector<Item*>, Direction);
 117   void set_manual_tie_configuration (SCM);
 118   Interval get_attachment (Real) const;
 119   Grob *common_x_refpoint () const;
 120 };
 121
 122 #endif /* TIE_FORMATTING_PROBLEM_HH */