com.yworks.yfiles.geometry

Class MutableRectangle

java.lang.Object

com.yworks.yfiles.geometry.MutableRectangle

All Implemented Interfaces:

IMutablePoint, IMutableRectangle, IMutableSize, IOrientedRectangle, IPoint, IRectangle, ISize, ICloneable

public final class MutableRectangle
extends Object
implements IMutableRectangle, IOrientedRectangle, ICloneable

A simple default implementation of a mutable rectangle in 2D coordinate space with double precision values stored in an instance of IMutablePoint and IMutableSize.

This implementation delegates the storage to implementations of IMutablePoint for the upper left corner of the rectangle and IMutableSize for the size of the rectangle. members. As a convenience it implements the IOrientedRectangle, and the ICloneable interfaces.

See Also:

IRectangle, IMutableRectangle

Field Summary

Fields inherited from interface com.yworks.yfiles.geometry.IOrientedRectangle

EMPTY

Constructor Summary

Constructors

Constructor and Description
MutableRectangle() Creates a new empty instance located at the origin with width and height set to -1.
MutableRectangle(double x, double y, double width, double height) Creates a new instance using the provided values to initialize the position and size.
MutableRectangle(IMutablePoint location, IMutableSize size) Creates a new instance using the provided implementation for the storage of the position and size of the rectangle.
MutableRectangle(IRectangle rectangle) Creates a new instance initialized to the values of the provided argument.
MutableRectangle(PointD location, SizeD size) Creates a new instance using the provided values to initialize the position and size.

Method Summary

Modifier and Type	Method and Description
MutableRectangle	clone() Creates a copy of the current state of this instance using a new MutablePoint and Size to store the position and size.
boolean	equals(IRectangle other)
boolean	equals(Object other) Implements the equals method by comparing the given object's values.
double	getAnchorX() Implements the IOrientedRectangle and will return the x coordinate of the Location.
double	getAnchorY() Implements the IOrientedRectangle and will return the y coordinate of the Location plus the Height.
PointD	getCenter() Gets the coordinates of the center of the rectangle as a PointD.
IMutablePoint	getDynamicCenter() Create a dynamic IMutablePoint implementation that always points to the center of the given rectangle.
double	getHeight() Gets the height of this instance from the Size instance.
IPoint	getLocation() Returns the instance that stores the position of this rectangle.
ISize	getSize() Returns the instance that stores the size of this rectangle.
double	getUpX() Always returns 0.
double	getUpY() Always returns -1.
double	getWidth() Gets the width of this instance from the Size instance.
double	getX() Gets the x coordinate of the upper left corner of this instance from the Location instance.
double	getX2() Gets the x coordinate of the lower right corner of this instance using the Location and Size instances.
double	getY() Gets the y coordinate of the upper left corner of this instance from the Location instance.
double	getY2() Gets the y coordinate of the lower right corner of this instance using the Location and Size instances.
boolean	isEmpty() Returns whether this instance has negative width or height.
void	moveBy(PointD delta) Moves this rectangle by applying the offset to the Location.
void	setAnchorX(double value) Implements the IOrientedRectangle and will return the x coordinate of the Location.
void	setAnchorY(double value) Implements the IOrientedRectangle and will return the y coordinate of the Location plus the Height.
void	setHeight(double value) Sets the height of this instance from the Size instance.
void	setLocation(IPoint value) Returns the instance that stores the position of this rectangle.
void	setSize(ISize value) Returns the instance that stores the size of this rectangle.
void	setWidth(double value) Sets the width of this instance from the Size instance.
void	setX(double value) Sets the x coordinate of the upper left corner of this instance from the Location instance.
void	setX2(double value) Sets the x coordinate of the lower right corner of this instance using the Location and Size instances.
void	setY(double value) Sets the y coordinate of the upper left corner of this instance from the Location instance.
void	setY2(double value) Sets the y coordinate of the lower right corner of this instance using the Location and Size instances.
SizeD	toSizeD() Gets the current size of the rectangle as a SizeD struct.
String	toString()

Methods inherited from class java.lang.Object

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

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

add, add, reshape, reshape, reshape, reshape, resize, setCenter, setToUnion

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

resize, resize

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

relocate, relocate, relocate

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

contains, contains, getBottomLeft, getBottomRight, getDynamicPoint, getMaxX, getMaxY, getTopLeft, getTopRight, toRectD

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

distanceTo, toPointD

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

contains, createTransform, getAnchorLocation, getBounds, getTopLeftLocation, getUp, hits

Constructor Detail

MutableRectangle

public MutableRectangle()

Creates a new empty instance located at the origin with width and height set to -1.

MutableRectangle

