TgifFile.H

Go to the documentation of this file.

/*---------------------------------------------------------------------+
 | Library QgarLib, graphics analysis and recognition                  |
 | Copyright (C) 2002  Qgar Project, LORIA                             |
 |                                                                     |
 | This library is free software; you can redistribute it and/or       |
 | modify it under the terms of the GNU Lesser General Public          |
 | License version 2.1, as published by the Free Software Foundation.  |
 |                                                                     |
 | This library is distributed in the hope that it will be useful,     |
 | but WITHOUT ANY WARRANTY; without even the implied warranty of      |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                |
 | See the GNU Lesser General Public License for more details.         |
 |                                                                     |
 | The GNU Lesser General Public License is included in the file       |
 | LICENSE.LGPL, in the root directory of the Qgar packaging. See      |
 | http://www.gnu.org/licenses/lgpl.html for the terms of the licence. |
 | To receive a paper copy, write to the Free Software Foundation,     |
 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.       |
 |                                                                     |
 | Contact Project Qgar for any information:                           |
 |   LORIA - équipe Qgar                                               |
 |   B.P. 239, 54506 Vandoeuvre-lès-Nancy Cedex, France                |
 |   email: qgar-contact@loria.fr                                      |
 |   http://www.qgar.org/                                              |
 *---------------------------------------------------------------------*/


#ifndef __TGIFFILE_H_INCLUDED__
#define __TGIFFILE_H_INCLUDED__


/**
 * @file     TgifFile.H
 * @brief    Header file of class qgar::TgifFile.
 *
 * Adapted by Gerald Masini from the previous release
 * by Christian Ah-Soon and Karl Tombre. 
 *
 * @author   <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Gerald Masini">Gérald Masini</a>
 * @date     Jul, 3  2001  18:21
 * @since    Qgar 1.0
 */

// For RCS/CVS use: Do not delete
/* $Id: TgifFile.H,v 1.19 2005/07/13 16:29:02 masini Exp $ */



// QGAR
#include <qgarlib/AbstractGraphicsFile.H>
#include <qgarlib/ConnectedComponents.H>
namespace qgar
{
  // Avoid #include's when not necessary
  class BoundingBox;
  class Component;
  class QgarErrorDeveloper;
  template <class T> class AbstractGenPointChain;
  template <class T> class GenArc;
  template <class T> class GenPoint;
  template <class T> class GenPolyline;
  template <class T> class GenSegment;
  template <class T> class GenTreeNode;
}



namespace qgar
{

/**
 * @class TgifFile TgifFile.H "qgarlib/TgifFile.H"
 * @ingroup IO_FILE
 * @brief File including Tgif graphics
 *        (designed for Tgif version 3.0, patchlevel 17). 
 *
 * All information (coordinates, thickness, length, etc.) manipulated
 * by Tgif is integer (<b>int</b>).
 *
 * File extension must be <b>.obj</b>.
 * For more information about Tgif, see the
 * <a href="http://bourbon.cs.ucla.edu:8001/tgif/" target="_blank">Tgif home page</a>.
 *
 * When using X Window, your Tgif environment will be consistent with
 * that used in Qgar (especially for colors) if you initialize Tgif variables
 * in the <b>.Xdefaults</b> file of your home directory as follows:
@verbatim
  Tgif*MaxColors: 20
  Tgif*Color0:  #000000
  Tgif*Color1:  #707070
  Tgif*Color2:  #a0a0a0
  Tgif*Color3:  #d0d0d0
  Tgif*Color4:  #ffffff
  Tgif*Color5:  #ff00ff
  Tgif*Color6:  #cc00cc
  Tgif*Color7:  #00ffff
  Tgif*Color8:  #00aaee
  Tgif*Color9:  #0000ff
  Tgif*Color10: #888800
  Tgif*Color11: #008800
  Tgif*Color12: #00ff00
  Tgif*Color13: #ffff00
  Tgif*Color14: #ff8000
  Tgif*Color15: #ff0000
  Tgif*Color16: #ff4080
  Tgif*Color17: #ff8080
  Tgif*Color18: #bb7020
  Tgif*Color19: #a02000
  Tgif*BackGround: white
  Tgif*Foreground: black
  Tgif*SplineTolerance: 13
  Tgif*InitialFont: Helvetica
  Tgif*InitialFontStyle: Roman
  Tgif*InitialFontJust: Center
  Tgif*InitialFontSize: 12
  Tgif*GridSystem: Metric
  Tgif*InitialGrid: -1
  Tgif*InitialSnapOn: false
@endverbatim
 *
 * @warning
 * Functions to read a Tgif file (get Qgar objects from Tgif ones)
 * are not available.
 *
 * @author <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Gerald Masini">Gerald Masini</a>
 * @date   Jul, 3  2001  18:21
 * @since  Qgar 1.0
 */
class TgifFile

