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.

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) Deprecated.
Polygonal2DRegion(LocalWorld world, List<BlockVector2D> points, int minY, int maxY) Deprecated.
Polygonal2DRegion(Polygonal2DRegion region) Make a copy of another region.
Polygonal2DRegion(World world) Construct the region.
Polygonal2DRegion(World world, List<BlockVector2D> points, int minY, int maxY) Construct the region.

Method Summary

Modifier and Type	Method and Description
void	addPoint(BlockVector2D position) Add a point to the list.
void	addPoint(Vector position) Add a point to the list.
void	addPoint(Vector2D position) Add a point to the list.
Iterable<Vector2D>	asFlatRegion() Get this region as an iterable flat region.
Polygonal2DRegion	clone() Make a clone of the region.
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 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.
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() Gets the maximum Y value
Vector	getMinimumPoint() Get the lower point of a region.
int	getMinimumY() Gets the minimum Y value
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, 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, setWorld

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Polygonal2DRegion

public Polygonal2DRegion()

Construct the region

Polygonal2DRegion

@Deprecated
public Polygonal2DRegion(LocalWorld world)

Deprecated.

Polygonal2DRegion

public Polygonal2DRegion(World world)

Construct the region.

Parameters:

world - the world

Polygonal2DRegion

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

Deprecated.

Polygonal2DRegion

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

Construct the region.

Parameters:

world - the world

points - list of points

minY - minimum Y

maxY - maximum Y

Polygonal2DRegion

public Polygonal2DRegion(Polygonal2DRegion region)

Make a copy of another region.

Parameters:

region - the other region

Method Detail

getPoints

public List<BlockVector2D> getPoints()

Get the list of points.

Returns:

a list of points

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

Add a point to the list.

Parameters:

position - the position

addPoint

public void addPoint(BlockVector2D position)

Add a point to the list.

Parameters:

position - the position

addPoint

public void addPoint(Vector position)

Add a point to the list.

Parameters:

position - the position

getMinimumY

public int getMinimumY()

Description copied from interface: FlatRegion

Gets the minimum Y value

Specified by:

getMinimumY in interface FlatRegion

Returns:

the Y value

getMininumY

@Deprecated
public int getMininumY()

Deprecated.

setMinimumY

public void setMinimumY(int y)

Set the minimum Y.

Parameters:

y - the Y

getMaximumY

public int getMaximumY()

Description copied from interface: FlatRegion

Gets the maximum Y value

Specified by:

getMaximumY in interface FlatRegion

Returns:

the Y value

setMaximumY

public void setMaximumY(int y)

Set the maximum Y.

Parameters:

y - the Y

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

getArea

public int getArea()

Description copied from class: AbstractRegion

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

Description copied from class: AbstractRegion

Get X-size.

Specified by:

getWidth in interface Region

Overrides:

getWidth in class AbstractRegion

Returns:

width

getHeight

public int getHeight()

Description copied from class: AbstractRegion

Get Y-size.

Specified by:

getHeight in interface Region

Overrides:

getHeight in class AbstractRegion

Returns:

height

getLength

public int getLength()

Description copied from class: AbstractRegion

Get Z-size.

Specified by:

getLength in interface Region

Overrides:

getLength in class AbstractRegion

Returns:

length

expand

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

Description copied from interface: Region

Expand the region.

Specified by:

expand in interface 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.

Specified by:

contract in interface Region

Parameters:

changes - array/arguments with multiple related 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

Parameters:

change - the change

Throws:

RegionOperationException

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

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 - a list of points

minY - the min Y

maxY - the max Y

pt - the position to check

Returns:

true if the given polygon contains the given point

size

public int size()

Return the number of points.

Returns:

the number of points

expandY

public boolean expandY(int y)

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

Parameters:

y - the amount to expand

Returns:

true if the area was expanded

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

Returns string representation in the format "(x1, z1) - ... - (xN, zN) * (minY - maxY)"

Overrides:

toString in class Object

Returns:

string

clone

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

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.