com.sk89q.worldedit.regions

Class CuboidRegion

java.lang.Object

com.sk89q.worldedit.regions.AbstractRegion

com.sk89q.worldedit.regions.CuboidRegion

All Implemented Interfaces:

FlatRegion, Region, Cloneable, Iterable<BlockVector>

public class CuboidRegion
extends AbstractRegion
implements FlatRegion

Author:

sk89q

Field Summary

Fields inherited from class com.sk89q.worldedit.regions.AbstractRegion

world

Constructor Summary

Constructors

Constructor and Description
CuboidRegion(LocalWorld world, Vector pos1, Vector pos2) Construct a new instance of this cuboid region.
CuboidRegion(Vector pos1, Vector pos2) Construct a new instance of this cuboid region.

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<Vector2D>	asFlatRegion()
CuboidRegion	clone()
boolean	contains(Vector pt) Returns true based on whether the region contains the point,
void	contract(Vector... changes) Contracts the cuboid in a direction.
void	expand(Vector... changes) Expands the cuboid in a direction.
Set<Vector>	getChunkCubes() Return a list of 16*16*16 chunks in a region
Set<Vector2D>	getChunks() Get a list of chunks that this region is within.
Vector	getMaximumPoint() Get the upper point of the cuboid.
int	getMaximumY() Gets the maximum Y value
Vector	getMinimumPoint() Get the lower point of the cuboid.
int	getMinimumY() Gets the minimum Y value
Vector	getPos1() Get position 1.
Vector	getPos2() Get position 2.
Iterator<BlockVector>	iterator() Get the iterator.
static CuboidRegion	makeCuboid(Region region) Make a cuboid region out of the given region using the minimum and maximum bounds of the provided region.
void	setPos1(Vector pos1) Set position 1.
void	setPos2(Vector pos2) Set position 2.
void	shift(Vector change) Shift the region.
String	toString() Returns string representation in the format "(minX, minY, minZ) - (maxX, maxY, maxZ)".

Methods inherited from class com.sk89q.worldedit.regions.AbstractRegion

getArea, getCenter, getHeight, getLength, getWidth, getWorld, polygonize, setWorld

Methods inherited from class java.lang.Object

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

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

getArea, getCenter, getHeight, getLength, getWidth, getWorld, polygonize, setWorld

Constructor Detail

CuboidRegion

public CuboidRegion(Vector pos1,
            Vector pos2)

Construct a new instance of this cuboid region.

Parameters:

pos1 -

pos2 -

CuboidRegion

public CuboidRegion(LocalWorld world,
            Vector pos1,
            Vector pos2)

Construct a new instance of this cuboid region.

Parameters:

world -

pos1 -

pos2 -

Method Detail

getMinimumPoint

public Vector getMinimumPoint()

Get the lower point of the cuboid.

Specified by:

getMinimumPoint in interface Region

Returns:

min point

getMaximumPoint

public Vector getMaximumPoint()

Get the upper point of the cuboid.

Specified by:

getMaximumPoint in interface Region

Returns:

max point

getMinimumY

public int getMinimumY()

Description copied from interface: FlatRegion

Gets the minimum Y value

Specified by:

getMinimumY in interface FlatRegion

Returns:

getMaximumY

public int getMaximumY()

Description copied from interface: FlatRegion

Gets the maximum Y value

Specified by:

getMaximumY in interface FlatRegion

Returns:

expand

public void expand(Vector... changes)

Expands the cuboid in a direction.

Specified by:

expand in interface Region

Parameters:

change -

contract

public void contract(Vector... changes)

Contracts the cuboid in a direction.

Specified by:

contract in interface Region

Parameters:

change -

shift

public void shift(Vector change)
           throws RegionOperationException

Description copied from interface: Region

Shift the region.

Specified by:

shift in interface Region

Overrides:

shift in class AbstractRegion

Throws:

RegionOperationException

getPos1

public Vector getPos1()

Get position 1.

Returns:

position 1

setPos1

public void setPos1(Vector pos1)

Set position 1.

Parameters:

pos1 -

getPos2

public Vector getPos2()

Get position 2.

Returns:

position 2

setPos2

public void setPos2(Vector pos2)

Set position 2.

Parameters:

pos2 -

getChunks

public Set<Vector2D> getChunks()

Get a list of chunks that this region is within.

Specified by:

getChunks in interface Region

Overrides:

getChunks in class AbstractRegion

Returns:

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

Overrides:

getChunkCubes in class AbstractRegion

Returns:

The chunk cubes this region overlaps with

contains

public boolean contains(Vector pt)

Returns true based on whether the region contains the point,

Specified by:

contains in interface Region

Parameters:

pt -

Returns:

iterator

public Iterator<BlockVector> iterator()

Get the iterator.

Specified by:

iterator in interface Iterable<BlockVector>

Overrides:

iterator in class AbstractRegion

Returns:

iterator of points inside the region

asFlatRegion

public Iterable<Vector2D> asFlatRegion()

Specified by:

asFlatRegion in interface FlatRegion

toString

public String toString()

Returns string representation in the format "(minX, minY, minZ) - (maxX, maxY, maxZ)".

Overrides:

toString in class Object

Returns:

string

clone

public CuboidRegion clone()

Specified by:

clone in interface Region

Overrides:

clone in class AbstractRegion

makeCuboid

public static CuboidRegion makeCuboid(Region region)

Make a cuboid region out of the given region using the minimum and maximum bounds of the provided region.

Parameters:

region - the region

Returns:

a new cuboid region