Rectangle5D

java.lang.Object
- icy.type.rectangle.Rectangle5D

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Rectangle5D.Double, Rectangle5D.Float, Rectangle5D.Integer
```
public abstract class Rectangle5D
extends java.lang.Object
implements java.lang.Cloneable
```
Rectangle5D class.
Incomplete implementation (work in progress...)

Author:

Stephane

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Rectangle5D.Double

static class Rectangle5D.Float

static class Rectangle5D.Integer

Nested Classes
Modifier and Type	Class and Description
`static class`	`Rectangle5D.Double`
`static class`	`Rectangle5D.Float`
`static class`	`Rectangle5D.Integer`

Constructor Summary

Constructors
Constructor and Description

Rectangle5D()

Constructors
Constructor and Description
`Rectangle5D()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(double newx, double newy, double newz, double newt, double newc)` Adds a 5D point, specified by the double precision coordinates arguments, to this `Rectangle5D`.
`void`	`add(Point5D pt)` Adds the `Point5D` object `pt` to this `Rectangle5D`.
`void`	`add(Rectangle5D r)` Adds a `Rectangle5D` object to this `Rectangle5D`.
`java.lang.Object`	`clone()` Creates a new object of the same class as this object.
`boolean`	`contains(double x, double y, double z, double t, double c)` Tests if the specified coordinates are inside the boundary of the `Rectangle5D`.
`boolean`	`contains(double x, double y, double z, double t, double c, double sizeX, double sizeY, double sizeZ, double sizeT, double sizeC)` Tests if the `Rectangle5D` entirely contains the specified 5D rectangular area.
`boolean`	`contains(Rectangle5D rect)` Tests if the `Rectangle5D` entirely contains the specified `Rectangle5D`.
`abstract Rectangle5D`	`createIntersection(Rectangle5D r)` Returns a new `Rectangle5D` object representing the intersection of this `Rectangle5D` with the specified `Rectangle5D`.
`abstract Rectangle5D`	`createUnion(Rectangle5D r)` Returns a new `Rectangle5D` object representing the union of this `Rectangle5D` with the specified `Rectangle5D`.
`boolean`	`equals(java.lang.Object obj)`
`abstract double`	`getC()` Returns the minimum C coordinate.
`double`	`getCenterC()` Returns the C coordinate of the center of the rectangle.
`double`	`getCenterT()` Returns the T coordinate of the center of the rectangle.
`double`	`getCenterX()` Returns the X coordinate of the center of the rectangle.
`double`	`getCenterY()` Returns the Y coordinate of the center of the rectangle.
`double`	`getCenterZ()` Returns the Z coordinate of the center of the rectangle.
`abstract Dimension5D`	`getDimension()` Returns the dimension.
`double`	`getMaxC()` Returns the largest C coordinate of the rectangle.
`double`	`getMaxT()` Returns the largest T coordinate of the rectangle.
`double`	`getMaxX()` Returns the largest X coordinate of the rectangle.
`double`	`getMaxY()` Returns the largest Y coordinate of the rectangle.
`double`	`getMaxZ()` Returns the largest Z coordinate of the rectangle.
`double`	`getMinC()` Returns the smallest C coordinate of the rectangle.
`double`	`getMinT()` Returns the smallest T coordinate of the rectangle.
`double`	`getMinX()` Returns the smallest X coordinate of the rectangle.
`double`	`getMinY()` Returns the smallest Y coordinate of the rectangle.
`double`	`getMinZ()` Returns the smallest Z coordinate of the rectangle.
`abstract Point5D`	`getPosition()` Returns the point coordinate.
`abstract double`	`getSizeC()` Returns the size of C dimension.
`abstract double`	`getSizeT()` Returns the size of T dimension.
`abstract double`	`getSizeX()` Returns the size of X dimension.
`abstract double`	`getSizeY()` Returns the size of Y dimension.
`abstract double`	`getSizeZ()` Returns the size of Z dimension.
`abstract double`	`getT()` Returns the minimum T coordinate.
`abstract double`	`getX()` Returns the minimum X coordinate.
`abstract double`	`getY()` Returns the minimum Y coordinate.
`abstract double`	`getZ()` Returns the minimum Z coordinate.
`int`	`hashCode()`
`static Rectangle5D`	`intersect(Rectangle5D src1, Rectangle5D src2, Rectangle5D dest)` Intersects the pair of specified source `Rectangle5D` objects and puts the result into the specified destination `Rectangle5D` object.
`boolean`	`intersects(double x, double y, double z, double t, double c, double sizeX, double sizeY, double sizeZ, double sizeT, double sizeC)` Tests if the interior of the `Rectangle5D` intersects the interior of a specified 5D rectangular area.
`boolean`	`intersects(Rectangle5D rect)` Tests if the interior of the `Rectangle5D` intersects the interior of a specified `Rectangle5D`.
`boolean`	`isEmpty()` Determines whether the `Rectangle5D` is empty.
`boolean`	`isInfiniteC()` Returns `true` if the C dimension should be considered as infinite.
`boolean`	`isInfiniteT()` Returns `true` if the T dimension should be considered as infinite.
`boolean`	`isInfiniteX()` Returns `true` if the X dimension should be considered as infinite.
`boolean`	`isInfiniteY()` Returns `true` if the Y dimension should be considered as infinite.
`boolean`	`isInfiniteZ()` Returns `true` if the Z dimension should be considered as infinite.
`abstract void`	`setC(double c)` Sets the minimum C coordinate.
`void`	`setInfiniteC()` Sets the C dimension to infinite.
`void`	`setInfiniteT()` Sets the T dimension to infinite.
`void`	`setInfiniteX()` Sets the X dimension to infinite.
`void`	`setInfiniteY()` Sets the Y dimension to infinite.
`void`	`setInfiniteZ()` Sets the Z dimension to infinite.
`abstract void`	`setRect(double x, double y, double z, double t, double c, double sizeX, double sizeY, double sizeZ, double sizeT, double sizeC)` Sets the position and size of this `Rectangle5D` to the specified `double` values.
`abstract void`	`setSizeC(double value)` Sets the size of C dimension.
`abstract void`	`setSizeT(double value)` Sets the size of T dimension.
`abstract void`	`setSizeX(double value)` Sets the size of X dimension.
`abstract void`	`setSizeY(double value)` Sets the size of Y dimension.
`abstract void`	`setSizeZ(double value)` Sets the size of Z dimension.
`abstract void`	`setT(double t)` Sets the minimum T coordinate.
`abstract void`	`setX(double x)` Sets the minimum X coordinate.
`abstract void`	`setY(double y)` Sets the minimum Y coordinate.
`abstract void`	`setZ(double z)` Sets the minimum Z coordinate.
`Rectangle5D.Integer`	`toInteger()` Returns an integer `Rectangle5D` that completely encloses the double `Rectangle`.
`abstract java.awt.geom.Rectangle2D`	`toRectangle2D()` Convert to 2D rectangle
`abstract Rectangle3D`	`toRectangle3D()` Convert to 3D rectangle
`abstract Rectangle4D`	`toRectangle4D()` Convert to 4D rectangle
`java.lang.String`	`toString()`
`static Rectangle5D`	`union(Rectangle5D src1, Rectangle5D src2, Rectangle5D dest)` Unions the pair of source `Rectangle5D` objects and puts the result into the specified destination `Rectangle5D` object.

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

