Package org.jungrapht.visualization.layout.model

Class Point

java.lang.Object

org.jungrapht.visualization.layout.model.Point

public class Point
extends Object

Simple, immutable Point class used for Graph layout. Included to reduce dependency on awt classes

Author:

Tom Nelson

Field Summary

Fields

Modifier and Type	Field	Description
static Point	ORIGIN	Point at location (0,0)
double	x	x coordinate
double	y	y coordinate

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Point(double x, double y)

Method Summary

Modifier and Type	Method	Description
Point	add(double dx, double dy)
Point	add(Point other)
static Point	centroidOf(Collection<Point> points)
double	distance(Point other)
double	distanceSquared(double ox, double oy)
double	distanceSquared(Point other)
boolean	equals(Object o)	Compare with another object for equality
int	hashCode()
boolean	inside(double minX, double minY, double maxX, double maxY)
boolean	inside(Circle c)
boolean	inside(Rectangle r)
double	length()
Point	multiply(double factor)
static Point	of(double x, double y)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

x

public final double x

x coordinate

y

public final double y

y coordinate

ORIGIN

public static final Point ORIGIN

Point at location (0,0)

Constructor Detail

Point

protected Point(double x,
                double y)

Parameters:

x - coordinate

y - coordinate

Method Detail

of

public static Point of(double x,
                       double y)

Parameters:

x - coordinate

y - coordinate

Returns:

a new Point with the passed coordinates

centroidOf

public static Point centroidOf(Collection<Point> points)

Parameters:

points - a collection of Point to consider

Returns:

the centroid of the Point collection

add

public Point add(Point other)

Parameters:

other - the Point with values to add

Returns:

a new Point with the sum of this Point and other Point's values

multiply

public Point multiply(double factor)

Parameters:

factor - the value to multiply

Returns:

a new Point with the sum of this Point and other Point's values

add

public Point add(double dx,
                 double dy)

Parameters:

dx - change in x

dy - change in y

Returns:

a new Point with the sum of this Point and the passed values

distanceSquared

public double distanceSquared(Point other)

Parameters:

other - the Point to measure against

Returns:

the square of the distance between this Point and the passed Point

distanceSquared

public double distanceSquared(double ox,
                              double oy)

Parameters:

ox - coordinate of another location

oy - coordinate of another location

Returns:

the square of the distance between this Point and the passed location

inside

public boolean inside(Circle c)

Parameters:

c - a Circle to compare against

Returns:

true if this Point is within the passed Circle, false otherwise

inside

public boolean inside(Rectangle r)

Parameters:

r - a Rectangle to compare against

Returns:

true if this Point is inside the passed Rectangle, false otherwise

inside

public boolean inside(double minX,
                      double minY,
                      double maxX,
                      double maxY)

Parameters:

minX - min coordinate of a rectangular space

minY - min coordinate of a rectangular space

maxX - max coordinate of a rectangular space

maxY - max coordinate of a rectangular space

Returns:

true if this Point is within the passed rectangular space, false otherwise

length

public double length()

Returns:

the distance between this Point and the origin.

distance

public double distance(Point other)

Parameters:

other - a Point to consider

Returns:

the distance between this Point and the passed Point

equals

public boolean equals(Object o)

Compare with another object for equality

Overrides:

equals in class Object

Parameters:

o - other object

Returns:

true if the other object is a Point at the same coordinates

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

hash value of properties (x, y)

toString

public String toString()

Overrides:

toString in class Object

Returns:

String representation of this Point