qgar::TgifFile Class Reference
[Files]

#include <qgarlib/TgifFile.H>

Inheritance diagram for qgar::TgifFile:

List of all members.

Detailed Description

File including Tgif graphics (designed for Tgif version 3.0, patchlevel 17).

All information (coordinates, thickness, length, etc.) manipulated by Tgif is integer (int).

File extension must be .obj. For more information about Tgif, see the Tgif home page.

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 .Xdefaults file of your home directory as follows:

  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

Warning:: Functions to read a Tgif file (get Qgar objects from Tgif ones) are not available.

Author:: Gerald Masini

Date:: Jul, 3 2001 18:21

Since:: Qgar 1.0

Definition at line 129 of file TgifFile.H.

Tgif specific information

int _tgifObjectCnt

Number of objects in the file.

static const char * _s_tgif_version = "3.0-p17"

Current Tgif version.

static const char * _s_tgif_colors [21]

Table of Tgif colors (see enum type qgar::QGEcolor).

static const unsigned char _s_tgif_outlines [10]

Table of Tgif outline types (see enum type qgar::QGEoutline).

static const int _s_tgif_pix_per_inch = 128

Tgif resolution: Number of pixels per inch.

static const float _s_tgif_a4_page_width = 8.25f * _s_tgif_pix_per_inch

Tgif A4 page width (in pixels).

static const float _s_tgif_a4_page_height = 11.7f * _s_tgif_pix_per_inch

Tgif A4 page height (in pixels).

Public Member Functions

Constructors

TgifFile (char *aFileName)

Initialize with given name.

Destructor

virtual ~TgifFile ()

Virtual destructor.

Output points

void write (const GenPoint< int > &aPt, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)

Write a point with coordinates of type int.

void write (const GenPoint< float > &aPt, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)

Write a point with coordinates of type float.

void write (const GenPoint< double > &aPt, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)

Write a point with coordinates of type double.

Output chains of points

void write (AbstChain &aChain, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)

Write a chain of points with coordinates of type int.

void write (FAbstChain &aChain, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)

Write a chain of points with coordinates of type float.

void write (DAbstChain &aChain, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)

Write a chain of points with coordinates of type double.

Output segments

