com.sk89q.worldedit.regions

Class AbstractRegion

java.lang.Object

com.sk89q.worldedit.regions.AbstractRegion

All Implemented Interfaces:

Region, Cloneable, Iterable<BlockVector>

Direct Known Subclasses:

ConvexPolyhedralRegion, CuboidRegion, CylinderRegion, EllipsoidRegion, Polygonal2DRegion, RegionIntersection, TransformRegion

public abstract class AbstractRegion
extends Object
implements Region

Field Summary

Fields

Modifier and Type	Field and Description
protected World	world

Constructor Summary

Constructors

Constructor and Description
AbstractRegion(World world)

Method Summary

Modifier and Type	Method and Description
AbstractRegion	clone() Make a clone of 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.
int	getWidth() Get X-size.
World	getWorld() Sets the world that the selection is in.
Iterator<BlockVector>	iterator() Get the iterator.
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 that the selection is in.
void	setWorld(World world) Sets the world that the selection is in.
void	shift(Vector change) Shift the region.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

contains, contract, expand, getMaximumPoint, getMinimumPoint

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

world

protected World world

Constructor Detail

AbstractRegion

public AbstractRegion(World world)

Method Detail

getCenter

public Vector getCenter()

Description copied from interface: Region

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

Specified by:

getCenter in interface Region

Returns:

center point

iterator

public Iterator<BlockVector> iterator()

Get the iterator.

Specified by:

iterator in interface Iterable<BlockVector>

Returns:

iterator of points inside the region

getWorld

public World getWorld()

Description copied from interface: Region

Sets the world that the selection is in.

Specified by:

getWorld in interface Region

Returns:

the world, or null

setWorld

public void setWorld(LocalWorld world)

Description copied from interface: Region

Sets the world that the selection is in.

Specified by:

setWorld in interface Region

Parameters:

world - the world, which may be null

setWorld

public void setWorld(World world)

Description copied from interface: Region

Sets the world that the selection is in.

Specified by:

setWorld in interface Region

Parameters:

world - the world, which may be null

shift

public void shift(Vector change)
           throws RegionOperationException

Description copied from interface: Region

Shift the region.

Specified by:

shift in interface Region

Parameters:

change - the change

Throws:

RegionOperationException

clone

public AbstractRegion clone()

Description copied from interface: Region

Make a clone of the region.

Specified by:

clone in interface Region

Overrides:

clone in class Object

Returns:

a cloned version

polygonize

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

Parameters:

maxPoints - maximum number of points to generate. -1 for no limit.

Returns:

the points.

getArea

public int getArea()

Get the number of blocks in the region.

Specified by:

getArea in interface Region

Returns:

number of blocks

getWidth

public int getWidth()

Get X-size.

Specified by:

getWidth in interface Region

Returns:

width

getHeight

public int getHeight()

Get Y-size.

Specified by:

getHeight in interface Region

Returns:

height

getLength

public int getLength()

Get Z-size.

Specified by:

getLength in interface Region

Returns:

length

getChunks

public Set<Vector2D> getChunks()

Get a list of chunks.

Specified by:

getChunks in interface Region

Returns:

a set of chunks

getChunkCubes

public Set<Vector> getChunkCubes()

Description copied from interface: Region

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

Specified by:

getChunkCubes in interface Region

Returns:

the chunk cubes this region overlaps with