Region (worldedit-core 7.2.0 API)

All Superinterfaces:

java.lang.Cloneable, java.lang.Iterable<BlockVector3>

All Known Subinterfaces:

FlatRegion

All Known Implementing Classes:

AbstractFlatRegion, AbstractRegion, ConvexPolyhedralRegion, CuboidRegion, CylinderRegion, EllipsoidRegion, NullRegion, Polygonal2DRegion, RegionIntersection, RequestSelection, TransformRegion
```
public interface Region
extends java.lang.Iterable<BlockVector3>, java.lang.Cloneable
```
Represents a physical shape.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`Region`	`clone()` Make a clone of the region.
`boolean`	`contains(BlockVector3 position)` Returns true based on whether the region contains the point.
`void`	`contract(BlockVector3... changes)` Contract the region.
`void`	`expand(BlockVector3... changes)` Expand the region.
`default int`	`getArea()` Deprecated. use `getVolume()` to prevent overflows
`default CuboidRegion`	`getBoundingBox()` Get the bounding box of this region as a `CuboidRegion`.
`Vector3`	`getCenter()` Get the center point of a region.
`java.util.Set<BlockVector3>`	`getChunkCubes()` Return a list of 161616 chunks in a region.
`java.util.Set<BlockVector2>`	`getChunks()` Get a list of chunks.
`int`	`getHeight()` Get Y-size.
`int`	`getLength()` Get Z-size.
`BlockVector3`	`getMaximumPoint()` Get the upper point of a region.
`BlockVector3`	`getMinimumPoint()` Get the lower point of a region.
`default long`	`getVolume()` Get the number of blocks in the region.
`int`	`getWidth()` Get X-size.
`World`	`getWorld()` Sets the world that the selection is in.
`java.util.List<BlockVector2>`	`polygonize(int maxPoints)` Polygonizes a cross-section or a 2D projection of the region orthogonal to the Y axis.
`void`	`setWorld(World world)` Sets the world that the selection is in.
`void`	`shift(BlockVector3 change)` Shift the region.

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

- Method Detail
  - getMinimumPoint
```
BlockVector3 getMinimumPoint()
```
    Get the lower point of a region.
    
    Returns:
    
    min. point
  - getMaximumPoint
```
BlockVector3 getMaximumPoint()
```
    Get the upper point of a region.
    
    Returns:
    
    max. point
  - getBoundingBox
```
default CuboidRegion getBoundingBox()
```
    Get the bounding box of this region as a CuboidRegion.
    
    Returns:
    
    the bounding box
  - getCenter
```
Vector3 getCenter()
```
    Get the center point of a region. Note: Coordinates will not be integers if the corresponding lengths are even.
    
    Returns:
    
    center point
  - getArea
```
@Deprecated
default int getArea()
```
    Deprecated. use getVolume() to prevent overflows
    
    Get the number of blocks in the region.
    
    Returns:
    
    number of blocks
  - getVolume
```
@NonAbstractForCompatibility(delegateName="getArea",
                             delegateParams={})
default long getVolume()
```
    Get the number of blocks in the region.
    
    Returns:
    
    number of blocks
    
    API Note:
    
    This must be overridden by new subclasses. See NonAbstractForCompatibility for details
  - getWidth
```
int getWidth()
```
    Get X-size.
    
    Returns:
    
    width
  - getHeight
```
int getHeight()
```
    Get Y-size.
    
    Returns:
    
    height
  - getLength
```
int getLength()
```
    Get Z-size.
    
    Returns:
    
    length
  - expand
```
void expand(BlockVector3... changes)
     throws RegionOperationException
```
    Expand the region.
    
    Parameters:
    
    changes - array/arguments with multiple related changes
    
    Throws:
    
    RegionOperationException - if the operation cannot be performed
  - contract
```
void contract(BlockVector3... changes)
       throws RegionOperationException
```
    Contract the region.
    
    Parameters:
    
    changes - array/arguments with multiple related changes
    
    Throws:
    
    RegionOperationException - if the operation cannot be performed
  - shift
```
void shift(BlockVector3 change)
    throws RegionOperationException
```
    Shift the region.
    
    Parameters:
    
    change - the change
    
    Throws:
    
    RegionOperationException - if the operation cannot be performed
  - contains
```
boolean contains(BlockVector3 position)
```
    Returns true based on whether the region contains the point.
    
    Parameters:
    
    position - the position
    
    Returns:
    
    true if contained
  - getChunks
```
java.util.Set<BlockVector2> getChunks()
```
    Get a list of chunks.
    
    Returns:
    
    a list of chunk coordinates
  - getChunkCubes
```
java.util.Set<BlockVector3> getChunkCubes()
```
    Return a list of 16*16*16 chunks in a region.
    
    Returns:
    
    the chunk cubes this region overlaps with
  - getWorld
```
@Nullable
World getWorld()
```
    Sets the world that the selection is in.
    
    Returns:
    
    the world, or null
  - setWorld
```
void setWorld(@Nullable
              World world)
```
    Sets the world that the selection is in.
    
    Parameters:
    
    world - the world, which may be null
  - clone
```
Region clone()
```
    Make a clone of the region.
    
    Returns:
    
    a cloned version
  - polygonize
```
java.util.List<BlockVector2> polygonize(int maxPoints)
```
    Polygonizes a cross-section or a 2D projection of the region orthogonal to the Y axis.
    
    Parameters:
    
    maxPoints - maximum number of points to generate. -1 for no limit.
    
    Returns:
    
    the points.

Interface Region

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

getMinimumPoint

getMaximumPoint

getBoundingBox

getCenter

getArea

getVolume

getWidth

getHeight

getLength

expand

contract

shift

contains

getChunks

getChunkCubes

getWorld

setWorld

clone

polygonize