com.sk89q.worldedit.regions

Class Polygonal2DRegion

java.lang.Object

com.sk89q.worldedit.regions.AbstractRegion

com.sk89q.worldedit.regions.Polygonal2DRegion

All Implemented Interfaces:

FlatRegion, Region, Cloneable, Iterable<BlockVector>

public class Polygonal2DRegion
extends AbstractRegion
implements FlatRegion

Represents a 2D polygonal region.

Author:

sk89q

Field Summary

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

world

Constructor Summary

Constructors

Constructor and Description
Polygonal2DRegion() Construct the region
Polygonal2DRegion(LocalWorld world) Construct the region.
Polygonal2DRegion(LocalWorld world, List<BlockVector2D> points, int minY, int maxY) Construct the region.
Polygonal2DRegion(Polygonal2DRegion region)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPoint(BlockVector2D pt) Add a point to the list.
void	addPoint(Vector pt) Add a point to the list.
void	addPoint(Vector2D pt) Add a point to the list.
Iterable<Vector2D>	asFlatRegion()
Polygonal2DRegion	clone()
static boolean	contains(List<BlockVector2D> points, int minY, int maxY, Vector pt) Checks to see if a point is inside a region.
boolean	contains(Vector pt) Checks to see if a point is inside this region.
void	contract(Vector... changes) Contract the region.
void	expand(Vector... changes) Expand the region.
boolean	expandY(int y) Expand the height of the polygon to fit the specified Y.
int	getArea() Get the number of blocks in the region.
int	getHeight() Get Y-size.
int	getLength() Get Z-size.
Vector	getMaximumPoint() Get the upper point of a region.
int	getMaximumY() Get the maximum Y.
Vector	getMinimumPoint() Get the lower point of a region.
int	getMinimumY() Get the minimum Y.
int	getMininumY() Deprecated.
List<BlockVector2D>	getPoints() Get the list of points.
int	getWidth() Get X-size.
Iterator<BlockVector>	iterator() Get the iterator.
List<BlockVector2D>	polygonize(int maxPoints) Polygonizes a cross-section or a 2D projection of the region orthogonal to the Y axis.
protected void	recalculate() Recalculate the bounding box of this polygonal region.
void	setMaximumY(int y) Set the maximum Y.
void	setMinimumY(int y) Set the minimum Y.
void	shift(Vector change) Shift the region.
int	size() Return the number of points.
String	toString() Returns string representation in the format "(x1, z1) - ...

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

getCenter, getChunkCubes, getChunks, getWorld, 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

getCenter, getChunkCubes, getChunks, getWorld, setWorld

Constructor Detail

Polygonal2DRegion

public Polygonal2DRegion()

Construct the region

Polygonal2DRegion

public Polygonal2DRegion(LocalWorld world)

Construct the region.

Parameters:

world -

Polygonal2DRegion

public Polygonal2DRegion(LocalWorld world,
                 List<BlockVector2D> points,
                 int minY,
                 int maxY)

Construct the region.

Parameters:

world -

points -

minY -

maxY -

Polygonal2DRegion

public Polygonal2DRegion(Polygonal2DRegion region)

Method Detail

getPoints

public List<BlockVector2D> getPoints()

Get the list of points.

Returns:

recalculate

protected void recalculate()

Recalculate the bounding box of this polygonal region. This should be called after points have been changed.

addPoint

public void addPoint(Vector2D pt)

Add a point to the list.

Parameters:

pt -

addPoint

public void addPoint(BlockVector2D pt)

Add a point to the list.

Parameters:

pt -

addPoint

public void addPoint(Vector pt)

Add a point to the list.

Parameters:

pt -

getMinimumY

public int getMinimumY()

Get the minimum Y.

Specified by:

getMinimumY in interface FlatRegion

Returns:

min y

getMininumY

@Deprecated
public int getMininumY()

Deprecated.

setMinimumY

public void setMinimumY(int y)

Set the minimum Y.

Parameters:

y -

getMaximumY

public int getMaximumY()

Get the maximum Y.

Specified by:

getMaximumY in interface FlatRegion

Returns:

max y

setMaximumY

public void setMaximumY(int y)

Set the maximum Y.

Parameters:

y -

getMinimumPoint

public Vector getMinimumPoint()

Get the lower point of a region.

Specified by:

getMinimumPoint in interface Region

Returns:

min. point

getMaximumPoint

public Vector getMaximumPoint()

Get the upper point of a region.

Specified by:

getMaximumPoint in interface Region

Returns:

max. point

getArea

public int getArea()

Get the number of blocks in the region.

Specified by:

getArea in interface Region

Overrides:

getArea in class AbstractRegion

Returns:

number of blocks

getWidth

public int getWidth()

Get X-size.

Specified by:

getWidth in interface Region

Overrides:

getWidth in class AbstractRegion

Returns:

width

getHeight

public int getHeight()

Get Y-size.

Specified by:

getHeight in interface Region

Overrides:

getHeight in class AbstractRegion

Returns:

height

getLength

public int getLength()

Get Z-size.

Specified by:

getLength in interface Region

Overrides:

getLength in class AbstractRegion

Returns:

length

expand

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

Expand the region.

Specified by:

expand in interface Region

Parameters:

changes -

Throws:

RegionOperationException

contract

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

Contract the region.

Specified by:

contract in interface Region

Parameters:

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

Overrides:

shift in class AbstractRegion

Throws:

RegionOperationException

contains

public boolean contains(Vector pt)

Checks to see if a point is inside this region.

Specified by:

contains in interface Region

Returns:

contains

public static boolean contains(List<BlockVector2D> points,
               int minY,
               int maxY,
               Vector pt)

Checks to see if a point is inside a region.

Parameters:

points -

minY -

maxY -

pt -

Returns:

size

public int size()

Return the number of points.

Returns:

expandY

public boolean expandY(int y)

Expand the height of the polygon to fit the specified Y.

Parameters:

y -

Returns:

true if the area was expanded

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 "(x1, z1) - ... - (xN, zN) * (minY - maxY)"

Overrides:

toString in class Object

Returns:

string

clone

public Polygonal2DRegion clone()

Specified by:

clone in interface Region

Overrides:

clone in class AbstractRegion

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

Overrides:

polygonize in class AbstractRegion

Parameters:

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

Returns:

the points.