summaryrefslogtreecommitdiff
path: root/java/awt/Point.java
blob: ddf11704d35f92e96fa6f187e256313d349e932e (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
/* Point.java -- Java representation of a point on a screen.
   Copyright (C) 1999 Free Software Foundation, Inc.

This file is part of the non-peer AWT libraries of GNU Classpath.

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

This library 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 Library General Public License for more details.

You should have received a copy of the GNU Library General Public License
along with this library; if not, write to the Free Software Foundation
Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307 USA. */


package java.awt;

/**
  * This class represents a point on the screen using cartesian coordinates.
  *
  * @author Aaron M. Renn (arenn@urbanophile.com)
  */
public class Point implements java.io.Serializable
{

/*
 * Instance Variables
 */

/**
  * @serial The X coordinate of the point.
  */
public int x;

/**
  * @serial The Y coordinate of the point.
  */
public int y;

/*************************************************************************/

/*
 * Constructors
 */

/**
  * Initializes a new instance of <code>Point</code> representing the
  * coordiates (0,0).
  */
public
Point()
{
  this(0, 0);
}
 
/*************************************************************************/

/**
  * Initializes a new instance of <code>Point</code> with coordinates
  * identical to the coordinates of the specified points.
  *
  * @param point The point to copy the coordinates from.
  */
public
Point(Point point)
{
  this(point.x, point.y);
}

/*************************************************************************/

/**
  * Initializes a new instance of <code>Point</code> with the specified
  * coordinates.
  *
  * @param x The X coordinate of this point.
  * @param y The Y coordinate of this point.
  */
public 
Point(int x, int y)
{
  this.x = x;
  this.y = y;
}

/*************************************************************************/

/*
 * Instance Methods
 */

/**
  * Returns the location of this object as a point.  A pretty useless
  * method.  It is included to mimic the <code>getLocation</code> method
  * in component.
  *
  * @return This point.
  */
public Point
getLocation()
{
  return(this);
}

/*************************************************************************/

/**
  * Sets this object's coordinates to match those of the specified point.
  *
  * @param point The point to copy the coordinates from.
  */
public void
setLocation(Point point)
{
  this.x = point.x;
  this.y = point.y;
}

/*************************************************************************/

/**
  * Sets this object's coordinates to the specified values.  This method
  * is identical to the <code>move()</code> method.
  *
  * @param x The new X coordinate.
  * @param y The new Y coordinate.
  */
public void
setLocation(int x, int y)
{
  this.x = x;
  this.y = x;
}

/*************************************************************************/

/**
  * Sets this object's coordinates to the specified values.  This method
  * is identical to the <code>setLocation(int, int)</code> method.
  *
  * @param x The new X coordinate.
  * @param y The new Y coordinate.
  */
public void
move(int x, int y)
{
  this.x = x;
  this.y = y;
}

/*************************************************************************/

/**
  * Changes the coordinates of this point such that the specified 
  * <code>dx</code> parameter is added to the existing X coordinate and
  * <code>dy</code> is added to the existing Y coordinate.
  *
  * @param dx The amount to add to the X coordinate.
  * @param dy The amount to add to the Y coordinate.
  */
public void
translate(int dx, int dy)
{
  x += dx;
  y += dy;
}

/*************************************************************************/

/**
  * Returns a hash value for this point.
  *
  * @param A hash value for this point.
  */
public int
hashCode()
{
  return(((x*y)*(x*y)) % 37);
}

/*************************************************************************/

/**
  * Tests whether or not this object is equal to the specified object.
  * This will be true if and only if the specified objectj:
  * <p>
  * <ul>
  * <li>Is not <code>null</code>.
  * <li>Is an instance of <code>Point</code>.
  * <li>Has X and Y coordinates equal to this object's.
  * </ul>
  *
  * @param obj The object to test against for equality.
  *
  * @return <code>true</code> if the specified object is equal to this
  * object, <code>false</code> otherwise.
  */
public boolean
equals(Object obj)
{
  if (obj == null)
    return(false);

  if (!(obj instanceof Point))
    return(false);

  Point p = (Point)obj;

  if (p.x != x)
    return(false);

  if (p.y != y)
    return(false);

  return(true);
}

/*************************************************************************/

/**
  * Returns a string representation of this object.
  *
  * @return A string representation of this object.
  */
public String
toString()
{
  return(getClass().getName() + ": (" + x + "," + y + ")");
}

} // class Point