RectD (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.geometry.RectD

All Implemented Interfaces:

IPoint, IRectangle, ISize, com.yworks.yfiles.utils.IStruct, Cloneable
```
public final class RectD
extends Object
implements com.yworks.yfiles.utils.IStruct, IRectangle
```
An immutable struct that models a rectangle in 2-d Cartesian coordinate space with double coordinates.
This class differs from other possible implementation in the way negative width and height properties are handled and interpreted. Width and/or height values may be negative in which case the rectangle is considered empty and non-existent. Empty rectangles are not considered in union-like operations, whereas rectangles with width and height of 0.0d are. This class implements the IRectangle interface so that it can be used in methods that require that interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static RectD`	`EMPTY` An `empty` rectangle.
`double`	`height` Gets the height of the rectangle.
`static RectD`	`INFINITE` An infinite rectangle.
`double`	`width` Gets the width of the rectangle.
`double`	`x` Gets the X coordinate of the upper left corner of the rectangle.
`double`	`y` Gets the Y coordinate of the upper left corner of the rectangle.

Constructor Summary

Constructors
Constructor and Description
`RectD()`
`RectD(double x, double y, double width, double height)` Initializes a new instance.
`RectD(IRectangle rectangle)` Initializes a new instance of the `RectD` struct with the initial values obtained from the given rectangle.
`RectD(PointD p1, PointD p2)` Initializes a new instance using two point to define the bounds.
`RectD(PointD location, SizeD size)` Initializes a new instance using the `TopLeft` corner and the `Size`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RectD`	`add(RectD rectangle, PointD point)` Returns the union of the given rectangle and the given point.
`static RectD`	`add(RectD firstRectangle, RectD secondRectangle)` Returns the union of the given rectangles.
`boolean`	`contains(PointD point, double eps)` Determines whether this rectangle contains the specified point with respect to a given epsilon.
`static RectD`	`convertFrom(MutableRectangle rectangle)` Performs an explicit conversion from `MutableRectangle` to `RectD`.
`static MutableRectangle`	`convertToMutableRectangle(RectD rectangle)` Performs an explicit conversion from `RectD` to `MutableRectangle`.
`boolean`	`equals(Object other)` Indicates whether this instance and a specified object are equal.
`static boolean`	`equals(RectD firstRectangle, RectD secondRectangle)` Implements the equality operation on `RectD` comparing `x` and `y` and `width` and `height` for equality.
`PointD`	`findLineIntersection(PointD inner, PointD outer)` Finds the intersection between a rectangle and a line.
`static RectD`	`fromCenter(PointD center, SizeD size)` Creates a new instance given the center of the rectangle and its size.
`double`	`getArea()` Gets the area of this instance which is the product of `width` and `height`.
`PointD`	`getBottomLeft()` Gets the coordinates of the bottom left corner of the rectangle.
`PointD`	`getBottomRight()` Gets the coordinates of the bottom right corner of the rectangle.
`PointD`	`getCenter()` Gets the center of the rectangle using `CenterX` and `CenterY`.
`double`	`getCenterX()` Gets the center X coordinate of the rectangle.
`double`	`getCenterY()` Gets the center Y coordinate of the rectangle.
`RectD`	`getEnlarged(double size)` Creates an enlarged instance of this rectangle using the same insets for all sides.
`RectD`	`getEnlarged(InsetsD insets)` Creates an enlarged instance that is the same as this one but enlarged by the specified insets.
`double`	`getHeight()` Gets or sets the height of the rectangle.
`double`	`getMaxX()` Gets the coordinates of the right border for this struct.
`double`	`getMaxY()` Gets the coordinates of the lower border for this struct.
`double`	`getMinX()` Gets the X coordinates of the left side of this instance.
`double`	`getMinY()` Gets the Y coordinates of the top side of this instance.
`SizeD`	`getSize()` Gets the size of this instance.
`PointD`	`getTopLeft()` Gets the coordinates of the top left corner of the rectangle.
`PointD`	`getTopRight()` Gets the coordinates of the top right corner of the rectangle.
`RectD`	`getTransformed(Matrix2D transform)` Transforms this instance using specified transform storing the bounds in place.
`RectD`	`getTranslated(PointD delta)` Returns a translated instance of this which has modified `x` and `y` by the given amount.
`double`	`getWidth()` Gets or sets the width of the rectangle.
`double`	`getX()` Gets or sets the X coordinate of the upper left corner of the rectangle.
`double`	`getY()` Gets or sets the Y coordinate of the upper left corner of the rectangle.
`int`	`hashCode()` Returns the hash code for this instance.
`boolean`	`intersects(IOrientedRectangle rectangle, double eps)` Determines whether this rectangle intersects an `IOrientedRectangle`, given an epsilon.
`boolean`	`intersects(RectD rectangle)` Determines whether the bounds of this instance intersect with the bounds of the specified rectangle.
`boolean`	`intersectsLine(PointD start, PointD end)` Determines whether this rectangle intersects a line.
`boolean`	`intersectsPolyline(Iterable<IPoint> points)` Determines whether a rectangle intersects a polygonal line.
`boolean`	`isEmpty()` Gets a value indicating whether this instance is considered empty.
`boolean`	`isFinite()` Gets a value indicating whether this instance is finite.
`IMutableRectangle`	`toMutableRectangle()` Creates an `IMutableRectangle` using the values from this instance.
`PointD`	`toPointD()` Copies the current values of the coordinates of the point to a `PointD` struct.
`RectD`	`toRectD()` Copies the current values of the rectangle to `RectD` struct.
`SizeD`	`toSizeD()` Gets the current size of the rectangle as a `SizeD` struct.
`String`	`toString()` Creates a human readable from of this instance.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.yworks.yfiles.geometry.IRectangle
contains, contains, getDynamicCenter, getDynamicPoint

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

- Field Detail
  - EMPTY
```
public static final RectD EMPTY
```
    An empty rectangle.
    width and height are set to -1.0d, x and y are set to 0.0d.
  - height
```
public final double height
```
    Gets the height of the rectangle.
  - INFINITE
```
public static final RectD INFINITE
```
    An infinite rectangle.
    width and height are set to Double.POSITIVE_INFINITY, x and y are set to Double.NEGATIVE_INFINITY.
  - width
```
public final double width
```
    Gets the width of the rectangle.
  - x
```
public final double x
```
    Gets the X coordinate of the upper left corner of the rectangle.
  - y
```
public final double y
```
    Gets the Y coordinate of the upper left corner of the rectangle.
- Constructor Detail
  - RectD
```
public RectD()
```
  - RectD
```
public RectD(double x,
             double y,
             double width,
             double height)
```
    Initializes a new instance.
    
    Parameters:
    
    x - The x coordinate of the top left corner.
    
    y - The y coordinate of the top left corner.
    
    width - The width of the rectangle.
    
    height - The height of the rectangle.
  - RectD
```
public RectD(IRectangle rectangle)
```
    Initializes a new instance of the RectD struct with the initial values obtained from the given rectangle.
    
    Parameters:
    
    rectangle - The rectangle to retrieve the initial values from.
  - RectD
```
public RectD(PointD p1,
             PointD p2)
```
    Initializes a new instance using two point to define the bounds.
    This will always result in non-IsEmpty rectangles as the coordinates of the points are sorted so that the smaller gets assigned to x and y respectively and the greater ones define the width and height.
    
    Parameters:
    
    p1 - The first point to determine the bounds.
    
    p2 - The second point to determine the bounds.
  - RectD
```
public RectD(PointD location,
             SizeD size)
```
    Initializes a new instance using the TopLeft corner and the Size.
    
    Parameters:
    
    location - The top left corner.
    
    size - The size to use.
- Method Detail
  - add
```
public static final RectD add(RectD rectangle,
                              PointD point)
```
    Returns the union of the given rectangle and the given point.
    If rectangle IsEmpty, the point will be used to set the x and y coordinates and width and height will be set to 0.0d, making it non-empty.
    
    Parameters:
    
    rectangle - The rectangle to enlarge.
    
    point - The point to add to the rectangle.
    
    Returns:
    
    The union rectangle.
  - add
```
public static final RectD add(RectD firstRectangle,
                              RectD secondRectangle)
```
    Returns the union of the given rectangles.
    
    Parameters:
    
    firstRectangle - The first rectangle.
    
    secondRectangle - The second rectangle.
    
    Returns:
    
    The union rectangle.
  - contains
```
public final boolean contains(PointD point,
                              double eps)
```
    Determines whether this rectangle contains the specified point with respect to a given epsilon.
    
    Parameters:
    
    point - The point to test.
    
    eps - The positive epsilon distance that the point may lie outside the rectangle and still be considered contained.
    
    Returns:
    
    true if this rectangle contains the specified point; false otherwise. An empty instance never contains any point. A point is considered to be contained in the rectangle when the coordinates are not smaller than MinX and MinY minus eps nor greater than MaxX and MaxY plus eps.
  - convertFrom
```
public static final RectD convertFrom(MutableRectangle rectangle)
```
    Performs an explicit conversion from MutableRectangle to RectD.
    
    Parameters:
    
    rectangle - The rectangle to convert.
    
    Returns:
    
    The result of the conversion.
  - convertToMutableRectangle
```
public static final MutableRectangle convertToMutableRectangle(RectD rectangle)
```
    Performs an explicit conversion from RectD to MutableRectangle.
    
    Parameters:
    
    rectangle - The rectangle to convert.
    
    Returns:
    
    The result of the conversion.
  - equals
```
public boolean equals(Object other)
```
    Indicates whether this instance and a specified object are equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - Another object to compare to.
    
    Returns:
    
    true if other and this instance are the same type and represent the same value; otherwise, false.
  - equals
```
public static final boolean equals(RectD firstRectangle,
                                   RectD secondRectangle)
```
    Implements the equality operation on RectD comparing x and y and width and height for equality.
    
    Parameters:
    
    firstRectangle - The first operand.
    
    secondRectangle - The second operand.
    
    Returns:
    
    Whether the x, y, width, and height properties of the instances are equal.
  - findLineIntersection
```
public final PointD findLineIntersection(PointD inner,
                                         PointD outer)
```
    Finds the intersection between a rectangle and a line.
    
    Parameters:
    
    inner - The coordinates of a point lying inside the rectangle.
    
    outer - The coordinates of a point lying outside the rectangle.
    
    Returns:
    
    The intersection point if the inner point lies inside the rectangle, the outer point lies outside the rectangle and thus an intersection point has been found, or null otherwise.
  - fromCenter
```
public static final RectD fromCenter(PointD center,
                                     SizeD size)
```
    Creates a new instance given the center of the rectangle and its size.
    
    Parameters:
    
    center - The center to use.
    
    size - The size to assign.
    
    Returns:
    
    An instance whose center is set to center and size is size
  - getArea
```
public final double getArea()
```
    Gets the area of this instance which is the product of width and height.
    
    Returns:
    
    The area.
  - getBottomLeft
```
public final PointD getBottomLeft()
```
    Gets the coordinates of the bottom left corner of the rectangle.
    
    Specified by:
    
    getBottomLeft in interface IRectangle
    
    Returns:
    
    The bottom left corner, which is always x and MaxY.
  - getBottomRight
```
public final PointD getBottomRight()
```
    Gets the coordinates of the bottom right corner of the rectangle.
    
    Specified by:
    
    getBottomRight in interface IRectangle
    
    Returns:
    
    The bottom right corner, which is always MaxX and MaxY.
  - getCenter
```
public final PointD getCenter()
```
    Gets the center of the rectangle using CenterX and CenterY.
    
    Specified by:
    
    getCenter in interface IRectangle
    
    Returns:
    
    A copy of the center of the rectangle.
  - getCenterX
```
public final double getCenterX()
```
    Gets the center X coordinate of the rectangle.
    
    Returns:
    
    The center x coordinate, or x if the width is non-positive.
  - getCenterY
```
public final double getCenterY()
```
    Gets the center Y coordinate of the rectangle.
    
    Returns:
    
    The center y coordinate, or y if the height is non-positive.
  - getEnlarged
```
public final RectD getEnlarged(double size)
```
    Creates an enlarged instance of this rectangle using the same insets for all sides.
    If this instance IsEmpty, the result will be the same.
    
    Parameters:
    
    size - The inset to add to each of the sides to grow the new instance.
    
    See Also:
    
    getEnlarged(InsetsD)
  - getEnlarged
```
public final RectD getEnlarged(InsetsD insets)
```
    Creates an enlarged instance that is the same as this one but enlarged by the specified insets.
    If this instance IsEmpty, the same will be returned.
    
    Parameters:
    
    insets - The insets to use to add to the instance.
  - getHeight
```
public final double getHeight()
```
    Gets or sets the height of the rectangle.
    
    Specified by:
    
    getHeight in interface ISize
    
    Returns:
    
    The height. Negative values make the rectangle empty.
  - getMaxX
```
public final double getMaxX()
```
    Gets the coordinates of the right border for this struct.
    
    Specified by:
    
    getMaxX in interface IRectangle
    
    Returns:
    
    The maximum X value. This is either the sum of x and width or simply x if the width is non-positive.
  - getMaxY
```
public final double getMaxY()
```
    Gets the coordinates of the lower border for this struct.
    
    Specified by:
    
    getMaxY in interface IRectangle
    
    Returns:
    
    The maximum Y value. This is either the sum of y and height or simply y if the height is non-positive.
  - getMinX
```
public final double getMinX()
```
    Gets the X coordinates of the left side of this instance.
    
    Returns:
    
    The minimum X.
  - getMinY
```
public final double getMinY()
```
    Gets the Y coordinates of the top side of this instance.
    
    Returns:
    
    The minimum Y.
  - getSize
```
public final SizeD getSize()
```
    Gets the size of this instance.
    
    Returns:
    
    The size, which is width and height.
  - getTopLeft
```
public final PointD getTopLeft()
```
    Gets the coordinates of the top left corner of the rectangle.
    
    Specified by:
    
    getTopLeft in interface IRectangle
    
    Returns:
    
    The top left corner, which is always x and y.
  - getTopRight
```
public final PointD getTopRight()
```
    Gets the coordinates of the top right corner of the rectangle.
    
    Specified by:
    
    getTopRight in interface IRectangle
    
    Returns:
    
    The top right corner, which is always MaxX and y.
  - getTransformed
```
public final RectD getTransformed(Matrix2D transform)
```
    Transforms this instance using specified transform storing the bounds in place.
    
    Parameters:
    
    transform - The transform matrix to apply to this instance.
  - getTranslated
```
public final RectD getTranslated(PointD delta)
```
    Returns a translated instance of this which has modified x and y by the given amount.
    
    Parameters:
    
    delta - The delta to add to x and y.
  - getWidth
```
public final double getWidth()
```
    Gets or sets the width of the rectangle.
    
    Specified by:
    
    getWidth in interface ISize
    
    Returns:
    
    The width. Negative values make the rectangle empty.
  - getX
```
public final double getX()
```
    Gets or sets the X coordinate of the upper left corner of the rectangle.
    
    Specified by:
    
    getX in interface IPoint
    
    Returns:
    
    The X coordinate.
  - getY
```
public final double getY()
```
    Gets or sets the Y coordinate of the upper left corner of the rectangle.
    
    Specified by:
    
    getY in interface IPoint
    
    Returns:
    
    The Y coordinate.
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this instance.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    A 32-bit signed integer that is the hash code for this instance. The hash code is computed using the x, y, width, and height property.
  - intersects
```
public final boolean intersects(IOrientedRectangle rectangle,
                                double eps)
```
    Determines whether this rectangle intersects an IOrientedRectangle, given an epsilon.
    
    Parameters:
    
    rectangle - The IOrientedRectangle to test.
    
    eps - 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:
    
    Whether they have a non-empty intersection.
  - intersects
```
public final boolean intersects(RectD rectangle)
```
    Determines whether the bounds of this instance intersect with the bounds of the specified rectangle.
    
    Parameters:
    
    rectangle - The rectangle to check.
    
    Returns:
    
    Whether both instance are non-empty and have an intersection with positive Area.
  - intersectsLine
```
public final boolean intersectsLine(PointD start,
                                    PointD end)
```
    Determines whether this rectangle intersects a line.
    
    Parameters:
    
    start - The first end point of the line.
    
    end - The second end point of the line.
    
    Returns:
    
    Whether the line intersects the rectangle.
  - intersectsPolyline
```
public final boolean intersectsPolyline(Iterable<IPoint> points)
```
    Determines whether a rectangle intersects a polygonal line.
    
    Parameters:
    
    points - The list of points that is interpreted as a number of line segments.
    
    Returns:
    
    true if the rectangle intersects at least one segment of the line.
  - isEmpty
```
public final boolean isEmpty()
```
    Gets a value indicating whether this instance is considered empty.
    Yields true if this at least one of width or height is negative; false otherwise. Note that a width and height of both 0.0d is not considered empty for this implementation.
    
    Specified by:
    
    isEmpty in interface IRectangle
    
    Returns:
    
    The IsEmpty.
  - isFinite
```
public final boolean isFinite()
```
    Gets a value indicating whether this instance is finite.
    
    Returns:
    
    true if this both width and height are not infinity; false otherwise.
  - toMutableRectangle
```
public final IMutableRectangle toMutableRectangle()
```
    Creates an IMutableRectangle using the values from this instance.
    
    Returns:
    
    An instance that has been initialized from the values of this struct.
  - toPointD
```
public PointD toPointD()
```
    Description copied from interface: IPoint
    
    Copies the current values of the coordinates of the point to a PointD struct.
    This method is useful to obtain a copy of the state and for making use of the various utility methods that are provided by PointD.
    
    Specified by:
    
    toPointD in interface IPoint
    
    Returns:
    
    The current values of the coordinates of the point.
    
    See Also:
    
    PointD.toMutablePoint(), IMutablePoint.relocate(PointD)
  - toRectD
```
public RectD toRectD()
```
    Description copied from interface: IRectangle
    
    Copies the current values of the rectangle to RectD struct.
    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 RectD type.
    
    Specified by:
    
    toRectD in interface IRectangle
    
    Returns:
    
    A RectD that holds the values of the rectangle at the time of the invocation.
    
    See Also:
    
    IMutableRectangle.reshape(double, double, double, double), toMutableRectangle()
  - toSizeD
```
public SizeD toSizeD()
```
    Description copied from interface: IRectangle
    
    Gets the current size of the rectangle as a SizeD struct.
    
    Specified by:
    
    toSizeD in interface IRectangle
    
    Specified by:
    
    toSizeD in interface ISize
    
    Returns:
    
    The current size of the rectangle.
  - toString
```
public String toString()
```
    Creates a human readable from of this instance.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string describing the properties of this instance.

Class RectD

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Field Detail

EMPTY

height

INFINITE

width

x

y

Constructor Detail

RectD

RectD

RectD

RectD

RectD

Method Detail

add

add

contains

convertFrom

convertToMutableRectangle

equals

equals

findLineIntersection

fromCenter

getArea

getBottomLeft

getBottomRight

getCenter

getCenterX

getCenterY

getEnlarged

getEnlarged

getHeight

getMaxX

getMaxY

getMinX

getMinY

getSize

getTopLeft

getTopRight

getTransformed

getTranslated

getWidth

getX

getY

hashCode

intersects

intersects

intersectsLine

intersectsPolyline

isEmpty

isFinite

toMutableRectangle

toPointD

toRectD

toSizeD

toString