P2DBoundingBox

java.lang.Object
- com.highqsoft.p2d.P2DBoundingBox

All Implemented Interfaces:

FwkInterface, P2DBoundingBoxInterface, java.io.Serializable
```
public class P2DBoundingBox
extends java.lang.Object
implements P2DBoundingBoxInterface
```
The P2DBoundingBox.

Since:

$Date: 2017/04/06 13:30:06 $

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.awt.geom.Point2D.Double`	`lower`
`protected java.awt.geom.Point2D.Double`	`upper`
`static java.lang.String`	`version`
`protected double`	`xFactor`
`protected double`	`xOffset`
`protected double`	`yFactor`
`protected double`	`yOffset`

Constructor Summary

Constructors
Constructor and Description
`P2DBoundingBox()` The default constructor.
`P2DBoundingBox(double lx, double ly, double ux, double uy)` The constructor receiving the edges of the bounding box.
`P2DBoundingBox(P2DBoundingBoxInterface box)` The constructor receiving a bounding box.
`P2DBoundingBox(java.awt.geom.Point2D lower, java.awt.geom.Point2D upper)` The constructor receiving the lower and upper corner of the box.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Return a copy of this box.
`P2DBoundingBoxInterface`	`closestIntersection(P2DBoundingBoxInterface[] bounds)` Finds closest bounding object which intersects this bounding box
`boolean`	`contains(P2DBoundingBoxInterface box)` Checks whether the complete bounding box is inside this one.
`boolean`	`contains(java.awt.geom.Point2D p)` Test for intersection with a point
`boolean`	`equals(java.lang.Object obj)` Indicates whether some other object is "equal to" this one.
`double`	`getArea()` Returns the square of the enclosed area.
`double`	`getHeight()` Retrieves the height of the box.
`java.awt.geom.AffineTransform`	`getInverseTransform()` Get the transformation for this boundingbox.
`java.awt.geom.Point2D`	`getLower()` Get the reference to the lower vector.
`void`	`getLower(java.awt.geom.Point2D lower)` Get the lower vector.
`java.awt.geom.Rectangle2D`	`getRectangle()` Retrieves the rectanlge defined by this box.
`P2DBoundingBoxInterface`	`getScaledBoundingBox()` Get the scaled bounding box.
`double`	`getScaledHeight()` Retrieves the scaled height of the box.
`java.awt.geom.Point2D`	`getScaledLower()` Get the lower scaled vector.
`void`	`getScaledLower(java.awt.geom.Point2D lower)` Get the lower scaled vector.
`java.awt.geom.Point2D`	`getScaledUpper()` Get the upper scaled vector.
`void`	`getScaledUpper(java.awt.geom.Point2D upper)` Get the upper scaled vector.
`double`	`getScaledWidth()` Retrieves the scaled width of the box.
`java.awt.geom.AffineTransform`	`getTransform()` Get the inverse transformation.
`java.awt.geom.Point2D`	`getUpper()` Get the reference to the upper vector.
`void`	`getUpper(java.awt.geom.Point2D upper)` Get the upper vector.
`java.lang.String`	`getVersion()` Return the version string of the FWK component.
`double`	`getWidth()` Retrieves the width of the box.
`double`	`getXFactor()` Get the scale of the bounding box in X direction.
`double`	`getXOffset()` Get the offset of the bounding box in X direction.
`java.awt.geom.AffineTransform`	`getXTransform()` Get the transformation for this boundingbox in x direction.
`double`	`getYFactor()` Get the scale of the bounding box in Y direction.
`double`	`getYOffset()` Get the offset of the bounding box in Y direction.
`java.awt.geom.AffineTransform`	`getYTransform()` Get the transformation for this boundingbox in y direction.
`boolean`	`intersects(P2DBoundingBoxInterface bounds)` Test for intersection with another bounds object
`boolean`	`intersects(P2DBoundingBoxInterface[] bounds)` Test for intersection with an array of bounds objects
`boolean`	`intersects(P2DBoundingBoxInterface[] bounds, P2DBoundingBoxInterface newBoundBox)` Test for intersection with an array of bounds objects
`boolean`	`intersects(P2DBoundingBoxInterface bounds, P2DBoundingBoxInterface newBoundBox)` Test for intersection with another bounding box
`boolean`	`intersects(java.awt.geom.Point2D v)` Test for intersection with a point
`java.awt.geom.Point2D`	`inverseTransformPoint(java.awt.geom.Point2D p)` Transform the point.
`boolean`	`isInside(P2DBoundingBoxInterface box)` Checks whether the this box is inside the given unscaled box.
`static void`	`main(java.lang.String[] args)`
`void`	`move(double xDiff, double yDiff)` Move the box.
`void`	`release()` Release the object.
`void`	`setHeight(double height)` Set the height of the box.
`void`	`setLower(java.awt.geom.Point2D lower)` Set the lower vector.
`void`	`setOffset(double xOffset, double yOffset)` Scale the bounding box to the given values.
`void`	`setScale(double xFactor, double yFactor)` Scale the bounding box to the given values.
`void`	`setUpper(java.awt.geom.Point2D upper)` Set the upper vector.
`void`	`setWidth(double width)` Set the width of the box.
`void`	`setXScale(double offset, double scale)` Scale the bounding box in X direction.
`void`	`setYScale(double offset, double scale)` Scale the bounding box in Y direction.
`java.lang.String`	`toString()` returns the string representation of the box.
`java.awt.geom.Point2D`	`transformPoint(java.awt.geom.Point2D p)` Transform the point.

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

- Field Detail
  - version
```
public static final java.lang.String version
```
    See Also:
    Constant Field Values
  - lower
```
protected java.awt.geom.Point2D.Double lower
```
  - upper
```
protected java.awt.geom.Point2D.Double upper
```
  - xFactor
```
protected double xFactor
```
  - yFactor
```
protected double yFactor
```
  - xOffset
```
protected double xOffset
```
  - yOffset
```
protected double yOffset
```
- Constructor Detail
  - P2DBoundingBox
```
public P2DBoundingBox()
```
    The default constructor. Constructs and initializes a cube where -1 <= x,y <= 1
  - P2DBoundingBox
```
public P2DBoundingBox(java.awt.geom.Point2D lower,
              java.awt.geom.Point2D upper)
