com.yworks.yfiles.algorithms

Class YPoint

java.lang.Object

com.yworks.yfiles.algorithms.YPoint

All Implemented Interfaces:

Comparable

public final class YPoint
extends Object
implements Comparable

This class represents a point in the plane with double coordinates.

This class implements the immutable design pattern.

Field Summary

Fields

Modifier and Type	Field and Description
static YPoint	ORIGIN A YPoint constant with coordinates (0,0).

Constructor Summary

Constructors

Constructor and Description
YPoint() Creates a new YPoint at location (0,0).
YPoint(double x, double y) Creates a new YPoint object for a given position.

Method Summary

Modifier and Type	Method and Description
static YPoint	add(YPoint p1, YPoint p2) Adds two points and returns the result.
int	compareTo(Object o) Comparable implementation.
static double	distance(double x1, double y1, double x2, double y2) Returns the euclidean distance between two points.
static double	distance(YPoint p1, YPoint p2) Returns the euclidean distance between two points.
double	distanceTo(double x, double y) Returns the euclidean distance between this point and a given point.
double	distanceTo(YPoint p) Returns the euclidean distance between this point and a given point.
boolean	equals(Object o) Tests a point to equality to another point.
double	getX() Gets the x-coordinate of the point object.
double	getY() Gets the y-coordinate of the point object.
int	hashCode()
static YPoint	midPoint(YPoint p1, YPoint p2) Returns a point that geometrically lies in in the middle of the line formed by the given points.
YPoint	moveBy(double x, double y) Returns the point, got by moving this point to another position.
static YPoint	subtract(YPoint p1, YPoint p2) Subtracts two points (p1 - p2) and returns the result.
static YPoint	swap(YPoint p) Returns a copy of the given point with exchanged x- and y-coordinates.
String	toString() Returns the coordinates of the point as string.

Methods inherited from class java.lang.Object

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

Field Detail

ORIGIN

public static final YPoint ORIGIN

A YPoint constant with coordinates (0,0).

Constructor Detail

YPoint

public YPoint()

Creates a new YPoint at location (0,0).

YPoint

public YPoint(double x,
              double y)

Creates a new YPoint object for a given position.

Parameters:

x - the x coordinate of the point.

y - the y coordinate of the point.

Method Detail

add

public static final YPoint add(YPoint p1,
                               YPoint p2)

Adds two points and returns the result.

Parameters:

p1 - an arbitrary instance of YPoint.

p2 - an arbitrary instance of YPoint.

compareTo

public final int compareTo(Object o)

Comparable implementation.

YPoints are ordered by ascending x-coordinates. If the x-coordinates of two points equal, then these points are ordered by ascending y-coordinates.

Specified by:

compareTo in interface Comparable

distance

public static final double distance(double x1,
                                    double y1,
                                    double x2,
                                    double y2)

Returns the euclidean distance between two points.

Parameters:

x1 - x-coordinate of first point

y1 - y-coordinate of first point

x2 - x-coordinate of second point

y2 - y-coordinate of second point

Returns:

the euclidean distance between first and second point

distance

public static final double distance(YPoint p1,
                                    YPoint p2)

Returns the euclidean distance between two points.

Parameters:

p1 - an arbitrary point

p2 - an arbitrary point

Returns:

the Euclidean distance between p1 and p2.

distanceTo

public final double distanceTo(double x,
                               double y)

Returns the euclidean distance between this point and a given point.

Parameters:

x - the x coordinate of an arbitrary point

y - the y coordinate of an arbitrary point

Returns:

the Euclidean distance between this point and the point (x,y).

distanceTo

public final double distanceTo(YPoint p)

Returns the euclidean distance between this point and a given point.

Parameters:

p - an arbitrary point

Returns:

the Euclidean distance between this point and p.

equals

public boolean equals(Object o)

Tests a point to equality to another point.

This test returns true if the o is also an instance of YPoint and has the same coordinates as the instance on which equals is invoked.

Overrides:

equals in class Object

Parameters:

o - an arbitrary instance.

getX

public final double getX()

Gets the x-coordinate of the point object.

Returns:

the value of the x-coordinate.

getY

public final double getY()

Gets the y-coordinate of the point object.

Returns:

the value of the y-coordinate.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

midPoint

public static final YPoint midPoint(YPoint p1,
                                    YPoint p2)

Returns a point that geometrically lies in in the middle of the line formed by the given points.

Parameters:

p1 - an arbitrary instance of YPoint.

p2 - an arbitrary instance of YPoint.

moveBy

public final YPoint moveBy(double x,
                           double y)

Returns the point, got by moving this point to another position.

Parameters:

x - the value which is added on the x-coordinate of the point.

y - the value which is added on the y-coordinate of the point.

Returns:

a new instance of YPoint which is the result of the moving operation.

subtract

public static final YPoint subtract(YPoint p1,
                                    YPoint p2)

Subtracts two points (p1 - p2) and returns the result.

Parameters:

p1 - an arbitrary instance of YPoint.

p2 - an arbitrary instance of YPoint.

swap

public static final YPoint swap(YPoint p)

Returns a copy of the given point with exchanged x- and y-coordinates.

Parameters:

p - an arbitrary instance of YPoint.

toString

public String toString()

Returns the coordinates of the point as string.

Overrides:

toString in class Object