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 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
|
//******************************************************************************
//
// File: Ellipse.java
// Package: edu.rit.draw.item
// Unit: Class edu.rit.draw.item.Ellipse
//
// This Java source file is copyright (C) 2008 by Alan Kaminsky. All rights
// reserved. For further information, contact the author, Alan Kaminsky, at
// ark@cs.rit.edu.
//
// This Java source file is part of the Parallel Java Library ("PJ"). PJ 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 3 of the License, or (at your option) any later version.
//
// PJ 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.
//
// 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.
//
// A copy of the GNU General Public License is provided in the file gpl.txt. You
// may also obtain a copy of the GNU General Public License on the World Wide
// Web at http://www.gnu.org/licenses/gpl.html.
//
//******************************************************************************
package edu.rit.draw.item;
import edu.rit.draw.Drawing;
import java.awt.Shape;
import java.awt.geom.Ellipse2D;
/**
* Class Ellipse provides an ellipse {@linkplain DrawingItem}. A circle is a
* special case of an ellipse with equal width and height.
* <P>
* The static <TT>defaultSize()</TT>, <TT>defaultWidth()</TT>, and
* <TT>defaultHeight()</TT> methods are provided to set the default size, width,
* and height. If an ellipse's size, width, or height is not specified, the
* current default size, width, or height is used.
*
* @author Alan Kaminsky
* @version 23-Jun-2008
*/
public class Ellipse
extends RectangularItem
{
// Exported constants.
/**
* The normal width for ellipses (72). <I>Note:</I> 72 points = 1 inch.
*/
public static final double NORMAL_WIDTH = 72.0;
/**
* The normal height for ellipses (72). <I>Note:</I> 72 points = 1 inch.
*/
public static final double NORMAL_HEIGHT = 72.0;
// Hidden data members.
private static final long serialVersionUID = 8085149752960383250L;
private static double theDefaultWidth = NORMAL_WIDTH;
private static double theDefaultHeight = NORMAL_HEIGHT;
// Exported constructors.
/**
* Construct a new ellipse. The ellipse's northwest corner is located at
* (0,0). The ellipse's size is the default size.
*/
public Ellipse()
{
super();
this.width = theDefaultWidth;
this.height = theDefaultHeight;
}
/**
* Construct a new ellipse with the same outline, fill paint, location,
* and size as the given ellipse.
*
* @param theItem Ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>theItem</TT> is null.
*/
public Ellipse
(Ellipse theItem)
{
super (theItem);
}
// Exported operations.
/**
* Returns the default size for ellipses.
*
* @return Default size.
*/
public static Size defaultSize()
{
return new Size (theDefaultWidth, theDefaultHeight);
}
/**
* Set the default size for ellipses.
*
* @param theSize Default size.
*
* @exception IllegalArgumentException
* (unchecked exception) Thrown if the width or the height of
* <TT>theSize</TT> is less than 0.
*/
public static void defaultSize
(Size theSize)
{
if (theSize.width < 0.0 || theSize.height < 0.0)
{
throw new IllegalArgumentException();
}
theDefaultWidth = theSize.width;
theDefaultHeight = theSize.height;
}
/**
* Returns the default width for ellipses.
*
* @return Default width.
*/
public static double defaultWidth()
{
return theDefaultWidth;
}
/**
* Set the default width for ellipses.
*
* @param theWidth Default width.
*
* @exception IllegalArgumentException
* (unchecked exception) Thrown if <TT>theWidth</TT> is less than 0.
*/
public static void defaultWidth
(double theWidth)
{
if (theWidth < 0.0) throw new IllegalArgumentException();
theDefaultWidth = theWidth;
}
/**
* Returns the default height for ellipses.
*
* @return Default height.
*/
public static double defaultHeight()
{
return theDefaultHeight;
}
/**
* Set the default height for ellipses.
*
* @param theHeight Default height.
*
* @exception IllegalArgumentException
* (unchecked exception) Thrown if <TT>theHeight</TT> is less than 0.
*/
public static void defaultHeight
(double theHeight)
{
if (theHeight < 0.0) throw new IllegalArgumentException();
theDefaultHeight = theHeight;
}
/**
* Set this ellipse's outline.
*
* @param theOutline Outline, or <TT>Outline.NONE</TT>.
*
* @return This ellipse.
*/
public Ellipse outline
(Outline theOutline)
{
doOutline (theOutline);
return this;
}
/**
* Set this ellipse's fill paint.
*
* @param theFill Fill paint, or <TT>Fill.NONE</TT>.
*
* @return This ellipse.
*/
public Ellipse fill
(Fill theFill)
{
doFill (theFill);
return this;
}
/**
* Set the size of this ellipse's bounding box.
*
* @param theSize Size.
*
* @return This ellipse.
*
* @exception IllegalArgumentException
* (unchecked exception) Thrown if the width or the height of
* <TT>theSize</TT> is less than 0.
*/
public Ellipse size
(Size theSize)
{
doSize (theSize);
return this;
}
/**
* Set the width of this ellipse's bounding box.
*
* @param theWidth Width.
*
* @return This ellipse.
*
* @exception IllegalArgumentException
* (unchecked exception) Thrown if <TT>theWidth</TT> is less than 0.
*/
public Ellipse width
(double theWidth)
{
doWidth (theWidth);
return this;
}
/**
* Set the height of this ellipse's bounding box.
*
* @param theHeight Height.
*
* @return This ellipse.
*
* @exception IllegalArgumentException
* (unchecked exception) Thrown if <TT>theHeight</TT> is less than 0.
*/
public Ellipse height
(double theHeight)
{
doHeight (theHeight);
return this;
}
/**
* Set the width and height of this ellipse's bounding box to make this
* ellipse a circle.
*
* @param theDiameter Diameter.
*
* @return This ellipse.
*
* @exception IllegalArgumentException
* (unchecked exception) Thrown if <TT>theDiameter</TT> is less than 0.
*/
public Ellipse diameter
(double theDiameter)
{
doWidth (theDiameter);
doHeight (theDiameter);
return this;
}
/**
* Set the northwest corner point of this ellipse's bounding box.
*
* @param x X coordinate of northwest corner point.
* @param y Y coordinate of northwest corner point.
*
* @return This ellipse.
*/
public Ellipse nw
(double x,
double y)
{
doNw (x, y);
return this;
}
/**
* Set the northwest corner point of this ellipse's bounding box.
*
* @param thePoint Northwest corner point.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>thePoint</TT> is null.
*/
public Ellipse nw
(Point thePoint)
{
doNw (thePoint.x, thePoint.y);
return this;
}
/**
* Set the north middle point of this ellipse's bounding box.
*
* @param x X coordinate of north middle point.
* @param y Y coordinate of north middle point.
*
* @return This ellipse.
*/
public Ellipse n
(double x,
double y)
{
doN (x, y);
return this;
}
/**
* Set the north middle point of this ellipse's bounding box.
*
* @param thePoint North middle point.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>thePoint</TT> is null.
*/
public Ellipse n
(Point thePoint)
{
doN (thePoint.x, thePoint.y);
return this;
}
/**
* Set the northeast corner point of this ellipse's bounding box.
*
* @param x X coordinate of northeast corner point.
* @param y Y coordinate of northeast corner point.
*
* @return This ellipse.
*/
public Ellipse ne
(double x,
double y)
{
doNe (x, y);
return this;
}
/**
* Set the northeast corner point of this ellipse's bounding box.
*
* @param thePoint Northeast corner point.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>thePoint</TT> is null.
*/
public Ellipse ne
(Point thePoint)
{
doNe (thePoint.x, thePoint.y);
return this;
}
/**
* Set the west middle point of this ellipse's bounding box.
*
* @param x X coordinate of west middle point.
* @param y Y coordinate of west middle point.
*
* @return This ellipse.
*/
public Ellipse w
(double x,
double y)
{
doW (x, y);
return this;
}
/**
* Set the west middle point of this ellipse's bounding box.
*
* @param thePoint West middle point.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>thePoint</TT> is null.
*/
public Ellipse w
(Point thePoint)
{
doW (thePoint.x, thePoint.y);
return this;
}
/**
* Set the center point of this ellipse's bounding box.
*
* @param x X coordinate of center point.
* @param y Y coordinate of center point.
*
* @return This ellipse.
*/
public Ellipse c
(double x,
double y)
{
doC (x, y);
return this;
}
/**
* Set the center point of this ellipse's bounding box.
*
* @param thePoint Center point.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>thePoint</TT> is null.
*/
public Ellipse c
(Point thePoint)
{
doC (thePoint.x, thePoint.y);
return this;
}
/**
* Set the east middle point of this ellipse's bounding box.
*
* @param x X coordinate of east middle point.
* @param y Y coordinate of east middle point.
*
* @return This ellipse.
*/
public Ellipse e
(double x,
double y)
{
doE (x, y);
return this;
}
/**
* Set the east middle point of this ellipse's bounding box.
*
* @param thePoint East middle point.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>thePoint</TT> is null.
*/
public Ellipse e
(Point thePoint)
{
doE (thePoint.x, thePoint.y);
return this;
}
/**
* Set the southwest corner point of this ellipse's bounding box.
*
* @param x X coordinate of southwest corner point.
* @param y Y coordinate of southwest corner point.
*
* @return This ellipse.
*/
public Ellipse sw
(double x,
double y)
{
doSw (x, y);
return this;
}
/**
* Set the southwest corner point of this ellipse's bounding box.
*
* @param thePoint Southwest corner point.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>thePoint</TT> is null.
*/
public Ellipse sw
(Point thePoint)
{
doSw (thePoint.x, thePoint.y);
return this;
}
/**
* Set the south middle point of this ellipse's bounding box.
*
* @param x X coordinate of south middle point.
* @param y Y coordinate of south middle point.
*
* @return This ellipse.
*/
public Ellipse s
(double x,
double y)
{
doS (x, y);
return this;
}
/**
* Set the south middle point of this ellipse's bounding box.
*
* @param thePoint South middle point.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>thePoint</TT> is null.
*/
public Ellipse s
(Point thePoint)
{
doS (thePoint.x, thePoint.y);
return this;
}
/**
* Set the southeast corner point of this ellipse's bounding box.
*
* @param x X coordinate of southeast corner point.
* @param y Y coordinate of southeast corner point.
*
* @return This ellipse.
*/
public Ellipse se
(double x,
double y)
{
doSe (x, y);
return this;
}
/**
* Set the southeast corner point of this ellipse's bounding box.
*
* @param thePoint Southeast corner point.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>thePoint</TT> is null.
*/
public Ellipse se
(Point thePoint)
{
doSe (thePoint.x, thePoint.y);
return this;
}
/**
* Add this ellipse to the end of the default drawing's sequence of drawing
* items.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if there is no default drawing.
*
* @see Drawing#defaultDrawing()
*/
public Ellipse add()
{
doAdd (Drawing.defaultDrawing());
return this;
}
/**
* Add this ellipse to the end of the given drawing's sequence of drawing
* items.
*
* @param theDrawing Drawing.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>theDrawing</TT> is null.
*/
public Ellipse add
(Drawing theDrawing)
{
doAdd (theDrawing);
return this;
}
/**
* Add this ellipse to the beginning of the default drawing's sequence of
* drawing items.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if there is no default drawing.
*
* @see Drawing#defaultDrawing()
*/
public Ellipse addFirst()
{
doAddFirst (Drawing.defaultDrawing());
return this;
}
/**
* Add this ellipse to the beginning of the given drawing's sequence of
* drawing items.
*
* @param theDrawing Drawing.
*
* @return This ellipse.
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>theDrawing</TT> is null.
*/
public Ellipse addFirst
(Drawing theDrawing)
{
doAddFirst (theDrawing);
return this;
}
/**
* Returns the point on the circumference of this ellipse at the given angle
* relative to this ellipse's center. The point on the ellipse's
* circumference is determined by <TT>angle</TT>, measured in radians. An
* angle of 0 gives the east point; an angle of pi/2 gives the south point;
* an angle of pi gives the west point; an angle of 3*pi/2 gives the north
* point.
*
* @param angle Angle (radians).
*
* @return Point on this ellipse's circumference.
*/
public Point circumferencePoint
(double angle)
{
Point c = c();
double xc = c.x;
double yc = c.y;
double xr = width() / 2;
double yr = height() / 2;
double x1 = xc + xr * Math.cos (angle);
double y1 = yc + yr * Math.sin (angle);
return new Point (x1, y1);
}
/**
* Returns the point on the circumference of this ellipse at the given angle
* relative to this ellipse's center. The point on the ellipse's
* circumference is determined by <TT>angle</TT>, measured in degrees. An
* angle of 0 gives the east point; an angle of 90 gives the south point;
* an angle of 180 gives the west point; an angle of 270 gives the north
* point.
*
* @param angle Angle (degrees).
*
* @return Point on this ellipse's circumference.
*/
public Point circumferencePointDegrees
(double angle)
{
return circumferencePoint (angle / 180.0 * Math.PI);
}
/**
* Returns the point on the circumference of this ellipse at the given angle
* relative to this ellipse's center, extended outward by the given length.
* First, a point on this ellipse's circumference is determined by
* <TT>angle</TT>, measured in radians. An angle of 0 gives the east point;
* an angle of pi/2 gives the south point; an angle of pi gives the west
* point; an angle of 3*pi/2 gives the north point. A line is projected from
* the center of this ellipse, through the point on the circumference, for a
* further distance of <TT>length</TT>; the endpoint of this line is
* returned.
*
* @param angle Angle (radians).
* @param length Length to extend from circumference.
*
* @return Point extended outward from this ellipse's circumference.
*/
public Point circumferencePoint
(double angle,
double length)
{
Point c = c();
double xc = c.x;
double yc = c.y;
double xr = width() / 2;
double yr = height() / 2;
double dx = xr * Math.cos (angle);
double dy = yr * Math.sin (angle);
double d = Math.sqrt (dx*dx + dy*dy);
double x1 = xc + dx + dx / d * length;
double y1 = yc + dy + dy / d * length;
return new Point (x1, y1);
}
/**
* Returns the point on the circumference of this ellipse at the given angle
* relative to this ellipse's center, extended outward by the given length.
* First, a point on this ellipse's circumference is determined by
* <TT>angle</TT>, measured in degrees. An angle of 0 gives the east point;
* an angle of 90 gives the south point; an angle of 180 gives the west
* point; an angle of 270 gives the north point. A line is projected from
* the center of this ellipse, through the point on the circumference, for a
* further distance of <TT>length</TT>; the endpoint of this line is
* returned.
*
* @param angle Angle (degrees).
* @param length Length to extend from circumference.
*
* @return Point extended outward from this ellipse's circumference.
*/
public Point circumferencePointDegrees
(double angle,
double length)
{
return circumferencePoint (angle / 180.0 * Math.PI, length);
}
/**
* Returns the point of intersection between (1) this ellipse's perimeter
* and (2) the line passing through this ellipse's center and the given
* point.
*
* @param point One point on the line.
*
* @return Point of intersection between perimeter and line.
*/
public Point perimeterIntersection
(Point point)
{
return perimeterIntersection (point.x, point.y);
}
/**
* Returns the point of intersection between (1) this ellipse's perimeter
* and (2) the line passing through this ellipse's center and the given
* point.
*
* @param x X coordinate of one point on the line.
* @param y Y coordinate of one point on the line.
*
* @return Point of intersection between perimeter and line.
*/
public Point perimeterIntersection
(double x,
double y)
{
Point center = c();
double cx = center.x;
double cy = center.y;
double w = width()/2;
double h = height()/2;
double dx = x - cx;
double dy = y - cy;
double d = Math.sqrt (dx*dx + dy*dy);
return new Point (cx + w*dx/d, cy + h*dy/d);
}
// Hidden operations.
/**
* Determine the 2-D graphics shape that this shape object will draw.
*
* @return Shape.
*/
Shape getShape()
{
Point nw = nw();
return new Ellipse2D.Double (nw.x, nw.y, width, height);
}
}
|