- Constructor Detail
  - Rectangle5D
```
public Rectangle5D()
```
- Method Detail
  - intersect
```
public static Rectangle5D intersect(Rectangle5D src1,
                    Rectangle5D src2,
                    Rectangle5D dest)
```
    Intersects the pair of specified source Rectangle5D objects and puts the result into the specified destination Rectangle5D object. One of the source rectangles can also be the destination to avoid creating a third Rectangle5D object, but in this case the original points of this source rectangle will be overwritten by this method.
    
    Parameters:
    src1 - the first of a pair of Rectangle5D objects to be intersected with each other
    src2 - the second of a pair of Rectangle5D objects to be intersected with each other
    dest - the Rectangle5D that holds the results of the intersection of src1 and src2.
    If set to null then a new Rectangle5D is created.
    
    Returns:
    resulting Rectangle5D from the intersect process.
  - createIntersection
```
public abstract Rectangle5D createIntersection(Rectangle5D r)
```
    Returns a new Rectangle5D object representing the intersection of this Rectangle5D with the specified Rectangle5D.
    
    Parameters:
    r - the Rectangle5D to be intersected with this Rectangle5D
    
    Returns:
    the largest Rectangle5D contained in both the specified Rectangle5D and in this Rectangle5D.
  - union
```
public static Rectangle5D union(Rectangle5D src1,
                Rectangle5D src2,
                Rectangle5D dest)
```
    Unions the pair of source Rectangle5D objects and puts the result into the specified destination Rectangle5D object. One of the source rectangles can also be the destination to avoid creating a third Rectangle5D object, but in this case the original points of this source rectangle will be overwritten by this method.
    
    Parameters:
    src1 - the first of a pair of Rectangle5D objects to be combined with each other
    src2 - the second of a pair of Rectangle5D objects to be combined with each other
    dest - the Rectangle5D that holds the results of the union of src1 and src2.
    If set to null then a new Rectangle5D is created.
    
    Returns:
    resulting Rectangle5D from the intersect process.
  - createUnion