public MutableRectangle(double x,
                        double y,
                        double width,
                        double height)

Creates a new instance using the provided values to initialize the position and size.

An instance of MutablePoint will be used to store the position and an instance of Size will be used to store the size.

Parameters:

x - The x coordinate of the upper left corner of the rectangle.

y - The y coordinate of the upper left corner of the rectangle.

width - The width of the rectangle.

height - The height of the rectangle.

MutableRectangle

public MutableRectangle(IMutablePoint location,
                        IMutableSize size)

Creates a new instance using the provided implementation for the storage of the position and size of the rectangle.

The instances provided will be referenced by this instance. This instance will be used as a live view over the provided instances. Changes to them will indirectly change the state of this instance and changes applied through this instance will be written to the referenced implementations.

Parameters:

location - The provider for the dynamic position of this instance.

size - The provider for the dynamic size of this instance.

MutableRectangle

public MutableRectangle(IRectangle rectangle)

Creates a new instance initialized to the values of the provided argument.

MutableRectangle

public MutableRectangle(PointD location,
                        SizeD size)

Creates a new instance using the provided values to initialize the position and size.

An instance of MutablePoint will be used to store the position and an instance of Size will be used to store the size.

Parameters:

location - The coordinates of the upper left corner of the rectangle.

size - The size of the rectangle.

Method Detail

clone

public final MutableRectangle clone()

Creates a copy of the current state of this instance using a new MutablePoint and Size to store the position and size.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

A new instance of MutableRectangle

See Also:

Object.clone()

equals

public final boolean equals(IRectangle other)

equals

public boolean equals(Object other)

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

Note that RectD 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:

other - 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.

getAnchorX

public final double getAnchorX()

Implements the IOrientedRectangle and will return the x coordinate of the Location.

This implementation behaves like an IOrientedRectangle that is anchored at the lower left corner of this rectangle and whose up vector is (0, -1).

Specified by:

getAnchorX in interface IOrientedRectangle

Returns:

The AnchorX.

See Also:

setAnchorX(double)

getAnchorY

public final double getAnchorY()

Implements the IOrientedRectangle and will return the y coordinate of the Location plus the Height.

This implementation behaves like an IOrientedRectangle that is anchored at the lower left corner of this rectangle and whose up vector is (0, -1).

Specified by:

getAnchorY in interface IOrientedRectangle

Returns:

The AnchorY.

See Also:

setAnchorY(double)

getCenter

public PointD getCenter()

Gets the coordinates of the center of the rectangle as a PointD.

Specified by:

getCenter in interface IOrientedRectangle

Specified by:

getCenter in interface IRectangle

Returns:

The current coordinates of the center.

getDynamicCenter

public IMutablePoint getDynamicCenter()

Create a dynamic IMutablePoint implementation that always points to the center of the given rectangle. Modifying the point's x and y coordinates, will in fact move the rectangle's position accordingly.

This method delegates to RectangleExtensions.getDynamicCenter(IMutableRectangle).

Specified by:

getDynamicCenter in interface IMutableRectangle

Specified by:

getDynamicCenter in interface IOrientedRectangle

Specified by:

getDynamicCenter in interface IRectangle

Returns:

A live view of the rectangle's center.

getHeight

public final double getHeight()

Gets the height of this instance from the Size instance.

Note that that depending on the implementation used for holding the size the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Specified by:

getHeight in interface IMutableSize

Specified by:

getHeight in interface ISize

Returns:

The Height.

See Also:

setHeight(double)

getLocation

public final IPoint getLocation()

Returns the instance that stores the position of this rectangle.

This will return a live view of the position of this rectangle. However setting a position instance will only copy the values of the point provided to the current position.

Returns:

The Location.

See Also:

setLocation(IPoint)

getSize

public final ISize getSize()

Returns the instance that stores the size of this rectangle.

This will return a live view of the size of this rectangle. However setting a size instance will only copy the values of the size provided to the current size.

Returns:

The Size.

See Also:

setSize(ISize)

getUpX

public final double getUpX()

Always returns 0.

This implementation behaves like an IOrientedRectangle that is anchored at the lower left corner of this rectangle and whose up vector is (0, -1).

Specified by:

getUpX in interface IOrientedRectangle

Returns:

The UpX.

getUpY

public final double getUpY()

Always returns -1.

This implementation behaves like an IOrientedRectangle that is anchored at the lower left corner of this rectangle and whose up vector is (0, -1).

Specified by:

getUpY in interface IOrientedRectangle

Returns:

The UpY.

getWidth

public final double getWidth()

Gets the width of this instance from the Size instance.

Note that depending on the implementation used for holding the size the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Specified by:

getWidth in interface IMutableSize

Specified by:

