offapi/com/sun/star/graphic/XPrimitive2D.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_graphic_XPrimitive2D_idl__
  20 #define __com_sun_star_graphic_XPrimitive2D_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/beans/PropertyValue.idl>
  24 #include <com/sun/star/geometry/RealRectangle2D.idl>
  25
  26 module com {  module sun {  module star {  module graphic {
  27
  28 /** XPrimitive2D interface
  29
  30     This is the basic interface for 2D graphic primitives. They need to be able
  31     - to provide a decomposition consisting of simpler graphic primitives
  32     - to provide a 2D bound rectangle as a 2D range
  33  */
  34 interface XPrimitive2D : ::com::sun::star::uno::XInterface
  35 {
  36     /** Retrieve decomposed list of simpler primitives
  37
  38         @param aViewParameters
  39         2D View-specific parameter set. The defined but not mandatory
  40         parameters include:
  41
  42         ::com::sun::star::geometry::AffineMatrix2D Transformation
  43
  44         A transformation matrix which maps between world coordinates (which
  45         is equal to object's local coordinates) to view coordinates. If not
  46         defined, an empty transformation is implied.
  47
  48         ::com::sun::star::geometry::RealRectangle2D Viewport
  49
  50         Defines the visible part of the view in world coordinates. May be used
  51         to optimize decompositions, e.g. for 3D scenes only the visible part
  52         needs to be created. If not given, an empty Viewport is implied which
  53         means all is visible.
  54
  55         double Time
  56
  57         Defines the point in time for which the geometry is defined. This may
  58         lead to varied results for animated objects. This value is defined in the
  59         range [0.0 .. n[, negative values are not allowed. If not given, a value of
  60         0.0 is implied.
  61      */
  62     sequence< XPrimitive2D > getDecomposition( [in] sequence< ::com::sun::star::beans::PropertyValue > aViewParameters );
  63
  64     /** Retrieve bound rect of primitive
  65
  66         This method calculates the actual bound rect of the area in
  67         <em>world coordinates</em>. Note that for view-dependent primitives,
  68         the necessary pixel adjustments are taken into account. For that reason
  69         the ViewParameters need to be given.
  70
  71         @param aViewParameters
  72         2D View-specific parameter set, same as in getDecomposition.
  73      */
  74     ::com::sun::star::geometry::RealRectangle2D getRange( [in] sequence< ::com::sun::star::beans::PropertyValue > aViewParameters );
  75 };
  76
  77 }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */