Area (overlap-examples-cli-dist 0.3.5 API)

All Known Implementing Classes:

SimplePane
```
public interface Area
```
A rectangular area.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`int`	`cx()` X coordinate of center.
`int`	`cy()` Y coordinate of center.
`default Area`	`east(int width, int gap)`
`Range`	`horizontal()` Horizontal range.
`default Area`	`north(int height, int gap)`
`static Area`	`of(Range h, Range v)`
`static Area`	`ofPixel(int x, int y)` Create an area representing a single pixel.
`static Area`	`ofPixel(Px2d p)`
`static Area`	`ofRect(int x0, int y0, int sx, int sy)`
`static Area`	`ofRect(Px2d p0, Px2d size)`
`Px2d`	`p0()` Upper left corner.
`Px2d`	`p1()` Lower right corner (inclusive!).
`Px2d`	`pc()` Center point.
`Px2d`	`pLeftCenter()`
`Px2d`	`pLowerCenter()`
`Px2d`	`pLowerLeft()`
`Px2d`	`pLowerRight()`
`Px2d`	`pRightCenter()`
`Px2d`	`pUpperCenter()`
`Px2d`	`pUpperLeft()`
`Px2d`	`pUpperRight()`
`Area`	`shrink(int px)` Shrink.
`Px2d`	`size()` Size.
`default Area`	`south(int height, int gap)`
`int`	`sx()` Horizontal size.
`int`	`sy()` Vertical size.
`Area`	`translate(int x, int y)` Translate.
`Area`	`translate(Px2d v)` Translate.
`Range`	`vertical()` Vertical range.
`default Area`	`west(int width, int gap)`
`int`	`x0()` X coordinate of upper left corner.
`int`	`x1()` X coordinate of lower right corner (inclusive!).
`int`	`y0()` Y coordinate of upper left corner.
`int`	`y1()` Y coordinate of lower right corner (inclusive!).

- Method Detail
  - horizontal
```
Range horizontal()
```
    Horizontal range.
    
    Returns:
    
    represented range
  - vertical
```
Range vertical()
```
    Vertical range.
    
    Returns:
    
    represented range
  - shrink
```
Area shrink(int px)
```
    Shrink.
    
    Parameters:
    
    px - Pixels to shrink on all sizes
    
    Returns:
    
    New instance.
  - translate
```
Area translate(int x,
               int y)
```
    Translate.
    
    Parameters:
    
    x - Horizontal translation
    
    y - Vertical translation
    
    Returns:
    
    New instance
  - translate
```
Area translate(Px2d v)
```
    Translate.
    
    Parameters:
    
    v - Translation vector
    
    Returns:
    
    New instance
  - north
```
default Area north(int height,
                   int gap)
```
  - south
```
default Area south(int height,
                   int gap)
```
  - west
```
default Area west(int width,
                  int gap)
```
  - east
```
default Area east(int width,
                  int gap)
```
  - x0
```
int x0()
```
    X coordinate of upper left corner.
    
    Returns:
    
    coordinate
  - y0
```
int y0()
```
    Y coordinate of upper left corner.
    
    Returns:
    
    coordinate
  - x1
```
int x1()
```
    X coordinate of lower right corner (inclusive!).
    
    Returns:
    
    coordinate
  - y1
```
int y1()
```
    Y coordinate of lower right corner (inclusive!).
    
    Returns:
    
    coordinate
  - sx
```
int sx()
```
    Horizontal size.
    
    Returns:
    
    size
  - sy
```
int sy()
```
    Vertical size.
    
    Returns:
    
    size
  - cx
```
int cx()
```
    X coordinate of center.
    
    Returns:
    
    coordinate
  - cy
```
int cy()
```
    Y coordinate of center.
    
    Returns:
    
    coordinate
  - p0
```
Px2d p0()
```
    Upper left corner.
    
    Returns:
    
    Point
  - p1
```
Px2d p1()
```
    Lower right corner (inclusive!).
    
    Returns:
    
    Point
  - pUpperLeft
```
Px2d pUpperLeft()
```
  - pUpperRight
```
Px2d pUpperRight()
```
  - pLowerLeft
```
Px2d pLowerLeft()
```
  - pLowerRight
```
Px2d pLowerRight()
```
  - pLeftCenter
```
Px2d pLeftCenter()
```
  - pRightCenter
```
Px2d pRightCenter()
```
  - pUpperCenter
```
Px2d pUpperCenter()
```
  - pLowerCenter
```
Px2d pLowerCenter()
```
  - size
```
Px2d size()
```
    Size.
    
    Returns:
    
    Size
  - pc
```
Px2d pc()
```
    Center point.
    
    Returns:
    
    Point
  - ofPixel
```
static Area ofPixel(int x,
                    int y)
```
    Create an area representing a single pixel.
    
    Parameters:
    
    x - Pixel coordinate
    
    y - Pixel coordinate
    
    Returns:
    
    1x1 sized area at the given pixel
  - ofPixel
```
static Area ofPixel(Px2d p)
```
  - ofRect
```
static Area ofRect(int x0,
                   int y0,
                   int sx,
                   int sy)
```
  - ofRect
```
static Area ofRect(Px2d p0,
                   Px2d size)
```
  - of
```
static Area of(Range h,
               Range v)
```

Interface Area

Method Summary

Method Detail

horizontal

vertical

shrink

translate

translate

north

south

west

east

x0

y0

x1

y1

sx

sy

cx

cy

p0

p1

pUpperLeft

pUpperRight

pLowerLeft

pLowerRight

pLeftCenter

pRightCenter

pUpperCenter

pLowerCenter

size

pc

ofPixel

ofPixel

ofRect

ofRect

of