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