diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl')
-rw-r--r-- | offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl | 160 |
1 files changed, 160 insertions, 0 deletions
diff --git a/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl b/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl new file mode 100644 index 000000000..fd8ff0eec --- /dev/null +++ b/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl @@ -0,0 +1,160 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_rendering_XBezierPolyPolygon2D_idl__ +#define __com_sun_star_rendering_XBezierPolyPolygon2D_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/lang/IndexOutOfBoundsException.idl> +#include <com/sun/star/rendering/XPolyPolygon2D.idl> +#include <com/sun/star/geometry/RealBezierSegment2D.idl> + +module com { module sun { module star { module rendering { + +/** This is a specialized interface for a 2D poly-polygon containing + straight line and Bezier segments.<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> + + @since OOo 2.0 + */ +interface XBezierPolyPolygon2D : XPolyPolygon2D +{ + /** Query subset of this poly-polygon.<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> + + @param nPolygonIndex + The index of the polygon to start point retrieval with. This + index must be in the range [0,numPolygons-1]. + + @param nNumberOfPolygons + The number of polygons to extract. This value must not exceed + numPolygons-nPolygonIndex. + + @param nPointIndex + 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. + + @param nNumberOfPoints + 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. + + @returns the sequence of extracted points. + + @throws com::sun::star::lang::IndexOutOfBoundsException + if one of the given values exceed the permissible range. + */ + sequence< sequence < ::com::sun::star::geometry::RealBezierSegment2D > > getBezierSegments( [in] long nPolygonIndex, [in] long nNumberOfPolygons, [in] long nPointIndex, [in] long nNumberOfPoints ) + raises (com::sun::star::lang::IndexOutOfBoundsException); + + + /** 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 + + @param points the points. + + @param nPolygonIndex + 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 + XBezierPolyPolygon2D::getNumberOfPolygons() + 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. + + @throws com::sun::star::lang::IndexOutOfBoundsException + if one of the given values exceed the permissible range. + */ + void setBezierSegments( [in] sequence< sequence< ::com::sun::star::geometry::RealBezierSegment2D > > points, [in] long nPolygonIndex ) + raises (com::sun::star::lang::IndexOutOfBoundsException); + + + /** Get a single point from the poly-polygon. + + @param nPolygonIndex + The index of the polygon where the point to be extract is + contained within. This index must be in the range + [0,numPolygons-1]. + + @param nPointIndex + 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. + + @returns the requested point. + + @throws com::sun::star::lang::IndexOutOfBoundsException + if one of the given values exceed the permissible range. + + */ + ::com::sun::star::geometry::RealBezierSegment2D getBezierSegment( [in] long nPolygonIndex, [in] long nPointIndex ) + raises (com::sun::star::lang::IndexOutOfBoundsException); + + + /** Set a single point on the poly-polygon.<p> + + The remaining points of the poly-polygon will not be changed by + this method. Use + XBezierPolyPolygon2D::getNumberOfPolygons() + or + XBezierPolyPolygon2D::getNumberOfPolygonPoints() + to append points or polygons, respectively.<p> + + @param point + The point to be set at the poly-polygon. + + @param nPolygonIndex + The index of the polygon to insert the point in. This index + must be in the range [0,numPolygons]. + + @param nPointIndex + 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. + + @throws com::sun::star::lang::IndexOutOfBoundsException + if one of the given values exceed the permissible range. + */ + void setBezierSegment( [in] ::com::sun::star::geometry::RealBezierSegment2D point, [in] long nPolygonIndex, [in] long nPointIndex ) + raises (com::sun::star::lang::IndexOutOfBoundsException); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |