<html> <head> <title>Interface XBezierPolyPolygon2D</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="XBezierPolyPolygon2D-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 XBezierPolyPolygon2D</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XBezierPolyPolygon2D</strong> ┗ <a href="XPolyPolygon2D.html">XPolyPolygon2D</a> </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>This is a specialized interface for a 2D poly-polygon containing straight line and bezier segments.</dd> <dd><p> This poly-polygon can contain polygons consisting of a mixture of cubic bezier curves and straight lines. As the straight line is a special case of a cubic bezier curve (control points collinear with the line through start and end point), this can be expressed uniformly with a sequence of ::RealBezierSegment2Ds.<p> By convention, a ::RealBezierSegment2D is a straight line segment, if all three contained points are strictly equal.<p> </dd> <dt><b/></dt> <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="#getBezierSegments">getBezierSegments</a></td> <td class="imsum_right">Query subset of this poly-polygon. </td> </tr> <tr> <td class="imsum_left"><a href="#setBezierSegments">setBezierSegments</a></td> <td class="imsum_right">Set the specified sequence of bezier segments to the poly-polygon. This method can either set the whole poly-polygon to the new data, or insert the segments at the given index </td> </tr> <tr> <td class="imsum_left"><a href="#getBezierSegment">getBezierSegment</a></td> <td class="imsum_right">Get a single point from the poly-polygon. </td> </tr> <tr> <td class="imsum_left"><a href="#setBezierSegment">setBezierSegment</a></td> <td class="imsum_right">Set a single point on the poly-polygon. </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="getBezierSegments" class="membertitle">getBezierSegments</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< sequence< ::com::sun::star::<a href="../geometry/module-ix.html">geometry</a>::<a href="../geometry/RealBezierSegment2D.html">RealBezierSegment2D</a> > ></td> </tr> <tr> <td valign="top"><b>getBezierSegments</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nPolygonIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nNumberOfPolygons,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nPointIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nNumberOfPoints )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Query subset of this poly-polygon.</dd> <dd><p> 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.<p> </dd> <dt><b>Parameter nPolygonIndex</b></dt> <dd>The index of the polygon to start point retrieval with. This index must be in the range [0,numPolygons-1]. </dd> <dt><b>Parameter nNumberOfPolygons</b></dt> <dd>The number of polygons to extract. This value must not exceed numPolygons-nPolygonIndex. </dd> <dt><b>Parameter nPointIndex</b></dt> <dd>The index of the first point in the first polygon to extract. This value must not exceed the number of points in this polygon minus one. </dd> <dt><b>Parameter nNumberOfPoints</b></dt> <dd>The number of points to extract from the last polygon. This value must not exceed the number of points in this last polygon minus one. </dd> <dt><b>Returns</b></dt> <dd>the sequence of extracted points. </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="setBezierSegments" class="membertitle">setBezierSegments</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>setBezierSegments</b>(</td> <td valign="top">[in] sequence< sequence< ::com::sun::star::<a href="../geometry/module-ix.html">geometry</a>::<a href="../geometry/RealBezierSegment2D.html">RealBezierSegment2D</a> > ></td> <td valign="bottom"> points,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nPolygonIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Set the specified sequence of bezier segments to the poly-polygon. This method can either set the whole poly-polygon to the new data, or insert the segments at the given index </dd> <dt><b>Parameter nPolygonIndex</b></dt> <dd>The index of the polygon to start segment 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 bezier sequence will precede all existing polygons already within the poly-polygon). To append to a poly-polygon, call setPoints() with <a href="XBezierPolyPolygon2D.html">XBezierPolyPolygon2D</a>::<a href="XBezierPolyPolygon2D.html#getNumberOfPolygons">getNumberOfPolygons()</a> as the polygon index. If nPolygonIndex is -1, the given bezier sequence <em>replaces</em> the poly-polygon content, such that after this method completes, it contains exactly the specified bezier segment 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="getBezierSegment" class="membertitle">getBezierSegment</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::<a href="../geometry/module-ix.html">geometry</a>::<a href="../geometry/RealBezierSegment2D.html">RealBezierSegment2D</a></td> </tr> <tr> <td valign="top"><b>getBezierSegment</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nPolygonIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nPointIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Get a single point from the poly-polygon. </dd> <dt><b>Parameter nPolygonIndex</b></dt> <dd>The index of the polygon where the point to be extract is contained within. This index must be in the range [0,numPolygons-1]. </dd> <dt><b>Parameter nPointIndex</b></dt> <dd>The index of the point in the polygon specified by nPolygonIndex, which is to be retrieved. This value must not exceed the number of points in this polygon minus one. </dd> <dt><b>Returns</b></dt> <dd>the requested point. </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="setBezierSegment" class="membertitle">setBezierSegment</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>setBezierSegment</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../geometry/module-ix.html">geometry</a>::<a href="../geometry/RealBezierSegment2D.html">RealBezierSegment2D</a></td> <td valign="bottom"> point,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nPolygonIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nPointIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Set a single point on the poly-polygon.</dd> <dd><p> The remaining points of the poly-polygon will not be changed by this method. Use <a href="XBezierPolyPolygon2D.html">XBezierPolyPolygon2D</a>::<a href="XBezierPolyPolygon2D.html#getNumberOfPolygons">getNumberOfPolygons()</a> or <a href="XBezierPolyPolygon2D.html">XBezierPolyPolygon2D</a>::<a href="XBezierPolyPolygon2D.html#getNumberOfPolygonPoints">getNumberOfPolygonPoints()</a> to append points or polygons, respectively.<p> </dd> <dt><b>Parameter point</b></dt> <dd>The point to be set at the poly-polygon. </dd> <dt><b>Parameter nPolygonIndex</b></dt> <dd>The index of the polygon to insert the point in. This index must be in the range [0,numPolygons]. </dd> <dt><b>Parameter nPointIndex</b></dt> <dd>The index of the point in the polygon specified by nPolygonIndex, which is to be set. This value must not exceed the number of points in this polygon. </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> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>