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