```
public abstract Rectangle5D createUnion(Rectangle5D r)
```
    Returns a new Rectangle5D object representing the union of this Rectangle5D with the specified Rectangle5D.
    
    Parameters:
    r - the Rectangle5D to be combined with this Rectangle5D
    
    Returns:
    the smallest Rectangle5D containing both the specified Rectangle5D and this Rectangle5D.
  - setRect
```
public abstract void setRect(double x,
           double y,
           double z,
           double t,
           double c,
           double sizeX,
           double sizeY,
           double sizeZ,
           double sizeT,
           double sizeC)
```
    Sets the position and size of this Rectangle5D to the specified double values.
    
    Parameters:
    x - the X coordinate of the minimum corner position of this Rectangle5D
    y - the Y coordinate of the minimum corner position of this Rectangle5D
    z - the Z coordinate of the minimum corner position of this Rectangle5D
    t - the T coordinate of the minimum corner position of this Rectangle5D
    c - the C coordinate of the minimum corner position of this Rectangle5D
    sizeX - size for X dimension of this Rectangle5D
    sizeY - size for Y dimension of this Rectangle5D
    sizeZ - size for Z dimension of this Rectangle5D
    sizeT - size for T dimension of this Rectangle5D
    sizeC - size for C dimension of this Rectangle5D
  - getX
```
public abstract double getX()
```
    Returns the minimum X coordinate.
  - getY
```
public abstract double getY()
```
    Returns the minimum Y coordinate.
  - getZ
```
public abstract double getZ()
```
    Returns the minimum Z coordinate.
  - getT
```
public abstract double getT()
```
    Returns the minimum T coordinate.
  - getC
```
public abstract double getC()
```
    Returns the minimum C coordinate.
  - getSizeX
```
public abstract double getSizeX()
```
    Returns the size of X dimension.
  - getSizeY
```
public abstract double getSizeY()
```
    Returns the size of Y dimension.
  - getSizeZ
```
public abstract double getSizeZ()
```
    Returns the size of Z dimension.
  - getSizeT
```
public abstract double getSizeT()
```
    Returns the size of T dimension.
  - getSizeC
```
public abstract double getSizeC()
```
    Returns the size of C dimension.
  - getPosition
```
public abstract Point5D getPosition()
```
    Returns the point coordinate.
  - getDimension
```
public abstract Dimension5D getDimension()
```
    Returns the dimension.
  - toInteger
```
public Rectangle5D.Integer toInteger()
```
    Returns an integer Rectangle5D that completely encloses the double Rectangle. The returned Rectangle might also fail to completely enclose the original double Rectangle if it overflows the limited range of the integer data type.
    
    Returns:
    an integer Rectangle that completely encloses the actual double Rectangle.
  - setX
```
public abstract void setX(double x)
```
    Sets the minimum X coordinate.
  - setY
```
public abstract void setY(double y)
```
    Sets the minimum Y coordinate.
  - setZ
```
public abstract void setZ(double z)
```
    Sets the minimum Z coordinate.
  - setT
```
public abstract void setT(double t)
```
    Sets the minimum T coordinate.
  - setC
```
public abstract void setC(double c)
```
    Sets the minimum C coordinate.
  - setSizeX
```
public abstract void setSizeX(double value)
```
    Sets the size of X dimension.
  - setSizeY
```
public abstract void setSizeY(double value)
```
    Sets the size of Y dimension.
  - setSizeZ
```
public abstract void setSizeZ(double value)
```
    Sets the size of Z dimension.
  - setSizeT
```
public abstract void setSizeT(double value)
```
    Sets the size of T dimension.
  - setSizeC
```
public abstract void setSizeC(double value)
```
    Sets the size of C dimension.
  - getMinX
```
public double getMinX()
```
    Returns the smallest X coordinate of the rectangle.
  - getMinY
```
public double getMinY()
```
    Returns the smallest Y coordinate of the rectangle.
  - getMinZ
```
public double getMinZ()
```
    Returns the smallest Z coordinate of the rectangle.
  - getMinT
```
public double getMinT()
```
    Returns the smallest T coordinate of the rectangle.
  - getMinC
