release: 1.3.91

[lilypond.git] / lily / include / side-position-interface.hh

diff --git a/lily/include/side-position-interface.hh b/lily/include/side-position-interface.hh
index 55a15f308adfabc121b2cbe71de431245d6eb06f..6d8563d434dfb656603e1cf5419c7059b085004f 100644 (file)
--- a/lily/include/side-position-interface.hh
+++ b/lily/include/side-position-interface.hh
@@ -3,7 +3,7 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1999--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   
  */
 
@@ -13,27 +13,52 @@
 #include "spanner.hh"
 #include "item.hh"
 
-#include "directional-element.hh"
 
-struct Side_position_interface
+/**
+   Position victim object (ELT_L_) next to other objects (the support).
+
+   side-support -- list of score elements
+
+   direction -- where to put the victim object (left or right?)
+
+   side-relative-direction -- if set: get the direction from a different object, and multiply by this.
+   
+   direction-source -- in case side-relative-direction is set, where
+   to get the direction
+
+   minimum-space -- minimum distance that the victim should move
+   (after padding)
+
+   padding -- add this much extra space between victim and support
+
+   self-alignment-X -- real number: -1 = left aligned, 0 = center, 1
+     right-aligned in X direction.
+     
+   self-alignment-Y -- like self-alignment-X but for Y axis
+   
+   TODO: move  out unrelated callbacks.
+
+   TODO: reduce number of methods.
+
+*/
+struct Side_position
 {
-  Score_element * elt_l_;
 public:
-  Side_position_interface (Score_element const*);
-  static Real side_position (Dimension_cache const *);
-  static Real self_alignment (Dimension_cache const *);
-  static Real aligned_side (Dimension_cache const *);  
-  static Real quantised_position (Dimension_cache const*);
-  void set_axis (Axis);
-  void set_quantised (Axis);
-  Axis get_axis () const;
-  
-  bool supported_b () const;
-  bool has_interface_b () const;
-  void add_support (Score_element*);
-  
-  Direction get_direction () const;
-  void set_direction (Direction);
+  static Real side_position (Score_element *, Axis);
+  static Real aligned_on_self (Score_element *, Axis);
+  static Real aligned_side (Score_element *, Axis);  
+  static Real quantised_position (Score_element *, Axis);
+  static Real centered_on_parent (Score_element *, Axis);
+  static void set_axis (Score_element*,Axis);
+  static void set_minimum_space (Score_element*,Real);
+  static void set_padding (Score_element*,Real);
+  static Axis get_axis (Score_element*) ;
+  static bool supported_b (Score_element*) ;
+  static bool has_interface (Score_element*) ;
+  static void add_support (Score_element*,Score_element*);
+  static void add_staff_support (Score_element*);
+  static Direction get_direction (Score_element*);
+  static void set_direction (Score_element*,Direction);
 };