src/appletbots/geometry/Point.java

   1 /*
   2  * Copyright (c) 2002 Erik Rasmussen - All Rights Reserverd
   3  */
   4 package appletbots.geometry;
   5
   6 /**
   7  * This class represents a point in two-dimensional space
   8  *
   9  * @author Erik Rasmussen
  10  */
  11 public class Point
  12 {
  13         /**
  14          * The x-coordinate
  15          */
  16         public double x;
  17         /**
  18          * The y-coordinate
  19          */
  20         public double y;
  21
  22         /**
  23          * Creates a new point with the given coordinates
  24          *
  25          * @param x The x-coordinate
  26          * @param y The y-coordinate
  27          */
  28         public Point(final double x, final double y)
  29         {
  30                 this.x = x;
  31                 this.y = y;
  32         }
  33
  34         /**
  35          * Returns the distance between this point and another point
  36          *
  37          * @param point Another point
  38          * @return The distance between this point and another point
  39          */
  40         public double distance(final Point point)
  41         {
  42                 final double px = point.x - x;
  43                 final double py = point.y - y;
  44                 return Math.sqrt(px * px + py * py);
  45         }
  46
  47         /**
  48          * Returns the result of adding a vector to this point
  49          *
  50          * @param vector The vector to add
  51          * @return The result of adding a vector to this point
  52          */
  53         public Point add(final Vector vector)
  54         {
  55                 return new Point(x + vector.x, y + vector.y);
  56         }
  57
  58         /**
  59          * Returns whether or not this point equals another point
  60          *
  61          * @param obj Another point
  62          * @return Whether or not this point equals another point
  63          */
  64         public boolean equals(final Object obj)
  65         {
  66                 if (obj instanceof Point)
  67                 {
  68                         final Point that = (Point) obj;
  69                         return this.x == that.x && this.y == that.y;
  70                 }
  71                 return false;
  72         }
  73
  74         /**
  75          * Returns a copy of this point
  76          *
  77          * @return A copy of this point
  78          */
  79         public Object clone()
  80         {
  81                 return new Point(x, y);
  82         }
  83
  84         /**
  85          * Returns a string representation of this point
  86          *
  87          * @return A string representation of this point
  88          */
  89         public String toString()
  90         {
  91                 return "(" + x + "," + y + ")";
  92         }
  93 }