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

An axis-aligned cuboid. It can be defined using two corners of the cuboid.

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) Deprecated. cast world to World
CuboidRegion(Vector pos1, Vector pos2) Construct a new instance of this cuboid using two corners of the cuboid.
CuboidRegion(World world, Vector pos1, Vector pos2) Construct a new instance of this cuboid using two corners of the cuboid.

Method Summary

Modifier and Type	Method and Description
Iterable<Vector2D>	asFlatRegion() Get this region as an iterable flat region.
CuboidRegion	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.
static CuboidRegion	fromCenter(Vector origin, int apothem) Make a cuboid from the center.
Set<Vector>	getChunkCubes() Return a list of 16*16*16 chunks in a region
Set<Vector2D>	getChunks() Get a list of chunks.
Region	getFaces() Get a region that contains the faces of this cuboid.
Vector	getMaximumPoint() Get the upper point of a region.
int	getMaximumY() Gets the maximum Y value
Vector	getMinimumPoint() Get the lower point of a region.
int	getMinimumY() Gets the minimum Y value
Vector	getPos1() Get the first cuboid-defining corner.
Vector	getPos2() Get the second cuboid-defining corner.
Region	getWalls() Get a region that contains the walls (all faces but the ones parallel to the X-Z plane) of this cuboid.
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 the first cuboid-defining corner.
void	setPos2(Vector pos2) Set the second cuboid-defining corner.
void	shift(Vector change) Shift the region.
String	toString()

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

getArea, getCenter, getHeight, getLength, getWidth, getWorld, polygonize, setWorld, 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, setWorld

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CuboidRegion

public CuboidRegion(Vector pos1,
                    Vector pos2)

Construct a new instance of this cuboid using two corners of the cuboid.

Parameters:

pos1 - the first position

pos2 - the second position

CuboidRegion

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

Deprecated. cast world to World

CuboidRegion

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

Construct a new instance of this cuboid using two corners of the cuboid.

Parameters:

world - the world

pos1 - the first position

pos2 - the second position

Method Detail

getPos1

public Vector getPos1()

Get the first cuboid-defining corner.

Returns:

a position

setPos1

public void setPos1(Vector pos1)

Set the first cuboid-defining corner.

Parameters:

pos1 - a position

getPos2

public Vector getPos2()

Get the second cuboid-defining corner.

Returns:

a position

setPos2

public void setPos2(Vector pos2)

Set the second cuboid-defining corner.

Parameters:

pos2 - a position

getFaces

public Region getFaces()

Get a region that contains the faces of this cuboid.

Returns:

a new complex region

getWalls

public Region getWalls()

Get a region that contains the walls (all faces but the ones parallel to the X-Z plane) of this cuboid.

Returns:

a new complex region

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

getMinimumY

public int getMinimumY()

Description copied from interface: FlatRegion

Gets the minimum Y value

Specified by:

getMinimumY in interface FlatRegion

Returns:

the Y value

getMaximumY

public int getMaximumY()

Description copied from interface: FlatRegion

Gets the maximum Y value

Specified by:

getMaximumY in interface FlatRegion

Returns:

the Y value

expand

public void expand(Vector... changes)

Description copied from interface: Region

Expand the region.

Specified by:

expand in interface Region

Parameters:

changes - array/arguments with multiple related changes

contract

public void contract(Vector... changes)

Description copied from interface: Region

Contract the region.

Specified by:

contract in interface Region

Parameters:

changes - array/arguments with multiple related changes

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

Parameters:

change - the change

Throws:

RegionOperationException

getChunks

public Set<Vector2D> getChunks()

Description copied from class: AbstractRegion

Get a list of chunks.

Specified by:

getChunks in interface Region

Overrides:

getChunks in class AbstractRegion

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

Overrides:

getChunkCubes in class AbstractRegion

Returns:

the chunk cubes this region overlaps with

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

iterator

public Iterator<BlockVector> iterator()

Description copied from class: AbstractRegion

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

Description copied from interface: FlatRegion

Get this region as an iterable flat region.

Specified by:

asFlatRegion in interface FlatRegion

Returns:

a flat region iterable

toString

public String toString()

Overrides:

toString in class Object

clone

public CuboidRegion clone()

Description copied from interface: Region

Make a clone of the region.

Specified by:

clone in interface Region

Overrides:

clone in class AbstractRegion

Returns:

a cloned version

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

fromCenter

public static CuboidRegion fromCenter(Vector origin,
                                      int apothem)

Make a cuboid from the center.

Parameters:

origin - the origin

apothem - the apothem, where 0 is the minimum value to make a 1x1 cuboid

Returns:

a cuboid region