P2DBoundingBoxInterface

All Superinterfaces:

FwkInterface, java.io.Serializable

All Known Implementing Classes:

P2DBoundingBox
```
public interface P2DBoundingBoxInterface
extends FwkInterface
```
The P2DBoundingBoxInterface defines the basic functionality of a bounding box.

Since:

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

Version:

$Revision: 1.12 $

Author:

Andreas Hofmann

Method Summary

Methods
Modifier and Type	Method and Description
`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
`double`	`getArea()` Returns the square of the enclosed area.
`double`	`getHeight()` Retrieves the height of the box.
`java.awt.geom.AffineTransform`	`getInverseTransform()` Get the inverse transformation.
`java.awt.geom.Point2D`	`getLower()` Get 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 transformation for this boundingbox.
`java.awt.geom.Point2D`	`getUpper()` Get the upper vector.
`void`	`getUpper(java.awt.geom.Point2D upper)` Get the upper vector.
`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
`java.awt.geom.Point2D`	`inverseTransformPoint(java.awt.geom.Point2D p)` Transform the point.
`boolean`	`isInside(P2DBoundingBoxInterface box)` Checks whether the given box is inside this one.
`void`	`move(double xDiff, double yDiff)` Move the box.
`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.awt.geom.Point2D`	`transformPoint(java.awt.geom.Point2D p)` Transform the point.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface
getVersion, release

- Method Detail
  - closestIntersection
```
P2DBoundingBoxInterface closestIntersection(P2DBoundingBoxInterface[] bounds)
```
    Finds closest bounding object which intersects this bounding box
    
    Parameters:
    boundsObjects - is an array of bounds objects
    
    Returns:
    closest bounding object
  - intersects
```
boolean intersects(P2DBoundingBoxInterface bounds)
```
    Test for intersection with another bounds object
  - intersects
```
boolean intersects(P2DBoundingBoxInterface[] bounds)
```
    Test for intersection with an array of bounds objects
    
    Returns:
    true or false indicating if an intersection occurred
  - intersects
```
boolean intersects(P2DBoundingBoxInterface[] bounds,
                 P2DBoundingBoxInterface newBoundBox)
```
    Test for intersection with an array of bounds objects
    
    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
```
boolean intersects(P2DBoundingBoxInterface bounds,
                 P2DBoundingBoxInterface newBoundBox)
```
    Test for intersection with another bounding box
    
    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
  - contains
```
boolean contains(java.awt.geom.Point2D p)
```
    Test for intersection with a point
  - contains
```
boolean contains(P2DBoundingBoxInterface box)
```
    Checks whether the complete bounding box is inside this one.
  - getLower
```
void getLower(java.awt.geom.Point2D lower)
```
    Get the lower vector.
    
    Parameters:
    lower - The vector that receives the lower value.
  - getUpper
```
java.awt.geom.Point2D getUpper()
```
    Get the upper vector.
    
    Returns:
    The upper value.
  - getLower
```
java.awt.geom.Point2D getLower()
```
    Get the lower vector.
    
    Returns:
    The lower value.
  - getScaledBoundingBox
```
P2DBoundingBoxInterface getScaledBoundingBox()
```
    Get the scaled bounding box.
    
    Returns:
    the scaled box.
  - getScaledUpper
```
java.awt.geom.Point2D getScaledUpper()
```
    Get the upper scaled vector.
    
    Returns:
    The upper value.
  - getScaledLower
```
java.awt.geom.Point2D getScaledLower()
```
    Get the lower scaled vector.
    
    Returns:
    The lower value.
  - getScaledUpper
```
void getScaledUpper(java.awt.geom.Point2D upper)
```
    Get the upper scaled vector.
    
    Parameters:
    The - upper value.
  - getScaledLower
```
void getScaledLower(java.awt.geom.Point2D lower)
```
    Get the lower scaled vector.
  - getUpper
```
void getUpper(java.awt.geom.Point2D upper)
```
    Get the upper vector.
    
    Parameters:
    upper - The vector that receives the upper value.
  - setLower
```
void setLower(java.awt.geom.Point2D lower)
```
    Set the lower vector.
    
    Parameters:
    lower - The vector that will be the new lower value.
  - setUpper
```
void setUpper(java.awt.geom.Point2D upper)
```
    Set the upper vector.
    
    Parameters:
    upper - The vector that will be the new upper value.
  - getArea
