1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_rendering_XParametricPolyPolygon2D_idl__
24#define __com_sun_star_rendering_XParametricPolyPolygon2D_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
30#include <com/sun/star/lang/IllegalArgumentException.idl>
31#endif
32#ifndef __com_sun_star_geometry_RealPoint2D_idl__
33#include <com/sun/star/geometry/RealPoint2D.idl>
34#endif
35#ifndef __com_sun_star_rendering_XPolyPolygon2D_idl__
36#include <com/sun/star/rendering/XPolyPolygon2D.idl>
37#endif
38#ifndef __com_sun_star_rendering_XColorSpace_idl__
39#include <com/sun/star/rendering/XColorSpace.idl>
40#endif
41
42module com { module sun { module star { module rendering {
43
44/** Interface to a dynamic poly-polygon generator, that generates
45    poly-polygons depending on a given parameter value.<p>
46
47    The returned poly-polygon should normally be contained in the
48    [0,1]x[0,1] rectangle. At least that is the dimension expected at
49    other places. e.g. <type>Texture</type>.
50 */
51published interface XParametricPolyPolygon2D : ::com::sun::star::uno::XInterface
52{
53    /** Query the polygonal outline at the specified value.
54
55        The returned outline should be clipped to the [0,1]x[0,1]
56        rectangle.
57
58        @param t
59        Parameter value in the range [0,1]. During painting, this
60        range is sweeped through starting from 0. When using such a
61        parametric polypolygon for gradients, the area covered by the
62        returned XPolyPolygon2D should be monotonically decreasing
63        with t (unless singularities in e.g. the resulting gradient
64        are desired).
65     */
66    XPolyPolygon2D                  getOutline( [in] double t )
67        raises (com::sun::star::lang::IllegalArgumentException);
68
69    //-------------------------------------------------------------------------
70
71    /** Query the color value for the polygonal area at the specified
72        parameter value.
73
74        @param t
75        Parameter value in the range [0,1]. During painting, this
76        range is swept through starting from 0.
77     */
78    sequence<ColorComponent>    getColor( [in] double t )
79        raises (com::sun::star::lang::IllegalArgumentException);
80
81    //-------------------------------------------------------------------------
82
83    /** Query the color for a dedicated point in the plane.
84
85        @param point
86        The permissible parameter range for point is [0,1]x[0,1]
87     */
88    sequence<ColorComponent>	getPointColor( [in] ::com::sun::star::geometry::RealPoint2D point )
89        raises (com::sun::star::lang::IllegalArgumentException);
90
91    //-------------------------------------------------------------------------
92
93    /** Query the color space employed by this object
94
95        @return the color space the colors generated by this object
96        are to be interpreted in.
97     */
98    XColorSpace					getColorSpace();
99
100};
101
102}; }; }; };
103
104#endif
105