MutableRectangle

Show usages

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

Inheritance Hierarchy

MutableRectangle

Implemented Interfaces

Remarks

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.

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.geometry.MutableRectangle

Constructors

MutableRectangle

(location: IMutablePoint, size: IMutableSize)

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

Remarks

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

options - Object
A map of options to pass to the method.

location - IMutablePoint: The provider for the dynamic position of this instance.
size - IMutableSize: The provider for the dynamic size of this instance.

MutableRectangle

(x: number, y: number, width: number, height: number)

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

Remarks

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

Parameters

options - Object
A map of options to pass to the method.

x - number: The x coordinate of the upper left corner of the rectangle.
y - number: The y coordinate of the upper left corner of the rectangle.
width - number: The width of the rectangle.
height - number: The height of the rectangle.

MutableRectangle

(location: Point, size: Size)

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

Remarks

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

Parameters

options - Object
A map of options to pass to the method.

location - Point: The coordinates of the upper left corner of the rectangle.
size - Size: The size of the rectangle.

MutableRectangle

()

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

MutableRectangle

(rectangle: IRectangle)

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

Properties

anchorLocation

: Point

Gets the anchor location of the oriented rectangle as a Point struct.

Defined in

IOrientedRectangle

anchorX

: number

Gets the x coordinate of the location.

Remarks

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

Implements

IOrientedRectangle

anchorY

: number

Gets the y coordinate of the location plus the height.

Remarks

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

Implements

IOrientedRectangle

bottomLeft

: Point

Gets the coordinates of the bottom left corner of the rectangle as a Point.

Overrides

IRectangle.bottomLeft

bottomRight

: Point

Gets the coordinates of the bottom right corner of the rectangle as a Point.

Overrides

IRectangle.bottomRight

bounds

: Rect

Determines the bounds of an oriented rectangle.

Remarks

Bounding rectangles are parallel to the coordinate axes.

Defined in

IOrientedRectangle

center

: Point

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

Overrides

IRectangle.center

height

: number

Gets or sets the height of this instance from the size instance.

Remarks

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.

Implements

ISize

isEmpty

: boolean

Gets whether this instance has negative width or height.

Overrides

IRectangle.isEmpty

location

: IPoint

Gets the position of this rectangle.

Remarks

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.

maxX

: number

Gets the maximum X coordinate of the rectangle.

Remarks

This is the x coordinate of the right side of the rectangle, or the left side if the rectangle is isEmpty.

Overrides

IRectangle.maxX

maxY

: number

Gets the maximum Y coordinate of the rectangle.

Remarks

This is the y coordinate of the bottom side of the rectangle, or the top side if the rectangle is isEmpty.

Overrides

IRectangle.maxY

orientedRectangleCenter

: Point

Gets the current center of the oriented rectangle as a Point struct.

Defined in

IOrientedRectangle

size

: ISize

Gets the size of this rectangle.

Remarks

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.

topLeft

: Point

Gets the coordinates of the top left corner of the rectangle as a Point.

Overrides

IRectangle.topLeft

topRight

: Point

Gets the coordinates of the top right corner of the rectangle as a Point.

Overrides

IRectangle.topRight

upVector

: Point

Gets the up vector of the oriented rectangle as a Point struct.

Defined in

IOrientedRectangle

upX

: number

Gets the x value of the up vector which is always 0

Remarks

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

Implements

IOrientedRectangle

upY

: number

Gets the y value of the up vector which is always -1

Remarks

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

Implements

IOrientedRectangle

width

: number

Gets or sets the width of this instance from the size instance.

Remarks

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.

Implements

ISize

x

: number

Gets or sets the x coordinate of the upper left corner of this instance from the location instance.

Remarks

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.

Implements

IPoint

x2

: number

Gets or sets the x coordinate of the lower right corner of this instance using the location and size instances.

Remarks

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.

y

: number

Gets or sets the y coordinate of the upper left corner of this instance from the location instance.

Remarks

Implements

IPoint

y2

: number

Gets or sets the y coordinate of the lower right corner of this instance using the location and size instances.

Remarks

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.

Methods

add

(rectangle2: IRectangle)

Adds a rectangle to another one.

Remarks

