offapi/com/sun/star/chart2/XTransformation.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_chart2_XTransformation_idl
  29 #define com_sun_star_chart2_XTransformation_idl
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #include <com/sun/star/lang/IllegalArgumentException.idl>
  33
  34 module com
  35 {
  36 module sun
  37 {
  38 module star
  39 {
  40 module chart2
  41 {
  42
  43     // NOTES
  44
  45     //... provide help for creating the right transformation
  46     //
  47     // ... access to source and destination coordinate system ?
  48
  49 /** allows the transformation of numeric values from one
  50     coordinate-system into an other.  Values may be transformed using
  51     any mapping.
  52  */
  53 interface XTransformation : ::com::sun::star::uno::XInterface
  54 {
  55     /** transforms the given input data tuple, given in the source
  56         coordinate system, according to the internal transformation
  57         rules, into a tuple of transformed coordinates in the
  58         destination coordinate system.
  59
  60         <p>Note that both coordinate systems may have different
  61         dimensions, e.g., if a transformation does simply a projection
  62         into a lower-dimensional space.</p>
  63
  64         @param aValues a source tuple of data that is to be
  65                transformed.  The length of this sequence must be
  66                equivalent to the dimension of the source coordinate
  67                system.
  68
  69         @return the transformed data tuple.  The length of this
  70                 sequence is equal to the dimension of the output
  71                 coordinate system.
  72
  73         @throws ::com::sun::star::lang::IllegalArgumentException
  74                if the dimension of the input vector is not equal to the
  75                dimension given in <member>getSourceDimension</member>.
  76      */
  77     sequence< double > transform( [in] sequence< double > aValues )
  78         raises( ::com::sun::star::lang::IllegalArgumentException );
  79
  80     /** the dimension of the input coordinate sequence that is to be
  81         transformed by the <member>transform</member> method.
  82      */
  83     long getSourceDimension();
  84
  85     /** the dimension of the output coordinate sequence that is the
  86         result of the <member>transform</member> method.
  87      */
  88     long getTargetDimension();
  89 };
  90
  91 } ; // chart2
  92 } ; // com
  93 } ; // sun
  94 } ; // star
  95
  96
  97 #endif
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */