java.awt

Class Point

java.lang.Object

java.awt.geom.Point2D

java.awt.Point

All Implemented Interfaces:

Serializable, Cloneable

public class Point
extends Point2D
implements Serializable

This class represents a point on the screen using cartesian coordinates. Remember that in screen coordinates, increasing x values go from left to right, and increasing y values go from top to bottom.

There are some public fields; if you mess with them in an inconsistent manner, it is your own fault when you get invalid results. Also, this class is not threadsafe.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.geom.Point2D

Point2D.Double, Point2D.Float

Field Summary

Fields

Modifier and Type	Field and Description
int	x The x coordinate.
int	y The y coordinate.

Constructor Summary

Constructors

Constructor and Description
Point() Initializes a new instance of Point representing the coordinates (0, 0).
Point(int x, int y) Initializes a new instance of Point with the specified coordinates.
Point(Point p) Initializes a new instance of Point with coordinates identical to the coordinates of the specified point.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Tests whether or not this object is equal to the specified object.
Point	getLocation() Returns the location of this point.
double	getX() Get the x coordinate.
double	getY() Get the y coordinate.
void	move(int x, int y) Sets this object's coordinates to the specified values.
void	setLocation(double x, double y) Sets this object's coordinates to the specified values.
void	setLocation(int x, int y) Sets this object's coordinates to the specified values.
void	setLocation(Point p) Sets this object's coordinates to match those of the specified point.
String	toString() Returns a string representation of this object.
void	translate(int dx, int dy) Changes the coordinates of this point such that the specified dx parameter is added to the existing X coordinate and dy is added to the existing Y coordinate.

Methods inherited from class java.awt.geom.Point2D

clone, distance, distance, distance, distanceSq, distanceSq, distanceSq, hashCode, setLocation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

x

public int x

The x coordinate.

See Also:

getLocation(), move(int, int)

y

public int y

The y coordinate.

See Also:

getLocation(), move(int, int)

Constructor Detail

Point

public Point()

Initializes a new instance of Point representing the coordinates (0, 0).

Since:

1.1

Point

public Point(Point p)

Initializes a new instance of Point with coordinates identical to the coordinates of the specified point.

Parameters:

p - the point to copy the coordinates from

Throws:

NullPointerException - if p is null

Point

public Point(int x,
     int y)

Initializes a new instance of Point with the specified coordinates.

Parameters:

x - the X coordinate

y - the Y coordinate

Method Detail

getX

public double getX()

Get the x coordinate.

Specified by:

getX in class Point2D

Returns:

the value of x, as a double

getY

public double getY()

Get the y coordinate.

Specified by:

getY in class Point2D

Returns:

the value of y, as a double

getLocation

public Point getLocation()

Returns the location of this point. A pretty useless method, as this is already a point.

Returns:

a copy of this point

Since:

1.1

See Also:

setLocation(Point)

setLocation

public void setLocation(Point p)

Sets this object's coordinates to match those of the specified point.

Parameters:

p - the point to copy the coordinates from

Throws:

NullPointerException - if p is null

Since:

1.1

setLocation

public void setLocation(int x,
               int y)

Sets this object's coordinates to the specified values. This method is identical to the move() method.

Parameters:

x - the new X coordinate

y - the new Y coordinate

setLocation

public void setLocation(double x,
               double y)

Sets this object's coordinates to the specified values. This method rounds to the nearest integer coordinates by adding 0.5 and calling Math.floor(double).

Specified by:

setLocation in class Point2D

Parameters:

x - the new X coordinate

y - the new Y coordinate

move

public void move(int x,
        int y)

Sets this object's coordinates to the specified values. This method is identical to the setLocation(int, int) method.

Parameters:

x - the new X coordinate

y - the new Y coordinate

translate

public void translate(int dx,
             int dy)

Changes the coordinates of this point such that the specified dx parameter is added to the existing X coordinate and dy is added to the existing Y coordinate.

Parameters:

dx - the amount to add to the X coordinate

dy - the amount to add to the Y coordinate

equals

public boolean equals(Object obj)

Tests whether or not this object is equal to the specified object. This will be true if and only if the specified object is an instance of Point2D and has the same X and Y coordinates.

Overrides:

equals in class Point2D

Parameters:

obj - the object to test against for equality

Returns:

true if the specified object is equal

See Also:

Object.hashCode()

toString

public String toString()

Returns a string representation of this object. The format is: getClass().getName() + "[x=" + x + ",y=" + y + ']'.

Overrides:

toString in class Object

Returns:

a string representation of this object

See Also:

Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)