offapi/com/sun/star/geometry/XMapping2D.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
  20 module com {  module sun {  module star {  module geometry {
  21
  22 /** Interface defining an arbitrary bijective mapping from R^2 to R^2.<p>
  23
  24     This interface provides methods to define an arbitrary bijective
  25     mapping from R^2 to R^2, i.e. from the two-dimensional space of
  26     real numbers onto itself, as is representable by the
  27     double floating point type. The mapping must be
  28     bijective, i.e. map a pair of real numbers to exactly one other
  29     pair of real numbers and vice versa, to facilitate a working
  30     inverse. Bijectiveness also implies completeness, i.e. for every
  31     pair of real numbers there must be another pair that is mapped
  32     upon them.<p>
  33
  34     @since OOo 2.0
  35  */
  36 interface XMapping2D : ::com::sun::star::uno::XInterface
  37 {
  38     /** Forward 2D mapping function
  39      */
  40     RealPoint2D     map( [in] RealPoint2D aPoint );
  41
  42
  43     /** Inverse 2D mapping function.<p>
  44
  45         The following invariant must hold:
  46         <code>map(mapInverse(p))=p</code>. This effectively rules out
  47         non-bijective mappings.<p>
  48      */
  49     RealPoint2D     mapInverse( [in] RealPoint2D aPoint );
  50 };
  51
  52 }; }; }; };
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */