com.yworks.yfiles.geometry

Interface IPoint

All Known Subinterfaces:

IMutablePoint, IMutableRectangle, IRectangle

All Known Implementing Classes:

MutablePoint, MutableRectangle, OrientedRectangle, PointD, RectangleHandle, RectD

public interface IPoint

Interface for a point in 2D coordinate space with double precision coordinates.

This interface provides read access to the coordinates only, however this does not mean that an instance that implements IPoint will always return the same values for the coordinate properties. Often times the instance provides a dynamic read access to the current state of a point. It depends on the context whether it is allowed to or even necessary to copy the state of the properties or whether the reference to the instance should always be used to query the values.

See Also:

IMutablePoint, MutablePoint

Method Summary

Modifier and Type	Method and Description
default double	distanceTo(IPoint point2) Calculates the Euclidean distance between two points.
double	getX() Gets the current x coordinate of this point.
double	getY() Gets the current y coordinate of this point.
default PointD	toPointD() Copies the current values of the coordinates of the point to a PointD struct.

Method Detail

distanceTo

default double distanceTo(IPoint point2)

Calculates the Euclidean distance between two points.

Parameters:

point2 - The second point.

Returns:

The distance between the two points.

getX

double getX()

Gets the current x coordinate of this point.

Depending on context the values returned may change over time.

Returns:

The X.

getY

double getY()

Gets the current y coordinate of this point.

Depending on context the values returned may change over time.

Returns:

The Y.

toPointD

default PointD toPointD()

Copies the current values of the coordinates of the point to a PointD struct.

This method is useful to obtain a copy of the state and for making use of the various utility methods that are provided by PointD.

Returns:

The current values of the coordinates of the point.

See Also:

PointD.toMutablePoint(), IMutablePoint.relocate(PointD)