com.sk89q.worldedit.regions

Class NullRegion

java.lang.Object

com.sk89q.worldedit.regions.NullRegion

All Implemented Interfaces:

Region, Cloneable, Iterable<BlockVector>

public class NullRegion
extends Object
implements Region

A region that contains no points.

Constructor Summary

Constructors

Constructor and Description
NullRegion()

Method Summary

Modifier and Type	Method and Description
NullRegion	clone() Make a clone of the region.
boolean	contains(Vector position) 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.
World	getWorld() Sets the world that the selection is in.
Iterator<BlockVector>	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 java.lang.Iterable

forEach, spliterator

Constructor Detail

NullRegion

public NullRegion()

Method Detail

getMinimumPoint

public Vector getMinimumPoint()

Description copied from interface: Region

Get the lower point of a region.

Specified by:

getMinimumPoint in interface Region

Returns:

min. point

getMaximumPoint

public Vector getMaximumPoint()

Description copied from interface: Region

Get the upper point of a region.

Specified by:

getMaximumPoint in interface Region

Returns:

max. point

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

getArea

public int getArea()

Description copied from interface: Region

Get the number of blocks in the region.

Specified by:

getArea in interface Region

Returns:

number of blocks

getWidth

public int getWidth()

Description copied from interface: Region

Get X-size.

Specified by:

getWidth in interface Region

Returns:

width

getHeight

public int getHeight()

Description copied from interface: Region

Get Y-size.

Specified by:

getHeight in interface Region

Returns:

height

getLength

public int getLength()

Description copied from interface: Region

Get Z-size.

Specified by:

getLength in interface Region

Returns:

length

expand

public void expand(Vector... 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

contract

public void contract(Vector... 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

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

contains

public boolean contains(Vector 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

getChunks

public Set<Vector2D> getChunks()

Description copied from interface: Region

Get a list of chunks.

Specified by:

getChunks in interface Region

Returns:

a list of chunk coordinates

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

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(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

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

clone

public NullRegion 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.

iterator

public Iterator<BlockVector> iterator()

Specified by:

iterator in interface Iterable<BlockVector>