The result is placed into the first rectangle, which is returned. If either of the two rectangles is empty, i.e. its width or height is negative, the result will be the other rectangle. If either of the two rectangles is infinite, i.e. its width or height is positive infinity, the result is an infinite rectangle.

Parameters

options - Object
A map of options to pass to the method.

rectangle2 - IRectangle: The rectangle to be added.

Defined in

IMutableRectangle

add

(point: IPoint)

Adds a point to a rectangle, possibly enlarging the rectangle.

Remarks

If the rectangle is initially empty, i.e. its width or height is negative, the bounds of the rectangle will be set to (p.x, p.y, 0, 0)

Parameters

options - Object
A map of options to pass to the method.

point - IPoint: The coordinate to include in the bounds.

Defined in

IMutableRectangle

clone

() : Object

Create a clone of this object.

Returns

↪Object: A clone of this object.

Implements

ICloneable

contains

(point: IPoint) : boolean

Determines whether the given rectangle contains the provided point.

Parameters

options - Object
A map of options to pass to the method.

point - IPoint: The point to test.

Returns

↪boolean: true iff the point lies inside the rectangle.

Overrides

IRectangle.contains

containsWithEps

(point: Point, eps: number) : boolean

Determines whether the given oriented rectangle contains the provided point, using an epsilon value.

Parameters

options - Object
A map of options to pass to the method.

point - Point: The coordinates of the point to test.
eps - number: A positive value allows for fuzzy hit testing. If the point lies outside the given object but it's distance is less than or equal to that value, it will be considered a hit.

Returns

↪boolean: true iff the point lies inside the rectangle.

Defined in

IOrientedRectangle

createTransform

() : Matrix

Creates a transformation matrix that can be used to transform points that are in the local coordinate system of the oriented rectangle if the top-left corner is the origin.

Returns

↪Matrix: A matrix that can be used to transform from oriented rectangle coordinates to world coordinates.

Defined in

IOrientedRectangle

distanceTo

(point2: IPoint) : number

Calculates the Euclidean distance between two points.

Parameters

options - Object
A map of options to pass to the method.

point2 - IPoint: The second point.

Returns

↪number: The distance between the two points.

Overrides

IPoint.distanceTo

equals

(other: Object) : boolean

Determines whether another object is equal to this one.

Parameters

options - Object
A map of options to pass to the method.

other - Object: the other object to compare for equality

Returns

↪boolean: true if other is considered equal to this instance.

getEnlarged

(padding: Insets) : OrientedRectangle

Creates an enlarged instance that is the same as this one but enlarged by the specified padding.

Parameters

options - Object
A map of options to pass to the method.

padding - Insets: The padding to use to add to the instance.

Returns

↪OrientedRectangle: A new OrientedRectangle instance which is enlarged by the given padding.

Defined in

IOrientedRectangle

hashCode

() : number

Returns a hash code for this object.

Remarks

The hash code is a numeric value that can be used to treat this object as a key in a hash table or similar data structure.

Two objects that are considered equal must have the same hash code. However, the reverse does not hold and two objects having the same hash code don't have to be equal. Ideally, the hash code should be roughly uniformly-distributed to prevent hash tables from performing poorly. Calculating the hash code is also a potentially frequent operation and should therefore be fast.

Returns

↪number: the hash code for this object

hits

(location: Point, eps: number) : boolean

Determines whether the oriented rectangle contains the provided point, using an epsilon value.

Parameters

options - Object
A map of options to pass to the method.

location - Point: The coordinates of the point to test.
eps - number: A positive value allows for fuzzy hit testing. If the point lies outside the given object but it's distance is less than or equal to that value, it will be considered a hit.

Returns

↪boolean: true iff the point lies inside the rectangle.

Defined in

IOrientedRectangle

moveBy

(delta: Point)

Moves this rectangle by applying the offset to the location

Parameters

options - Object
A map of options to pass to the method.

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

relocate

(x: number, y: number)

Sets the coordinates of the point to the given values.

Parameters

options - Object
A map of options to pass to the method.

x - number: The new x coordinate
y - number: The new y coordinate

Overrides

IMutablePoint.relocate(number,number)

relocate

(location: IPoint)

Sets the coordinates of the point to the given values.

