com.yworks.yfiles.algorithms

Class Point2D

java.lang.Object

com.yworks.yfiles.algorithms.Point2D

All Implemented Interfaces:

ICloneable

public class Point2D
extends Object
implements ICloneable

Represents a two-dimensional point located at (x, y).

Constructor Summary

Constructors

Constructor and Description
Point2D() Creates a new instance that is located at (0, 0).
Point2D(double x, double y) Creates a new instance at the given location.

Method Summary

Modifier and Type	Method and Description
Point2D	clone() Creates a new instance of this class that has the same values as this objects.
double	distance(double px, double py) Calculates the distance between this points and another one, given as its coordinates.
static double	distance(double x1, double y1, double x2, double y2) Calculates the distance between two points, given as their coordinates.
double	distance(Point2D p) Calculates the distance between this points and another one.
double	distanceSq(double px, double py) Calculates the squared distance between this points and another one, given as its coordinates.
static double	distanceSq(double x1, double y1, double x2, double y2) Calculates the squared distance between two points, given as their coordinates.
double	distanceSq(Point2D p) Calculates the squared distance between this points and another one.
boolean	equals(Object obj) Returns whether this point and obj are equal.
double	getX() Gets the x coordinate of this point.
double	getY() Gets the y coordinate of this point.
int	hashCode()
void	setLocation(double x, double y) Sets the location of this point to the given coordinates.
void	setLocation(Point2D value) Sets the location of this point to the same values as for the given point.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Point2D

public Point2D()

Creates a new instance that is located at (0, 0).

Point2D

public Point2D(double x,
               double y)

Creates a new instance at the given location.

Parameters:

x - The x coordinate of the new point

y - The x coordinate of the new point

Method Detail

clone

public Point2D clone()

Creates a new instance of this class that has the same values as this objects.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

a new instance of this class that has the same values as this objects.

See Also:

Object.clone()

distance

public double distance(double px,
                       double py)

Calculates the distance between this points and another one, given as its coordinates.

Parameters:

px - The x coordinate of the second point.

py - The y coordinate of the second point.

Returns:

the distance between this points and another one, given as its coordinates.

distance

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

Calculates the distance between two points, given as their coordinates.

Parameters:

x1 - The x coordinate of the first point.

y1 - The y coordinate of the first point.

x2 - The x coordinate of the second point.

y2 - The y coordinate of the second point.

Returns:

the distance between two points, given as their coordinates.

distance

public double distance(Point2D p)

Calculates the distance between this points and another one.

Parameters:

p - The second point.

Returns:

the distance between this points and another one.

distanceSq

public double distanceSq(double px,
                         double py)

Calculates the squared distance between this points and another one, given as its coordinates.

Parameters:

px - The x coordinate of the second point.

py - The y coordinate of the second point.

Returns:

the squared distance between this points and another one, given as its coordinates.

distanceSq

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

Calculates the squared distance between two points, given as their coordinates.

Parameters:

x1 - The x coordinate of the first point.

y1 - The y coordinate of the first point.

x2 - The x coordinate of the second point.

y2 - The y coordinate of the second point.

Returns:

the squared distance between two points, given as their coordinates.

distanceSq

public double distanceSq(Point2D p)

Calculates the squared distance between this points and another one.

Parameters:

p - The second point.

Returns:

the squared distance between this points and another one.

equals

public boolean equals(Object obj)

Returns whether this point and obj are equal.

Two points are considered equal if the have the same location.

Overrides:

equals in class Object

Parameters:

obj - The object to test for equality

Returns:

true if both objects are equal.

getX

public double getX()

Gets the x coordinate of this point.

Returns:

the x coordinate of this point.

getY

public double getY()

Gets the y coordinate of this point.

Returns:

the y coordinate of this point.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setLocation

public void setLocation(double x,
                        double y)

Sets the location of this point to the given coordinates.

Parameters:

x - the new x coordinate

y - the new y coordinate

setLocation

public void setLocation(Point2D value)

Sets the location of this point to the same values as for the given point.

Parameters:

value - point whose coordinates are used

toString

public String toString()

Overrides:

toString in class Object