offapi/com/sun/star/geometry/XMapping2D.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: XMapping2D.idl,v $
  10  * $Revision: 1.5 $
  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_geometry_XMapping2D_idl__
  31 #define __com_sun_star_geometry_XMapping2D_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36 #ifndef __com_sun_star_geometry_RealPoint2D_idl__
  37 #include <com/sun/star/geometry/RealPoint2D.idl>
  38 #endif
  39
  40 module com {  module sun {  module star {  module geometry {
  41
  42 /** Interface defining an arbitrary bijective mapping from R^2 to R^2.<p>
  43
  44     This interface provides methods to define an arbitrary bijective
  45     mapping from R^2 to R^2, i.e. from the two-dimensional space of
  46     real numbers onto itself, as is representable by the
  47     <type>double</type> floating point type. The mapping must be
  48     bijective, i.e. map a pair of real numbers to exactly one other
  49     pair of real numbers an vice versa, to facilitate a working
  50     inverse. Bijectiveness also implies completeness, i.e. for every
  51     pair of real numbers there must be another pair that is mapped
  52     upon them.<p>
  53
  54     @since OOo 2.0.0
  55  */
  56 interface XMapping2D : ::com::sun::star::uno::XInterface
  57 {
  58     /** Forward 2D mapping function
  59      */
  60     RealPoint2D         map( [in] RealPoint2D aPoint );
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** Inverse 2D mapping function.<p>
  65
  66         The following invariant must hold:
  67         <code>map(mapInverse(p))=p</code>. This effectively rules out
  68         non-bijective mappings.<p>
  69      */
  70     RealPoint2D         mapInverse( [in] RealPoint2D aPoint );
  71 };
  72
  73 }; }; }; };
  74
  75 #endif