summaryrefslogtreecommitdiffstats
path: root/doc/html/qpointarray.html
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-08 12:31:36 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-08 12:31:36 -0600
commitd796c9dd933ab96ec83b9a634feedd5d32e1ba3f (patch)
tree6e3dcca4f77e20ec8966c666aac7c35bd4704053 /doc/html/qpointarray.html
downloadtqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.tar.gz
tqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.zip
Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731
Diffstat (limited to 'doc/html/qpointarray.html')
-rw-r--r--doc/html/qpointarray.html285
1 files changed, 285 insertions, 0 deletions
diff --git a/doc/html/qpointarray.html b/doc/html/qpointarray.html
new file mode 100644
index 000000000..049de4c79
--- /dev/null
+++ b/doc/html/qpointarray.html
@@ -0,0 +1,285 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qpointarray.cpp:47 -->
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>TQPointArray Class</title>
+<style type="text/css"><!--
+fn { margin-left: 1cm; text-indent: -1cm; }
+a:link { color: #004faf; text-decoration: none }
+a:visited { color: #672967; text-decoration: none }
+body { background: #ffffff; color: black; }
+--></style>
+</head>
+<body>
+
+<table border="0" cellpadding="0" cellspacing="0" width="100%">
+<tr bgcolor="#E5E5E5">
+<td valign=center>
+ <a href="index.html">
+<font color="#004faf">Home</font></a>
+ | <a href="classes.html">
+<font color="#004faf">All&nbsp;Classes</font></a>
+ | <a href="mainclasses.html">
+<font color="#004faf">Main&nbsp;Classes</font></a>
+ | <a href="annotated.html">
+<font color="#004faf">Annotated</font></a>
+ | <a href="groups.html">
+<font color="#004faf">Grouped&nbsp;Classes</font></a>
+ | <a href="functions.html">
+<font color="#004faf">Functions</font></a>
+</td>
+<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQPointArray Class Reference</h1>
+
+<p>The TQPointArray class provides an array of points.
+<a href="#details">More...</a>
+<p><tt>#include &lt;<a href="qpointarray-h.html">qpointarray.h</a>&gt;</tt>
+<p>Inherits <a href="qmemarray.html">TQMemArray</a>&lt;TQPoint&gt;.
+<p><a href="qpointarray-members.html">List of all member functions.</a>
+<h2>Public Members</h2>
+<ul>
+<li class=fn><a href="#TQPointArray"><b>TQPointArray</b></a> ()</li>
+<li class=fn><a href="#~TQPointArray"><b>~TQPointArray</b></a> ()</li>
+<li class=fn><a href="#TQPointArray-2"><b>TQPointArray</b></a> ( int&nbsp;size )</li>
+<li class=fn><a href="#TQPointArray-3"><b>TQPointArray</b></a> ( const&nbsp;TQPointArray&nbsp;&amp;&nbsp;a )</li>
+<li class=fn><a href="#TQPointArray-4"><b>TQPointArray</b></a> ( const&nbsp;TQRect&nbsp;&amp;&nbsp;r, bool&nbsp;closed = FALSE )</li>
+<li class=fn>TQPointArray &amp; <a href="#operator-eq"><b>operator=</b></a> ( const&nbsp;TQPointArray&nbsp;&amp;&nbsp;a )</li>
+<li class=fn>TQPointArray <a href="#copy"><b>copy</b></a> () const</li>
+<li class=fn>void <a href="#translate"><b>translate</b></a> ( int&nbsp;dx, int&nbsp;dy )</li>
+<li class=fn>TQRect <a href="#boundingRect"><b>boundingRect</b></a> () const</li>
+<li class=fn>void <a href="#point"><b>point</b></a> ( uint&nbsp;index, int&nbsp;*&nbsp;x, int&nbsp;*&nbsp;y ) const</li>
+<li class=fn>TQPoint <a href="#point-2"><b>point</b></a> ( uint&nbsp;index ) const</li>
+<li class=fn>void <a href="#setPoint"><b>setPoint</b></a> ( uint&nbsp;index, int&nbsp;x, int&nbsp;y )</li>
+<li class=fn>void <a href="#setPoint-2"><b>setPoint</b></a> ( uint&nbsp;i, const&nbsp;TQPoint&nbsp;&amp;&nbsp;p )</li>
+<li class=fn>bool <a href="#putPoints"><b>putPoints</b></a> ( int&nbsp;index, int&nbsp;nPoints, int&nbsp;firstx, int&nbsp;firsty, ... )</li>
+<li class=fn>bool <a href="#putPoints-3"><b>putPoints</b></a> ( int&nbsp;index, int&nbsp;nPoints, const&nbsp;TQPointArray&nbsp;&amp;&nbsp;from, int&nbsp;fromIndex = 0 )</li>
+<li class=fn>void <a href="#makeArc"><b>makeArc</b></a> ( int&nbsp;x, int&nbsp;y, int&nbsp;w, int&nbsp;h, int&nbsp;a1, int&nbsp;a2 )</li>
+<li class=fn>void <a href="#makeEllipse"><b>makeEllipse</b></a> ( int&nbsp;x, int&nbsp;y, int&nbsp;w, int&nbsp;h )</li>
+<li class=fn>void <a href="#makeArc-2"><b>makeArc</b></a> ( int&nbsp;x, int&nbsp;y, int&nbsp;w, int&nbsp;h, int&nbsp;a1, int&nbsp;a2, const&nbsp;TQWMatrix&nbsp;&amp;&nbsp;xf )</li>
+<li class=fn>TQPointArray <a href="#cubicBezier"><b>cubicBezier</b></a> () const</li>
+</ul>
+<h2>Related Functions</h2>
+<ul>
+<li class=fn>TQDataStream &amp; <a href="#operator-lt-lt"><b>operator&lt;&lt;</b></a> ( TQDataStream&nbsp;&amp;&nbsp;s, const&nbsp;TQPointArray&nbsp;&amp;&nbsp;a )</li>
+<li class=fn>TQDataStream &amp; <a href="#operator-gt-gt"><b>operator&gt;&gt;</b></a> ( TQDataStream&nbsp;&amp;&nbsp;s, TQPointArray&nbsp;&amp;&nbsp;a )</li>
+</ul>
+<hr><a name="details"></a><h2>Detailed Description</h2>
+
+
+The TQPointArray class provides an array of points.
+<p>
+
+
+<p> A TQPointArray is an array of <a href="qpoint.html">TQPoint</a> objects. In addition to the
+functions provided by <a href="qmemarray.html">TQMemArray</a>, TQPointArray provides some
+point-specific functions.
+<p> For convenient reading and writing of the point data use
+setPoints(), <a href="#putPoints">putPoints</a>(), <a href="#point">point</a>(), and <a href="#setPoint">setPoint</a>().
+<p> For geometry operations use <a href="#boundingRect">boundingRect</a>() and <a href="#translate">translate</a>(). There
+is also the <a href="qwmatrix.html#map">TQWMatrix::map</a>() function for more general
+transformations of TQPointArrays. You can also create arcs and
+ellipses with <a href="#makeArc">makeArc</a>() and <a href="#makeEllipse">makeEllipse</a>().
+<p> Among others, TQPointArray is used by <a href="qpainter.html#drawLineSegments">TQPainter::drawLineSegments</a>(),
+<a href="qpainter.html#drawPolyline">TQPainter::drawPolyline</a>(), <a href="qpainter.html#drawPolygon">TQPainter::drawPolygon</a>() and
+<a href="qpainter.html#drawCubicBezier">TQPainter::drawCubicBezier</a>().
+<p> Note that because this class is a TQMemArray, copying an array and
+modifying the copy modifies the original as well, i.e. a <a href="shclass.html#shallow-copy">shallow copy</a>. If you need a <a href="shclass.html#deep-copy">deep copy</a> use <a href="#copy">copy</a>() or <a href="qmemarray.html#detach">detach</a>(), for example:
+<p> <pre>
+ void drawGiraffe( const TQPointArray &amp; r, TQPainter * p )
+ {
+ TQPointArray tmp = r;
+ tmp.<a href="qmemarray.html#detach">detach</a>();
+ // some code that modifies tmp
+ p-&gt;drawPoints( tmp );
+ }
+ </pre>
+
+<p> If you forget the tmp.detach(), the const array will be modified.
+<p> <p>See also <a href="qpainter.html">TQPainter</a>, <a href="qwmatrix.html">TQWMatrix</a>, <a href="qmemarray.html">TQMemArray</a>, <a href="graphics.html">Graphics Classes</a>, <a href="images.html">Image Processing Classes</a>, and <a href="shared.html">Implicitly and Explicitly Shared Classes</a>.
+
+<hr><h2>Member Function Documentation</h2>
+<h3 class=fn><a name="TQPointArray"></a>TQPointArray::TQPointArray ()
+</h3>
+
+<p> Constructs a null point array.
+<p> <p>See also <a href="qmemarray.html#isNull">isNull</a>().
+
+<h3 class=fn><a name="TQPointArray-2"></a>TQPointArray::TQPointArray ( int&nbsp;size )
+</h3>
+
+<p> Constructs a point array with room for <em>size</em> points. Makes a
+null array if <em>size</em> == 0.
+<p> <p>See also <a href="qmemarray.html#resize">resize</a>() and <a href="qmemarray.html#isNull">isNull</a>().
+
+<h3 class=fn><a name="TQPointArray-3"></a>TQPointArray::TQPointArray ( const&nbsp;<a href="qpointarray.html">TQPointArray</a>&nbsp;&amp;&nbsp;a )
+</h3>
+
+<p> Constructs a <a href="shclass.html#shallow-copy">shallow copy</a> of the point array <em>a</em>.
+<p> <p>See also <a href="#copy">copy</a>() and <a href="qmemarray.html#detach">detach</a>().
+
+<h3 class=fn><a name="TQPointArray-4"></a>TQPointArray::TQPointArray ( const&nbsp;<a href="qrect.html">TQRect</a>&nbsp;&amp;&nbsp;r, bool&nbsp;closed = FALSE )
+</h3>
+Constructs a point array from the rectangle <em>r</em>.
+<p> If <em>closed</em> is FALSE, then the point array just contains the
+following four points in the listed order: r.topLeft(),
+r.topRight(), r.bottomRight() and r.bottomLeft().
+<p> If <em>closed</em> is TRUE, then a fifth point is set to r.topLeft().
+
+<h3 class=fn><a name="~TQPointArray"></a>TQPointArray::~TQPointArray ()
+</h3>
+
+<p> Destroys the point array.
+
+<h3 class=fn><a href="qrect.html">TQRect</a> <a name="boundingRect"></a>TQPointArray::boundingRect () const
+</h3>
+Returns the bounding rectangle of the points in the array, or
+<a href="qrect.html">TQRect</a>(0,0,0,0) if the array is empty.
+
+<h3 class=fn><a href="qpointarray.html">TQPointArray</a> <a name="copy"></a>TQPointArray::copy () const
+</h3>
+
+<p> Creates a <a href="shclass.html#deep-copy">deep copy</a> of the array.
+<p> <p>See also <a href="qmemarray.html#detach">detach</a>().
+
+<h3 class=fn><a href="qpointarray.html">TQPointArray</a> <a name="cubicBezier"></a>TQPointArray::cubicBezier () const
+</h3>
+Returns the Bezier points for the four control points in this
+array.
+
+<h3 class=fn>void <a name="makeArc"></a>TQPointArray::makeArc ( int&nbsp;x, int&nbsp;y, int&nbsp;w, int&nbsp;h, int&nbsp;a1, int&nbsp;a2 )
+</h3>
+Sets the points of the array to those describing an arc of an
+ellipse with size, width <em>w</em> by height <em>h</em>, and position (<em>x</em>,
+<em>y</em>), starting from angle <em>a1</em> and spanning by angle <em>a2</em>. The
+resulting array has sufficient resolution for pixel accuracy (see
+the overloaded function which takes an additional <a href="qwmatrix.html">TQWMatrix</a>
+parameter).
+<p> Angles are specified in 16ths of a degree, i.e. a full circle
+equals 5760 (16*360). Positive values mean counter-clockwise,
+whereas negative values mean the clockwise direction. Zero degrees
+is at the 3 o'clock position.
+<p> See the <a href="qcanvasellipse.html#anglediagram">angle diagram</a>.
+
+<h3 class=fn>void <a name="makeArc-2"></a>TQPointArray::makeArc ( int&nbsp;x, int&nbsp;y, int&nbsp;w, int&nbsp;h, int&nbsp;a1, int&nbsp;a2, const&nbsp;<a href="qwmatrix.html">TQWMatrix</a>&nbsp;&amp;&nbsp;xf )
+</h3>
+This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
+<p> Sets the points of the array to those describing an arc of an
+ellipse with width <em>w</em> and height <em>h</em> and position (<em>x</em>, <em>y</em>),
+starting from angle <em>a1</em>, and spanning angle by <em>a2</em>, and
+transformed by the matrix <em>xf</em>. The resulting array has
+sufficient resolution for pixel accuracy.
+<p> Angles are specified in 16ths of a degree, i.e. a full circle
+equals 5760 (16*360). Positive values mean counter-clockwise,
+whereas negative values mean the clockwise direction. Zero degrees
+is at the 3 o'clock position.
+<p> See the <a href="qcanvasellipse.html#anglediagram">angle diagram</a>.
+
+<h3 class=fn>void <a name="makeEllipse"></a>TQPointArray::makeEllipse ( int&nbsp;x, int&nbsp;y, int&nbsp;w, int&nbsp;h )
+</h3>
+Sets the points of the array to those describing an ellipse with
+size, width <em>w</em> by height <em>h</em>, and position (<em>x</em>, <em>y</em>).
+<p> The returned array has sufficient resolution for use as pixels.
+
+<h3 class=fn><a href="qpointarray.html">TQPointArray</a>&nbsp;&amp; <a name="operator-eq"></a>TQPointArray::operator= ( const&nbsp;<a href="qpointarray.html">TQPointArray</a>&nbsp;&amp;&nbsp;a )
+</h3>
+
+<p> Assigns a <a href="shclass.html#shallow-copy">shallow copy</a> of <em>a</em> to this point array and returns a
+reference to this point array.
+<p> Equivalent to <a href="qmemarray.html#assign">assign</a>(a).
+<p> <p>See also <a href="#copy">copy</a>() and <a href="qmemarray.html#detach">detach</a>().
+
+<h3 class=fn>void <a name="point"></a>TQPointArray::point ( uint&nbsp;index, int&nbsp;*&nbsp;x, int&nbsp;*&nbsp;y ) const
+</h3>
+Reads the coordinates of the point at position <em>index</em> within the
+array and writes them into <em>*x</em> and <em>*y</em>.
+
+<h3 class=fn><a href="qpoint.html">TQPoint</a> <a name="point-2"></a>TQPointArray::point ( uint&nbsp;index ) const
+</h3>
+This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
+<p> Returns the point at position <em>index</em> within the array.
+
+<h3 class=fn>bool <a name="putPoints"></a>TQPointArray::putPoints ( int&nbsp;index, int&nbsp;nPoints, int&nbsp;firstx, int&nbsp;firsty, ... )
+</h3>
+Copies <em>nPoints</em> points from the variable argument list into this
+point array from position <em>index</em>, and resizes the point array if
+<tt>index+nPoints</tt> exceeds the size of the array.
+<p> Returns TRUE if successful, or FALSE if the array could not be
+resized (typically due to lack of memory).
+<p> The example code creates an array with three points (4,5), (6,7)
+and (8,9), by expanding the array from 1 to 3 points:
+<p> <pre>
+ TQPointArray a( 1 );
+ a[0] = TQPoint( 4, 5 );
+ a.<a href="#putPoints">putPoints</a>( 1, 2, 6,7, 8,9 ); // index == 1, points == 2
+ </pre>
+
+<p> This has the same result, but here putPoints overwrites rather
+than extends:
+<pre>
+ TQPointArray a( 3 );
+ a.<a href="#putPoints">putPoints</a>( 0, 3, 4,5, 0,0, 8,9 );
+ a.<a href="#putPoints">putPoints</a>( 1, 1, 6,7 );
+ </pre>
+
+<p> The points are given as a sequence of integers, starting with <em>firstx</em> then <em>firsty</em>, and so on.
+<p> <p>See also <a href="qmemarray.html#resize">resize</a>().
+
+<h3 class=fn>bool <a name="putPoints-3"></a>TQPointArray::putPoints ( int&nbsp;index, int&nbsp;nPoints, const&nbsp;<a href="qpointarray.html">TQPointArray</a>&nbsp;&amp;&nbsp;from, int&nbsp;fromIndex = 0 )
+</h3>
+This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
+<p> This version of the function copies <em>nPoints</em> from <em>from</em> into
+this array, starting at <em>index</em> in this array and <em>fromIndex</em> in
+<em>from</em>. <em>fromIndex</em> is 0 by default.
+<p> <pre>
+ TQPointArray a;
+ a.<a href="#putPoints">putPoints</a>( 0, 3, 1,2, 0,0, 5,6 );
+ // a is now the three-point array ( 1,2, 0,0, 5,6 );
+ TQPointArray b;
+ b.<a href="#putPoints">putPoints</a>( 0, 3, 4,4, 5,5, 6,6 );
+ // b is now ( 4,4, 5,5, 6,6 );
+ a.<a href="#putPoints">putPoints</a>( 2, 3, b );
+ // a is now ( 1,2, 0,0, 4,4, 5,5, 6,6 );
+ </pre>
+
+
+<h3 class=fn>void <a name="setPoint"></a>TQPointArray::setPoint ( uint&nbsp;index, int&nbsp;x, int&nbsp;y )
+</h3>
+Sets the point at position <em>index</em> in the array to <em>(x, y)</em>.
+
+<p>Example: <a href="themes-example.html#x231">themes/wood.cpp</a>.
+<h3 class=fn>void <a name="setPoint-2"></a>TQPointArray::setPoint ( uint&nbsp;i, const&nbsp;<a href="qpoint.html">TQPoint</a>&nbsp;&amp;&nbsp;p )
+</h3>
+
+<p> This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
+<p> Sets the point at array index <em>i</em> to <em>p</em>.
+
+<h3 class=fn>void <a name="translate"></a>TQPointArray::translate ( int&nbsp;dx, int&nbsp;dy )
+</h3>
+Translates all points in the array by <em>(dx, dy)</em>.
+
+<hr><h2>Related Functions</h2>
+<h3 class=fn><a href="qdatastream.html">TQDataStream</a>&nbsp;&amp; <a name="operator-lt-lt"></a>operator&lt;&lt; ( <a href="qdatastream.html">TQDataStream</a>&nbsp;&amp;&nbsp;s, const&nbsp;<a href="qpointarray.html">TQPointArray</a>&nbsp;&amp;&nbsp;a )
+</h3>
+
+<p> Writes the point array, <em>a</em> to the stream <em>s</em> and returns a
+reference to the stream.
+<p> <p>See also <a href="datastreamformat.html">Format of the TQDataStream operators</a>.
+
+<h3 class=fn><a href="qdatastream.html">TQDataStream</a>&nbsp;&amp; <a name="operator-gt-gt"></a>operator&gt;&gt; ( <a href="qdatastream.html">TQDataStream</a>&nbsp;&amp;&nbsp;s, <a href="qpointarray.html">TQPointArray</a>&nbsp;&amp;&nbsp;a )
+</h3>
+
+<p> Reads a point array, <em>a</em> from the stream <em>s</em> and returns a
+reference to the stream.
+<p> <p>See also <a href="datastreamformat.html">Format of the TQDataStream operators</a>.
+
+<!-- eof -->
+<hr><p>
+This file is part of the <a href="index.html">TQt toolkit</a>.
+Copyright &copy; 1995-2007
+<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
+<table width=100% cellspacing=0 border=0><tr>
+<td>Copyright &copy; 2007
+<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
+<td align=right><div align=right>TQt 3.3.8</div>
+</table></div></address></body>
+</html>