Rectangle3D

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

All Implemented Interfaces:

Shape3D, java.lang.Cloneable

Direct Known Subclasses:

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

Author:

Stephane

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Rectangle3D.Double

static class Rectangle3D.Float

static class Rectangle3D.Integer

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

Constructor Summary

Constructors
Constructor and Description

Rectangle3D()

Constructors
Constructor and Description
`Rectangle3D()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(double newx, double newy, double newz)` Adds a 3D point, specified by the double precision coordinates arguments, to this `Rectangle3D`.
`void`	`add(Point3D pt)` Adds the `Point3D` object `pt` to this `Rectangle3D`.
`void`	`add(Rectangle3D r)` Adds a `Rectangle3D` object to this `Rectangle3D`.
`java.lang.Object`	`clone()` Creates a new object of the same class as this object.
`boolean`	`contains(double x, double y, double z)` Tests if the specified coordinates are inside the boundary of the `Rectangle3D`.
`boolean`	`contains(double x, double y, double z, double sizeX, double sizeY, double sizeZ)` Tests if the `Rectangle3D` entirely contains the specified 3D rectangular area.
`boolean`	`contains(Point3D p)` Tests if a specified `Point3D` is inside the boundary of the `Shape3D`.
`boolean`	`contains(Rectangle3D rect)` Tests if the `Rectangle3D` entirely contains the specified `Rectangle3D`.
`abstract Rectangle3D`	`createIntersection(Rectangle3D r)` Returns a new `Rectangle3D` object representing the intersection of this `Rectangle3D` with the specified `Rectangle3D`.
`abstract Rectangle3D`	`createUnion(Rectangle3D r)` Returns a new `Rectangle3D` object representing the union of this `Rectangle3D` with the specified `Rectangle3D`.
`boolean`	`equals(java.lang.Object obj)`
`Rectangle3D`	`getBounds()` Returns the bounding box of the `Shape3D`.
`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 Dimension3D`	`getDimension()` Returns the dimension.
`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`	`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 Point3D`	`getPosition()` Returns the point coordinates.
`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`	`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 Rectangle3D`	`intersect(Rectangle3D src1, Rectangle3D src2, Rectangle3D dest)` Intersects the pair of specified source `Rectangle3D` objects and puts the result into the specified destination `Rectangle3D` object.
`boolean`	`intersects(double x, double y, double z, double sizeX, double sizeY, double sizeZ)` Tests if the interior of the `Rectangle3D` intersects the interior of a specified 3D rectangular area.
`static boolean`	`intersects(Line3D line, Rectangle3D rect)` Returns `true` if the specified Line3D intersects the given Rectangle3D.
`boolean`	`intersects(Rectangle3D rect)` Tests if the interior of the `Rectangle3D` intersects the interior of a specified `Rectangle3D`.
`boolean`	`intersectsLine(double x1, double y1, double z1, double x2, double y2, double z2)` Tests if the specified 3D line intersects this `Rectangle3D`.
`boolean`	`intersectsLine(Line3D line)` Tests if the specified 3D line intersects this `Rectangle3D`.
`boolean`	`intersectsLine(Point3D pt1, Point3D pt2)` Tests if the line specified by the given starting and ending Point intersects the plan defined by this `Rectangle3D`.
`boolean`	`isEmpty()` Determines whether the `Rectangle5D` is empty.
`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.
`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 sizeX, double sizeY, double sizeZ)` Sets the position and size of this `Rectangle3D` to the specified `double` values.
`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`	`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.
`Rectangle3D.Integer`	`toInteger()` Returns an integer `Rectangle3D` that completely encloses the double `Rectangle`.
`abstract java.awt.geom.Rectangle2D`	`toRectangle2D()` Convert to 2D rectangle
`java.lang.String`	`toString()`
`static Rectangle3D`	`union(Rectangle3D src1, Rectangle3D src2, Rectangle3D dest)` Unions the pair of source `Rectangle3D` objects and puts the result into the specified destination `Rectangle3D` object.

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

- Constructor Detail
  - Rectangle3D
```
public Rectangle3D()
```
- Method Detail
  - intersects
```
public static boolean intersects(Line3D line,
                 Rectangle3D rect)
```
    Returns true if the specified Line3D intersects the given Rectangle3D.
    
    Parameters:
    line - the Line3D we want to test intersection for
    rect - the Rectangle3D we want to test intersection for
  - intersect
