offapi/com/sun/star/geometry/XMapping2D.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_geometry_XMapping2D_idl__
  28 #define __com_sun_star_geometry_XMapping2D_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33 #ifndef __com_sun_star_geometry_RealPoint2D_idl__
  34 #include <com/sun/star/geometry/RealPoint2D.idl>
  35 #endif
  36
  37 module com {  module sun {  module star {  module geometry {
  38
  39 /** Interface defining an arbitrary bijective mapping from R^2 to R^2.<p>
  40
  41     This interface provides methods to define an arbitrary bijective
  42     mapping from R^2 to R^2, i.e. from the two-dimensional space of
  43     real numbers onto itself, as is representable by the
  44     <type>double</type> floating point type. The mapping must be
  45     bijective, i.e. map a pair of real numbers to exactly one other
  46     pair of real numbers an vice versa, to facilitate a working
  47     inverse. Bijectiveness also implies completeness, i.e. for every
  48     pair of real numbers there must be another pair that is mapped
  49     upon them.<p>
  50
  51     @since OOo 2.0.0
  52  */
  53 interface XMapping2D : ::com::sun::star::uno::XInterface
  54 {
  55     /** Forward 2D mapping function
  56      */
  57     RealPoint2D     map( [in] RealPoint2D aPoint );
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** Inverse 2D mapping function.<p>
  62
  63         The following invariant must hold:
  64         <code>map(mapInverse(p))=p</code>. This effectively rules out
  65         non-bijective mappings.<p>
  66      */
  67     RealPoint2D     mapInverse( [in] RealPoint2D aPoint );
  68 };
  69
  70 }; }; }; };
  71
  72 #endif