com.sk89q.worldedit.regions

Class CylinderRegion

java.lang.Object

com.sk89q.worldedit.regions.AbstractRegion

com.sk89q.worldedit.regions.CylinderRegion

All Implemented Interfaces:

FlatRegion, Region, Cloneable, Iterable<BlockVector>

public class CylinderRegion
extends AbstractRegion
implements FlatRegion

Represents a cylindrical region.

Author:

yetanotherx

Field Summary

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

world

Constructor Summary

Constructors

Constructor and Description
CylinderRegion() Construct the region
CylinderRegion(CylinderRegion region)
CylinderRegion(LocalWorld world) Construct the region.
CylinderRegion(LocalWorld world, Vector center, Vector2D radius, int minY, int maxY) Construct the region.

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<Vector2D>	asFlatRegion()
CylinderRegion	clone()
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.
void	extendRadius(Vector2D minRadius) Extends the radius to be at least the given radius
int	getArea() Get the number of blocks in the region.
Vector	getCenter() Returns the main center point of the cylinder
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
Vector2D	getRadius() Returns the radius of the cylinder
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.
void	setCenter(Vector center) Deprecated. replaced by setCenter(Vector2D)
void	setCenter(Vector2D center) Sets the main center point of the region
void	setMaximumY(int y) Se the maximum Y.
void	setMinimumY(int y) Set the minimum Y.
void	setRadius(Vector2D radius) Sets the radius of the cylinder
boolean	setY(int y) Sets the height of the cylinder to fit the specified Y.
void	shift(Vector change) Shift the region.
String	toString() Returns string representation in the format "(centerX, centerZ) - (radiusX, radiusZ) - (minY, maxY)"

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

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

getChunkCubes, getChunks, getWorld, setWorld

Constructor Detail

CylinderRegion

public CylinderRegion()

Construct the region

CylinderRegion

public CylinderRegion(LocalWorld world)

Construct the region.

Parameters:

world -

CylinderRegion

public CylinderRegion(LocalWorld world,
              Vector center,
              Vector2D radius,
              int minY,
              int maxY)

Construct the region.

Parameters:

world -

center -

radius -

minY -

maxY -

CylinderRegion

public CylinderRegion(CylinderRegion region)

Method Detail

getCenter

public Vector getCenter()

Returns the main center point of the cylinder

Specified by:

getCenter in interface Region

Overrides:

getCenter in class AbstractRegion

Returns:

setCenter

@Deprecated
public void setCenter(Vector center)

Deprecated. replaced by setCenter(Vector2D)

Sets the main center point of the region

setCenter

public void setCenter(Vector2D center)

Sets the main center point of the region

Parameters:

center -

getRadius

public Vector2D getRadius()

Returns the radius of the cylinder

Returns:

setRadius

public void setRadius(Vector2D radius)

Sets the radius of the cylinder

Parameters:

radius -

extendRadius

public void extendRadius(Vector2D minRadius)

Extends the radius to be at least the given radius

Parameters:

minRadius -

setMinimumY

public void setMinimumY(int y)

Set the minimum Y.

Parameters:

y -

setMaximumY

public void setMaximumY(int y)

Se 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

getMaximumY

public int getMaximumY()

Gets the maximum Y value

Specified by:

getMaximumY in interface FlatRegion

Returns:

getMinimumY

public int getMinimumY()

Gets the minimum Y value

Specified by:

getMinimumY in interface FlatRegion

Returns:

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

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

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:

setY

public boolean setY(int y)

Sets the height of the cylinder to fit the specified Y.

Parameters:

y -

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

Specified by:

asFlatRegion in interface FlatRegion

toString

public String toString()

Returns string representation in the format "(centerX, centerZ) - (radiusX, radiusZ) - (minY, maxY)"

Overrides:

toString in class Object

Returns:

string

clone

public CylinderRegion 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.