offapi/com/sun/star/graphic/XPrimitive2D.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: XPrimitive2D.idl,v $
  10  *
  11  * $Revision: 1.2 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31 #ifndef __com_sun_star_graphic_XPrimitive2D_idl__
  32 #define __com_sun_star_graphic_XPrimitive2D_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_beans_PropertyValue_idl__
  38 #include <com/sun/star/beans/PropertyValue.idl>
  39 #endif
  40 #ifndef __com_sun_star_geometry_RealRectangle2D_idl__
  41 #include <com/sun/star/geometry/RealRectangle2D.idl>
  42 #endif
  43
  44 module com {  module sun {  module star {  module graphic {
  45
  46 /** XPrimitive2D interface
  47
  48     This is the basic interface for 2D graphic primitives. They need to be able
  49     - to provide a decomposition consisting of simpler graphic primitives
  50     - to provide a 2D bound rectangle as a 2D range
  51  */
  52 interface XPrimitive2D : ::com::sun::star::uno::XInterface
  53 {
  54     /** Retrieve decomposed list of simpler primitives
  55
  56         @param aViewParameters
  57         2D View-specific parameter set. The defined but not mandatory
  58         parameters include:
  59
  60         ::com::sun::star::geometry::AffineMatrix2D Transformation
  61
  62         A transformation matrix which maps between world coordinates (which
  63         is equal to object's local coordinates) to view coordinates. If not
  64         defined, an empty transformation is implied.
  65
  66         ::com::sun::star::geometry::RealRectangle2D Viewport
  67
  68         Defines the visible part of the view in world coordinates. May be used
  69         to optimize decompositions, e.g. for 3d scenes only the visible part
  70         needs to be created. If not given, an empty Viewport is implied which
  71         means all is visible.
  72
  73         double Time
  74
  75         Defines the point in time for which the geometry is defined. This may
  76         lead to varied results for animated objects. This value is defined in the
  77         range [0.0 .. n[, negative values are not allowed. If not given, a value of
  78         0.0 is implied.
  79      */
  80     sequence< XPrimitive2D > getDecomposition( [in] sequence< ::com::sun::star::beans::PropertyValue > aViewParameters );
  81
  82     /** Retrieve bound rect of primitive
  83
  84         This method calculates the actual bound rect of the area in
  85         <em>world coordinates<em>. Note that for view-dependent primitives,
  86         the necessary pixel adjustments are taken into account. For that reason
  87         the ViewParameters need to be given.
  88
  89         @param aViewParameters
  90         2D View-specific parameter set, same as in getDecomposition.
  91      */
  92     ::com::sun::star::geometry::RealRectangle2D getRange( [in] sequence< ::com::sun::star::beans::PropertyValue > aViewParameters );
  93 };
  94
  95 }; }; }; };
  96
  97 #endif