void write (const GenSegment< int > &aSeg, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a geometrical segment with coordinates of type int.

void write (const GenSegment< float > &aSeg, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a geometrical segment with coordinates of type float.

void write (const GenSegment< double > &aSeg, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a geometrical segment with coordinates of type double.

Output circles and arcs of circle

void write (const GenPoint< int > &aCenter, double aRadius, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a circle with coordinates of type int.

void write (const GenPoint< float > &aCenter, double aRadius, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a circle with coordinates of type float.

void write (const GenPoint< double > &aCenter, double aRadius, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a circle with coordinates of type double.

void write (const GenArc< int > &anArc, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a geometrical arc with coordinates of type int.

void write (const GenArc< float > &anArc, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a geometrical arc with coordinates of type float.

void write (const GenArc< double > &anArc, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a geometrical arc with coordinates of type double.

Output polylines

void write (const GenPolyline< int > &aPoly, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a geometrical polyline with coordinates of type int.

void write (const GenPolyline< float > &aPoly, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a geometrical polyline with coordinates of type float.

void write (const GenPolyline< double > &aPoly, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a geometrical polyline with coordinates of type double.

Output bounding boxes

void write (const BoundingBox &aBox, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write a bounding box with coordinates of type int.

Output components

void write (const ConnectedComponents::node_type *const aPNode, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Write the contour of a (connected) component and of all included components (i.e. children in the component tree).

Points

virtual void write (AbstractGenPointChain< float > &aChain, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)=0

Record a chain of points with coordinates of type float.

Segments

void write (const GenQgarSegment< int > &aQSeg, int aThickness=-1, QGEcolor aColor=QGE_COLOR_NONE, QGEoutline anOutline=QGE_OUTLINE_NONE)

Record a Qgar segment with coordinates of type int.

Circles and arcs of circle

void write (const GenQgarArc< int > &aQArc, int aThickness=-1, QGEcolor aColor=QGE_COLOR_NONE, QGEoutline anOutline=QGE_OUTLINE_NONE)

Record a Qgar arc with coordinates of type int.

Polylines

void write (const GenQgarPolyline< int > &aQPoly, int aThickness=-1, QGEcolor aColor=QGE_COLOR_NONE, QGEoutline anOutline=QGE_OUTLINE_NONE)

Record a Qgar polyline with coordinates of type int.

Access to file characteristics

std::fstream & fileStream ()

Get file stream.

const char *const fileName () const

Get file name.

QGEfileStatus fileStatus () const

Get current file status.

Opening

virtual void openRONLY () throw (QgarErrorIO)

Open in read-only mode.

virtual void openWONLY () throw (QgarErrorIO)

Open in write-only mode.

virtual void openAPPEND () throw (QgarErrorIO)

Open in append mode.

virtual void openRW () throw (QgarErrorIO)

Open in read-write mode.

virtual void openRA () throw (QgarErrorIO)

Open in read-append mode.

Closing

virtual void close ()

Close the file.

Checking status

virtual void isOpenR () throw (QgarErrorUser)

Abort if the file is not open in a mode allowing reading.

virtual void isOpenW () throw (QgarErrorUser)

Abort if the file is not open in a mode allowing writing.

virtual void isOpenA () throw (QgarErrorUser)

Abort if the file is not open in a mode allowing appending.

virtual void isOpenRW () throw (QgarErrorUser)

Abort if the file is not open in read-write mode.

virtual void isOpenRA () throw (QgarErrorUser)

Abort if the file is not open in readi-append mode.

Protected Member Functions

Output

void writeHeader ()

Write file header.

void writeFooter ()

Write file footer (nothing to do).

Save predicates describing Tgif objects

void beginSavePoly (int aVerticesCnt, QGEcolor aColor)

Save the beginning part of the predicate describing a Tgif polyline.

void endSavePoly (int aVerticesCnt, int aThickness, QGEoutline anOutline)

Save the ending part of the predicate describing a Tgif polyline.

void saveBox (int aXTopLeft, int aYTopLeft, int aXBottomRight, int aYBottomRight, int aThickness, QGEcolor aColor, QGEoutline anOutline)

Save the predicate describing a Tgif box.

void saveCircle (int aXCenter, int aYCenter, int aRadius, int aThickness, QGEcolor aColor, QGEoutline anOutline)

Save the predicate describing a Tgif circle.

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)

Save the predicate describing a Tgif arc.

void savePoint (int aX, int aY, int aThickness, QGEcolor aColor)

Save the predicate describing a point.

template<class T>

void saveChain (AbstractGenPointChain< T > &aChain, int aThickness, QGEcolor aColor)

Save the predicate describing a chain of points with coordinates of type T.

void saveSegment (int aXSource, int aYSource, int aXTarget, int aYTarget, int aThickness, QGEcolor aColor, QGEoutline anOutline)

Save the predicate describing a segment.

template<class T>

void savePolyline (const GenPolyline< T > &aPoly, int aThickness, QGEcolor aColor, QGEoutline anOutline)

Save the predicate describing a polyline with coordinates of type T.

Protected Attributes

Representation of a file

char * _fileName

File name.

QGEfileStatus _fileStatus

File status.

std::fstream _fileStream

Associated file stream.

Private Member Functions

Not yet implemented

These functions belong to the private section as they are not yet implemented and thus should not be used.

void readHeader () throw (QgarErrorDeveloper)

Read file header.

AUXILIARIES

void PRIVATEwriteComponent (const ConnectedComponents::node_type *const aPNode, int aThickness, QGEcolor aColor, QGEoutline anOutline)

Write the contour of a (connected) component and of all included components (i.e. children in the component tree).

Constructor & Destructor Documentation

qgar::TgifFile::TgifFile ( char * aFileName )

Initialize with given name.

Warning:
A file must be opened to be used.

Definition at line 167 of file TgifFile.C.

qgar::TgifFile::~TgifFile ( ) [virtual]

Virtual destructor.

Definition at line 182 of file TgifFile.C.

Member Function Documentation

void qgar::TgifFile::beginSavePoly ( int aVerticesCnt,

QGEcolor aColor

) [protected]

Save the beginning part of the predicate describing a Tgif polyline.

Parameters:

aVerticesCnt number of vertices of the polyline

aColor color of the drawing

Definition at line 704 of file TgifFile.C.
References qgar::AbstractFile::_fileStream, and _s_tgif_colors.
Referenced by saveChain(), savePoint(), savePolyline(), and saveSegment().

void qgar::TgifFile::endSavePoly ( int aVerticesCnt,

int aThickness,

QGEoutline anOutline

) [protected]

Save the ending part of the predicate describing a Tgif polyline.

Parameters:

aVerticesCnt number of vertices of the polyline

aThickness thickness of the drawing

anOutline outline of the drawing

Definition at line 730 of file TgifFile.C.
References qgar::AbstractFile::_fileStream, _s_tgif_outlines, _tgifObjectCnt, qgar::TGIFFILE_arrowHeadHeight(), and qgar::TGIFFILE_arrowHeadWidth().
Referenced by saveChain(), savePoint(), savePolyline(), and saveSegment().

const char *const qgar::AbstractFile::fileName ( ) const [inline, inherited]

Get file name.

Definition at line 395 of file AbstractFile.H.
References qgar::AbstractFile::_fileName.

QGEfileStatus qgar::AbstractFile::fileStatus ( ) const [inline, inherited]

Get current file status.

Definition at line 404 of file AbstractFile.H.
References qgar::AbstractFile::_fileStatus.

std::fstream & qgar::AbstractFile::fileStream ( ) [inline, inherited]

Get file stream.
When saving the stream, usual I/O operations apply to the associated file, depending on the opening mode.
Definition at line 386 of file AbstractFile.H.
References qgar::AbstractFile::_fileStream.

void qgar::AbstractFile::isOpenA ( ) throw (QgarErrorUser) [virtual, inherited]

Abort if the file is not open in a mode allowing appending.

Exceptions:

qgar::QgarErrorUser (file not open in append mode)

Definition at line 310 of file AbstractFile.C.
References qgar::AbstractFile::_fileName, qgar::AbstractFile::_fileStatus, qgar::QGE_FILE_STATUS_APPEND, and qgar::QGE_FILE_STATUS_READ_APPEND.

void qgar::AbstractFile::isOpenR ( ) throw (QgarErrorUser) [virtual, inherited]

Abort if the file is not open in a mode allowing reading.

Exceptions:

qgar::QgarErrorUser (file not open in read mode)

Definition at line 273 of file AbstractFile.C.
References qgar::AbstractFile::_fileName, qgar::AbstractFile::_fileStatus, qgar::QGE_FILE_STATUS_APPEND, and qgar::QGE_FILE_STATUS_WRITE_ONLY.
Referenced by qgar::PgmFile::readRow(), and qgar::PbmFile::readRow().

void qgar::AbstractFile::isOpenRA ( ) throw (QgarErrorUser) [virtual, inherited]

Abort if the file is not open in readi-append mode.

Exceptions:

qgar::QgarErrorUser (file not open in read/append mode)

Definition at line 347 of file AbstractFile.C.
References qgar::AbstractFile::_fileName, qgar::AbstractFile::_fileStatus, and qgar::QGE_FILE_STATUS_READ_APPEND.

void qgar::AbstractFile::isOpenRW ( ) throw (QgarErrorUser) [virtual, inherited]

Abort if the file is not open in read-write mode.

Exceptions:

qgar::QgarErrorUser (file not open in read/write mode)

Definition at line 329 of file AbstractFile.C.
References qgar::AbstractFile::_fileName, qgar::AbstractFile::_fileStatus, and qgar::QGE_FILE_STATUS_READ_WRITE.

void qgar::AbstractFile::isOpenW ( ) throw (QgarErrorUser) [virtual, inherited]

Abort if the file is not open in a mode allowing writing.

Exceptions:

qgar::QgarErrorUser (file not open in write mode)

Definition at line 292 of file AbstractFile.C.
References qgar::AbstractFile::_fileName, qgar::AbstractFile::_fileStatus, and qgar::QGE_FILE_STATUS_READ_ONLY.
Referenced by write(), qgar::DxfFile::write(), qgar::PgmFile::writeRow(), and qgar::PbmFile::writeRow().

void qgar::AbstractFile::openAPPEND ( ) throw (QgarErrorIO) [virtual, inherited]

Open in append mode.
The eventual content of the file is preserved and the file pointer is set to the end of the file.

Warning:
The file header is read using function qgar::AbstractFile::readHeader.

Exceptions:

qgar::QgarErrorIO (file cannot be opened)

Definition at line 166 of file AbstractFile.C.
References qgar::AbstractFile::_fileName, qgar::AbstractFile::_fileStatus, qgar::AbstractFile::_fileStream, qgar::AbstractFile::close(), qgar::QGE_FILE_STATUS_APPEND, and qgar::AbstractFile::readHeader().

void qgar::AbstractFile::openRA ( ) throw (QgarErrorIO) [virtual, inherited]

Open in read-append mode.
The file pointer is set to the end of the file.

Warning:
The file header is read using function qgar::AbstractFile::readHeader.

Exceptions:

qgar::QgarErrorIO (file cannot be opened)

Definition at line 223 of file AbstractFile.C.
References qgar::AbstractFile::_fileName, qgar::AbstractFile::_fileStatus, qgar::AbstractFile::_fileStream, qgar::AbstractFile::close(), qgar::QGE_FILE_STATUS_READ_APPEND, and qgar::AbstractFile::readHeader().

void qgar::AbstractFile::openRONLY ( ) throw (QgarErrorIO) [virtual, inherited]

Open in read-only mode.
The file pointer is set to the first character after the header.

Warning:
The file header is read using function qgar::AbstractFile::readHeader.

Exceptions:

qgar::QgarErrorIO (file cannot be opened)

Definition at line 107 of file AbstractFile.C.
References qgar::AbstractFile::_fileName, qgar::AbstractFile::_fileStatus, qgar::AbstractFile::_fileStream, qgar::AbstractFile::close(), qgar::QGE_FILE_STATUS_READ_ONLY, and qgar::AbstractFile::readHeader().
Referenced by qgar::GenImage< T, CheckPolicy >::GenImage().

void qgar::AbstractFile::openRW ( ) throw (QgarErrorIO) [virtual, inherited]

Open in read-write mode.

Warning:
The file is new and a header is written into the file using function qgar::AbstractFile::writeHeader. If a file with given name already exists, its content is lost.

Exceptions:

qgar::QgarErrorIO (file cannot be opened)

Definition at line 197 of file AbstractFile.C.
References qgar::AbstractFile::_fileName, qgar::AbstractFile::_fileStatus, qgar::AbstractFile::_fileStream, qgar::AbstractFile::close(), qgar::QGE_FILE_STATUS_READ_WRITE, and qgar::AbstractFile::writeHeader().

void qgar::AbstractFile::openWONLY ( ) throw (QgarErrorIO) [virtual, inherited]

Open in write-only mode.

Warning:
The file is new and a header is written into the file using function qgar::AbstractFile::writeHeader. If a file with given name already exists, its content is lost.

Exceptions:

qgar::QgarErrorIO (file cannot be opened)

Definition at line 136 of file AbstractFile.C.
References qgar::AbstractFile::_fileName, qgar::AbstractFile::_fileStatus, qgar::AbstractFile::_fileStream, qgar::AbstractFile::close(), qgar::QGE_FILE_STATUS_WRITE_ONLY, and qgar::AbstractFile::writeHeader().
Referenced by qgar::MapleFile::MapleFile(), and qgar::GenImage< T, CheckPolicy >::save().

void qgar::TgifFile::PRIVATEwriteComponent ( const ConnectedComponents::node_type *const aPNode,

int aThickness,

QGEcolor aColor,

QGEoutline anOutline

) [private]

Write the contour of a (connected) component and of all included components (i.e. children in the component tree).

Parameters:

aPNode pointer to the node of the component tree including the component

aThickness thickness of the drawing

aColor color of the drawing

anOutline outline of the drawing

See also:
class qgar::Component

Definition at line 1264 of file TgifFile.C.
References qgar::Component::accessBoundingBox(), qgar::Component::accessContour(), qgar::GenTreeNode< T >::accessData(), qgar::Component::areaPixels(), qgar::Component::color(), qgar::GenTreeNode< T >::pFirstChild(), qgar::GenTreeNode< T >::pRSibling(), qgar::QGE_BW_WHITE, qgar::QGE_COLOR_BLACK, qgar::QGE_COLOR_BLUE, qgar::QGE_COLOR_RED, qgar::QGE_OUTLINE_SOLID, and write().
Referenced by write().

void qgar::TgifFile::readHeader ( ) throw (QgarErrorDeveloper) [private, virtual]

Read file header.

Warning:
Not yet implemented.

Exceptions:

qgar::QgarErrorDeveloper (not yet implemented)

Todo:
Implement qgar::TgifFile::readHeader()

Implements qgar::AbstractFile.
Definition at line 1245 of file TgifFile.C.

void qgar::TgifFile::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

) [protected]

Save the predicate describing a Tgif arc.

Parameters:

aXSource X coordinate of source point

aYSource Y coordinate of source point

aXTarget X coordinate of target point

aYTarget Y coordinate of target point

aXCenter X coordinate of the center

aYCenter Y coordinate of the center

aSourceAngle angle at source point

aTargetAngle angle at target point

aRadius radius of the arc

aThickness thickness of the drawing

aColor color of the drawing

anOutline outline of the drawing

Definition at line 956 of file TgifFile.C.
References qgar::AbstractFile::_fileStream, _s_tgif_colors, _s_tgif_outlines, _tgifObjectCnt, qgar::TGIFFILE_arrowHeadHeight(), and qgar::TGIFFILE_arrowHeadWidth().
Referenced by write().

void qgar::TgifFile::saveBox ( int aXTopLeft,

int aYTopLeft,

int aXBottomRight,

int aYBottomRight,

int aThickness,

QGEcolor aColor,

QGEoutline anOutline

) [protected]

Save the predicate describing a Tgif box.

Parameters:

aXTopLeft X coordinate of top left point

aYTopLeft Y coordinate of top left point

aXBottomRight X coordinate of bottom right point

aYBottomRight Y coordinate of bottom right point

aThickness thickness of the drawing

aColor color of the drawing

anOutline outline of the drawing

Definition at line 829 of file TgifFile.C.
References qgar::AbstractFile::_fileStream, _s_tgif_colors, _s_tgif_outlines, and _tgifObjectCnt.
Referenced by write().

template<class T>

void qgar::TgifFile::saveChain ( AbstractGenPointChain< T > & aChain,

int aThickness,

QGEcolor aColor

) [protected]

Save the predicate describing a chain of points with coordinates of type T.
As points are not Tgif objects, the chain is described by a polyline whose vertices are the points of the chain.

Parameters:

aChain a chain

aThickness thickness of the drawing

aColor color of the drawing

Todo:
Argument aChain cannot be declared const because iterating on a list occasions some modifications in the list (see function setInitialPosition() of class qgar::GenChain, for example). Class AbstractGenPointChain and its descendants should be modified by declaring some data members as mutable.

Definition at line 1123 of file TgifFile.C.
References qgar::AbstractFile::_fileStream, qgar::AbstractGenPointChain< T >::accessCurrent(), beginSavePoly(), qgar::AbstractGenPointChain< T >::empty(), endSavePoly(), qgar::AbstractGenPointChain< T >::hasNext(), qgar::AbstractGenPointChain< T >::moveNext(), qgar::QGE_OUTLINE_SOLID, qgar::AbstractGenPointChain< T >::setToBegin(), and qgar::AbstractGenPointChain< T >::size().
Referenced by write().

void qgar::TgifFile::saveCircle ( int aXCenter,

int aYCenter,

int aRadius,

int aThickness,

QGEcolor aColor,

QGEoutline anOutline

) [protected]

Save the predicate describing a Tgif circle.

Parameters:

aXCenter X coordinate of the center

aYCenter Y coordinate of the center

aRadius radius

aThickness thickness of the drawing

aColor color of the drawing

anOutline outline of the drawing

Definition at line 890 of file TgifFile.C.
References qgar::AbstractFile::_fileStream, _s_tgif_colors, _s_tgif_outlines, and _tgifObjectCnt.
Referenced by write().

void qgar::TgifFile::savePoint ( int aX,

int aY,

int aThickness,

QGEcolor aColor

) [protected]

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).

Parameters:

aX X coordinate of the point

aY Y coordinate of the point

aThickness thickness of the drawing

aColor color of the drawing

Definition at line 1101 of file TgifFile.C.
References qgar::AbstractFile::_fileStream, beginSavePoly(), endSavePoly(), and qgar::QGE_OUTLINE_SOLID.
Referenced by write().

template<class T>

void qgar::TgifFile::savePolyline ( const GenPolyline< T > & aPoly,

int aThickness,

QGEcolor aColor,

QGEoutline anOutline

) [protected]

Save the predicate describing a polyline with coordinates of type T.

Parameters:

aPoly a polyline

aThickness thickness of the drawing

aColor color of the drawing

anOutline outline of the drawing

Definition at line 1208 of file TgifFile.C.
References qgar::AbstractFile::_fileStream, qgar::GenPolyline< T >::accessVertices(), beginSavePoly(), and endSavePoly().
Referenced by write().

void qgar::TgifFile::saveSegment ( int aXSource,

int aYSource,

int aXTarget,

int aYTarget,

int aThickness,

QGEcolor aColor,

QGEoutline anOutline

) [protected]

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).

Parameters:

aXSource X coordinate of the source point

aYSource Y coordinate of the source point

aXTarget X coordinate of the target point

aYTarget Y coordinate of the target point

aThickness thickness of the drawing

aColor color of the drawing

anOutline outline of the drawing

Definition at line 1176 of file TgifFile.C.
References qgar::AbstractFile::_fileStream, beginSavePoly(), and endSavePoly().
Referenced by write().

void qgar::AbstractGraphicsFile::write ( const GenQgarPolyline< int > & aQPoly,

int aThickness = -1,

QGEcolor aColor = QGE_COLOR_NONE,

QGEoutline anOutline = QGE_OUTLINE_NONE

) [inherited]

Record a Qgar polyline with coordinates of type int.

Parameters:

aQPoly a Qgar polyline

aThickness thickness to be recorded (default -1, i.e. current)

aColor color to be recorded (default qgar::QGE_COLOR_NONE, i.e. current)

anOutline outline to be recorded (default qgar::QGE_OUTLINE_NONE, i.e. current)

Definition at line 188 of file AbstractGraphicsFile.C.
References qgar::GenQgarPolyline< T >::accessGeomStructure(), qgar::AbstractGenQgarPrimitive< T >::color(), qgar::AbstractGenQgarPrimitive< T >::outline(), qgar::QGE_COLOR_NONE, qgar::QGE_OUTLINE_NONE, qgar::AbstractGenQgarPrimitive< T >::thickness(), and qgar::AbstractGraphicsFile::write().

void qgar::AbstractGraphicsFile::write ( const GenQgarArc< int > & aQArc,

int aThickness = -1,

QGEcolor aColor = QGE_COLOR_NONE,

QGEoutline anOutline = QGE_OUTLINE_NONE

) [inherited]

Record a Qgar arc with coordinates of type int.

Parameters:

aQArc a Qgar arc

aThickness thickness to be recorded (default -1, i.e. current)

aColor color to be recorded (default qgar::QGE_COLOR_NONE, i.e. current)

anOutline outline to be recorded (default qgar::QGE_OUTLINE_NONE, i.e. current)

Definition at line 138 of file AbstractGraphicsFile.C.
References qgar::GenQgarArc< T >::accessGeomStructure(), qgar::AbstractGenQgarPrimitive< T >::color(), qgar::AbstractGenQgarPrimitive< T >::outline(), qgar::QGE_COLOR_NONE, qgar::QGE_OUTLINE_NONE, qgar::AbstractGenQgarPrimitive< T >::thickness(), and qgar::AbstractGraphicsFile::write().

void qgar::AbstractGraphicsFile::write ( const GenQgarSegment< int > & aQSeg,

int aThickness = -1,

QGEcolor aColor = QGE_COLOR_NONE,

QGEoutline anOutline = QGE_OUTLINE_NONE

) [inherited]

Record a Qgar segment with coordinates of type int.

Parameters:

aQSeg a Qgar segment

aThickness thickness to be recorded (default -1, i.e. current)

aColor color to be recorded (default qgar::QGE_COLOR_NONE, i.e. current)

anOutline outline to be recorded (default qgar::QGE_OUTLINE_NONE, i.e. current)

Definition at line 87 of file AbstractGraphicsFile.C.
References qgar::GenQgarSegment< T >::accessGeomStructure(), qgar::AbstractGenQgarPrimitive< T >::color(), qgar::AbstractGenQgarPrimitive< T >::outline(), qgar::QGE_COLOR_NONE, qgar::QGE_OUTLINE_NONE, qgar::AbstractGenQgarPrimitive< T >::thickness(), and qgar::AbstractGraphicsFile::write().

virtual void qgar::AbstractGraphicsFile::write ( AbstractGenPointChain< float > & aChain,

int aThickness = 3,

QGEcolor aColor = QGE_COLOR_DEFAULT

) [pure virtual, inherited]

Record a chain of points with coordinates of type float.

Parameters:

aChain a chain

aThickness thickness to be recorded (default 3)

aColor color to be recorded (default qgar::QGE_COLOR_DEFAULT)

Todo:
Parameter aChain cannot be declared const because functions qgar::AbstractGenPointChain::setToBegin and qgar::AbstractGenPointChain::moveNext are not declared const. In particular, their implementation in class qgar::GenLinkedChain modify data member qgar::GenLinkedChain::_iter, that should be declared as mutable.

Implemented in qgar::DxfFile, and qgar::DxfFile.

void qgar::TgifFile::write ( const ConnectedComponents::node_type *const aPNode,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write the contour of a (connected) component and of all included components (i.e. children in the component tree).

Parameters:

aPNode pointer to the node of the component tree including the component

aThickness thickness of the drawing (default 1)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

See also:
class qgar::Component

Implements qgar::AbstractGraphicsFile.
Definition at line 550 of file TgifFile.C.
References qgar::Component::accessBoundingBox(), qgar::Component::accessContour(), qgar::GenTreeNode< T >::accessData(), qgar::Component::areaPixels(), qgar::Component::color(), qgar::AbstractFile::isOpenW(), qgar::GenTreeNode< T >::pFirstChild(), PRIVATEwriteComponent(), qgar::QGE_BW_WHITE, qgar::QGE_COLOR_BLACK, qgar::QGE_COLOR_BLUE, qgar::QGE_COLOR_RED, qgar::QGE_OUTLINE_SOLID, and write().

void qgar::TgifFile::write ( const BoundingBox & aBox,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a bounding box with coordinates of type int.

Parameters:

aBox a bounding box

aThickness thickness of the drawing (default 1)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.
Definition at line 525 of file TgifFile.C.
References qgar::AbstractFile::isOpenW(), saveBox(), qgar::BoundingBox::xBottomRight(), qgar::BoundingBox::xTopLeft(), qgar::BoundingBox::yBottomRight(), and qgar::BoundingBox::yTopLeft().

void qgar::TgifFile::write ( const GenPolyline< double > & aPoly,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a geometrical polyline with coordinates of type double.

Parameters:

aPoly a polyline

aThickness thickness of the drawing (default 1)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.

void qgar::TgifFile::write ( const GenPolyline< float > & aPoly,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a geometrical polyline with coordinates of type float.

Parameters:

aPoly a polyline

aThickness thickness of the drawing (default 1)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.

void qgar::TgifFile::write ( const GenPolyline< int > & aPoly,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a geometrical polyline with coordinates of type int.

Parameters:

aPoly a polyline

aThickness thickness of the drawing (default 1)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.
Definition at line 481 of file TgifFile.C.
References qgar::AbstractFile::isOpenW(), and savePolyline().

void qgar::TgifFile::write ( const GenArc< double > & anArc,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a geometrical arc with coordinates of type double.

Parameters:

anArc a segment

aThickness thickness of the drawing (default 1)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.

void qgar::TgifFile::write ( const GenArc< float > & anArc,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a geometrical arc with coordinates of type float.

Parameters:

anArc a segment

aThickness thickness of the drawing (default 1)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.

void qgar::TgifFile::write ( const GenArc< int > & anArc,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a geometrical arc with coordinates of type int.

Parameters:

anArc a segment

aThickness thickness of the drawing (default 1)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.
Definition at line 402 of file TgifFile.C.
References qgar::AbstractFile::isOpenW(), qgar::GenArc< T >::radius(), saveArc(), qgar::GenArc< T >::sourceAngleDegrees(), qgar::GenArc< T >::targetAngleDegrees(), qgar::GenArc< T >::xCenter(), qgar::AbstractGenPrimitive< T >::xSource(), qgar::AbstractGenPrimitive< T >::xTarget(), qgar::GenArc< T >::yCenter(), qgar::AbstractGenPrimitive< T >::ySource(), and qgar::AbstractGenPrimitive< T >::yTarget().

void qgar::TgifFile::write ( const GenPoint< double > & aCenter,

double aRadius,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a circle with coordinates of type double.

Parameters:

aCenter center of the circle

aRadius radius of the circle

aThickness thickness (default 1)

aColor color (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.

void qgar::TgifFile::write ( const GenPoint< float > & aCenter,

double aRadius,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a circle with coordinates of type float.

Parameters:

aCenter center of the circle

aRadius radius of the circle

aThickness thickness (default 1)

aColor color (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.
Definition at line 362 of file TgifFile.C.
References qgar::AbstractFile::isOpenW(), saveCircle(), qgar::GenPoint< T >::x(), and qgar::GenPoint< T >::y().

void qgar::TgifFile::write ( const GenPoint< int > & aCenter,

double aRadius,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a circle with coordinates of type int.

Parameters:

aCenter center of the circle

aRadius radius of the circle

aThickness thickness (default 1)

aColor color (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.
Definition at line 342 of file TgifFile.C.
References qgar::AbstractFile::isOpenW(), saveCircle(), qgar::GenPoint< T >::x(), and qgar::GenPoint< T >::y().

void qgar::TgifFile::write ( const GenSegment< double > & aSeg,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a geometrical segment with coordinates of type double.

Parameters:

aSeg a segment

aThickness thickness of the drawing (default 1)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.

void qgar::TgifFile::write ( const GenSegment< float > & aSeg,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a geometrical segment with coordinates of type float.

Parameters:

aSeg a segment

aThickness thickness of the drawing (default 1)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.
Definition at line 297 of file TgifFile.C.
References qgar::AbstractFile::isOpenW(), saveSegment(), qgar::AbstractGenPrimitive< T >::xSource(), qgar::AbstractGenPrimitive< T >::xTarget(), qgar::AbstractGenPrimitive< T >::ySource(), and qgar::AbstractGenPrimitive< T >::yTarget().

void qgar::TgifFile::write ( const GenSegment< int > & aSeg,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [virtual]

Write a geometrical segment with coordinates of type int.

Parameters:

aSeg a segment

aThickness thickness of the drawing (default 1)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

anOutline outline of the drawing (default qgar::QGE_OUTLINE_DEFAULT)

Implements qgar::AbstractGraphicsFile.
Definition at line 277 of file TgifFile.C.
References qgar::AbstractFile::isOpenW(), saveSegment(), qgar::AbstractGenPrimitive< T >::xSource(), qgar::AbstractGenPrimitive< T >::xTarget(), qgar::AbstractGenPrimitive< T >::ySource(), and qgar::AbstractGenPrimitive< T >::yTarget().

void qgar::TgifFile::write ( DAbstChain & aChain,

int aThickness = 3,

QGEcolor aColor = QGE_COLOR_DEFAULT

)

Write a chain of points with coordinates of type double.

Parameters:

aChain a chain of points

aThickness thickness of the drawing (default 3)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

Todo:
Parameter aChain cannot be declared const because functions qgar::AbstractGenPointChain::setToBegin and qgar::AbstractGenPointChain::moveNext are not declared const. In particular, their implementation in class qgar::GenLinkedChain modify data member qgar::GenLinkedChain::_iter, that should be declared as mutable.

void qgar::TgifFile::write ( FAbstChain & aChain,

int aThickness = 3,

QGEcolor aColor = QGE_COLOR_DEFAULT

)

Write a chain of points with coordinates of type float.

Parameters:

aChain a chain of points

aThickness thickness of the drawing (default 3)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

Todo:
Parameter aChain cannot be declared const because functions qgar::AbstractGenPointChain::setToBegin and qgar::AbstractGenPointChain::moveNext are not declared const. In particular, their implementation in class qgar::GenLinkedChain modify data member qgar::GenLinkedChain::_iter, that should be declared as mutable.

Definition at line 248 of file TgifFile.C.
References qgar::AbstractFile::isOpenW(), and saveChain().

void qgar::TgifFile::write ( AbstChain & aChain,

int aThickness = 3,

QGEcolor aColor = QGE_COLOR_DEFAULT

) [virtual]

Write a chain of points with coordinates of type int.

Parameters:

aChain a chain of points

aThickness thickness of the drawing (default 3)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

Todo:
Parameter aChain cannot be declared const because functions qgar::AbstractGenPointChain::setToBegin and qgar::AbstractGenPointChain::moveNext are not declared const. In particular, their implementation in class qgar::GenLinkedChain modify data member qgar::GenLinkedChain::_iter, that should be declared as mutable.

Implements qgar::AbstractGraphicsFile.
Definition at line 236 of file TgifFile.C.
References qgar::AbstractFile::isOpenW(), and saveChain().

void qgar::TgifFile::write ( const GenPoint< double > & aPt,

int aThickness = 3,

QGEcolor aColor = QGE_COLOR_DEFAULT

) [virtual]

Write a point with coordinates of type double.

Parameters:

aPt a point

aThickness thickness of the drawing (default 3)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

Implements qgar::AbstractGraphicsFile.

void qgar::TgifFile::write ( const GenPoint< float > & aPt,

int aThickness = 3,

QGEcolor aColor = QGE_COLOR_DEFAULT

) [virtual]

Write a point with coordinates of type float.

Parameters:

aPt a point

aThickness thickness of the drawing (default 3)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

Implements qgar::AbstractGraphicsFile.
Definition at line 207 of file TgifFile.C.
References qgar::AbstractFile::isOpenW(), savePoint(), qgar::GenPoint< T >::x(), and qgar::GenPoint< T >::y().

void qgar::TgifFile::write ( const GenPoint< int > & aPt,

int aThickness = 3,

QGEcolor aColor = QGE_COLOR_DEFAULT

) [virtual]

Write a point with coordinates of type int.

Parameters:

aPt a point

aThickness thickness of the drawing (default 3)

aColor color of the drawing (default qgar::QGE_COLOR_DEFAULT)

Implements qgar::AbstractGraphicsFile.
Definition at line 195 of file TgifFile.C.
References qgar::AbstractFile::isOpenW(), savePoint(), qgar::GenPoint< T >::x(), and qgar::GenPoint< T >::y().
Referenced by PRIVATEwriteComponent(), and write().

void qgar::TgifFile::writeFooter ( ) [protected, virtual]

Write file footer (nothing to do).

Implements qgar::AbstractFile.
Definition at line 684 of file TgifFile.C.

void qgar::TgifFile::writeHeader ( ) [protected, virtual]

Write file header.

Implements qgar::AbstractFile.
Definition at line 592 of file TgifFile.C.
References qgar::AbstractFile::_fileStream, _s_tgif_a4_page_height, _s_tgif_a4_page_width, and _s_tgif_version.

Member Data Documentation

std::fstream qgar::AbstractFile::_fileStream [protected, inherited]

Associated file stream.

Definition at line 359 of file AbstractFile.H.
Referenced by beginSavePoly(), qgar::AbstractFile::close(), endSavePoly(), qgar::AbstractFile::fileStream(), qgar::AbstractPbmPlusFile::getChar(), qgar::AbstractPbmPlusFile::getRawByte(), qgar::MapleFile::MapleFile(), qgar::AbstractFile::openAPPEND(), qgar::AbstractFile::openRA(), qgar::AbstractFile::openRONLY(), qgar::AbstractFile::openRW(), qgar::AbstractFile::openWONLY(), qgar::PgmFile::readHeader(), qgar::PbmFile::readHeader(), qgar::DxfFile::retrieveDxfGroup(), saveArc(), saveBox(), saveChain(), saveCircle(), qgar::DxfFile::saveDxfGroup(), savePoint(), savePolyline(), saveSegment(), writeHeader(), qgar::PgmFile::writeHeader(), qgar::PbmFile::writeHeader(), qgar::MapleFile::writeHeader(), qgar::DxfFile::writeHeader(), qgar::PgmFile::writeRow(), and qgar::PbmFile::writeRow().

const float qgar::TgifFile::_s_tgif_a4_page_height = 11.7f * _s_tgif_pix_per_inch [static, protected]

Tgif A4 page height (in pixels).

Definition at line 113 of file TgifFile.C.
Referenced by writeHeader().

const float qgar::TgifFile::_s_tgif_a4_page_width = 8.25f * _s_tgif_pix_per_inch [static, protected]

Tgif A4 page width (in pixels).

Definition at line 111 of file TgifFile.C.
Referenced by writeHeader().

const char * qgar::TgifFile::_s_tgif_colors [static, protected]

Initial value:
{ "#000000", "#000000", "#707070", "#a0a0a0", "#d0d0d0", "#ffffff", "#ff00ff", "#cc00cc", "#00ffff", "#00aaee", "#0000ff", "#888800", "#008800", "#00ff00", "#ffff00", "#ff8000", "#ff0000", "#ff4080", "#ff8080", "#bb7020", "#a02000" }
Table of Tgif colors (see enum type qgar::QGEcolor).

Definition at line 119 of file TgifFile.C.
Referenced by beginSavePoly(), saveArc(), saveBox(), and saveCircle().

const unsigned char qgar::TgifFile::_s_tgif_outlines [static, protected]

Initial value:
{ 0, 0, 1, 2, 3, 4, 5, 6, 7, 8 }
Table of Tgif outline types (see enum type qgar::QGEoutline).

Definition at line 145 of file TgifFile.C.
Referenced by endSavePoly(), saveArc(), saveBox(), and saveCircle().

const int qgar::TgifFile::_s_tgif_pix_per_inch = 128 [static, protected]

Tgif resolution: Number of pixels per inch.

Definition at line 109 of file TgifFile.C.

const char * qgar::TgifFile::_s_tgif_version = "3.0-p17" [static, protected]

Current Tgif version.

Definition at line 116 of file TgifFile.C.
Referenced by writeHeader().

int qgar::TgifFile::_tgifObjectCnt [protected]

Number of objects in the file.

Definition at line 549 of file TgifFile.H.
Referenced by endSavePoly(), saveArc(), saveBox(), and saveCircle().

The documentation for this class was generated from the following files:


Tgif specific information
int	_tgifObjectCnt
	Number of objects in the file.
static const char *	_s_tgif_version = "3.0-p17"
	Current Tgif version.
static const char *	_s_tgif_colors [21]
	Table of Tgif colors (see enum type qgar::QGEcolor).
static const unsigned char	_s_tgif_outlines [10]
	Table of Tgif outline types (see enum type qgar::QGEoutline).
static const int	_s_tgif_pix_per_inch = 128
	Tgif resolution: Number of pixels per inch.
static const float	_s_tgif_a4_page_width = 8.25f * _s_tgif_pix_per_inch
	Tgif A4 page width (in pixels).
static const float	_s_tgif_a4_page_height = 11.7f * _s_tgif_pix_per_inch
	Tgif A4 page height (in pixels).
Public Member Functions
Constructors
	TgifFile (char *aFileName)
	Initialize with given name.
Destructor
virtual	~TgifFile ()
	Virtual destructor.
Output points
void	write (const GenPoint< int > &aPt, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)
	Write a point with coordinates of type int.
void	write (const GenPoint< float > &aPt, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)
	Write a point with coordinates of type float.
void	write (const GenPoint< double > &aPt, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)
	Write a point with coordinates of type double.
Output chains of points
void	write (AbstChain &aChain, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)
	Write a chain of points with coordinates of type int.
void	write (FAbstChain &aChain, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)
	Write a chain of points with coordinates of type float.
void	write (DAbstChain &aChain, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)
	Write a chain of points with coordinates of type double.
Output segments
void	write (const GenSegment< int > &aSeg, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a geometrical segment with coordinates of type int.
void	write (const GenSegment< float > &aSeg, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a geometrical segment with coordinates of type float.
void	write (const GenSegment< double > &aSeg, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a geometrical segment with coordinates of type double.
Output circles and arcs of circle
void	write (const GenPoint< int > &aCenter, double aRadius, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a circle with coordinates of type int.
void	write (const GenPoint< float > &aCenter, double aRadius, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a circle with coordinates of type float.
void	write (const GenPoint< double > &aCenter, double aRadius, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a circle with coordinates of type double.
void	write (const GenArc< int > &anArc, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a geometrical arc with coordinates of type int.
void	write (const GenArc< float > &anArc, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a geometrical arc with coordinates of type float.
void	write (const GenArc< double > &anArc, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a geometrical arc with coordinates of type double.
Output polylines
void	write (const GenPolyline< int > &aPoly, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a geometrical polyline with coordinates of type int.
void	write (const GenPolyline< float > &aPoly, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a geometrical polyline with coordinates of type float.
void	write (const GenPolyline< double > &aPoly, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a geometrical polyline with coordinates of type double.
Output bounding boxes
void	write (const BoundingBox &aBox, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write a bounding box with coordinates of type int.
Output components
void	write (const ConnectedComponents::node_type *const aPNode, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Write the contour of a (connected) component and of all included components (i.e. children in the component tree).
Points
virtual void	write (AbstractGenPointChain< float > &aChain, int aThickness=3, QGEcolor aColor=QGE_COLOR_DEFAULT)=0
	Record a chain of points with coordinates of type float.
Segments
void	write (const GenQgarSegment< int > &aQSeg, int aThickness=-1, QGEcolor aColor=QGE_COLOR_NONE, QGEoutline anOutline=QGE_OUTLINE_NONE)
	Record a Qgar segment with coordinates of type int.
Circles and arcs of circle
void	write (const GenQgarArc< int > &aQArc, int aThickness=-1, QGEcolor aColor=QGE_COLOR_NONE, QGEoutline anOutline=QGE_OUTLINE_NONE)
	Record a Qgar arc with coordinates of type int.
Polylines
void	write (const GenQgarPolyline< int > &aQPoly, int aThickness=-1, QGEcolor aColor=QGE_COLOR_NONE, QGEoutline anOutline=QGE_OUTLINE_NONE)
	Record a Qgar polyline with coordinates of type int.
Access to file characteristics
std::fstream &	fileStream ()
	Get file stream.
const char *const	fileName () const
	Get file name.
QGEfileStatus	fileStatus () const
	Get current file status.
Opening
virtual void	openRONLY () throw (QgarErrorIO)
	Open in read-only mode.
virtual void	openWONLY () throw (QgarErrorIO)
	Open in write-only mode.
virtual void	openAPPEND () throw (QgarErrorIO)
	Open in append mode.
virtual void	openRW () throw (QgarErrorIO)
	Open in read-write mode.
virtual void	openRA () throw (QgarErrorIO)
	Open in read-append mode.
Closing
virtual void	close ()
	Close the file.
Checking status
virtual void	isOpenR () throw (QgarErrorUser)
	Abort if the file is not open in a mode allowing reading.
virtual void	isOpenW () throw (QgarErrorUser)
	Abort if the file is not open in a mode allowing writing.
virtual void	isOpenA () throw (QgarErrorUser)
	Abort if the file is not open in a mode allowing appending.
virtual void	isOpenRW () throw (QgarErrorUser)
	Abort if the file is not open in read-write mode.
virtual void	isOpenRA () throw (QgarErrorUser)
	Abort if the file is not open in readi-append mode.
Protected Member Functions
Output
void	writeHeader ()
	Write file header.
void	writeFooter ()
	Write file footer (nothing to do).
Save predicates describing Tgif objects
void	beginSavePoly (int aVerticesCnt, QGEcolor aColor)
	Save the beginning part of the predicate describing a Tgif polyline.
void	endSavePoly (int aVerticesCnt, int aThickness, QGEoutline anOutline)
	Save the ending part of the predicate describing a Tgif polyline.
void	saveBox (int aXTopLeft, int aYTopLeft, int aXBottomRight, int aYBottomRight, int aThickness, QGEcolor aColor, QGEoutline anOutline)
	Save the predicate describing a Tgif box.
void	saveCircle (int aXCenter, int aYCenter, int aRadius, int aThickness, QGEcolor aColor, QGEoutline anOutline)
	Save the predicate describing a Tgif circle.
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)
	Save the predicate describing a Tgif arc.
void	savePoint (int aX, int aY, int aThickness, QGEcolor aColor)
	Save the predicate describing a point.
template<class T>
void	saveChain (AbstractGenPointChain< T > &aChain, int aThickness, QGEcolor aColor)
	Save the predicate describing a chain of points with coordinates of type T.
void	saveSegment (int aXSource, int aYSource, int aXTarget, int aYTarget, int aThickness, QGEcolor aColor, QGEoutline anOutline)
	Save the predicate describing a segment.
template<class T>
void	savePolyline (const GenPolyline< T > &aPoly, int aThickness, QGEcolor aColor, QGEoutline anOutline)
	Save the predicate describing a polyline with coordinates of type T.
Protected Attributes
Representation of a file
char *	_fileName
	File name.
QGEfileStatus	_fileStatus
	File status.
std::fstream	_fileStream
	Associated file stream.
Private Member Functions
Not yet implemented
These functions belong to the private section as they are not yet implemented and thus should not be used.
void	readHeader () throw (QgarErrorDeveloper)
	Read file header.
AUXILIARIES
void	PRIVATEwriteComponent (const ConnectedComponents::node_type *const aPNode, int aThickness, QGEcolor aColor, QGEoutline anOutline)
	Write the contour of a (connected) component and of all included components (i.e. children in the component tree).

qgar::TgifFile Class Reference [Files]

Detailed Description

Tgif specific information

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

qgar::TgifFile Class Reference
[Files]