getWidth in interface ISize

Returns:

The Width.

See Also:

setWidth(double)

getX

public final double getX()

Gets the x coordinate of the upper left corner of this instance from the Location instance.

Note that depending on the implementation used for holding the position the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Specified by:

getX in interface IMutablePoint

Specified by:

getX in interface IPoint

Returns:

The X.

See Also:

setX(double)

getX2

public final double getX2()

Gets the x coordinate of the lower right corner of this instance using the Location and Size instances.

Setting this value will update the width accordingly. Note that depending on the implementation used for holding the Size the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Returns:

The X2.

See Also:

setX2(double)

getY

public final double getY()

Gets the y coordinate of the upper left corner of this instance from the Location instance.

Note that depending on the implementation used for holding the position the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Specified by:

getY in interface IMutablePoint

Specified by:

getY in interface IPoint

Returns:

The Y.

See Also:

setY(double)

getY2

public final double getY2()

Gets the y coordinate of the lower right corner of this instance using the Location and Size instances.

Setting this value will update the height accordingly. Note that depending on the implementation used for holding the Size the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Returns:

The Y2.

See Also:

setY2(double)

isEmpty

public final boolean isEmpty()

Returns whether this instance has negative width or height.

Specified by:

isEmpty in interface IRectangle

Returns:

The IsEmpty.

moveBy

public final void moveBy(PointD delta)

Moves this rectangle by applying the offset to the Location.

Parameters:

delta - The offset to move the rectangle's position by.

setAnchorX

public final void setAnchorX(double value)

Implements the IOrientedRectangle and will return the x coordinate of the Location.

This implementation behaves like an IOrientedRectangle that is anchored at the lower left corner of this rectangle and whose up vector is (0, -1).

Parameters:

value - The AnchorX to set.

See Also:

getAnchorX()

setAnchorY

public final void setAnchorY(double value)

Implements the IOrientedRectangle and will return the y coordinate of the Location plus the Height.

This implementation behaves like an IOrientedRectangle that is anchored at the lower left corner of this rectangle and whose up vector is (0, -1).

Parameters:

value - The AnchorY to set.

See Also:

getAnchorY()

setHeight

public final void setHeight(double value)

Sets the height of this instance from the Size instance.

Note that that depending on the implementation used for holding the size the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Specified by:

setHeight in interface IMutableSize

Parameters:

value - The Height to set.

See Also:

getHeight()

setLocation

public final void setLocation(IPoint value)

Returns the instance that stores the position of this rectangle.

This will return a live view of the position of this rectangle. However setting a position instance will only copy the values of the point provided to the current position.

Parameters:

value - The Location to set.

See Also:

getLocation()

setSize

public final void setSize(ISize value)

Returns the instance that stores the size of this rectangle.

This will return a live view of the size of this rectangle. However setting a size instance will only copy the values of the size provided to the current size.

Parameters:

value - The Size to set.

See Also:

getSize()

setWidth

public final void setWidth(double value)

Sets the width of this instance from the Size instance.

Note that depending on the implementation used for holding the size the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Specified by:

setWidth in interface IMutableSize

Parameters:

value - The Width to set.

See Also:

getWidth()

setX

public final void setX(double value)

Sets the x coordinate of the upper left corner of this instance from the Location instance.

Note that depending on the implementation used for holding the position the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Specified by:

setX in interface IMutablePoint

Parameters:

value - The X to set.

See Also:

getX()

setX2

public final void setX2(double value)

Sets the x coordinate of the lower right corner of this instance using the Location and Size instances.

Setting this value will update the width accordingly. Note that depending on the implementation used for holding the Size the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Parameters:

value - The X2 to set.

See Also:

getX2()

setY

public final void setY(double value)

Sets the y coordinate of the upper left corner of this instance from the Location instance.

Note that depending on the implementation used for holding the position the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Specified by:

setY in interface IMutablePoint

Parameters:

value - The Y to set.

See Also:

getY()

setY2

public final void setY2(double value)

Sets the y coordinate of the lower right corner of this instance using the Location and Size instances.

Setting this value will update the height accordingly. Note that depending on the implementation used for holding the Size the results may vary. However the default implementation will do just that: read and write the values without modifying them in any way.

Parameters:

value - The Y2 to set.

See Also:

getY2()

toSizeD

public SizeD toSizeD()

Gets the current size of the rectangle as a SizeD struct.

This method delegates to RectangleExtensions.toSizeD(IRectangle).

Specified by:

toSizeD in interface IOrientedRectangle

Specified by:

toSizeD in interface IRectangle

Specified by:

toSizeD in interface ISize

Returns:

The current size of the rectangle.

toString

public String toString()

Overrides:

toString in class Object