  : public AbstractGraphicsFile

{
// -------------------------------------------------------------------
// P U B L I C    M E M B E R S
// -------------------------------------------------------------------
public:

  /** @name Constructors */
  //        ============
  //@{

  /**
   * @brief Initialize with given name.
   *
   * @warning A file must be opened to be used.
   */
  TgifFile(char* aFileName);

  //@}


  /** @name Destructor */
  //        ==========
  //@{

  /**
   * @brief Virtual destructor.
   */
  virtual ~TgifFile();

  //@}


// -------------------------------------------------------------------
// P U B L I C    M E M B E R S :   O U T P U T
// -------------------------------------------------------------------
public:

  // To bring (concrete) functions 'write' inherited from class
  // qgar::AbstractGraphicsFile into the scope of the class
  using AbstractGraphicsFile::write;


  /** @name Output points */
  //        =============
  //@{

  /**
   * @brief Write a point with coordinates of type <b>int</b>.
   *
   * @param aPt         a point
   * @param aThickness  thickness of the drawing (default <b>3</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   */
  void write(const GenPoint<int>& aPt,
             int aThickness  = 3,
             QGEcolor aColor = QGE_COLOR_DEFAULT);

  /**
   * @brief Write a point with coordinates of type <b>float</b>.
   *
   * @param aPt         a point
   * @param aThickness  thickness of the drawing (default <b>3</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   */
  void write(const GenPoint<float>& aPt,
             int aThickness  = 3,
             QGEcolor aColor = QGE_COLOR_DEFAULT);

  /**
   * @brief Write a point with coordinates of type <b>double</b>.
   *
   * @param aPt         a point
   * @param aThickness  thickness of the drawing (default <b>3</b>)
   * @param aColor      color of the drawing    (default qgar::QGE_COLOR_DEFAULT)
   */
  void write(const GenPoint<double>& aPt,
             int aThickness  = 3,
             QGEcolor aColor = QGE_COLOR_DEFAULT);

  //@}


  /** @name Output chains of points */
  //        =======================
  //@{

  /**
   * @brief Write a chain of points with coordinates of type <b>int</b>.
   *
   * @param aChain      a chain of points
   * @param aThickness  thickness of the drawing (default <b>3</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   *
   * @todo
   *   Parameter <b>aChain</b> cannot be declared <b>const</b> because
   *   functions qgar::AbstractGenPointChain::setToBegin
   *   and qgar::AbstractGenPointChain::moveNext are not declared <b>const</b>.
   *   In particular, their implementation in class qgar::GenLinkedChain modify
   *   data member 
   *   qgar::GenLinkedChain::_iter, that should be declared as <b>mutable</b>.
   */
  void write(AbstChain& aChain,
             int aThickness  = 3,
             QGEcolor aColor = QGE_COLOR_DEFAULT);

  /**
   * @brief Write a chain of points with coordinates of type <b>float</b>.
   *
   * @param aChain      a chain of points
   * @param aThickness  thickness of the drawing (default <b>3</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   *
   * @todo
   *   Parameter <b>aChain</b> cannot be declared <b>const</b> because
   *   functions qgar::AbstractGenPointChain::setToBegin
   *   and qgar::AbstractGenPointChain::moveNext are not declared <b>const</b>.
   *   In particular, their implementation in class qgar::GenLinkedChain modify
   *   data member 
   *   qgar::GenLinkedChain::_iter, that should be declared as <b>mutable</b>.
   */
  void write(FAbstChain& aChain,
             int aThickness  = 3,
             QGEcolor aColor = QGE_COLOR_DEFAULT);

  /**
   * @brief Write a chain of points with coordinates of type <b>double</b>.
   *
   * @param aChain      a chain of points
   * @param aThickness  thickness of the drawing (default <b>3</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   *
   * @todo
   *   Parameter <b>aChain</b> cannot be declared <b>const</b> because
   *   functions qgar::AbstractGenPointChain::setToBegin
   *   and qgar::AbstractGenPointChain::moveNext are not declared <b>const</b>.
   *   In particular, their implementation in class qgar::GenLinkedChain modify
   *   data member 
   *   qgar::GenLinkedChain::_iter, that should be declared as <b>mutable</b>.
   */
  void write(DAbstChain& aChain,
             int aThickness  = 3,
             QGEcolor aColor = QGE_COLOR_DEFAULT);

  //@}


  /** @name Output segments */
  //        ===============
  //@{

  /**
   * @brief Write a geometrical segment with coordinates of type <b>int</b>.
   *
   * @param aSeg        a segment
   * @param aThickness  thickness of the drawing (default <b>1</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing   (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenSegment<int>& aSeg,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  /**
   * @brief Write a geometrical segment with coordinates of type <b>float</b>.
   *
   * @param aSeg        a segment
   * @param aThickness  thickness of the drawing (default <b>1</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing   (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenSegment<float>& aSeg,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  /**
   * @brief Write a geometrical segment with coordinates of type <b>double</b>.
   *
   * @param aSeg        a segment
   * @param aThickness  thickness of the drawing (default <b>1</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing   (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenSegment<double>& aSeg,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  //@}


  /** @name Output circles and arcs of circle */
  //        =================================
  //@{

  /**
   * @brief Write a circle with coordinates of type <b>int</b>.
   *
   * @param aCenter     center of the circle
   * @param aRadius     radius of the circle
   * @param aThickness  thickness              (default <b>1</b>)
   * @param aColor      color                  (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenPoint<int>& aCenter,
             double aRadius,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  /**
   * @brief Write a circle with coordinates of type <b>float</b>.
   *
   * @param aCenter     center of the circle
   * @param aRadius     radius of the circle 
   * @param aThickness  thickness              (default <b>1</b>)
   * @param aColor      color                 (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenPoint<float>& aCenter,
             double aRadius,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  /**
   * @brief Write a circle with coordinates of type <b>double</b>.
   *
   * @param aCenter     center of the circle
   * @param aRadius     radius of the circle
   * @param aThickness  thickness              (default <b>1</b>)
   * @param aColor      color                  (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenPoint<double>& aCenter,
             double aRadius,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  /**
   * @brief Write a geometrical arc with coordinates of type <b>int</b>.
   *
   * @param anArc       a segment
   * @param aThickness  thickness of the drawing (default <b>1</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing   (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenArc<int>& anArc,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  /**
   * @brief Write a geometrical arc with coordinates of type <b>float</b>.
   *
   * @param anArc       a segment
   * @param aThickness  thickness of the drawing (default <b>1</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing   (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenArc<float>& anArc,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  /**
   * @brief Write a geometrical arc with coordinates of type <b>double</b>.
   *
   * @param anArc       a segment
   * @param aThickness  thickness of the drawing (default <b>1</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing   (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenArc<double>& anArc,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  //@}


  /** @name Output polylines */
  //        ================
  //@{

  /**
   * @brief Write a geometrical polyline with coordinates of type <b>int</b>.
   *
   * @param aPoly       a polyline
   * @param aThickness  thickness of the drawing (default <b>1</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing   (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenPolyline<int>& aPoly,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  /**
   * @brief Write a geometrical polyline with coordinates of type <b>float</b>.
   *
   * @param aPoly       a polyline
   * @param aThickness  thickness of the drawing (default <b>1</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing   (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenPolyline<float>& aPoly,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  /**
   * @brief Write a geometrical polyline with coordinates of type <b>double</b>.
   *
   * @param aPoly       a polyline
   * @param aThickness  thickness of the drawing (default <b>1</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing   (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const GenPolyline<double>& aPoly,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  //@}


  /** @name Output bounding boxes */
  //        =====================
  //@{

  /**
   * @brief Write a bounding box with coordinates of type <b>int</b>.
   *
   * @param aBox        a bounding box
   * @param aThickness  thickness of the drawing (default <b>1</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing   (default qgar::QGE_OUTLINE_DEFAULT)
   */
  void write(const BoundingBox& aBox,
             int        aThickness = 1,
             QGEcolor   aColor     = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  //@}


  /** @name Output components */
  //        =================
  //@{

  /**
   * @brief Write the contour of a (connected) component and of all
   * included components (i.e. children in the component tree).
   *
   * @param aPNode      pointer to the node of the component tree
   *                    including the component
   * @param aThickness  thickness of the drawing (default <b>1</b>)
   * @param aColor      color of the drawing     (default qgar::QGE_COLOR_DEFAULT)
   * @param anOutline   outline of the drawing   (default qgar::QGE_OUTLINE_DEFAULT)
   *
   * @see class qgar::Component
   */
  void write(const ConnectedComponents::node_type* const aPNode,
             int        aThickness = 1,
             QGEcolor   aColor    = QGE_COLOR_DEFAULT,
             QGEoutline anOutline  = QGE_OUTLINE_DEFAULT);

  //@}


// -------------------------------------------------------------------
// P R O T E C T E D    M E M B E R S
// -------------------------------------------------------------------
protected:


  /** @name Tgif specific information */
  //        =========================
  //@{

  /**
   * @brief Current Tgif version.
   */
  static const char* _s_tgif_version;

  /**
   * @brief Table of Tgif colors (see enum type qgar::QGEcolor).
   */
  static const char* _s_tgif_colors[21];

  /**
   * @brief Table of Tgif outline types (see enum type qgar::QGEoutline).
   */
  static const unsigned char _s_tgif_outlines[10];

  /**
   * @brief Tgif resolution: Number of pixels per inch.
   */
  static const int _s_tgif_pix_per_inch;

  /**
   * @brief Tgif A4 page width (in pixels).
   */
  static const float _s_tgif_a4_page_width;

  /**
   * @brief Tgif A4 page height (in pixels).
   */
  static const float _s_tgif_a4_page_height;

  /**
   * @brief Number of objects in the file.
   */
  int _tgifObjectCnt;

  //@}


  /** @name Output */
  //        ======
  //@{

  /**
   * @brief Write file header.
   */
  void writeHeader();

  /**
   * @brief Write file footer (nothing to do).
   */
  void writeFooter();

  //@}


  /** @name Save predicates describing Tgif objects */
  //        =======================================
  //@{

  /**
   * @brief Save the beginning part of the predicate
   *        describing a Tgif polyline.
   *
   * @param aVerticesCnt  number of vertices of the polyline
   * @param aColor       color of the drawing
   */
  void beginSavePoly(int aVerticesCnt, QGEcolor aColor);

  /**
   * @brief Save the ending part of the predicate
   *        describing a Tgif polyline.
   *
   * @param aVerticesCnt  number of vertices of the polyline
   * @param aThickness    thickness of the drawing
   * @param anOutline     outline of the drawing
   */
  void endSavePoly(int aVerticesCnt,
                   int aThickness,
                   QGEoutline anOutline);

  /**
   * @brief Save the predicate describing a Tgif box.
   *
   * @param aXTopLeft      X coordinate of top left point
   * @param aYTopLeft      Y coordinate of top left point
   * @param aXBottomRight  X coordinate of bottom right point
   * @param aYBottomRight  Y coordinate of bottom right point
   * @param aThickness     thickness of the drawing
   * @param aColor         color of the drawing
   * @param anOutline      outline of the drawing
   */
  void saveBox(int aXTopLeft,
               int aYTopLeft,
               int aXBottomRight,
               int aYBottomRight,
               int aThickness,
               QGEcolor aColor,
               QGEoutline anOutline);

  /**
   * @brief Save the predicate describing a Tgif circle.
   *
   * @param aXCenter    X coordinate of the center
   * @param aYCenter    Y coordinate of the center
   * @param aRadius     radius
   * @param aThickness  thickness of the drawing
   * @param aColor      color of the drawing
   * @param anOutline   outline of the drawing
   */
  void saveCircle(int aXCenter,
                  int aYCenter,
                  int aRadius,
                  int aThickness,
                  QGEcolor aColor,
                  QGEoutline anOutline);

  /**
   * @brief Save the predicate describing a Tgif arc.
   *
   * @param aXSource     X coordinate of source point
   * @param aYSource     Y coordinate of source point
   * @param aXTarget     X coordinate of target point
   * @param aYTarget     Y coordinate of target point
   * @param aXCenter     X coordinate of the center
   * @param aYCenter     Y coordinate of the center
   * @param aSourceAngle angle at source point
   * @param aTargetAngle angle at target point
   * @param aRadius      radius of the arc
   * @param aThickness   thickness of the drawing
   * @param aColor       color of the drawing
   * @param anOutline    outline of the drawing
   */
  void saveArc(int aXSource,
               int aYSource,
               int aXTarget,
               int aYTarget,
               int aXCenter,
               int aYCenter,
               int aSourceAngle,
               int aTargetAngle,
               int aRadius,
               int aThickness,
               QGEcolor aColor,
               QGEoutline anOutline);

  /**
   * @brief Save the predicate describing a point.
   *
   * As a point is not a Tgif object, it is described by
   * a polyline including only one vertice (integer coordinates).
   *
   * @param aX          X coordinate of the point
   * @param aY          Y coordinate of the point
   * @param aThickness  thickness of the drawing
   * @param aColor      color of the drawing
   */
  void savePoint(int aX,
                 int aY,
                 int aThickness,
                 QGEcolor aColor);

  /**
   * @brief Save the predicate describing a chain of points
   *        with coordinates of type <b>T</b>.
   *
   * As points are not Tgif objects, the chain is described by
   * a polyline whose vertices are the points of the chain.
   *
   * @param aChain      a chain
   * @param aThickness  thickness of the drawing
   * @param aColor      color of the drawing
   *
   * @todo
   *   Argument <b>aChain</b> cannot be declared <b>const</b>
   *   because iterating on a list occasions some modifications 
   *   in the list (see function <b>setInitialPosition()</b> of class
   *   qgar::GenChain, for example). Class <b>AbstractGenPointChain</b>
   *   and its descendants should be modified by declaring some data
   *   members as <b>mutable</b>.
   */
  template <class T>
  void
  saveChain(AbstractGenPointChain<T>& aChain,
            int aThickness,
            QGEcolor aColor);

  /**
   * @brief Save the predicate describing a segment.
   *
   * As a segment is not a Tgif object, it is described
   * by a polyline including two points (the source and target
   * of the segment).
   *
   * @param aXSource   X coordinate of the source point
   * @param aYSource   Y coordinate of the source point
   * @param aXTarget   X coordinate of the target point
   * @param aYTarget   Y coordinate of the target point
   * @param aThickness thickness of the drawing
   * @param aColor     color of the drawing
   * @param anOutline  outline of the drawing
   */
  void saveSegment(int aXSource,
                   int aYSource,
                   int aXTarget,
                   int aYTarget,
                   int aThickness,
                   QGEcolor aColor,
                   QGEoutline anOutline);

  /**
   * @brief Save the predicate describing a polyline
   *        with coordinates of type <b>T</b>.
   *
   * @param aPoly       a polyline
   * @param aThickness  thickness of the drawing
   * @param aColor      color of the drawing
   * @param anOutline   outline of the drawing
   */
  template <class T>
  void
  savePolyline(const GenPolyline<T>& aPoly,
               int aThickness,
               QGEcolor aColor,
               QGEoutline anOutline);

  //@}


// -------------------------------------------------------------------
// P R I V A T E    M E M B E R S
// -------------------------------------------------------------------
private:

  //  ============================================================
  /** @name Not yet implemented
      These functions belong to the private section
      as they are not yet implemented and thus should not be used.
  */
  //  ============================================================
  //@{

  /**
   * @brief Read file header.
   *
   * @warning Not yet implemented.
   * @exception qgar::QgarErrorDeveloper (not yet implemented)
   *
   * @todo Implement qgar::TgifFile::readHeader()
   */
  void readHeader() throw(QgarErrorDeveloper);

  //@}


  /** @name AUXILIARIES */
  //        ===========
  //@{

  /**
   * @brief Write the contour of a (connected) component and of all
   * included components (i.e. children in the component tree).
   *
   * @param aPNode     pointer to the node of the component tree
   *                   including the component
   * @param aThickness thickness of the drawing
   * @param aColor     color of the drawing
   * @param anOutline  outline of the drawing
   *
   * @see class qgar::Component
   */
  void
  PRIVATEwriteComponent(const ConnectedComponents::node_type* const aPNode,
                        int aThickness,
                        QGEcolor aColor,
                        QGEoutline anOutline);

  //@}


// -------------------------------------------------------------------
}; // class TgifFile

} // namespace qgar


#endif /* __TGIFFILE_H_INCLUDED__ */