offapi/com/sun/star/rendering/XParametricPolyPolygon2D.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_rendering_XParametricPolyPolygon2D_idl__
  20 #define __com_sun_star_rendering_XParametricPolyPolygon2D_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/geometry/RealPoint2D.idl>
  25 #include <com/sun/star/rendering/XPolyPolygon2D.idl>
  26 #include <com/sun/star/rendering/XColorSpace.idl>
  27
  28 module com { module sun { module star { module rendering {
  29
  30 /** Interface to a dynamic poly-polygon generator, that generates
  31     poly-polygons depending on a given parameter value.<p>
  32
  33     The returned poly-polygon should normally be contained in the
  34     [0,1]x[0,1] rectangle. At least that is the dimension expected at
  35     other places. e.g. Texture.
  36  */
  37 interface XParametricPolyPolygon2D : ::com::sun::star::uno::XInterface
  38 {
  39     /** Query the polygonal outline at the specified value.
  40
  41         The returned outline should be clipped to the [0,1]x[0,1]
  42         rectangle.
  43
  44         @param t
  45         Parameter value in the range [0,1]. During painting, this
  46         range is swept through starting from 0. When using such a
  47         parametric poly-polygon for gradients, the area covered by the
  48         returned XPolyPolygon2D should be monotonically decreasing
  49         with t (unless singularities in e.g. the resulting gradient
  50         are desired).
  51      */
  52     XPolyPolygon2D              getOutline( [in] double t )
  53         raises (com::sun::star::lang::IllegalArgumentException);
  54
  55
  56     /** Query the color value for the polygonal area at the specified
  57         parameter value.
  58
  59         @param t
  60         Parameter value in the range [0,1]. During painting, this
  61         range is swept through starting from 0.
  62      */
  63     sequence<ColorComponent>    getColor( [in] double t )
  64         raises (com::sun::star::lang::IllegalArgumentException);
  65
  66
  67     /** Query the color for a dedicated point in the plane.
  68
  69         @param point
  70         The permissible parameter range for point is [0,1]x[0,1]
  71      */
  72     sequence<ColorComponent>    getPointColor( [in] ::com::sun::star::geometry::RealPoint2D point )
  73         raises (com::sun::star::lang::IllegalArgumentException);
  74
  75
  76     /** Query the color space employed by this object
  77
  78         @return the color space the colors generated by this object
  79         are to be interpreted in.
  80      */
  81     XColorSpace                 getColorSpace();
  82
  83 };
  84
  85 }; }; }; };
  86
  87 #endif
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */