summaryrefslogtreecommitdiff
path: root/libjava/classpath/java/awt/geom/Ellipse2D.java
blob: 3bbf2f0104b57c5304dfe681416b00e4ab44fc53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
/* Ellipse2D.java -- represents an ellipse in 2-D space
   Copyright (C) 2000, 2002, 2004 Free Software Foundation

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package java.awt.geom;


/**
 * Ellipse2D is the shape of an ellipse.
 * <BR>
 * <img src="doc-files/Ellipse-1.png" width="347" height="221"
 * alt="A drawing of an ellipse" /><BR>
 * The ellipse is defined by it's bounding box (shown in red),
 * and is defined by the implicit curve:<BR>
 * <blockquote>(<i>x</i>/<i>a</i>)<sup>2</sup> +
 * (<i>y</i>/<i>b</i>)<sup>2</sup> = 1<BR><BR></blockquote>
 *
 * @author Tom Tromey (tromey@cygnus.com)
 * @author Eric Blake (ebb9@email.byu.edu)
 *
 * @since 1.2
 */
public abstract class Ellipse2D extends RectangularShape
{
  /**
   * Ellipse2D is defined as abstract.
   * Implementing classes are Ellipse2D.Float and Ellipse2D.Double.
   */
  protected Ellipse2D()
  {
  }

  /**
   * Determines if a point is contained within the ellipse. <P>
   * @param x - x coordinate of the point.
   * @param y - y coordinate of the point.
   * @return true if the point is within the ellipse, false otherwise.
   */
  public boolean contains(double x, double y)
  {
    double rx = getWidth() / 2;
    double ry = getHeight() / 2;
    double tx = (x - (getX() + rx)) / rx;
    double ty = (y - (getY() + ry)) / ry;
    return tx * tx + ty * ty < 1.0;
  }

  /**
   * Determines if a rectangle is completely contained within the
   * ellipse. <P>
   * @param x - x coordinate of the upper-left corner of the rectangle
   * @param y - y coordinate of the upper-left corner of the rectangle
   * @param w - width of the rectangle
   * @param h - height of the rectangle
   * @return true if the rectangle is completely contained, false otherwise.
   */
  public boolean contains(double x, double y, double w, double h)
  {
    double x2 = x + w;
    double y2 = y + h;
    return (contains(x, y) && contains(x, y2) && contains(x2, y)
           && contains(x2, y2));
  }

  /**
   * Returns a PathIterator object corresponding to the ellipse.<P>
   *
   * Note: An ellipse cannot be represented exactly in PathIterator
   * segments, the outline is thefore approximated with cubic
   * Bezier segments.
   *
   * @param at an optional transform.
   * @return A path iterator.
   */
  public PathIterator getPathIterator(AffineTransform at)
  {
    // An ellipse is just a complete arc.
    return new Arc2D.ArcIterator(this, at);
  }

  /**
   * Determines if a rectangle intersects any part of the ellipse.<P>
   * @param x - x coordinate of the upper-left corner of the rectangle
   * @param y - y coordinate of the upper-left corner of the rectangle
   * @param w - width of the rectangle
   * @param h - height of the rectangle
   * @return true if the rectangle intersects the ellipse, false otherwise.
   */
  public boolean intersects(double x, double y, double w, double h)
  {
    Rectangle2D r = new Rectangle2D.Double(x, y, w, h);
    if (! r.intersects(getX(), getY(), getWidth(), getHeight()))
      return false;

    if (contains(x, y) || contains(x, y + h) || contains(x + w, y)
        || contains(x + w, y + h))
      return true;

    Line2D l1 = new Line2D.Double(getX(), getY() + (getHeight() / 2),
                                  getX() + getWidth(),
                                  getY() + (getHeight() / 2));
    Line2D l2 = new Line2D.Double(getX() + (getWidth() / 2), getY(),
                                  getX() + (getWidth() / 2),
                                  getY() + getHeight());

    if (l1.intersects(r) || l2.intersects(r))
      return true;

    return false;
  }

  /**
   * An {@link Ellipse2D} that stores its coordinates using <code>double</code>
   * primitives.
   */
  public static class Double extends Ellipse2D
  {
    /**
     * The height of the ellipse.
     */
    public double height;

    /**
     * The width of the ellipse.
     */
    public double width;

    /**
     * The upper-left x coordinate of the bounding-box
     */
    public double x;

    /**
     * The upper-left y coordinate of the bounding-box
     */
    public double y;

    /**
     * Creates a new Ellipse2D with an upper-left coordinate of (0,0)
     * and a zero size.
     */
    public Double()
    {
    }

    /**
     * Creates a new Ellipse2D within a given rectangle
     * using double-precision coordinates.<P>
     * @param x - x coordinate of the upper-left of the bounding rectangle
     * @param y - y coordinate of the upper-left of the bounding rectangle
     * @param w - width of the ellipse
     * @param h - height of the ellipse
     */
    public Double(double x, double y, double w, double h)
    {
      this.x = x;
      this.y = y;
      height = h;
      width = w;
    }