```
    The constructor receiving the lower and upper corner of the box.
  - P2DBoundingBox
```
public P2DBoundingBox(P2DBoundingBoxInterface box)
```
    The constructor receiving a bounding box.
  - P2DBoundingBox
```
public P2DBoundingBox(double lx,
              double ly,
              double ux,
              double uy)
```
    The constructor receiving the edges of the bounding box.
    
    Parameters:
    lx - The lower x value.
    ly - The lower y value.
    ux - The upper x value.
    uy - The upper y value.
- Method Detail
  - getVersion
```
public java.lang.String getVersion()
```
    Description copied from interface: FwkInterface
    
    Return the version string of the FWK component.
    
    Specified by:
    
    getVersion in interface FwkInterface
  - release
```
public void release()
```
    Release the object.
    
    Specified by:
    
    release in interface FwkInterface
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Indicates whether some other object is "equal to" this one.
    
    Overrides:
    
    equals in class java.lang.Object
  - clone
```
public java.lang.Object clone()
```
    Return a copy of this box.
    
    Overrides:
    
    clone in class java.lang.Object
  - closestIntersection
```
public P2DBoundingBoxInterface closestIntersection(P2DBoundingBoxInterface[] bounds)
```
    Finds closest bounding object which intersects this bounding box
    
    Specified by:
    
    closestIntersection in interface P2DBoundingBoxInterface
    
    Parameters:
    boundsObjects - is an array of bounds objects
    
    Returns:
    closest bounding object
  - getArea
```
public double getArea()
```
    Returns the square of the enclosed area.
    
    Specified by:
    
    getArea in interface P2DBoundingBoxInterface
    
    Returns:
    the square of the enclosed area.
  - intersects
```
public boolean intersects(P2DBoundingBoxInterface bounds)
```
    Test for intersection with another bounds object
    
    Specified by:
    
    intersects in interface P2DBoundingBoxInterface
  - intersects
```
public boolean intersects(P2DBoundingBoxInterface[] bounds)
```
    Test for intersection with an array of bounds objects
    
    Specified by:
    
    intersects in interface P2DBoundingBoxInterface
    
    Returns:
    true or false indicating if an intersection occurred
  - intersects
```
public boolean intersects(P2DBoundingBoxInterface[] bounds,
                 P2DBoundingBoxInterface newBoundBox)