```
double getArea()
```
    Returns the square of the enclosed area.
    
    Returns:
    the square of the enclosed area.
  - getWidth
```
double getWidth()
```
    Retrieves the width of the box.
    
    Returns:
    The width
  - getHeight
```
double getHeight()
```
    Retrieves the height of the box.
    
    Returns:
    The height
  - getScaledWidth
```
double getScaledWidth()
```
    Retrieves the scaled width of the box.
    
    Returns:
    The width
  - getScaledHeight
```
double getScaledHeight()
```
    Retrieves the scaled height of the box.
    
    Returns:
    The height
  - setWidth
```
void setWidth(double width)
```
    Set the width of the box.
    
    Parameters:
    width - The width
  - setHeight
```
void setHeight(double height)
```
    Set the height of the box.
    
    Parameters:
    height - The height
  - getRectangle
```
java.awt.geom.Rectangle2D getRectangle()
```
    Retrieves the rectanlge defined by this box.
    
    Returns:
    The defined rectanlge.
  - move
```
void move(double xDiff,
        double yDiff)
```
    Move the box.
    
    Parameters:
    xDiff - the movement in x.
    yDiff - the movement in y.
  - isInside
```
boolean isInside(P2DBoundingBoxInterface box)
```
    Checks whether the given box is inside this one.
  - setScale
```
void setScale(double xFactor,
            double yFactor)
```
    Scale the bounding box to the given values.
    
    Parameters:
    xFactor - the scaling in x.
    yFactor - The scaling in y.
  - setOffset
```
void setOffset(double xOffset,
             double yOffset)
```
    Scale the bounding box to the given values.
    
    Parameters:
    xOffset - the offset in x.
    yOffset - The offset in y.
  - setXScale
```
void setXScale(double offset,
             double scale)
```
    Scale the bounding box in X direction.
    
    Parameters:
    offset - the offset in x.
    scale - the scaling in x.
  - setYScale
```
void setYScale(double offset,
             double scale)
```
    Scale the bounding box in Y direction.
    
    Parameters:
    offset - the offset in y.
    scale - the scaling in y.
  - getXFactor
```
double getXFactor()
```
    Get the scale of the bounding box in X direction.
    
    Returns:
    the scaling in x.
  - getYFactor
```
double getYFactor()
```
    Get the scale of the bounding box in Y direction.
    
    Returns:
    the scaling in y.
  - getXOffset
```
double getXOffset()
```
    Get the offset of the bounding box in X direction.
    
    Returns:
    the offset in x.
  - getYOffset
```
double getYOffset()
```
    Get the offset of the bounding box in Y direction.
    
    Returns:
    the offset in y.
  - getTransform
```
java.awt.geom.AffineTransform getTransform()
```
    Get the transformation for this boundingbox. The returned transformation transforms coordinates specified in the scaled box to coordinates in the outer coordinate system.
    
    Returns:
    the transformation.
  - getXTransform
```
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.
    
    Returns:
    the transformation.
  - getYTransform
```
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.
    
    Returns:
    the transformation.
  - getInverseTransform
```
java.awt.geom.AffineTransform getInverseTransform()
```
    Get the inverse transformation.
    
    Returns:
    the inverse transformation
    See Also:
    getTransform
  - transformPoint
```
java.awt.geom.Point2D transformPoint(java.awt.geom.Point2D p)
```
    Transform the point.
    
    Parameters:
    p - The point to be transformed to the out coordinate system.
    
    Returns:
    The point in outer system.
  - inverseTransformPoint
```
java.awt.geom.Point2D inverseTransformPoint(java.awt.geom.Point2D p)
```
    Transform the point.
    
    Parameters:
    p - The point to be transformed to the defined coordinate system.
    
    Returns:
    The point in inner system.

Interface P2DBoundingBoxInterface

Method Summary

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

Method Detail

closestIntersection

intersects

intersects

intersects

intersects

contains

contains

getLower

getUpper

getLower

getScaledBoundingBox

getScaledUpper

getScaledLower

getScaledUpper

getScaledLower

getUpper

setLower

setUpper

getArea

getWidth

getHeight

getScaledWidth

getScaledHeight

setWidth

setHeight

getRectangle

move

isInside

setScale

setOffset

setXScale

setYScale

getXFactor

getYFactor

getXOffset

getYOffset

getTransform

getXTransform

getYTransform

getInverseTransform

transformPoint

inverseTransformPoint