    /**
     * Returns the bounding-box of the ellipse.
     * @return The bounding box.
     */
    public Rectangle2D getBounds2D()
    {
      return new Rectangle2D.Double(x, y, width, height);
    }

    /**
     * Returns the height of the ellipse.
     * @return The height of the ellipse.
     */
    public double getHeight()
    {
      return height;
    }

    /**
     * Returns the width of the ellipse.
     * @return The width of the ellipse.
     */
    public double getWidth()
    {
      return width;
    }

    /**
     * Returns x coordinate of the upper-left corner of
     * the ellipse's bounding-box.
     * @return The x coordinate.
     */
    public double getX()
    {
      return x;
    }

    /**
     * Returns y coordinate of the upper-left corner of
     * the ellipse's bounding-box.
     * @return The y coordinate.
     */
    public double getY()
    {
      return y;
    }

    /**
     * Returns <code>true</code> if the ellipse encloses no area, and
     * <code>false</code> otherwise.
     *
     * @return A boolean.
     */
    public boolean isEmpty()
    {
      return height <= 0 || width <= 0;
    }

    /**
     * Sets the geometry of the ellipse's bounding box.<P>
     *
     * @param x - x coordinate of the upper-left of the bounding rectangle
     * @param y - y coordinate of the upper-left of the bounding rectangle
     * @param w - width of the ellipse
     * @param h - height of the ellipse
     */
    public void setFrame(double x, double y, double w, double h)
    {
      this.x = x;
      this.y = y;
      height = h;
      width = w;
    }
  } // class Double

  /**
   * An {@link Ellipse2D} that stores its coordinates using <code>float</code>
   * primitives.
   */
  public static class Float extends Ellipse2D
  {
    /**
     * The height of the ellipse.
     */
    public float height;

    /**
     * The width of the ellipse.
     */
    public float width;

    /**
     * The upper-left x coordinate of the bounding-box
     */
    public float x;

    /**
     * The upper-left y coordinate of the bounding-box
     */
    public float y;

    /**
     * Creates a new Ellipse2D with an upper-left coordinate of (0,0)
     * and a zero size.
     */
    public Float()
    {
    }

    /**
     * Creates a new Ellipse2D within a given rectangle
     * using floating-point precision.<P>
     * @param x - x coordinate of the upper-left of the bounding rectangle
     * @param y - y coordinate of the upper-left of the bounding rectangle
     * @param w - width of the ellipse
     * @param h - height of the ellipse
     *
     */
    public Float(float x, float y, float w, float h)
    {
      this.x = x;
      this.y = y;
      this.height = h;
      this.width = w;
    }

    /**
     * Returns the bounding-box of the ellipse.
     * @return The bounding box.
     */
    public Rectangle2D getBounds2D()
    {
      return new Rectangle2D.Float(x, y, width, height);
    }

    /**
     * Returns the height of the ellipse.
     * @return The height of the ellipse.
     */
    public double getHeight()
    {
      return height;
    }

    /**
     * Returns the width of the ellipse.
     * @return The width of the ellipse.
     */
    public double getWidth()
    {
      return width;
    }

    /**
     * Returns x coordinate of the upper-left corner of
     * the ellipse's bounding-box.
     * @return The x coordinate.
     */
    public double getX()
    {
      return x;
    }

    /**
     * Returns y coordinate of the upper-left corner of
     * the ellipse's bounding-box.
     * @return The y coordinate.
     */
    public double getY()
    {
      return y;
    }

    /**
     * Returns <code>true</code> if the ellipse encloses no area, and
     * <code>false</code> otherwise.
     *
     * @return A boolean.
     */
    public boolean isEmpty()
    {
      return height <= 0 || width <= 0;
    }

    /**
     * Sets the geometry of the ellipse's bounding box.<P>
     *
     * @param x - x coordinate of the upper-left of the bounding rectangle
     * @param y - y coordinate of the upper-left of the bounding rectangle
     * @param w - width of the ellipse
     * @param h - height of the ellipse
     */
    public void setFrame(float x, float y, float w, float h)
    {
      this.x = x;
      this.y = y;
      height = h;
      width = w;
    }

    /**
     * Sets the geometry of the ellipse's bounding box.
     *
     * Note: This leads to a loss of precision.<P>
     *
     * @param x - x coordinate of the upper-left of the bounding rectangle
     * @param y - y coordinate of the upper-left of the bounding rectangle
     * @param w - width of the ellipse
     * @param h - height of the ellipse
     */
    public void setFrame(double x, double y, double w, double h)
    {
      this.x = (float) x;
      this.y = (float) y;
      height = (float) h;
      width = (float) w;
    }
  } // class Float
} // class Ellipse2D