com.sk89q.worldedit.regions

Interface Region

All Superinterfaces:

Cloneable, Iterable<BlockVector>

All Known Subinterfaces:

FlatRegion

All Known Implementing Classes:

AbstractRegion, ConvexPolyhedralRegion, CuboidRegion, CylinderRegion, EllipsoidRegion, Polygonal2DRegion

public interface Region
extends Iterable<BlockVector>, Cloneable

Author:

sk89q

Method Summary

Methods

Modifier and Type	Method and Description
Region	clone()
boolean	contains(Vector pt) Returns true based on whether the region contains the point.
void	contract(Vector... changes) Contract the region.
void	expand(Vector... changes) Expand the region.
int	getArea() Get the number of blocks in the region.
Vector	getCenter() Get the center point of a region.
Set<Vector>	getChunkCubes() Return a list of 16*16*16 chunks in a region
Set<Vector2D>	getChunks() Get a list of chunks.
int	getHeight() Get Y-size.
int	getLength() Get Z-size.
Vector	getMaximumPoint() Get the upper point of a region.
Vector	getMinimumPoint() Get the lower point of a region.
int	getWidth() Get X-size.
LocalWorld	getWorld() Get the world the selection is in
List<BlockVector2D>	polygonize(int maxPoints) Polygonizes a cross-section or a 2D projection of the region orthogonal to the Y axis.
void	setWorld(LocalWorld world) Sets the world the selection is in
void	shift(Vector change) Shift the region.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getMinimumPoint

Vector getMinimumPoint()

Get the lower point of a region.

Returns:

min. point

getMaximumPoint

Vector getMaximumPoint()

Get the upper point of a region.

Returns:

max. point

getCenter

Vector getCenter()

Get the center point of a region. Note: Coordinates will not be integers if the corresponding lengths are even.

Returns:

center point

getArea

int getArea()

Get the number of blocks in the region.

Returns:

number of blocks

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(Vector... changes)
            throws RegionOperationException

Expand the region.

Parameters:

changes - array/arguments with multiple related changes

Throws:

RegionOperationException

contract

void contract(Vector... changes)
              throws RegionOperationException

Contract the region.

Parameters:

changes - array/arguments with multiple related changes

Throws:

RegionOperationException

shift

void shift(Vector change)
           throws RegionOperationException

Shift the region.

Parameters:

change -

Throws:

RegionOperationException

contains

boolean contains(Vector pt)

Returns true based on whether the region contains the point.

Parameters:

pt -

Returns:

getChunks

Set<Vector2D> getChunks()

Get a list of chunks.

Returns:

getChunkCubes

Set<Vector> getChunkCubes()

Return a list of 16*16*16 chunks in a region

Returns:

The chunk cubes this region overlaps with

getWorld

LocalWorld getWorld()

Get the world the selection is in

Returns:

setWorld

void setWorld(LocalWorld world)

Sets the world the selection is in

clone

Region clone()

polygonize

List<BlockVector2D> 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.