Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: rendering ::

interface XPolyPolygon2D
Description
Generic interface for poly-polygons in 2D.
Since
OOo 2.0

Methods' Summary
addPolyPolygon 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.  
getNumberOfPolygons Query number of polygons inside this poly-polygon  
getNumberOfPolygonPoints Query number of points inside given polygon  
getFillRule Query the rule used to determine inside and outside of the poly-polygon.  
setFillRule Set the rule used to determine inside and outside of the poly-polygon.  
isClosed Query whether the specified polygon outline is closed.  
setClosed Set the close state of the specified polygon outline. Use -1 as the index to affect all polygons of this poly-polygon.  
Methods' Details
addPolyPolygon
void
addPolyPolygon( [in] ::com::sun::star::geometry::RealPoint2D  position,
[in] XPolyPolygon2D  polyPolygon )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
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.
Parameter position
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.
Parameter polyPolygon
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.
Throws
a com::sun::star::lang::IllegalArgumentException, if the XPolyPolygon2D parameter does not support one of the data-providing derivative interfaces (XBezierPolyPolygon2D, XLinePolyPolygon2D).
getNumberOfPolygons
long
getNumberOfPolygons();

Description
Query number of polygons inside this poly-polygon
getNumberOfPolygonPoints
long
getNumberOfPolygonPoints( [in] long  polygon )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
Query number of points inside given polygon
Parameter polygon
The index of the polygon to query the number of points for. Must be in the range [0,getNumberOfPolygons()-1].
getFillRule
FillRule
getFillRule();

Description
Query the rule used to determine inside and outside of the poly-polygon.
setFillRule
void
setFillRule( [in] FillRule  fillRule );

Description
Set the rule used to determine inside and outside of the poly-polygon.
isClosed
boolean
isClosed( [in] long  index )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
Query whether the specified polygon outline is closed.
setClosed
void
setClosed( [in] long  index,
[in] boolean  closedState )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
Set the close state of the specified polygon outline. Use -1 as the index to affect all polygons of this poly-polygon.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.