blob: 8821a756d2417950230146eef9e4e217ec328a91 [file]
<html>
<head>
<title>Interface XPolyPolygon2D</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="XPolyPolygon2D-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 XPolyPolygon2D</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XPolyPolygon2D</strong>
&#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">::com::sun::star::uno::XInterface</td>
<td class="imsum_right"><dl></dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Generic interface for poly-polygons in 2D.
</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="#addPolyPolygon">addPolyPolygon</a></td>
<td class="imsum_right">Add the specified poly-polygon at the given position.
One can do symbolic path construction with this method. The
poly-polygons added by this method are not joined in the sense
that they participate in mutual fill rule calculations like
the polygons inside a single poly-polygon do. When rendering
such a poly-polygon without transparency, it will look like the
constituing poly-polygons rendered separately on top of
another. Alas, when rendering with transparency, separate
rendering will combine the alpha of overlapping areas, whereas
addPolyPolygon results in constant alpha, regardless how many
internal poly-polygons overlap at a single place.
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getNumberOfPolygons">getNumberOfPolygons</a></td>
<td class="imsum_right">Query number of polygons inside this poly-polygon
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getNumberOfPolygonPoints">getNumberOfPolygonPoints</a></td>
<td class="imsum_right">Query number of points inside given polygon
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFillRule">getFillRule</a></td>
<td class="imsum_right">Query the rule used to determine inside and outside of the
poly-polygon.
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setFillRule">setFillRule</a></td>
<td class="imsum_right">Set the rule used to determine inside and outside of the
poly-polygon.
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isClosed">isClosed</a></td>
<td class="imsum_right">Query whether the specified polygon outline is closed.
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setClosed">setClosed</a></td>
<td class="imsum_right">Set the close state of the specified polygon outline. Use -1
as the index to affect all polygons of this poly-polygon.
&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="addPolyPolygon" class="membertitle">addPolyPolygon</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>addPolyPolygon</b>(</td>
<td valign="top">[in] ::com::sun::star::geometry::RealPoint2D</td>
<td valign="bottom">&nbsp;position,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XPolyPolygon2D.html">XPolyPolygon2D</a></td>
<td valign="bottom">&nbsp;polyPolygon )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::lang::IllegalArgumentException );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Add the specified poly-polygon at the given position.
One can do symbolic path construction with this method. The
poly-polygons added by this method are not joined in the sense
that they participate in mutual fill rule calculations like
the polygons inside a single poly-polygon do. When rendering
such a poly-polygon without transparency, it will look like the
constituing poly-polygons rendered separately on top of
another. Alas, when rendering with transparency, separate
rendering will combine the alpha of overlapping areas, whereas
addPolyPolygon results in constant alpha, regardless how many
internal poly-polygons overlap at a single place.
</dd>
<dt><b>Parameter position</b></dt>
<dd>The poly-polygon will be added at the given position, i.e. the
upper, left edge of the referenced poly-polygon will be at
this position relative to the target poly-polygon.
</dd>
<dt><b>Parameter polyPolygon</b></dt>
<dd>The poly-polygon to add. Note that the content of this
poly-polygon is copied, later changes to polyPolygon will have
no effect on the poly-polygon it was added to.
</dd>
<dt><b>Throws</b></dt>
<dd>an IllegalArgumentException, if the XPolyPolygon2D
parameter does not support one of the data-providing
derivative interfaces (XBezierPolyPolygon2D,
XLinePolyPolygon2D).
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getNumberOfPolygons" class="membertitle">getNumberOfPolygons</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">long</td>
</tr>
<tr>
<td valign="top"><b>getNumberOfPolygons</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Query number of polygons inside this poly-polygon
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getNumberOfPolygonPoints" class="membertitle">getNumberOfPolygonPoints</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">long</td>
</tr>
<tr>
<td valign="top"><b>getNumberOfPolygonPoints</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;polygon )</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 number of points inside given polygon
</dd>
<dt><b>Parameter polygon</b></dt>
<dd>The index of the polygon to query the number of points
for. Must be in the range [0,getNumberOfPolygons()-1].
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFillRule" class="membertitle">getFillRule</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"><a href="FillRule.html">FillRule</a></td>
</tr>
<tr>
<td valign="top"><b>getFillRule</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Query the rule used to determine inside and outside of the
poly-polygon.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setFillRule" class="membertitle">setFillRule</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>setFillRule</b>(</td>
<td valign="top">[in] <a href="FillRule.html">FillRule</a></td>
<td valign="bottom">&nbsp;fillRule );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set the rule used to determine inside and outside of the
poly-polygon.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isClosed" class="membertitle">isClosed</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">boolean</td>
</tr>
<tr>
<td valign="top"><b>isClosed</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;index )</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 whether the specified polygon outline is closed.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setClosed" class="membertitle">setClosed</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>setClosed</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;index,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;closedState )</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 close state of the specified polygon outline. Use -1
as the index to affect all polygons of this poly-polygon.
</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>