com.yworks.yfiles.geometry

Interface IMutableOrientedRectangle

All Superinterfaces:

IMutableSize, IOrientedRectangle, ISize

All Known Implementing Classes:

OrientedRectangle

public interface IMutableOrientedRectangle
extends IOrientedRectangle, IMutableSize

Interface for mutable oriented rectangles in 2D coordinate space with double precision coordinates.

See Also:

ISize, IOrientedRectangle, OrientedRectangle

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method and Description
double	getAnchorX() Gets the x coordinate for the anchor of the rectangle.
double	getAnchorY() Gets the y coordinate for the anchor of the rectangle.
default void	resize(ISize size) Sets the size of the rectangle to the provided value.
default void	resize(SizeD size) Sets the size of the rectangle to the provided value.
default void	setAnchor(PointD location) Sets the anchor vector of the oriented rectangle to the given value.
void	setAnchorX(double value) Sets the x coordinate for the anchor of the rectangle.
void	setAnchorY(double value) Sets the y coordinate for the anchor of the rectangle.
default void	setCenter(PointD center) Sets the center of the oriented rectangle to the given value.
void	setUpVector(double upx, double upy) Sets the orientation of this oriented rectangle by modifying the up vector components.
default void	setUpVector(PointD up) Sets up vector of the oriented rectangle to the given value.

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

contains, createTransform, getAnchorLocation, getBounds, getCenter, getDynamicCenter, getTopLeftLocation, getUp, getUpX, getUpY, hits, toSizeD

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

getHeight, getWidth, resize, setHeight, setWidth

Method Detail

getAnchorX

double getAnchorX()

Gets the x coordinate for the anchor of the rectangle.

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:

getAnchorX in interface IOrientedRectangle

Returns:

The AnchorX.

See Also:

setAnchorX(double)

getAnchorY

double getAnchorY()

Gets the y coordinate for the anchor of the rectangle.

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:

getAnchorY in interface IOrientedRectangle

Returns:

The AnchorY.

See Also:

setAnchorY(double)

resize

default void resize(ISize size)

Sets the size of the rectangle to the provided value.

Specified by:

resize in interface IMutableSize

Parameters:

size - The size to set.

resize

default void resize(SizeD size)

Sets the size of the rectangle to the provided value.

Specified by:

resize in interface IMutableSize

Parameters:

size - The size to set.

setAnchor

default void setAnchor(PointD location)

Sets the anchor vector of the oriented rectangle to the given value.

Parameters:

location - The coordinates of the new anchor location.

setAnchorX

void setAnchorX(double value)

Sets the x coordinate for the anchor of the rectangle.

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 AnchorX to set.

See Also:

getAnchorX()

setAnchorY

void setAnchorY(double value)

Sets the y coordinate for the anchor of the rectangle.

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 AnchorY to set.

See Also:

getAnchorY()

setCenter

default void setCenter(PointD center)

Sets the center of the oriented rectangle to the given value.

Parameters:

center - The coordinates of the new center.

setUpVector

void setUpVector(double upx,
                 double upy)

Sets the orientation of this oriented rectangle by modifying the up vector components.

It is up to the caller to assure that the values describe a vector of length 1.

Parameters:

upx - The x component of the normalized up vector.

upy - The y component of the normalized up vector.

See Also:

IOrientedRectangle.getUpX(), IOrientedRectangle.getUpY()

setUpVector

default void setUpVector(PointD up)

Sets up vector of the oriented rectangle to the given value.

Parameters:

up - The coordinates of the new up vector.