offapi/com/sun/star/geometry/EllipticalArc.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: EllipticalArc.idl,v $
  10  * $Revision: 1.6 $
  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_EllipticalArc_idl__
  31 #define __com_sun_star_geometry_EllipticalArc_idl__
  32
  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 /** This structure specifies an arbitrary elliptical arc.<p>
  40
  41     This structure contains all parameters necessary to specify
  42     arbitrary elliptical arcs. The parameters are modelled closely
  43     after the <a href="www.w3c.org">SVG</a> specification.<p>
  44
  45     As with the parameters below, there are mostly four different
  46     ellipses arcs (two different ellipses, on which four different
  47     arcs connect start and end point) which satisfy the given set of
  48     constrains. Thus, there are two flags indicating which one of those
  49     ellipses should be taken.<p>
  50
  51     @since OOo 2.0.0
  52  */
  53 struct EllipticalArc
  54 {
  55     /// Start point of the arc.
  56     RealPoint2D StartPosition;
  57
  58     //-------------------------------------------------------------------------
  59
  60     /// End point of the arc.
  61     RealPoint2D EndPosition;
  62
  63     //-------------------------------------------------------------------------
  64
  65     /// Main radius in x direction of the ellipse this arc is part of.
  66     double      RadiusX;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /// Main radius in y direction of the ellipse this arc is part of.
  71     double      RadiusY;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** Rotation angle of the x axis of the ellipse relative to the x
  76         axis of the reference coordinate system.
  77      */
  78     double      XAxisRotation;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** If <TRUE/>, and there's a choice, take the longer one of two arcs
  83         connecting start and end point.
  84      */
  85     boolean     IsLargeArc;
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** If <TRUE/>, and there's a choice, take the arc that goes
  90         clock-wise from start to end point.
  91      */
  92     boolean IsClockwiseSweep;
  93 };
  94
  95 }; }; }; };
  96
  97 #endif