```
    Test for intersection with an array of bounds objects
    
    Specified by:
    
    intersects in interface P2DBoundingBoxInterface
    
    Parameters:
    boundsObjects - is an array of bounds objects
    newBoundBox - is the new bounding box which is the intersection of the boundsObject and this BoundingBox
    
    Returns:
    true or false indicating if an intersection occurred
  - intersects
```
public boolean intersects(P2DBoundingBoxInterface bounds,
                 P2DBoundingBoxInterface newBoundBox)
```
    Test for intersection with another bounding box
    
    Specified by:
    
    intersects in interface P2DBoundingBoxInterface
    
    Parameters:
    boundsObject - is another bounding object
    newBoundBox - - is the new bounding box which is the intersection of the boundsObject and this BoundingBox
    
    Returns:
    true or false indicating if an intersection occurred
  - intersects
```
public boolean intersects(java.awt.geom.Point2D v)
```
    Test for intersection with a point
  - contains
```
public boolean contains(java.awt.geom.Point2D p)
```
    Test for intersection with a point
    
    Specified by:
    
    contains in interface P2DBoundingBoxInterface
  - contains
```
public boolean contains(P2DBoundingBoxInterface box)
```
    Checks whether the complete bounding box is inside this one.
    
    Specified by:
    
    contains in interface P2DBoundingBoxInterface
  - getUpper
```
public java.awt.geom.Point2D getUpper()
```
    Get the reference to the upper vector.
    
    Specified by:
    
    getUpper in interface P2DBoundingBoxInterface
    
    Returns:
    The upper value.
    See Also:
    getLower(Point2D)
  - getLower
```
public java.awt.geom.Point2D getLower()
```
    Get the reference to the lower vector.
    
    Specified by:
    
    getLower in interface P2DBoundingBoxInterface
    
    Returns:
    The lower value.
    See Also:
    getLower(Point2D)
  - getLower
```
public void getLower(java.awt.geom.Point2D lower)
```
    Get the lower vector.
    
    Specified by:
    
    getLower in interface P2DBoundingBoxInterface
    
    Parameters:
    lower - The vector that receives the lower value.
  - getUpper
```
public void getUpper(java.awt.geom.Point2D upper)
```
    Get the upper vector.
    
    Specified by:
    
    getUpper in interface P2DBoundingBoxInterface
    
    Parameters:
    upper - The vector that receives the upper value.
  - setLower
```
public void setLower(java.awt.geom.Point2D lower)
```
    Set the lower vector.
    
    Specified by:
    
    setLower in interface P2DBoundingBoxInterface
    
    Parameters:
    lower - The vector that will be the new lower value.
  - setUpper
```
public void setUpper(java.awt.geom.Point2D upper)
```
    Set the upper vector.
    
    Specified by:
    
    setUpper in interface P2DBoundingBoxInterface
    
    Parameters:
    upper - The vector that will be the new upper value.
  - getScaledBoundingBox
```
public P2DBoundingBoxInterface getScaledBoundingBox()
```
    Get the scaled bounding box.
    
    Specified by:
    
    getScaledBoundingBox in interface P2DBoundingBoxInterface
    
    Returns:
    the scaled box.
  - getScaledUpper
```
public java.awt.geom.Point2D getScaledUpper()
```
    Get the upper scaled vector.
    
    Specified by:
    
    getScaledUpper in interface P2DBoundingBoxInterface
    
    Returns:
    The upper value.
  - getScaledLower
```
public java.awt.geom.Point2D getScaledLower()
```
    Get the lower scaled vector.
    
    Specified by:
    
    getScaledLower in interface P2DBoundingBoxInterface
    
    Returns:
    The lower value.
  - getScaledUpper
```
public void getScaledUpper(java.awt.geom.Point2D upper)
```
    Get the upper scaled vector.
    
    Specified by:
    
    getScaledUpper in interface P2DBoundingBoxInterface
    
    Parameters:
    The - upper value.
  - getScaledLower
```
public void getScaledLower(java.awt.geom.Point2D lower)
```
    Get the lower scaled vector.
    
    Specified by:
    
    getScaledLower in interface P2DBoundingBoxInterface
  - getWidth
```
public double getWidth()
```
    Retrieves the width of the box.
    
    Specified by:
    
    getWidth in interface P2DBoundingBoxInterface
    
    Returns:
    The width
  - getHeight
```
public double getHeight()
```
    Retrieves the height of the box.
    
    Specified by:
    
    getHeight in interface P2DBoundingBoxInterface
    
    Returns:
    The height
  - getScaledWidth
```
public double getScaledWidth()
```
    Retrieves the scaled width of the box.
    
    Specified by:
    
    getScaledWidth in interface P2DBoundingBoxInterface
    
    Returns:
    The width
  - getScaledHeight
```
public double getScaledHeight()
```
    Retrieves the scaled height of the box.
    
    Specified by:
    
    getScaledHeight in interface P2DBoundingBoxInterface
    
    Returns:
    The height
  - setWidth
```
public void setWidth(double width)
```
    Set the width of the box.
    
    Specified by:
    
    setWidth in interface P2DBoundingBoxInterface
    
    Parameters:
    width - The width
  - setHeight
```
public void setHeight(double height)
```
    Set the height of the box.
    
    Specified by:
    
    setHeight in interface P2DBoundingBoxInterface
    
    Parameters:
    height - The height
  - getRectangle
```
public java.awt.geom.Rectangle2D getRectangle()
```
    Retrieves the rectanlge defined by this box.
    
    Specified by:
    
    getRectangle in interface P2DBoundingBoxInterface
    
    Returns:
    The defined rectanlge.
  - toString
```
public java.lang.String toString()
```
    returns the string representation of the box.
    
    Overrides:
    
    toString in class java.lang.Object
  - move
```
public void move(double xDiff,
        double yDiff)
