Class AbstractRegion

java.lang.Object

java.util.AbstractCollection<BlockVector3>

java.util.AbstractSet<BlockVector3>

com.sk89q.worldedit.regions.AbstractRegion

All Implemented Interfaces:

IBatchProcessor, Region, Cloneable, Iterable<BlockVector3>, Collection<BlockVector3>, Set<BlockVector3>

Direct Known Subclasses:

AbstractFlatRegion, BlockSet, ConvexPolyhedralRegion, CuboidRegion, CylinderRegion, EllipsoidRegion, FuzzyRegion, Polygonal2DRegion, PolyhedralRegion, RegionIntersection, TransformRegion

public abstract class AbstractRegion
extends AbstractSet<BlockVector3>
implements Region

Field Summary

Fields

Modifier and Type	Field	Description
protected World	world

Constructor Summary

Constructors

Constructor	Description
AbstractRegion(World world)

Method Summary

Modifier and Type	Method	Description
AbstractRegion	clone()	Make a clone of the region.
boolean	equals(Object o)
Vector3	getCenter()	Get the center point of a region.
Set<BlockVector3>	getChunkCubes()	Return a list of 16*16*16 chunks in a region.
Set<BlockVector2>	getChunks()	Get a list of chunks.
int	getHeight()	Get Y-size.
int	getLength()	Get Z-size.
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.
protected final int	getWorldMaxY()
protected final int	getWorldMinY()
int	hashCode()
Iterator<BlockVector3>	iterator()	Get the iterator.
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.
int	size()

Methods inherited from class AbstractSet

removeAll

Methods inherited from class AbstractCollection

add, addAll, clear, contains, containsAll, isEmpty, remove, retainAll, toArray, toArray, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface IBatchProcessor

flush, join, joinPost, postProcess, postProcessSet, processGet, processGet, remove, trimNBT, trimNBT, trimY

Methods inherited from interface Iterable

forEach

Methods inherited from interface Region

construct, contains, contains, contains, containsChunk, containsEntireCuboid, contract, expand, filter, filter, filter, filter, filter, getArea, getBoundingBox, getDimensions, getMaximumPoint, getMaximumY, getMinimumPoint, getMinimumY, getScope, isGlobal, processSet, processSet

Methods inherited from interface Set

add, addAll, clear, contains, containsAll, isEmpty, remove, retainAll, spliterator, toArray, toArray

Field Details

world

@Nullable
protected World world

Constructor Details

AbstractRegion

public AbstractRegion(@Nullable
 World world)

Method Details

size

public int size()

Specified by:

size in interface Collection<BlockVector3>

Specified by:

size in interface Set<BlockVector3>

Specified by:

size in class AbstractCollection<BlockVector3>

getCenter

public Vector3 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<BlockVector3> iterator()

Get the iterator.

Specified by:

iterator in interface Collection<BlockVector3>

Specified by:

iterator in interface Iterable<BlockVector3>

Specified by:

iterator in interface Set<BlockVector3>

Specified by:

iterator in class AbstractCollection<BlockVector3>

Returns:

iterator of points inside the region

getWorld

@Nullable
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

shift

public void shift(BlockVector3 change)
           throws RegionOperationException

Description copied from interface: Region

Shift the region.

Specified by:

shift in interface Region

Parameters:

change - the change

Throws:

RegionOperationException - if the operation cannot be performed

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

Parameters:

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

Returns:

the points.

getVolume

public long getVolume()

Description copied from interface: Region

Get the number of blocks in the region.

Specified by:

getVolume 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<BlockVector2> getChunks()

Get a list of chunks.

Specified by:

getChunks in interface Region

Returns:

a set of chunks

getChunkCubes

public Set<BlockVector3> 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

getWorldMinY

protected final int getWorldMinY()

getWorldMaxY

protected final int getWorldMaxY()

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<BlockVector3>

Specified by:

hashCode in interface Set<BlockVector3>

Overrides:

hashCode in class AbstractSet<BlockVector3>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<BlockVector3>

Specified by:

equals in interface Set<BlockVector3>

Overrides:

equals in class AbstractSet<BlockVector3>