offapi/com/sun/star/graphic/XPrimitive2D.idl

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