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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Texture.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_rendering_Texture_idl__
  31 #define __com_sun_star_rendering_Texture_idl__
  32
  33 #ifndef __com_sun_star_geometry_AffineMatrix2D_idl__
  34 #include <com/sun/star/geometry/AffineMatrix2D.idl>
  35 #endif
  36 #ifndef __com_sun_star_rendering_StrokeAttributes_idl__
  37 #include <com/sun/star/rendering/StrokeAttributes.idl>
  38 #endif
  39
  40 module com { module sun { module star { module rendering {
  41
  42 interface XBitmap;
  43 interface XParametricPolyPolygon2D;
  44
  45 /** Contains all information needed to define a texture.<p>
  46
  47     This structure contains all information necessary to define a
  48     texture. A texture describes the filled area of polygonal shapes,
  49     providing its own transformation matrix, repeat mode, and
  50     transparency.<p>
  51
  52     To achieve uniformity, if this texture has a bitmap set, it is
  53     scaled in such a way that it will cover the same [0,1]x[0,1] box
  54     as the hatch and the gradient. The transformation member can then
  55     be used to scale the complete texture as it fits suit.<p>
  56
  57     @since OOo 2.0.0
  58  */
  59 struct Texture
  60 {
  61     /** Texture transformation from texture to primitive space.<p>
  62
  63         This member allows arbitrary transformations of the texture,
  64         relative to the textured primitive. Thus, the total
  65         transformation from the [0,1]x[0,1] texture space to the
  66         device coordinate space is the concatenation of texture,
  67         render state, and view state transformation (with only render
  68         state and view state transformation being applied to the
  69         textured primitive).<p>
  70      */
  71     ::com::sun::star::geometry::AffineMatrix2D  AffineTransform;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** Overall transparency of the texturing.<p>
  76
  77         The valid range for this value is [0,1], where 0 denotes
  78         complete transparency, and 1 denotes fully opaque.<p>
  79      */
  80     double                                                          Alpha;
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** Specifies the number of parameterized polygons used for the texture.<p>
  85
  86         This member specifies the number of polygons the parametric
  87         polygon interface is queried. The continuous range [0,1] of
  88         the XParametricPolyPolygon::getOutline() method is divided up
  89         into numberOfHatchPolygons equal parts, and for everyone of
  90         these parts, the start of the interval is plugged into the
  91         getOutline method. For example, if numberOfHatchPolygons is 2,
  92         then getOutline is called twice, once with 0.0 and once with
  93         0.5. Use this parameter to control the density of the
  94         hatching.<p>
  95      */
  96     long                                                            NumberOfHatchPolygons;
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** Texture bitmap.<p>
 101
 102         This member can be used together with gradient and hatching.<p>
 103
 104         The bitmap is scaled to a one-by-one rectangle, to cover the
 105         same area as both the gradient and the hatching.<p>
 106     */
 107     XBitmap                                                         Bitmap;
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** Texture gradient.<p>
 112
 113         This member can be used together with bitmap and hatching. The
 114         parametric polygons color value is used to fill the returned
 115         polygonal outlines.<p>
 116      */
 117     XParametricPolyPolygon2D                    Gradient;
 118
 119     //-------------------------------------------------------------------------
 120
 121     /** Texture hatching.<p>
 122
 123         This member can be used together with bitmap and gradient. The
 124         parametric polygons color value is used to stroke the returned
 125         polygonal outlines.<p>
 126      */
 127     XParametricPolyPolygon2D                    Hatching;
 128
 129     //-------------------------------------------------------------------------
 130
 131     /** Specifies the stroke attributes used for hatching.<p>
 132
 133         Use 0.0 as the strokeWidth here to indicate hair lines.<p>
 134      */
 135     StrokeAttributes                                HatchAttributes;
 136
 137     //-------------------------------------------------------------------------
 138
 139     /** Repeat mode of the texture, x direction.<p>
 140
 141         The repeat mode is separated into x and y direction, this is
 142         the x direction part. Permissible values are from the
 143         <type>TexturingMode</type> constants.<p>
 144     */
 145     byte                                                                RepeatModeX;
 146
 147     /** Repeat mode of the texture, y direction.<p>
 148
 149         The repeat mode is separated into x and y direction, this is
 150         the y direction part. Permissible values are from the
 151         <type>TexturingMode</type> constants.<p>
 152     */
 153     byte                                                                RepeatModeY;
 154
 155 };
 156
 157 }; }; }; };
 158
 159 #endif