```
public double getMinC()
```
    Returns the smallest C coordinate of the rectangle.
  - getMaxX
```
public double getMaxX()
```
    Returns the largest X coordinate of the rectangle.
  - getMaxY
```
public double getMaxY()
```
    Returns the largest Y coordinate of the rectangle.
  - getMaxZ
```
public double getMaxZ()
```
    Returns the largest Z coordinate of the rectangle.
  - getMaxT
```
public double getMaxT()
```
    Returns the largest T coordinate of the rectangle.
  - getMaxC
```
public double getMaxC()
```
    Returns the largest C coordinate of the rectangle.
  - getCenterX
```
public double getCenterX()
```
    Returns the X coordinate of the center of the rectangle.
  - getCenterY
```
public double getCenterY()
```
    Returns the Y coordinate of the center of the rectangle.
  - getCenterZ
```
public double getCenterZ()
```
    Returns the Z coordinate of the center of the rectangle.
  - getCenterT
```
public double getCenterT()
```
    Returns the T coordinate of the center of the rectangle.
  - getCenterC
```
public double getCenterC()
```
    Returns the C coordinate of the center of the rectangle.
  - isEmpty
```
public boolean isEmpty()
```
    Determines whether the Rectangle5D is empty.
    
    Returns:
    true if the Rectangle5D is empty; false otherwise.
  - isInfiniteX
```
public boolean isInfiniteX()
```
    Returns true if the X dimension should be considered as infinite.
  - isInfiniteY
```
public boolean isInfiniteY()
```
    Returns true if the Y dimension should be considered as infinite.
  - isInfiniteZ
```
public boolean isInfiniteZ()
```
    Returns true if the Z dimension should be considered as infinite.
  - isInfiniteT
```
public boolean isInfiniteT()
```
    Returns true if the T dimension should be considered as infinite.
  - isInfiniteC
```
public boolean isInfiniteC()
```
    Returns true if the C dimension should be considered as infinite.
  - setInfiniteX
```
public void setInfiniteX()
```
    Sets the X dimension to infinite.
  - setInfiniteY
```
public void setInfiniteY()
```
    Sets the Y dimension to infinite.
  - setInfiniteZ
```
public void setInfiniteZ()
```
    Sets the Z dimension to infinite.
  - setInfiniteT
```
public void setInfiniteT()
```
    Sets the T dimension to infinite.
  - setInfiniteC
```
public void setInfiniteC()
```
    Sets the C dimension to infinite.
  - contains
```
public boolean contains(double x,
               double y,
               double z,
               double t,
               double c)
```
    Tests if the specified coordinates are inside the boundary of the Rectangle5D.
    
    Parameters:
    x - the specified X coordinate to be tested
    y - the specified Y coordinate to be tested
    z - the specified Z coordinate to be tested
    t - the specified T coordinate to be tested
    c - the specified C coordinate to be tested
    
    Returns:
    true if the specified coordinates are inside the Rectangle5D boundary; false otherwise.
  - contains
```
public boolean contains(double x,
               double y,
               double z,
               double t,
               double c,
               double sizeX,
               double sizeY,
               double sizeZ,
               double sizeT,
               double sizeC)
```
    Tests if the Rectangle5D entirely contains the specified 5D rectangular area.
    All coordinates that lie inside the 5D rectangular area must lie within the Rectangle5D.
    
    Parameters:
    x - the X coordinate of the minimum corner position of the specified rectangular area
    y - the Y coordinate of the minimum corner position of the specified rectangular area
    z - the Z coordinate of the minimum corner position of the specified rectangular area
    t - the T coordinate of the minimum corner position of the specified rectangular area
    c - the C coordinate of the minimum corner position of the specified rectangular area
    sizeX - size for X dimension of the specified rectangular area
    sizeY - size for Y dimension of the specified rectangular area
    sizeZ - size for Z dimension of the specified rectangular area
    sizeT - size for T dimension of the specified rectangular area
    sizeC - size for C dimension of the specified rectangular area
    
    Returns:
    true if the Rectangle5D entirely contains the specified 5D rectangular area; false otherwise
    See Also:
    intersects(double, double, double, double, double, double, double, double, double, double)
  - contains
```
public boolean contains(Rectangle5D rect)
```
    Tests if the Rectangle5D entirely contains the specified Rectangle5D.
    
    See Also:
    contains(double, double, double, double, double, double, double, double, double, double)
  - intersects
