stanford.androidlib.graphics

Class GPoint

java.lang.Object

stanford.androidlib.graphics.GPoint

public class GPoint
extends Object

This class is a double-precision version of the Point class in java.awt.

Constructor Summary

Constructors

Constructor and Description
GPoint() Constructs a new GPoint at the origin (0, 0).
GPoint(float x, float y) Constructs a new GPoint with the specified coordinates.
GPoint(GPoint p) Constructs a new GPoint from an existing one.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Tests whether two GPoint objects are equal.
GPoint	getLocation() Returns a new GPoint whose coordinates are the same as this one.
float	getX() Returns the x coordinate of this GPoint.
float	getY() Returns the y coordinate of this GPoint.
int	hashCode() Returns an integer hash code for the point.
GPoint	setLocation(float x, float y) Sets the location of the GPoint to the specified x and y values.
GPoint	setLocation(GPoint p) Sets the location of the GPoint to that of an existing one.
String	toString() Converts this GPoint to its string representation.
GPoint	translate(float dx, float dy) Adjusts the coordinates of a point by the specified dx and dy offsets.

Methods inherited from class java.lang.Object

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

Constructor Detail

GPoint

public GPoint()

Constructs a new GPoint at the origin (0, 0).

Usage:

pt = new GPoint();

GPoint

public GPoint(float x,
              float y)

Constructs a new GPoint with the specified coordinates.

Parameters:

x - The x-coordinate of the point

y - The y-coordinate of the point

Usage:

pt = new GPoint(x, y);

GPoint

public GPoint(GPoint p)

Constructs a new GPoint from an existing one.

Parameters:

p - The original point

Usage:

pt = new GPoint(p);

Method Detail

getX

public float getX()

Returns the x coordinate of this GPoint.

Returns:

The x coordinate of this GPoint

Usage:

x = pt.getX();

getY

public float getY()

Returns the y coordinate of this GPoint.

Returns:

The y coordinate of this GPoint

Usage:

y = pt.getY();

setLocation

public GPoint setLocation(float x,
                          float y)

Sets the location of the GPoint to the specified x and y values.

Parameters:

x - The new x-coordinate for the point

y - The new y-coordinate for the point

Usage:

pt.setLocation(x, y);

setLocation

public GPoint setLocation(GPoint p)

Sets the location of the GPoint to that of an existing one.

Parameters:

p - An existing GPoint specifying the new location

Usage:

pt.setLocation(p);

getLocation

public GPoint getLocation()

Returns a new GPoint whose coordinates are the same as this one.

Returns:

A new point with the same coordinates

Usage:

p = pt.getLocation();

translate

public GPoint translate(float dx,
                        float dy)

Adjusts the coordinates of a point by the specified dx and dy offsets.

Parameters:

dx - The change in the x direction (positive is rightward)

dy - The change in the y direction (positive is downward)

Usage:

pt.translate(dx, dy);

hashCode

public int hashCode()

Returns an integer hash code for the point. The hash code for a GPoint is constructed from the hash codes from the float values of the coordinates, which are the ones used in the equals method.

Overrides:

hashCode in class Object

Returns:

The hash code for this pt

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

Usage:

hash = pt.hashCode();

Noshow:

equals

public boolean equals(Object obj)

Tests whether two GPoint objects are equal. Because floating-point values are inexact, this method checks for equality by comparing the float values (rather than the float values) of the coordinates.

Overrides:

equals in class Object

Parameters:

obj - Any object

Returns:

true if the obj is a GPoint equal to this one, and false otherwise

See Also:

Object.hashCode(), HashMap

Usage:

if (pt.equals(obj)) . . .

Noshow:

toString

public String toString()

Converts this GPoint to its string representation.

Overrides:

toString in class Object

Returns:

A string representation of this point

Usage:

str = rect.toString();

Noshow: