diff options
Diffstat (limited to 'doc/man/man3/tqwmatrix.3qt')
| -rw-r--r-- | doc/man/man3/tqwmatrix.3qt | 166 |
1 files changed, 83 insertions, 83 deletions
diff --git a/doc/man/man3/tqwmatrix.3qt b/doc/man/man3/tqwmatrix.3qt index c46e92415..b95922d67 100644 --- a/doc/man/man3/tqwmatrix.3qt +++ b/doc/man/man3/tqwmatrix.3qt @@ -1,5 +1,5 @@ '\" t -.TH QWMatrix 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQWMatrix 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -7,17 +7,17 @@ .ad l .nh .SH NAME -QWMatrix \- 2D transformations of a coordinate system +TQWMatrix \- 2D transformations of a coordinate system .SH SYNOPSIS -\fC#include <ntqwmatrix.h>\fR +\fC#include <tqwmatrix.h>\fR .PP .SS "Public Members" .in +1c .ti -1c -.BI "\fBQWMatrix\fR ()" +.BI "\fBTQWMatrix\fR ()" .br .ti -1c -.BI "\fBQWMatrix\fR ( double m11, double m12, double m21, double m22, double dx, double dy )" +.BI "\fBTQWMatrix\fR ( double m11, double m12, double m21, double m22, double dx, double dy )" .br .ti -1c .BI "void \fBsetMatrix\fR ( double m11, double m12, double m21, double m22, double dx, double dy )" @@ -47,25 +47,25 @@ QWMatrix \- 2D transformations of a coordinate system .BI "void \fBmap\fR ( double x, double y, double * tx, double * ty ) const" .br .ti -1c -.BI "QRect \fBmapRect\fR ( const QRect & rect ) const" +.BI "TQRect \fBmapRect\fR ( const TQRect & rect ) const" .br .ti -1c -.BI "QPoint \fBmap\fR ( const QPoint & p ) const" +.BI "TQPoint \fBmap\fR ( const TQPoint & p ) const" .br .ti -1c -.BI "QRect map ( const QRect & r ) const \fI(obsolete)\fR" +.BI "TQRect map ( const TQRect & r ) const \fI(obsolete)\fR" .br .ti -1c -.BI "QPointArray \fBmap\fR ( const QPointArray & a ) const" +.BI "TQPointArray \fBmap\fR ( const TQPointArray & a ) const" .br .ti -1c -.BI "QRegion \fBmap\fR ( const QRegion & r ) const" +.BI "TQRegion \fBmap\fR ( const TQRegion & r ) const" .br .ti -1c -.BI "QRegion \fBmapToRegion\fR ( const QRect & rect ) const" +.BI "TQRegion \fBmapToRegion\fR ( const TQRect & rect ) const" .br .ti -1c -.BI "QPointArray \fBmapToPolygon\fR ( const QRect & rect ) const" +.BI "TQPointArray \fBmapToPolygon\fR ( const TQRect & rect ) const" .br .ti -1c .BI "void \fBreset\fR ()" @@ -74,16 +74,16 @@ QWMatrix \- 2D transformations of a coordinate system .BI "bool \fBisIdentity\fR () const" .br .ti -1c -.BI "QWMatrix & \fBtranslate\fR ( double dx, double dy )" +.BI "TQWMatrix & \fBtranslate\fR ( double dx, double dy )" .br .ti -1c -.BI "QWMatrix & \fBscale\fR ( double sx, double sy )" +.BI "TQWMatrix & \fBscale\fR ( double sx, double sy )" .br .ti -1c -.BI "QWMatrix & \fBshear\fR ( double sh, double sv )" +.BI "TQWMatrix & \fBshear\fR ( double sh, double sv )" .br .ti -1c -.BI "QWMatrix & \fBrotate\fR ( double a )" +.BI "TQWMatrix & \fBrotate\fR ( double a )" .br .ti -1c .BI "bool \fBisInvertible\fR () const" @@ -92,16 +92,16 @@ QWMatrix \- 2D transformations of a coordinate system .BI "double \fBdet\fR () const" .br .ti -1c -.BI "QWMatrix \fBinvert\fR ( bool * invertible = 0 ) const" +.BI "TQWMatrix \fBinvert\fR ( bool * invertible = 0 ) const" .br .ti -1c -.BI "bool \fBoperator==\fR ( const QWMatrix & m ) const" +.BI "bool \fBoperator==\fR ( const TQWMatrix & m ) const" .br .ti -1c -.BI "bool \fBoperator!=\fR ( const QWMatrix & m ) const" +.BI "bool \fBoperator!=\fR ( const TQWMatrix & m ) const" .br .ti -1c -.BI "QWMatrix & \fBoperator*=\fR ( const QWMatrix & m )" +.BI "TQWMatrix & \fBoperator*=\fR ( const TQWMatrix & m )" .br .ti -1c .BI "enum \fBTransformationMode\fR { Points, Areas }" @@ -110,7 +110,7 @@ QWMatrix \- 2D transformations of a coordinate system .SS "Static Public Members" .in +1c .ti -1c -.BI "void \fBsetTransformationMode\fR ( QWMatrix::TransformationMode m )" +.BI "void \fBsetTransformationMode\fR ( TQWMatrix::TransformationMode m )" .br .ti -1c .BI "TransformationMode \fBtransformationMode\fR ()" @@ -119,18 +119,18 @@ QWMatrix \- 2D transformations of a coordinate system .SH RELATED FUNCTION DOCUMENTATION .in +1c .ti -1c -.BI "TQDataStream & \fBoperator<<\fR ( TQDataStream & s, const QWMatrix & m )" +.BI "TQDataStream & \fBoperator<<\fR ( TQDataStream & s, const TQWMatrix & m )" .br .ti -1c -.BI "TQDataStream & \fBoperator>>\fR ( TQDataStream & s, QWMatrix & m )" +.BI "TQDataStream & \fBoperator>>\fR ( TQDataStream & s, TQWMatrix & m )" .br .in -1c .SH DESCRIPTION -The QWMatrix class specifies 2D transformations of a coordinate system. +The TQWMatrix class specifies 2D transformations of a coordinate system. .PP The standard coordinate system of a paint device has the origin located at the top-left position. X values increase to the right; Y values increase downward. .PP -This coordinate system is the default for the TQPainter, which renders graphics in a paint device. A user-defined coordinate system can be specified by setting a QWMatrix for the painter. +This coordinate system is the default for the TQPainter, which renders graphics in a paint device. A user-defined coordinate system can be specified by setting a TQWMatrix for the painter. .PP Example: .PP @@ -142,7 +142,7 @@ Example: .br TQPainter p; // our painter .br - QWMatrix m; // our transformation matrix + TQWMatrix m; // our transformation matrix .br m.rotate( 22.5 ); // rotated coordinate system .br @@ -158,9 +158,9 @@ Example: .br .fi .PP -A matrix specifies how to translate, scale, shear or rotate the graphics; the actual transformation is performed by the drawing routines in TQPainter and by QPixmap::xForm(). +A matrix specifies how to translate, scale, shear or rotate the graphics; the actual transformation is performed by the drawing routines in TQPainter and by TQPixmap::xForm(). .PP -The QWMatrix class contains a 3x3 matrix of the form: +The TQWMatrix class contains a 3x3 matrix of the form: .nf .TS l @@ -195,13 +195,13 @@ Scaling can be done by setting \fIm11\fR and \fIm22\fR. For example, setting \fI .PP Shearing is controlled by \fIm12\fR and \fIm21\fR. Setting these elements to values different from zero will twist the coordinate system. .PP -Rotation is achieved by carefully setting both the shearing factors and the scaling factors. The QWMatrix also has a function that sets rotation directly. +Rotation is achieved by carefully setting both the shearing factors and the scaling factors. The TQWMatrix also has a function that sets rotation directly. .PP -QWMatrix lets you combine transformations like this: +TQWMatrix lets you combine transformations like this: .PP .nf .br - QWMatrix m; // identity matrix + TQWMatrix m; // identity matrix .br m.translate(10, -20); // first translate (10,-20) .br @@ -221,38 +221,38 @@ Here's the same example using basic matrix operations: .br double cosa = cos(a); .br - QWMatrix m1(1, 0, 0, 1, 10, -20); // translation matrix + TQWMatrix m1(1, 0, 0, 1, 10, -20); // translation matrix .br - QWMatrix m2( cosa, sina, // rotation matrix + TQWMatrix m2( cosa, sina, // rotation matrix .br -sina, cosa, 0, 0 ); .br - QWMatrix m3(1.2, 0, 0, 0.7, 0, 0); // scaling matrix + TQWMatrix m3(1.2, 0, 0, 0.7, 0, 0); // scaling matrix .br - QWMatrix m; + TQWMatrix m; .br m = m3 * m2 * m1; // combine all transformations .br .fi .PP -TQPainter has functions to translate, scale, shear and rotate the coordinate system without using a QWMatrix. Although these functions are very convenient, it can be more efficient to build a QWMatrix and call TQPainter::setWorldMatrix() if you want to perform more than a single transform operation. +TQPainter has functions to translate, scale, shear and rotate the coordinate system without using a TQWMatrix. Although these functions are very convenient, it can be more efficient to build a TQWMatrix and call TQPainter::setWorldMatrix() if you want to perform more than a single transform operation. .PP -See also TQPainter::setWorldMatrix(), QPixmap::xForm(), Graphics Classes, and Image Processing Classes. +See also TQPainter::setWorldMatrix(), TQPixmap::xForm(), Graphics Classes, and Image Processing Classes. .SS "Member Type Documentation" -.SH "QWMatrix::TransformationMode" +.SH "TQWMatrix::TransformationMode" .PP -QWMatrix offers two transformation modes. Calculations can either be done in terms of points (Points mode, the default), or in terms of area (Area mode). +TQWMatrix offers two transformation modes. Calculations can either be done in terms of points (Points mode, the default), or in terms of area (Area mode). .PP In Points mode the transformation is applied to the points that mark out the shape's bounding line. In Areas mode the transformation is applied in such a way that the area of the contained region is correctly transformed under the matrix. .TP -\fCQWMatrix::Points\fR - transformations are applied to the shape's points. +\fCTQWMatrix::Points\fR - transformations are applied to the shape's points. .TP -\fCQWMatrix::Areas\fR - transformations are applied (e.g. to the width and height) so that the area is transformed. +\fCTQWMatrix::Areas\fR - transformations are applied (e.g. to the width and height) so that the area is transformed. .PP Example: .PP -Suppose we have a rectangle, \fCQRect( 10, 20, 30, 40 )\fR and a transformation matrix \fCQWMatrix( 2, 0, 0, 2, 0, 0 )\fR to double the rectangle's size. +Suppose we have a rectangle, \fCTQRect( 10, 20, 30, 40 )\fR and a transformation matrix \fCTQWMatrix( 2, 0, 0, 2, 0, 0 )\fR to double the rectangle's size. .PP In Points mode, the matrix will transform the top-left (10,20) and the bottom-right (39,59) points producing a rectangle with its top-left point at (20,40) and its bottom-right point at (78,118), i.e. with a width of 59 and a height of 79. .PP @@ -268,17 +268,17 @@ Under Points mode, \fCmatrix * ( region1 | region2 )\fR is not equal to \fCmatri .PP </center> .SH MEMBER FUNCTION DOCUMENTATION -.SH "QWMatrix::QWMatrix ()" +.SH "TQWMatrix::TQWMatrix ()" Constructs an identity matrix. All elements are set to zero except \fIm11\fR and \fIm22\fR (scaling), which are set to 1. -.SH "QWMatrix::QWMatrix ( double m11, double m12, double m21, double m22, double dx, double dy )" +.SH "TQWMatrix::TQWMatrix ( double m11, double m12, double m21, double m22, double dx, double dy )" Constructs a matrix with the elements, \fIm11\fR, \fIm12\fR, \fIm21\fR, \fIm22\fR, \fIdx\fR and \fIdy\fR. -.SH "double QWMatrix::det () const" +.SH "double TQWMatrix::det () const" Returns the matrix's determinant. -.SH "double QWMatrix::dx () const" +.SH "double TQWMatrix::dx () const" Returns the horizontal translation. -.SH "double QWMatrix::dy () const" +.SH "double TQWMatrix::dy () const" Returns the vertical translation. -.SH "QWMatrix QWMatrix::invert ( bool * invertible = 0 ) const" +.SH "TQWMatrix TQWMatrix::invert ( bool * invertible = 0 ) const" Returns the inverted matrix. .PP If the matrix is singular (not invertible), the identity matrix is returned. @@ -288,23 +288,23 @@ If \fIinvertible\fR is not 0: the value of \fI*invertible\fR is set to TRUE if t See also isInvertible(). .PP Example: t14/cannon.cpp. -.SH "bool QWMatrix::isIdentity () const" +.SH "bool TQWMatrix::isIdentity () const" Returns TRUE if the matrix is the identity matrix; otherwise returns FALSE. .PP See also reset(). -.SH "bool QWMatrix::isInvertible () const" +.SH "bool TQWMatrix::isInvertible () const" Returns TRUE if the matrix is invertible; otherwise returns FALSE. .PP See also invert(). -.SH "double QWMatrix::m11 () const" +.SH "double TQWMatrix::m11 () const" Returns the X scaling factor. -.SH "double QWMatrix::m12 () const" +.SH "double TQWMatrix::m12 () const" Returns the vertical shearing factor. -.SH "double QWMatrix::m21 () const" +.SH "double TQWMatrix::m21 () const" Returns the horizontal shearing factor. -.SH "double QWMatrix::m22 () const" +.SH "double TQWMatrix::m22 () const" Returns the Y scaling factor. -.SH "void QWMatrix::map ( int x, int y, int * tx, int * ty ) const" +.SH "void TQWMatrix::map ( int x, int y, int * tx, int * ty ) const" Transforms ( \fIx\fR, \fIy\fR ) to ( \fI*tx\fR, \fI*ty\fR ) using the formulae: .PP .nf @@ -317,7 +317,7 @@ Transforms ( \fIx\fR, \fIy\fR ) to ( \fI*tx\fR, \fI*ty\fR ) using the formulae: .PP Examples: .)l t14/cannon.cpp and xform/xform.cpp. -.SH "void QWMatrix::map ( double x, double y, double * tx, double * ty ) const" +.SH "void TQWMatrix::map ( double x, double y, double * tx, double * ty ) const" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Transforms ( \fIx\fR, \fIy\fR ) to ( \fI*tx\fR, \fI*ty\fR ) using the following formulae: @@ -329,7 +329,7 @@ Transforms ( \fIx\fR, \fIy\fR ) to ( \fI*tx\fR, \fI*ty\fR ) using the following *ty = m22*y + m12*x + dy .br .fi -.SH "QPoint QWMatrix::map ( const QPoint & p ) const" +.SH "TQPoint TQWMatrix::map ( const TQPoint & p ) const" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Transforms \fIp\fR to using the formulae: @@ -341,23 +341,23 @@ Transforms \fIp\fR to using the formulae: rety = m22*py + m12*px + dy (rounded to the nearest integer) .br .fi -.SH "QRect QWMatrix::map ( const QRect & r ) const" +.SH "TQRect TQWMatrix::map ( const TQRect & r ) const" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP -Please use QWMatrix::mapRect() instead. +Please use TQWMatrix::mapRect() instead. .PP Note that this method does return the bounding rectangle of the \fIr\fR, when shearing or rotations are used. -.SH "QPointArray QWMatrix::map ( const QPointArray & a ) const" +.SH "TQPointArray TQWMatrix::map ( const TQPointArray & a ) const" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Returns the point array \fIa\fR transformed by calling map for each point. -.SH "QRegion QWMatrix::map ( const QRegion & r ) const" +.SH "TQRegion TQWMatrix::map ( const TQRegion & r ) const" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Transforms the region \fIr\fR. .PP Calling this method can be rather expensive, if rotations or shearing are used. -.SH "QRect QWMatrix::mapRect ( const QRect & rect ) const" +.SH "TQRect TQWMatrix::mapRect ( const TQRect & rect ) const" Returns the transformed rectangle \fIrect\fR. .PP The bounding rectangle is returned if rotation or shearing has been specified. @@ -367,31 +367,31 @@ If you need to know the exact region \fIrect\fR maps to use operator*(). See also operator*(). .PP Example: xform/xform.cpp. -.SH "QPointArray QWMatrix::mapToPolygon ( const QRect & rect ) const" +.SH "TQPointArray TQWMatrix::mapToPolygon ( const TQRect & rect ) const" Returns the transformed rectangle \fIrect\fR as a polygon. .PP -Polygons and rectangles behave slightly differently when transformed (due to integer rounding), so \fCmatrix.map( QPointArray( rect ) )\fR is not always the same as \fCmatrix.mapToPolygon( rect )\fR. -.SH "QRegion QWMatrix::mapToRegion ( const QRect & rect ) const" +Polygons and rectangles behave slightly differently when transformed (due to integer rounding), so \fCmatrix.map( TQPointArray( rect ) )\fR is not always the same as \fCmatrix.mapToPolygon( rect )\fR. +.SH "TQRegion TQWMatrix::mapToRegion ( const TQRect & rect ) const" Returns the transformed rectangle \fIrect\fR. .PP A rectangle which has been rotated or sheared may result in a non-rectangular region being returned. .PP Calling this method can be expensive, if rotations or shearing are used. If you just need to know the bounding rectangle of the returned region, use mapRect() which is a lot faster than this function. .PP -See also QWMatrix::mapRect(). -.SH "bool QWMatrix::operator!= ( const QWMatrix & m ) const" +See also TQWMatrix::mapRect(). +.SH "bool TQWMatrix::operator!= ( const TQWMatrix & m ) const" Returns TRUE if this matrix is not equal to \fIm\fR; otherwise returns FALSE. -.SH "QWMatrix & QWMatrix::operator*= ( const QWMatrix & m )" +.SH "TQWMatrix & TQWMatrix::operator*= ( const TQWMatrix & m )" Returns the result of multiplying this matrix by matrix \fIm\fR. -.SH "bool QWMatrix::operator== ( const QWMatrix & m ) const" +.SH "bool TQWMatrix::operator== ( const TQWMatrix & m ) const" Returns TRUE if this matrix is equal to \fIm\fR; otherwise returns FALSE. -.SH "void QWMatrix::reset ()" +.SH "void TQWMatrix::reset ()" Resets the matrix to an identity matrix. .PP All elements are set to zero, except \fIm11\fR and \fIm22\fR (scaling) which are set to 1. .PP See also isIdentity(). -.SH "QWMatrix & QWMatrix::rotate ( double a )" +.SH "TQWMatrix & TQWMatrix::rotate ( double a )" Rotates the coordinate system \fIa\fR degrees counterclockwise. .PP Returns a reference to the matrix. @@ -400,7 +400,7 @@ See also translate(), scale(), and shear(). .PP Examples: .)l canvas/canvas.cpp, desktop/desktop.cpp, drawdemo/drawdemo.cpp, t14/cannon.cpp, and xform/xform.cpp. -.SH "QWMatrix & QWMatrix::scale ( double sx, double sy )" +.SH "TQWMatrix & TQWMatrix::scale ( double sx, double sy )" Scales the coordinate system unit by \fIsx\fR horizontally and \fIsy\fR vertically. .PP Returns a reference to the matrix. @@ -409,13 +409,13 @@ See also translate(), shear(), and rotate(). .PP Examples: .)l canvas/canvas.cpp, fileiconview/tqfileiconview.cpp, movies/main.cpp, qmag/qmag.cpp, showimg/showimg.cpp, and xform/xform.cpp. -.SH "void QWMatrix::setMatrix ( double m11, double m12, double m21, double m22, double dx, double dy )" +.SH "void TQWMatrix::setMatrix ( double m11, double m12, double m21, double m22, double dx, double dy )" Sets the matrix elements to the specified values, \fIm11\fR, \fIm12\fR, \fIm21\fR, \fIm22\fR, \fIdx\fR and \fIdy\fR. -.SH "void QWMatrix::setTransformationMode ( QWMatrix::TransformationMode m )\fC [static]\fR" -Sets the transformation mode that QWMatrix and painter transformations use to \fIm\fR. +.SH "void TQWMatrix::setTransformationMode ( TQWMatrix::TransformationMode m )\fC [static]\fR" +Sets the transformation mode that TQWMatrix and painter transformations use to \fIm\fR. .PP -See also QWMatrix::TransformationMode. -.SH "QWMatrix & QWMatrix::shear ( double sh, double sv )" +See also TQWMatrix::TransformationMode. +.SH "TQWMatrix & TQWMatrix::shear ( double sh, double sv )" Shears the coordinate system by \fIsh\fR horizontally and \fIsv\fR vertically. .PP Returns a reference to the matrix. @@ -424,11 +424,11 @@ See also translate(), scale(), and rotate(). .PP Examples: .)l drawdemo/drawdemo.cpp and xform/xform.cpp. -.SH "TransformationMode QWMatrix::transformationMode ()\fC [static]\fR" +.SH "TransformationMode TQWMatrix::transformationMode ()\fC [static]\fR" Returns the current transformation mode. .PP -See also QWMatrix::TransformationMode. -.SH "QWMatrix & QWMatrix::translate ( double dx, double dy )" +See also TQWMatrix::TransformationMode. +.SH "TQWMatrix & TQWMatrix::translate ( double dx, double dy )" Moves the coordinate system \fIdx\fR along the X-axis and \fIdy\fR along the Y-axis. .PP Returns a reference to the matrix. @@ -438,17 +438,17 @@ See also scale(), shear(), and rotate(). Examples: .)l canvas/canvas.cpp, drawdemo/drawdemo.cpp, t14/cannon.cpp, and xform/xform.cpp. .SH RELATED FUNCTION DOCUMENTATION -.SH "TQDataStream & operator<< ( TQDataStream & s, const QWMatrix & m )" +.SH "TQDataStream & operator<< ( TQDataStream & s, const TQWMatrix & m )" Writes the matrix \fIm\fR to the stream \fIs\fR and returns a reference to the stream. .PP See also Format of the TQDataStream operators. -.SH "TQDataStream & operator>> ( TQDataStream & s, QWMatrix & m )" +.SH "TQDataStream & operator>> ( TQDataStream & s, TQWMatrix & m )" Reads the matrix \fIm\fR from the stream \fIs\fR and returns a reference to the stream. .PP See also Format of the TQDataStream operators. .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqwmatrix.html +.BR http://doc.trolltech.com/tqwmatrix.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |