Polygonal2DRegion (worldedit-core 7.2.0 API)

java.lang.Object
- com.sk89q.worldedit.regions.AbstractRegion
- - com.sk89q.worldedit.regions.Polygonal2DRegion

All Implemented Interfaces:

FlatRegion, Region, java.lang.Cloneable, java.lang.Iterable<BlockVector3>
```
public class Polygonal2DRegion
extends AbstractRegion
implements FlatRegion
```
Represents a 2D polygonal region.

Field Summary
- Fields inherited from class com.sk89q.worldedit.regions.AbstractRegion
  world

Constructor Summary

Constructors
Constructor and Description
`Polygonal2DRegion()` Construct the region.
`Polygonal2DRegion(Polygonal2DRegion region)` Make a copy of another region.
`Polygonal2DRegion(World world)` Construct the region.
`Polygonal2DRegion(World world, java.util.List<BlockVector2> points, int minY, int maxY)` Construct the region.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPoint(BlockVector2 position)` Add a point to the list.
`void`	`addPoint(BlockVector3 position)` Add a point to the list.
`java.lang.Iterable<BlockVector2>`	`asFlatRegion()` Get this region as an iterable flat region.
`Polygonal2DRegion`	`clone()` Make a clone of the region.
`boolean`	`contains(BlockVector3 position)` Returns true based on whether the region contains the point.
`static boolean`	`contains(java.util.List<BlockVector2> points, int minY, int maxY, BlockVector3 pt)` Checks to see if a point is inside a region.
`void`	`contract(BlockVector3... changes)` Contract the region.
`void`	`expand(BlockVector3... changes)` Expand the region.
`boolean`	`expandY(int y)` Expand the height of the polygon to fit the specified Y.
`int`	`getHeight()` Get Y-size.
`int`	`getLength()` Get Z-size.
`BlockVector3`	`getMaximumPoint()` Get the upper point of a region.
`int`	`getMaximumY()` Gets the maximum Y value.
`BlockVector3`	`getMinimumPoint()` Get the lower point of a region.
`int`	`getMinimumY()` Gets the minimum Y value.
`java.util.List<BlockVector2>`	`getPoints()` Get the list of points.
`long`	`getVolume()` Get the number of blocks in the region.
`int`	`getWidth()` Get X-size.
`java.util.Iterator<BlockVector3>`	`iterator()` Get the iterator.
`java.util.List<BlockVector2>`	`polygonize(int maxPoints)` Polygonizes a cross-section or a 2D projection of the region orthogonal to the Y axis.
`protected void`	`recalculate()` Recalculate the bounding box of this polygonal region.
`void`	`setMaximumY(int y)` Set the maximum Y.
`void`	`setMinimumY(int y)` Set the minimum Y.
`void`	`shift(BlockVector3 change)` Shift the region.
`int`	`size()` Return the number of points.
`java.lang.String`	`toString()` Returns string representation in the format "(x1, z1) - ...

Methods inherited from class com.sk89q.worldedit.regions.AbstractRegion
getCenter, getChunkCubes, getChunks, getWorld, getWorldMaxY, getWorldMinY, setWorld

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

Methods inherited from interface com.sk89q.worldedit.regions.Region
getArea, getBoundingBox, getCenter, getChunkCubes, getChunks, getWorld, setWorld

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Polygonal2DRegion
```
public Polygonal2DRegion()
```
    Construct the region.
  - Polygonal2DRegion
```
public Polygonal2DRegion(World world)
```
    Construct the region.
    
    Parameters:
    
    world - the world
  - Polygonal2DRegion
```
public Polygonal2DRegion(World world,
                         java.util.List<BlockVector2> points,
                         int minY,
                         int maxY)
```
    Construct the region.
    
    Parameters:
    
    world - the world
    
    points - list of points
    
    minY - minimum Y
    
    maxY - maximum Y
  - Polygonal2DRegion
```
public Polygonal2DRegion(Polygonal2DRegion region)
```
    Make a copy of another region.
    
    Parameters:
    
    region - the other region
- Method Detail
  - getPoints
```
public java.util.List<BlockVector2> getPoints()
```
    Get the list of points.
    
    Returns:
    
    a list of points
  - recalculate
```
protected void recalculate()
```
    Recalculate the bounding box of this polygonal region. This should be called after points have been changed.
  - addPoint
```
public void addPoint(BlockVector2 position)
```
    Add a point to the list.
    
    Parameters:
    
    position - the position
  - addPoint
```
public void addPoint(BlockVector3 position)
```
    Add a point to the list.
    
    Parameters:
    
    position - the position
  - getMinimumY
```
public int getMinimumY()
```
    Description copied from interface: FlatRegion
    
    Gets the minimum Y value.
    
    Specified by:
    
    getMinimumY in interface FlatRegion
    
    Returns:
    
    the Y value
  - setMinimumY
```
public void setMinimumY(int y)
```
    Set the minimum Y.
    
    Parameters:
    
    y - the Y
  - getMaximumY
```
public int getMaximumY()
```
    Description copied from interface: FlatRegion
    
    Gets the maximum Y value.
    
    Specified by:
    
    getMaximumY in interface FlatRegion
    
    Returns:
    
    the Y value
  - setMaximumY
```
public void setMaximumY(int y)
```
    Set the maximum Y.
    
    Parameters:
    
    y - the Y
  - getMinimumPoint
```
public BlockVector3 getMinimumPoint()
```
    Description copied from interface: Region
    
    Get the lower point of a region.
    
    Specified by:
    
    getMinimumPoint in interface Region
    
    Returns:
    
    min. point
  - getMaximumPoint
```
public BlockVector3 getMaximumPoint()
```
    Description copied from interface: Region
    
    Get the upper point of a region.
    
    Specified by:
    
    getMaximumPoint in interface Region
    
    Returns:
    
    max. point
  - getVolume
```
public long getVolume()
```
    Description copied from interface: Region
    
    Get the number of blocks in the region.
    
    Specified by:
    
    getVolume in interface Region
    
    Overrides:
    
    getVolume in class AbstractRegion
    
    Returns:
    
    number of blocks
  - getWidth
```
public int getWidth()
```
    Description copied from class: AbstractRegion
    
    Get X-size.
    
    Specified by:
    
    getWidth in interface Region
    
    Overrides:
    
    getWidth in class AbstractRegion
    
    Returns:
    
    width
  - getHeight
```
public int getHeight()
```
    Description copied from class: AbstractRegion
    
    Get Y-size.
    
    Specified by:
    
    getHeight in interface Region
    
    Overrides:
    
    getHeight in class AbstractRegion
    
    Returns:
    
    height
  - getLength
```
public int getLength()
```
    Description copied from class: AbstractRegion
    
    Get Z-size.
    
    Specified by:
    
    getLength in interface Region
    
    Overrides:
    
    getLength in class AbstractRegion
    
    Returns:
    
    length
  - expand
```
public void expand(BlockVector3... changes)
            throws RegionOperationException