```
public boolean intersects(double x,
                 double y,
                 double z,
                 double t,
                 double c,
                 double sizeX,
                 double sizeY,
                 double sizeZ,
                 double sizeT,
                 double sizeC)
```
    Tests if the interior of the Rectangle5D intersects the interior of a specified 5D rectangular area.
    The 5D rectangular area is considered to intersect the Rectangle5D if any point is contained in both the interior of the Rectangle5D and the specified rectangular area.
    
    Parameters:
    x - the X coordinate of the minimum corner position of the specified rectangular area
    y - the Y coordinate of the minimum corner position of the specified rectangular area
    z - the Z coordinate of the minimum corner position of the specified rectangular area
    t - the T coordinate of the minimum corner position of the specified rectangular area
    c - the C coordinate of the minimum corner position of the specified rectangular area
    sizeX - size for X dimension of the specified rectangular area
    sizeY - size for Y dimension of the specified rectangular area
    sizeZ - size for Z dimension of the specified rectangular area
    sizeT - size for T dimension of the specified rectangular area
    sizeC - size for C dimension of the specified rectangular area
    
    Returns:
    true if the interior of the Rectangle5D and the interior of the 5D rectangular area intersect.
  - intersects
```
public boolean intersects(Rectangle5D rect)
```
    Tests if the interior of the Rectangle5D intersects the interior of a specified Rectangle5D.
    
    See Also:
    intersects(double, double, double, double, double, double, double, double, double, double)
  - add
```
public void add(double newx,
       double newy,
       double newz,
       double newt,
       double newc)
```
    Adds a 5D point, specified by the double precision coordinates arguments, to this Rectangle5D. The resulting Rectangle5D is the smallest Rectangle5D that contains both the original Rectangle5D and the specified 5D point.
    After adding a 5D point, a call to contains with the added point as an argument does not necessarily return true. The contains method does not return true for points on the edges of a rectangle. Therefore, if the added 5D point falls on edge of the enlarged rectangle, contains returns false for that point.
    
    Parameters:
    newx - the X coordinate of the new point
    newy - the Y coordinate of the new point
    newz - the Z coordinate of the new point
    newt - the T coordinate of the new point
    newc - the C coordinate of the new point
  - add
```
public void add(Point5D pt)
```
    Adds the Point5D object pt to this Rectangle5D. The resulting Rectangle5D is the smallest Rectangle5D that contains both the original Rectangle5D and the specified Point5D.
    After adding a point, a call to contains with the added point as an argument does not necessarily return true. The contains method does not return true for points on the edges of a rectangle. Therefore, if the added point falls on edge of the enlarged rectangle, contains returns false for that point.
    
    Parameters:
    pt - the new Point5D to add to this Rectangle5D.
  - add
```
public void add(Rectangle5D r)
```
    Adds a Rectangle5D object to this Rectangle5D. The resulting Rectangle5D is the union of the two Rectangle5D objects.
    
    Parameters:
    r - the Rectangle5D to add to this Rectangle5D.
  - toRectangle2D
```
public abstract java.awt.geom.Rectangle2D toRectangle2D()
```
    Convert to 2D rectangle
  - toRectangle3D
```
public abstract Rectangle3D toRectangle3D()
```
    Convert to 3D rectangle
  - toRectangle4D
```
public abstract Rectangle4D toRectangle4D()
```
    Convert to 4D rectangle
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - clone
```
public java.lang.Object clone()
```
    Creates a new object of the same class as this object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    a clone of this instance.
    
    Throws:
    
    java.lang.OutOfMemoryError - if there is not enough memory.
    See Also:
    Cloneable
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Rectangle5D

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rectangle5D

Method Detail

intersect

createIntersection

union

createUnion

setRect

getX

getY

getZ

getT

getC

getSizeX

getSizeY

getSizeZ

getSizeT

getSizeC

getPosition

getDimension

toInteger

setX

setY

setZ

setT

setC

setSizeX

setSizeY

setSizeZ

setSizeT

setSizeC

getMinX

getMinY

getMinZ

getMinT

getMinC

getMaxX

getMaxY

getMaxZ

getMaxT

getMaxC

getCenterX

getCenterY

getCenterZ

getCenterT

getCenterC

isEmpty

isInfiniteX

isInfiniteY

isInfiniteZ

isInfiniteT

isInfiniteC

setInfiniteX

setInfiniteY

setInfiniteZ

setInfiniteT

setInfiniteC

contains

contains

contains

intersects

intersects

add

add

add

toRectangle2D

toRectangle3D

toRectangle4D

equals

hashCode

clone

toString