.TH "DviFilePosition" 3 "Mon Jan 12 2015" "Version dvi2bitmap1.0" "dvi2bitmap" \" -*- nroff -*-
.ad l
.nh
.SH NAME
DviFilePosition \- 
.PP
Represents a location within the \fBDviFile\fP\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <DviFilePosition\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBDviFilePosition\fP (\fBDviFile\fP *, double x, double y, \fBDviFile::DviUnits\fP)"
.br
.RI "\fICreate a new marked position in a DVI file\&. \fP"
.ti -1c
.RI "\fBDviFilePosition\fP (\fBDviFilePosition\fP *, double x, double y, \fBDviFile::DviUnits\fP)"
.br
.RI "\fICreate a new marked position in a DVI file\&. \fP"
.ti -1c
.RI "double \fBgetX\fP (const \fBDviFile::DviUnits\fP u)"
.br
.RI "\fIRetrieve the x-coordinate of this position\&. \fP"
.ti -1c
.RI "double \fBgetY\fP (const \fBDviFile::DviUnits\fP u)"
.br
.RI "\fIRetrieve the y-coordinate of this position\&. \fP"
.ti -1c
.RI "void \fBshift\fP (double dx, double dy, \fBDviFile::DviUnits\fP u)"
.br
.RI "\fIShift the mark position by the given amount\&. \fP"
.ti -1c
.RI "void \fBscale\fP (double factor)"
.br
.RI "\fIScale the position by the given factor\&. \fP"
.ti -1c
.RI "\fBDviFilePosition\fP * \fBcopy\fP ()"
.br
.RI "\fIReturn a copy of the object\&. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBverbosities\fP \fBverbosity\fP (const \fBverbosities\fP level)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Represents a location within the \fBDviFile\fP\&. 

Coordinates \fCx\fP and \fCy\fP are relative to the top-left corner of the `page', with the pixel in the top-left corner having coordinates (0,0)\&. Note that this is different from DVI coordinates, which have their origin at a point one inch in and one inch down from the top-left of the `paper'\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "DviFilePosition::DviFilePosition (\fBDviFile\fP *f, doublex, doubley, \fBDviFile::DviUnits\fPu)"

.PP
Create a new marked position in a DVI file\&. 
.PP
\fBParameters:\fP
.RS 4
\fIf\fP the DVI file of interest 
.br
\fIx\fP the x-coordinate of the position 
.br
\fIy\fP the y-coordinate of the position 
.br
\fIu\fP the units of the (x,y) position 
.RE
.PP

.PP
References DviFile::convertFromScaledPoints(), DviFile::convertToScaledPoints(), normal, and DviFile::unit_pixels\&.
.PP
Referenced by copy()\&.
.SS "DviFilePosition::DviFilePosition (\fBDviFilePosition\fP *dvifp, doublex, doubley, \fBDviFile::DviUnits\fPu)"

.PP
Create a new marked position in a DVI file\&. 
.PP
\fBParameters:\fP
.RS 4
\fIdvifp\fP use the DVI file referred to by this class 
.br
\fIx\fP the x-coordinate of the position 
.br
\fIy\fP the y-coordinate of the position 
.br
\fIu\fP the units of the (x,y) position 
.RE
.PP

.PP
References DviFile::convertToScaledPoints()\&.
.SH "Member Function Documentation"
.PP 
.SS "\fBDviFilePosition\fP * DviFilePosition::copy ()"

.PP
Return a copy of the object\&. 
.PP
References DviFilePosition(), and DviFile::unit_sp\&.
.PP
Referenced by Bitmap::getMark()\&.
.SS "double DviFilePosition::getX (const \fBDviFile::DviUnits\fPu)"

.PP
Retrieve the x-coordinate of this position\&. 
.PP
\fBParameters:\fP
.RS 4
\fIu\fP express the answer in these units 
.RE
.PP
\fBReturns:\fP
.RS 4
the x-coordinate in the required units 
.RE
.PP

.PP
References DviFile::convertFromScaledPoints()\&.
.PP
Referenced by Bitmap::mark(), and Bitmap::write()\&.
.SS "double DviFilePosition::getY (const \fBDviFile::DviUnits\fPu)"

.PP
Retrieve the y-coordinate of this position\&. 
.PP
\fBParameters:\fP
.RS 4
\fIu\fP express the answer in these units 
.RE
.PP
\fBReturns:\fP
.RS 4
the y-coordinate in the required units 
.RE
.PP

.PP
References DviFile::convertFromScaledPoints()\&.
.PP
Referenced by Bitmap::mark(), and Bitmap::write()\&.
.SS "void DviFilePosition::scale (doublefactor)"

.PP
Scale the position by the given factor\&. The scaling is done in such a way that the coordinate \fI(0,0)\fP remains `fixed'\&. 
.PP
\fBParameters:\fP
.RS 4
\fIfactor\fP a scaling factor, by which all distances are multiplied 
.RE
.PP

.PP
References DviFile::convertFromScaledPoints(), normal, and DviFile::unit_pixels\&.
.SS "void DviFilePosition::shift (doubledx, doubledy, \fBDviFile::DviUnits\fPu)"

.PP
Shift the mark position by the given amount\&. 
.PP
\fBParameters:\fP
.RS 4
\fIdx\fP the amount to shift in the x direction 
.br
\fIdy\fP the amount to shift in the y direction 
.br
\fIu\fP the units in which dx and dy are expressed 
.RE
.PP

.PP
References DviFile::convertFromScaledPoints(), DviFile::convertToScaledPoints(), normal, and DviFile::unit_pixels\&.
.PP
Referenced by Bitmap::getMark()\&.
.SS "static \fBverbosities\fP DviFilePosition::verbosity (const \fBverbosities\fPlevel)\fC [inline]\fP, \fC [static]\fP"

.PP
Referenced by main()\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for dvi2bitmap from the source code\&.