```
public static Rectangle3D intersect(Rectangle3D src1,
                    Rectangle3D src2,
                    Rectangle3D dest)
```
    Intersects the pair of specified source Rectangle3D objects and puts the result into the specified destination Rectangle3D object. One of the source rectangles can also be the destination to avoid creating a third Rectangle3D 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 Rectangle3D objects to be intersected with each other
    src2 - the second of a pair of Rectangle3D objects to be intersected with each other
    dest - the Rectangle3D that holds the results of the intersection of src1 and src2
  - createIntersection
```
public abstract Rectangle3D createIntersection(Rectangle3D r)
```
    Returns a new Rectangle3D object representing the intersection of this Rectangle3D with the specified Rectangle3D.
    
    Parameters:
    r - the Rectangle3D to be intersected with this Rectangle3D
    
    Returns:
    the largest Rectangle3D contained in both the specified Rectangle3D and in this Rectangle3D.
  - union
```
public static Rectangle3D union(Rectangle3D src1,
                Rectangle3D src2,
                Rectangle3D dest)
```
    Unions the pair of source Rectangle3D objects and puts the result into the specified destination Rectangle3D object. One of the source rectangles can also be the destination to avoid creating a third Rectangle3D 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 Rectangle3D objects to be combined with each other
    src2 - the second of a pair of Rectangle3D objects to be combined with each other
    dest - the Rectangle3D that holds the results of the union of src1 and src2
  - createUnion
```
public abstract Rectangle3D createUnion(Rectangle3D r)
```
    Returns a new Rectangle3D object representing the union of this Rectangle3D with the specified Rectangle3D.
    
    Parameters:
    r - the Rectangle3D to be combined with this Rectangle3D
    
    Returns:
    the smallest Rectangle3D containing both the specified Rectangle3D and this Rectangle3D.
  - setRect
```
public abstract void setRect(double x,
           double y,
           double z,
           double sizeX,
           double sizeY,
           double sizeZ)
```
    Sets the position and size of this Rectangle3D to the specified double values.
    
    Parameters:
    x - the X coordinate of the minimum corner position of this Rectangle3D
    y - the Y coordinate of the minimum corner position of this Rectangle3D
    z - the Z coordinate of the minimum corner position of this Rectangle3D
    sizeX - size for X dimension of this Rectangle3D
    sizeY - size for Y dimension of this Rectangle3D
    sizeZ - size for Z dimension of this Rectangle3D
  - 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.
  - getPosition
```
public abstract Point3D getPosition()
```
    Returns the point coordinates.
  - getDimension
```
public abstract Dimension3D getDimension()
```
    Returns the dimension.
  - 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.
  - toInteger
```
public Rectangle3D.Integer toInteger()
```
    Returns an integer Rectangle3D 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - getBounds
```
public Rectangle3D getBounds()
```
    Description copied from interface: Shape3D
    
    Returns the bounding box of the Shape3D. Note that there is no guarantee that the returned Rectangle3D is the smallest bounding box that encloses the Shape3D, only that the Shape3D lies entirely within the indicated Rectangle3D.
    
    Specified by:
    
    getBounds in interface Shape3D
    
    Returns:
    an instance of Rectangle3D that is a high-precision bounding box of the Shape3D.
  - contains
```
public boolean contains(double x,
               double y,
               double z)
```
    Tests if the specified coordinates are inside the boundary of the Rectangle3D.
    
    Specified by:
    
    contains in interface Shape3D
    
    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
    
    Returns:
    true if the specified coordinates are inside the Rectangle3D boundary; false otherwise.
  - contains
```
public boolean contains(Point3D p)
```
    Description copied from interface: Shape3D
    
    Tests if a specified Point3D is inside the boundary of the Shape3D.
    
    Specified by:
    
    contains in interface Shape3D
    
    Parameters:
    p - the specified Point3D to be tested
    
    Returns:
    true if the specified Point3D is inside the boundary of the Shape3D; false otherwise.
  - contains
