ZPlacement.H

// ZPlacement.H     $Revision: 1.4 $    $Date: 2003/12/28 14:42:18 $ 

#if !defined __ZPlacement_H

#define __ZPlacement_H


#include <zm/ZPixelCoord.H>


/*************************************************************
 * Base placement of groups in one dimension.
 *************************************************************/
class ZPlacement
{
protected:

  /* Master of all groups */
  ZPCoordMaster &master;

public:

  /* Link with master of this dimension */
  ZPlacement (ZPCoordMaster& rMaster)
    : master(rMaster) {};

  /* Just to make compiler happy */
  virtual ~ZPlacement ();

  /* The main placement procedure.
   * Input:
   *   pc[0] -- start coord;
   *   pc[1] -- end coord of allowed area;
   * Return:
   *   0 - OK, successful placement;
   *   negative - this count of pixels are needed to add to area
   *    place all groups;
   */
  virtual int   place (int pc[2]) = 0;

};


/*************************************************************
 * Typical proportional placement of groups: indentation on
 * borders and equal delta between groups.  Each group uses
 * proportional space under itself.
 *************************************************************/

struct ZPropPlacedType
{
  /* Predefined */
  ZGroupId  id; /* id of group */
  float     part;   /* user-defined fraction > 0 */

  /* Calculated */
  enum{
    non_placed = 0, test_placed, fix_placed
    }       placed;
  Logic     empty;  /* TRUE if group is empty -- skip during calculation */
  float     size;   /* size of group in pixels */
  int       min_size;   /* minimum size due to linked group */
};


#define AnyType ZPropPlacedType
#define AnyAr   ZPropPlacedAr
#define AnyFormatSpec   "\n[%d]: id=%d part=%g placed=%d(1-test,2-fixed) size=%g min_size=%d%s"
#define AnyPrintList    i, item.id, item.part, item.placed, item.size, \
            item.min_size, item.empty?" <empty>": ""
#include <mix/AnyAr.H>


class ZPropPlacement : public ZPlacement
{
private:

  /* Control parameters */
  int       iLeftOffset;    /* pixels */
  int       iRightOffset;   /* pixels */
  int       iDelta;     /* pixels */
  ZPropPlacedAr ar;     /* groups and calculation of its sizes */

  void  place_group (ZGroupId gid, int c[2]);

public:

  /* Link with master of this dimension */
  ZPropPlacement (ZPCoordMaster& master);

  /* Clear object from groups */
  void  reset ();

  /* Includes one more group at the end of list */
  void  add (ZGroupId gid, float fraction);

  /* set - get */
  void  set_left_offset (int leftOffset);
  void  set_right_offset (int rightOffset);
  void  set_delta (int delta);

  int   get_left_offset () const;
  int   get_right_offset () const;
  int   get_delta () const;

  /* The main placement procedure.
   * Input:
   *   pc[0] -- start coord;
   *   pc[1] -- end coord of allowed area;
   * Return:
   *   0 - OK, successful placement;
   *   negative - this count of pixels are needed to add to area
   *    place all groups;
   * Known bugs of method:
   *   1. Computed sizes may slightly differ from ideal (1-3 pixels),
   *     but limited size groups (FixedSize, MinSize) have always right
   *     size;
   *   2. The last group may have greater size than needed (1-3 pixels).
   */
  virtual int   place (int pc[2]);

};


#endif  // ZPlacement.H