Parameters

options - Object
A map of options to pass to the method.

location - IPoint: The new location.

Overrides

IMutablePoint.relocate(yfiles.geometry.IPoint)

reshape

(x: number, y: number, width: number, height: number)

Applies a new position and size to a given mutable rectangle.

Parameters

options - Object
A map of options to pass to the method.

x - number: The new x coordinate of the upper left corner of the rectangle.
y - number: The new y coordinate of the upper left corner of the rectangle.
width - number: The new width of the rectangle.
height - number: The new height of the rectangle.

Defined in

IMutableRectangle

reshape

(newRectangle: IRectangle)

Applies a new position and size to a given mutable rectangle.

Parameters

options - Object
A map of options to pass to the method.

newRectangle - IRectangle: The bounds to set to the rectangle.

Defined in

IMutableRectangle

reshape

(position: IPoint, size: ISize)

Applies a new position and size to a given mutable rectangle.

Parameters

options - Object
A map of options to pass to the method.

position - IPoint: The new location.
size - ISize: The new size.

Defined in

IMutableRectangle

resize

(newWidth: number, newHeight: number)

Sets the coordinates of the size to the given values.

Parameters

options - Object
A map of options to pass to the method.

newWidth - number: The new x coordinate
newHeight - number: The new y coordinate

Overrides

IMutableSize.resize(number,number)

resize

(newSize: ISize)

Sets the coordinates of the size to the given values.

Parameters

options - Object
A map of options to pass to the method.

newSize - ISize: The new location.

Overrides

IMutableSize.resize(yfiles.geometry.ISize)

setCenter

(center: Point)

Sets the center of the rectangle to the provided value.

Parameters

options - Object
A map of options to pass to the method.

center - Point: The new center coordinates.

Defined in

IMutableRectangle

setToUnion

(rectangle1: IRectangle, rectangle2: IRectangle)

Creates the union of two rectangles, placing the result in the this parameter.

Remarks

Either of the two parameters rectangles may be the same as the first parameter. The result is placed into the this parameter. This method treats rectangles with negative width or height as empty. If one of the rectangles is an infinite rectangle, an infinite rectangle is returned.

Parameters

options - Object
A map of options to pass to the method.

rectangle1 - IRectangle: The first rectangle to create the union of.
rectangle2 - IRectangle: The second rectangle to create the union of.

This method is not available unless the module view-layout-bridge is loaded. Either load the module 'view-layout-bridge' explicitly or call Class.ensure(LayoutExecutor) More information.

Defined in

IOrientedRectangle

toPoint

() : Point

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

Remarks

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

Returns

↪Point: The current values of the coordinates of the point.

Overrides

IPoint.toPoint

toRect

() : Rect

Copies the current values of the rectangle to Rect struct.

Remarks

This method can be used to obtain a copy of the current state of the rectangle and for using the utility methods that are available for the Rect type.

Returns

↪Rect: A Rect that holds the values of the rectangle at the time of the invocation.

Overrides

IRectangle.toRect

toSize

() : Size

Converts the ISize to a Size struct.

Returns

↪Size: A Size struct that has been initialized with the current values of size.

Overrides

ISize.toSize

toString

() : string

Returns a string representation for this object.

Returns

↪string: a string describing this object

MutableRectangle

Remarks

Type Details

See Also

Constructors

MutableRectangle

Remarks

Parameters

MutableRectangle

Remarks

Parameters

MutableRectangle

Remarks

Parameters

MutableRectangle

MutableRectangle

Properties

anchorLocation

Defined in

anchorX

Remarks

Implements

anchorY

Remarks

Implements

bottomLeft

Overrides

bottomRight

Overrides

bounds

Remarks

Defined in

center

Overrides

height

Remarks

See Also

Implements

isEmpty

Overrides

location

Remarks

maxX

Remarks

Overrides

maxY

Remarks

Overrides

orientedRectangleCenter

Defined in

size

Remarks

topLeft

Overrides

topRight

Overrides

upVector

Defined in

upX

Remarks

Implements

upY

Remarks

Implements

width

Remarks

See Also

Implements

x

Remarks

See Also

Implements

x2

Remarks

y

Remarks

See Also

Implements

y2

Remarks