com.yworks.yfiles.geometry

Class MutablePoint

java.lang.Object

com.yworks.yfiles.geometry.MutablePoint

All Implemented Interfaces:

IMutablePoint, IPoint, ICloneable, Cloneable

public final class MutablePoint
extends Object
implements IMutablePoint, ICloneable, Cloneable

A simple default implementation of a mutable point in 2D coordinate space with double precision coordinates.

This implementation stores the values of the coordinates in double precision floating point members. As a convenience it implements the ICloneable interface.

See Also:

IPoint

Constructor Summary

Constructors

Constructor and Description
MutablePoint() Creates the point with initially 0.0d values for X and Y.
MutablePoint(double x, double y) Creates an instance using the given coordinate pair.
MutablePoint(IPoint point) Creates an instance using the given coordinate pair.

Method Summary

Modifier and Type	Method and Description
MutablePoint	clone() Returns a clone of this instance.
boolean	equals(IPoint other)
boolean	equals(Object o) Implements the equals method by comparing the given object's values.
double	getX() Gets the x coordinate.
double	getY() Gets the y coordinate.
int	hashCode() Yields a hash code for this type based on the values of X and Y.
void	moveBy(PointD delta) Moves this instance by adding the provided offsets to the coordinates of this point.
void	normalize() Normalizes this point as if it was a vector.
void	setX(double value) Sets the x coordinate.
void	setY(double value) Sets the y coordinate.
String	toString()

Methods inherited from class java.lang.Object

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

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

relocate, relocate, relocate

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

distanceTo, toPointD

Constructor Detail

MutablePoint

public MutablePoint()

Creates the point with initially 0.0d values for X and Y.

MutablePoint

public MutablePoint(double x,
                    double y)

Creates an instance using the given coordinate pair.

Parameters:

x - The x coordinate

y - The y coordinate

MutablePoint

public MutablePoint(IPoint point)

Creates an instance using the given coordinate pair.

Parameters:

point - The coordinate.

Method Detail

clone

public final MutablePoint clone()

Returns a clone of this instance.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

An instance of MutablePoint initialized to the current state of this instance.

See Also:

Object.clone()

equals

public final boolean equals(IPoint other)

equals

public boolean equals(Object o)

Implements the equals method by comparing the given object's values.

Note that PointD cannot be equal. Only instances of this type and the ones returned by the factory methods of this type can be equal to each other.

Overrides:

equals in class Object

Parameters:

o - The other instance to compare the values against.

Returns:

Whether the other instance is of this type or the immutable types created by this class and whether their values are the same as for this type.

getX

public final double getX()

Gets the x coordinate.

Specified by:

getX in interface IMutablePoint

Specified by:

getX in interface IPoint

Returns:

The X.

See Also:

setX(double)

getY

public final double getY()

Gets the y coordinate.

Specified by:

getY in interface IMutablePoint

Specified by:

getY in interface IPoint

Returns:

The Y.

See Also:

setY(double)

hashCode

public int hashCode()

Yields a hash code for this type based on the values of X and Y.

Overrides:

hashCode in class Object

Returns:

A hashcode for the values of this instance.

moveBy

public final void moveBy(PointD delta)

Moves this instance by adding the provided offsets to the coordinates of this point.

Parameters:

delta - The offset to add to this point's x coordinate

normalize

public final void normalize()

Normalizes this point as if it was a vector.

After this the "length" of this point is 1.0d if it is treated as a vector.

See Also:

PointD.getNormalized()

setX

public final void setX(double value)

Sets the x coordinate.

Specified by:

setX in interface IMutablePoint

Parameters:

value - The X to set.

See Also:

getX()

setY

public final void setY(double value)

Sets the y coordinate.

Specified by:

setY in interface IMutablePoint

Parameters:

value - The Y to set.

See Also:

getY()

toString

public String toString()

Overrides:

toString in class Object