src/math/yearline.h

   1 /****************************************************************************
   2  *  Familia Lignum - Genealogical program                                   *
   3  *  Copyright (C) 2011-2012 Rafał Długołęcki <rafal@dlugolecki.net.pl>      *
   4  *                                                                          *
   5  *  This program is free software; you can redistribute it and/or modify    *
   6  *  it under the terms of the GNU General Public License as published by    *
   7  *  the Free Software Foundation; version 2 of the License.                 *
   8  *                                                                          *
   9  *  This program is distributed in the hope that it will be useful,         *
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           *
  12  *  GNU General Public License for more details.                            *
  13  *                                                                          *
  14  *  You should have received a copy of the GNU General Public License along *
  15  *  with this program; if not, write to the Free Software Foundation, Inc., *
  16  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.             *
  17  *                                                                          *
  18  ****************************************************************************/
  19
  20 #ifndef _FAMILIA_MATH_YEARLINE_H
  21 #define _FAMILIA_MATH_YEARLINE_H
  22
  23 #include <gedcom.h>
  24
  25 /**
  26  * @file math/yearline.h
  27  * @brief Code for calculating year->position conversion.
  28  *
  29  */
  30
  31 /**
  32  * Return normalized year, which is used as a point value on the Y axis.
  33  *
  34  * This function is used as a common place for converting date years to global
  35  * Y coords. If there will be a change in displaying height position, it will be
  36  * changed in this function.
  37  *
  38  * @param dv Date for which to convert to the Y position.
  39  * @return GLOBAL coordinate for Y axis for the given date.
  40  */
  41 int convert_date_to_height(struct date_value *dv);
  42
  43
  44
  45 #endif /* _FAMILIA_MATH_YEARLINE_H */