```
    Description copied from interface: Region
    
    Expand the region.
    
    Specified by:
    
    expand in interface Region
    
    Parameters:
    
    changes - array/arguments with multiple related changes
    
    Throws:
    
    RegionOperationException - if the operation cannot be performed
  - contract
```
public void contract(BlockVector3... changes)
              throws RegionOperationException
```
    Description copied from interface: Region
    
    Contract the region.
    
    Specified by:
    
    contract in interface Region
    
    Parameters:
    
    changes - array/arguments with multiple related changes
    
    Throws:
    
    RegionOperationException - if the operation cannot be performed
  - shift
```
public void shift(BlockVector3 change)
           throws RegionOperationException
```
    Description copied from interface: Region
    
    Shift the region.
    
    Specified by:
    
    shift in interface Region
    
    Overrides:
    
    shift in class AbstractRegion
    
    Parameters:
    
    change - the change
    
    Throws:
    
    RegionOperationException - if the operation cannot be performed
  - contains
```
public boolean contains(BlockVector3 position)
```
    Description copied from interface: Region
    
    Returns true based on whether the region contains the point.
    
    Specified by:
    
    contains in interface Region
    
    Parameters:
    
    position - the position
    
    Returns:
    
    true if contained
  - contains
```
public static boolean contains(java.util.List<BlockVector2> points,
                               int minY,
                               int maxY,
                               BlockVector3 pt)
```
    Checks to see if a point is inside a region.
    
    Parameters:
    
    points - a list of points
    
    minY - the min Y
    
    maxY - the max Y
    
    pt - the position to check
    
    Returns:
    
    true if the given polygon contains the given point
  - size
```
public int size()
```
    Return the number of points.
    
    Returns:
    
    the number of points
  - expandY
```
public boolean expandY(int y)
```
    Expand the height of the polygon to fit the specified Y.
    
    Parameters:
    
    y - the amount to expand
    
    Returns:
    
    true if the area was expanded
  - iterator
```
public java.util.Iterator<BlockVector3> iterator()
```
    Description copied from class: AbstractRegion
    
    Get the iterator.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<BlockVector3>
    
    Overrides:
    
    iterator in class AbstractRegion
    
    Returns:
    
    iterator of points inside the region
  - asFlatRegion
```
public java.lang.Iterable<BlockVector2> asFlatRegion()
```
    Description copied from interface: FlatRegion
    
    Get this region as an iterable flat region.
    
    Specified by:
    
    asFlatRegion in interface FlatRegion
    
    Returns:
    
    a flat region iterable
  - toString
```
public java.lang.String toString()
```
    Returns string representation in the format "(x1, z1) - ... - (xN, zN) * (minY - maxY)"
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    string
  - clone
```
public Polygonal2DRegion clone()
```
    Description copied from interface: Region
    
    Make a clone of the region.
    
    Specified by:
    
    clone in interface Region
    
    Overrides:
    
    clone in class AbstractRegion
    
    Returns:
    
    a cloned version
  - polygonize
```
public java.util.List<BlockVector2> polygonize(int maxPoints)
```
    Description copied from interface: Region
    
    Polygonizes a cross-section or a 2D projection of the region orthogonal to the Y axis.
    
    Specified by:
    
    polygonize in interface Region
    
    Overrides:
    
    polygonize in class AbstractRegion
    
    Parameters:
    
    maxPoints - maximum number of points to generate. -1 for no limit.
    
    Returns:
    
    the points.

Class Polygonal2DRegion

Field Summary

Fields inherited from class com.sk89q.worldedit.regions.AbstractRegion

Constructor Summary

Method Summary

Methods inherited from class com.sk89q.worldedit.regions.AbstractRegion

Methods inherited from class java.lang.Object

Methods inherited from interface com.sk89q.worldedit.regions.Region

Methods inherited from interface java.lang.Iterable

Constructor Detail

Polygonal2DRegion

Polygonal2DRegion

Polygonal2DRegion

Polygonal2DRegion

Method Detail

getPoints

recalculate

addPoint

addPoint

getMinimumY

setMinimumY

getMaximumY

setMaximumY

getMinimumPoint

getMaximumPoint

getVolume

getWidth

getHeight

getLength

expand

contract

shift

contains

contains

size

expandY

iterator

asFlatRegion

toString

clone

polygonize