```
    Move the box.
    
    Specified by:
    
    move in interface P2DBoundingBoxInterface
    
    Parameters:
    xDiff - the movement in x.
    yDiff - the movement in y.
  - isInside
```
public boolean isInside(P2DBoundingBoxInterface box)
```
    Checks whether the this box is inside the given unscaled box.
    
    Specified by:
    
    isInside in interface P2DBoundingBoxInterface
  - setScale
```
public void setScale(double xFactor,
            double yFactor)
```
    Scale the bounding box to the given values.
    
    Specified by:
    
    setScale in interface P2DBoundingBoxInterface
    
    Parameters:
    xFactor - the scaling in x.
    yFactor - The scaling in y.
  - setOffset
```
public void setOffset(double xOffset,
             double yOffset)
```
    Scale the bounding box to the given values.
    
    Specified by:
    
    setOffset in interface P2DBoundingBoxInterface
    
    Parameters:
    xOffset - the offset in x.
    yOffset - The offset in y.
  - setXScale
```
public void setXScale(double offset,
             double scale)
```
    Scale the bounding box in X direction.
    
    Specified by:
    
    setXScale in interface P2DBoundingBoxInterface
    
    Parameters:
    offset - the offset in x.
    scale - the scaling in x.
  - setYScale
```
public void setYScale(double offset,
             double scale)
