java.awt

Class Point

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

UNKNOWN: updated to 1.4

Field Summary
int	x The x coordinate.
int	y The y coordinate.

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

Method Summary
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(Point p) Sets this object's coordinates to match those of the specified point.
void	setLocation(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.
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.

Field Detail

x

public int x

The x coordinate.

Serial: the X coordinate of the point

y

public int y

The y coordinate.

Serial: The Y coordinate of the point

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

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.

Parameters: obj the object to test against for equality

Returns: true if the specified object is equal

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

getX

public double getX()

Get the x coordinate.

Returns: the value of x, as a double

getY

public double getY()

Get the y coordinate.

Returns: the value of y, as a double

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

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 {@link Math#floor(double)}.

Parameters: x the new X coordinate y the new Y coordinate

toString

public String toString()

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

Returns: a string representation of this object

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