com.sk89q.worldedit.regions

Class RegionIntersection

java.lang.Object

com.sk89q.worldedit.regions.AbstractRegion

com.sk89q.worldedit.regions.RegionIntersection

All Implemented Interfaces:

Region, Cloneable, Iterable<BlockVector>

public class RegionIntersection
extends AbstractRegion

An intersection of several other regions. Any location that is contained in one of the child regions is considered as contained by this region.

iterator() returns a special iterator that will iterate through the iterators of each region in an undefined sequence. Some positions may be repeated if the position is contained in more than one region, but this cannot be guaranteed to occur.

Field Summary

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

world

Constructor Summary

Constructors

Constructor and Description
RegionIntersection(List<Region> regions) Create a new instance with the included list of regions.
RegionIntersection(LocalWorld world, List<Region> regions) Create a new instance with the included list of regions.
RegionIntersection(LocalWorld world, Region... regions) Create a new instance with the included list of regions.
RegionIntersection(Region... regions) Create a new instance with the included list of regions.

Method Summary

Modifier and Type	Method and Description
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.
Vector	getMaximumPoint() Get the upper point of a region.
Vector	getMinimumPoint() Get the lower point of a region.
Iterator<BlockVector>	iterator() Get the iterator.

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

clone, getArea, getCenter, getChunkCubes, getChunks, getHeight, getLength, getWidth, getWorld, polygonize, setWorld, setWorld, shift

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

RegionIntersection

public RegionIntersection(List<Region> regions)

Create a new instance with the included list of regions.

Parameters:

regions - a list of regions, which is copied

RegionIntersection

public RegionIntersection(Region... regions)

Create a new instance with the included list of regions.

Parameters:

regions - a list of regions, which is copied

RegionIntersection

public RegionIntersection(LocalWorld world,
                          List<Region> regions)

Create a new instance with the included list of regions.

Parameters:

world - the world

regions - a list of regions, which is copied

RegionIntersection

public RegionIntersection(LocalWorld world,
                          Region... regions)

Create a new instance with the included list of regions.

Parameters:

world - the world

regions - an array of regions, which is copied

Method Detail

getMinimumPoint

public Vector getMinimumPoint()

Description copied from interface: Region

Get the lower point of a region.

Returns:

min. point

getMaximumPoint

public Vector getMaximumPoint()

Description copied from interface: Region

Get the upper point of a region.

Returns:

max. point

expand

public void expand(Vector... changes)
            throws RegionOperationException

Description copied from interface: Region

Expand the 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.

Parameters:

changes - array/arguments with multiple related changes

Throws:

RegionOperationException

contains

public boolean contains(Vector position)

Description copied from interface: Region

Returns true based on whether the region contains the point.

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