```
    Scale the bounding box in Y direction.
    
    Specified by:
    
    setYScale in interface P2DBoundingBoxInterface
    
    Parameters:
    offset - the offset in y.
    scale - the scaling in y.
  - getXFactor
```
public double getXFactor()
```
    Get the scale of the bounding box in X direction.
    
    Specified by:
    
    getXFactor in interface P2DBoundingBoxInterface
    
    Returns:
    the scaling in x.
  - getYFactor
```
public double getYFactor()
```
    Get the scale of the bounding box in Y direction.
    
    Specified by:
    
    getYFactor in interface P2DBoundingBoxInterface
    
    Returns:
    the scaling in y.
  - getXOffset
```
public double getXOffset()
```
    Get the offset of the bounding box in X direction.
    
    Specified by:
    
    getXOffset in interface P2DBoundingBoxInterface
    
    Returns:
    the offset in x.
  - getYOffset
```
public double getYOffset()
```
    Get the offset of the bounding box in Y direction.
    
    Specified by:
    
    getYOffset in interface P2DBoundingBoxInterface
    
    Returns:
    the offset in y.
  - getInverseTransform
```
public java.awt.geom.AffineTransform getInverseTransform()
```
    Get the transformation for this boundingbox. The returned transformation transforms coordinates specified in the scaled box to coordinates in the outer coordinate system.
    
    Specified by:
    
    getInverseTransform in interface P2DBoundingBoxInterface
    
    Returns:
    the transformation.
    See Also:
    getTransform
  - getTransform
```
public java.awt.geom.AffineTransform getTransform()
```
    Get the inverse transformation.
    
    Specified by:
    
    getTransform in interface P2DBoundingBoxInterface
    
    Returns:
    the inverse transformation
    See Also:
    getTransform
  - getXTransform
```
public java.awt.geom.AffineTransform getXTransform()
```
    Get the transformation for this boundingbox in x direction. The returned transformation transforms coordinates specified in the scaled box to coordinates in the outer coordinate system.
    
    Specified by:
    
    getXTransform in interface P2DBoundingBoxInterface
    
    Returns:
    the transformation.
  - getYTransform
```
public java.awt.geom.AffineTransform getYTransform()
```
    Get the transformation for this boundingbox in y direction. The returned transformation transforms coordinates specified in the scaled box to coordinates in the outer coordinate system.
    
    Specified by:
    
    getYTransform in interface P2DBoundingBoxInterface
    
    Returns:
    the transformation.
  - inverseTransformPoint
```
public java.awt.geom.Point2D inverseTransformPoint(java.awt.geom.Point2D p)
```
    Transform the point.
    
    Specified by:
    
    inverseTransformPoint in interface P2DBoundingBoxInterface
    
    Parameters:
    p - The point to be transformed to the out coordinate system.
    
    Returns:
    The point in outer system.
  - transformPoint
```
public java.awt.geom.Point2D transformPoint(java.awt.geom.Point2D p)
```
    Transform the point.
    
    Specified by:
    
    transformPoint in interface P2DBoundingBoxInterface
    
    Parameters:
    p - The point to be transformed to the defined coordinate system.
    
    Returns:
    The point in inner system.
  - main
```
public static void main(java.lang.String[] args)
```

Class P2DBoundingBox

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

lower

upper

xFactor

yFactor

xOffset

yOffset

Constructor Detail

P2DBoundingBox

P2DBoundingBox

P2DBoundingBox

P2DBoundingBox

Method Detail

getVersion

release

equals

clone

closestIntersection

getArea

intersects

intersects

intersects

intersects

intersects

contains

contains

getUpper

getLower

getLower

getUpper

setLower

setUpper

getScaledBoundingBox

getScaledUpper

getScaledLower

getScaledUpper

getScaledLower

getWidth

getHeight

getScaledWidth

getScaledHeight

setWidth

setHeight

getRectangle

toString

move

isInside

setScale

setOffset

setXScale

setYScale

getXFactor

getYFactor

getXOffset

getYOffset

getInverseTransform

getTransform

getXTransform

getYTransform

inverseTransformPoint

transformPoint

main