blob: a059a6fc27c0c0729f5d2376a6f1fdc3c31abb0e [file] [log] [blame]
<html>
<head>
<title>Interface XLinePolyPolygon2D</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">
<a name="_top_"> </a>
<table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XLinePolyPolygon2D-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">rendering</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XLinePolyPolygon2D</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XLinePolyPolygon2D</strong>
&#x2517 <a href="XPolyPolygon2D.html">XPolyPolygon2D</a>
&#x2517 ::com::sun::star::uno::XInterface
</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XPolyPolygon2D.html">XPolyPolygon2D</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>Generic interface for poly-polygons in 2D.
</dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Specialized interface for a 2D poly-polygon containing only straight line segments.
</dd>
<dt><b>Since </b></dt>
<dd>OOo 2.0.0 </dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPoints">getPoints</a></td>
<td class="imsum_right">Query subset of this poly-polygon, starting at the given
polygon and the given point within that polygon, and
containing the specified number of polygons and points in the
last polygon.
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setPoints">setPoints</a></td>
<td class="imsum_right">Set the specified sequence of points to the poly-polygon.
This method can either set the whole poly-polygon to the new
data, or insert the points at the given index
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPoint">getPoint</a></td>
<td class="imsum_right">Get a single point from the poly-polygon
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setPoint">setPoint</a></td>
<td class="imsum_right">Set a single point on the poly-polygon. The remaining points of
the poly-polygon will not be changed by this method.
&nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="getPoints" class="membertitle">getPoints</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; sequence&lt; ::com::sun::star::geometry::RealPoint2D &gt; &gt;</td>
</tr>
<tr>
<td valign="top"><b>getPoints</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nPolygonIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nNumberOfPolygons,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nPointIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nNumberOfPoints )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::lang::IndexOutOfBoundsException );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Query subset of this poly-polygon, starting at the given
polygon and the given point within that polygon, and
containing the specified number of polygons and points in the
last polygon.
</dd>
<dt><b>Parameter nPolygonIndex</b></dt>
<dd>The index number of the polygon to start with extracting
points. Set to 0 to start with the first polygon.
</dd>
<dt><b>Parameter nNumberOfPolygons</b></dt>
<dd>The number of polygons, starting with nPolygonIndex, to
extract points from. Set to -1 to extract all polygons,
starting with nPolygonIndex (i.e. a total of
getNumberOfPolygons() - nPolygonIndex polygons is extracted).
</dd>
<dt><b>Parameter nPointIndex</b></dt>
<dd>The index of the point within the first polygon (that with the
index number nPolygonIndex) to start extraction with. Set to 0
to start with the first point in this polygon.
</dd>
<dt><b>Parameter nNumberOfPoints</b></dt>
<dd>The number of points in the last polygon of the extraction
sequence, to be extracted. Set to -1 to extract all points
from the last polygon.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setPoints" class="membertitle">setPoints</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setPoints</b>(</td>
<td valign="top">[in] sequence&lt; sequence&lt; ::com::sun::star::geometry::RealPoint2D &gt; &gt;</td>
<td valign="bottom">&nbsp;points,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nPolygonIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::lang::IndexOutOfBoundsException );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set the specified sequence of points to the poly-polygon.
This method can either set the whole poly-polygon to the new
data, or insert the points at the given index
</dd>
<dt><b>Parameter nPolygonIndex</b></dt>
<dd>The index of the polygon to start point insertion with. This
index must be in the range [0,numPolygons], and the insertion
will take place <em>before </em>this position (i.e. when
specifying 0 here, the given point sequence will precede all
existing polygons already within the poly-polygon). To append
to a poly-polygon, call setPoints() with
<a href="XLinePolyPolygon2D.html">XLinePolyPolygon2D</a>::<a href="XLinePolyPolygon2D.html#getNumberOfPolygons">getNumberOfPolygons()</a>
as the polygon index. If nPolygonIndex is -1, the given
sequence of points <em>replaces </em>the poly-polygon content,
such that after this method completes, it contains exactly the
specified point data.
</dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IndexOutOfBoundsException
if one of the given values exceed the permissible range.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getPoint" class="membertitle">getPoint</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">::com::sun::star::geometry::RealPoint2D</td>
</tr>
<tr>
<td valign="top"><b>getPoint</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nPolygonIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nPointIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::lang::IndexOutOfBoundsException );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Get a single point from the poly-polygon
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setPoint" class="membertitle">setPoint</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setPoint</b>(</td>
<td valign="top">[in] ::com::sun::star::geometry::RealPoint2D</td>
<td valign="bottom">&nbsp;point,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nPolygonIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nPointIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::lang::IndexOutOfBoundsException );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set a single point on the poly-polygon. The remaining points of
the poly-polygon will not be changed by this method.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2003 Sun Microsystems, Inc.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>