com.yworks.yfiles.geometry

Interface IMutablePoint

All Superinterfaces:

IPoint

All Known Subinterfaces:

IMutableRectangle

All Known Implementing Classes:

MutablePoint, MutableRectangle, OrientedRectangle, RectangleHandle

public interface IMutablePoint
extends IPoint

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

This interface provides read and write access to the coordinates. It adds write access to the read only interface IPoint.

See Also:

IPoint, MutablePoint

Method Summary

Modifier and Type	Method and Description
double	getX() Gets the x coordinate for this point.
double	getY() Gets the y coordinate for this point.
default void	relocate(double x, double y) Sets the coordinates of the point to the given values.
default void	relocate(IPoint location) Sets the coordinates of the point to the given values.
default void	relocate(PointD location) Sets the coordinates of the point to the given values.
void	setX(double value) Sets the x coordinate for this point.
void	setY(double value) Sets the y coordinate for this point.

Methods inherited from interface com.yworks.yfiles.geometry.IPoint

distanceTo, toPointD

Method Detail

getX

double getX()

Gets the x coordinate for this point.

Implementations may adjust the coordinates internally, e.g. to automatically snap the coordinates to grid points. So depending on context the value that can be read might not necessarily be the exact same value that has just been written.

Specified by:

getX in interface IPoint

Returns:

The X.

See Also:

IPoint.getX(), setX(double)

getY

double getY()

Gets the y coordinate for this point.

Implementations may adjust the coordinates internally, e.g. to automatically snap the coordinates to grid points. So depending on context the value that can be read might not necessarily be the exact same value that has just been written.

Specified by:

getY in interface IPoint

Returns:

The Y.

See Also:

IPoint.getY(), setY(double)

relocate

default void relocate(double x,
                      double y)

Sets the coordinates of the point to the given values.

Parameters:

x - The new x coordinate

y - The new y coordinate

relocate

default void relocate(IPoint location)

Sets the coordinates of the point to the given values.

Parameters:

location - The new location.

relocate

default void relocate(PointD location)

Sets the coordinates of the point to the given values.

Parameters:

location - The new location.

setX

void setX(double value)

Sets the x coordinate for this point.

Implementations may adjust the coordinates internally, e.g. to automatically snap the coordinates to grid points. So depending on context the value that can be read might not necessarily be the exact same value that has just been written.

Parameters:

value - The X to set.

See Also:

IPoint.getX(), getX()

setY

void setY(double value)

Sets the y coordinate for this point.

Implementations may adjust the coordinates internally, e.g. to automatically snap the coordinates to grid points. So depending on context the value that can be read might not necessarily be the exact same value that has just been written.

Parameters:

value - The Y to set.

See Also:

IPoint.getY(), getY()