```
public boolean contains(double x,
               double y,
               double z,
               double sizeX,
               double sizeY,
               double sizeZ)
```
    Tests if the Rectangle3D entirely contains the specified 3D rectangular area. All coordinates that lie inside the 3D rectangular area must lie within the Rectangle3D.
    
    Specified by:
    
    contains in interface Shape3D
    
    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
    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
    
    Returns:
    true if the Rectangle3D entirely contains the specified 3D rectangular area; false otherwise
    See Also:
    intersects(icy.type.geom.Line3D, icy.type.rectangle.Rectangle3D)
  - contains
```
public boolean contains(Rectangle3D rect)
```
    Tests if the Rectangle3D entirely contains the specified Rectangle3D.
    
    Specified by:
    
    contains in interface Shape3D
    
    Parameters:
    rect - The specified Rectangle3D
    
    Returns:
    true if the interior of the Shape3D entirely contains the Rectangle3D; false otherwise or, if the Shape3D contains the Rectangle3D and the intersects method returns true and the containment calculations would be too expensive to perform.
    See Also:
    contains(double, double, double, double, double, double)
  - intersects
```
public boolean intersects(double x,
                 double y,
                 double z,
                 double sizeX,
                 double sizeY,
                 double sizeZ)
```
    Tests if the interior of the Rectangle3D intersects the interior of a specified 3D rectangular area.
    The 3D rectangular area is considered to intersect the Rectangle3D if any point is contained in both the interior of the Rectangle3D and the specified rectangular area.
    
    Specified by:
    
    intersects in interface Shape3D
    
    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
    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
    
    Returns:
    true if the interior of the Rectangle3D and the interior of the 3D rectangular area intersect.
  - intersects
```
public boolean intersects(Rectangle3D rect)
```
    Tests if the interior of the Rectangle3D intersects the interior of a specified Rectangle3D.
    
    Specified by:
    
    intersects in interface Shape3D
    
    Parameters:
    rect - the specified Rectangle3D
    
    Returns:
    true if the interior of the Shape3D and the interior of the specified Rectangle3D intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false otherwise.
    See Also:
    intersects(double, double, double, double, double, double)
  - intersectsLine
```
public boolean intersectsLine(Line3D line)
```
    Tests if the specified 3D line intersects this Rectangle3D.
  - intersectsLine
```
public boolean intersectsLine(Point3D pt1,
                     Point3D pt2)
```
    Tests if the line specified by the given starting and ending Point intersects the plan defined by this Rectangle3D.
  - intersectsLine
```
public boolean intersectsLine(double x1,
                     double y1,
                     double z1,
                     double x2,
                     double y2,
                     double z2)
```
    Tests if the specified 3D line intersects this Rectangle3D.
  - add
```
public void add(double newx,
       double newy,
       double newz)
```
    Adds a 3D point, specified by the double precision coordinates arguments, to this Rectangle3D. The resulting Rectangle3D is the smallest Rectangle3D that contains both the original Rectangle3D and the specified 3D point.
    After adding a 3D 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 3D 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
  - add
```
public void add(Point3D pt)
```
    Adds the Point3D object pt to this Rectangle3D. The resulting Rectangle3D is the smallest Rectangle3D that contains both the original Rectangle3D and the specified Point3D.
    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 Point3D to add to this Rectangle3D.
  - add
```
public void add(Rectangle3D r)
```
    Adds a Rectangle3D object to this Rectangle3D. The resulting Rectangle3D is the union of the two Rectangle3D objects.
    
    Parameters:
    r - the Rectangle3D to add to this Rectangle3D.
  - toRectangle2D
```
public abstract java.awt.geom.Rectangle2D toRectangle2D()
```
    Convert to 2D 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 Rectangle3D

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rectangle3D

Method Detail

intersects

intersect

createIntersection

union

createUnion

setRect

getX

getY

getZ

getPosition

getDimension

getSizeX

getSizeY

getSizeZ

toInteger

setX

setY

setZ

setSizeX

setSizeY

setSizeZ

getMinX

getMinY

getMinZ

getMaxX

getMaxY

getMaxZ

getCenterX

getCenterY

getCenterZ

isEmpty

isInfiniteX

isInfiniteY

isInfiniteZ

setInfiniteX

setInfiniteY

setInfiniteZ

getBounds

contains

contains

contains

contains

intersects

intersects

intersectsLine

intersectsLine

intersectsLine

add

add

add

toRectangle2D

equals

hashCode

clone

toString