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.

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) Deprecated. cast world to World
CylinderRegion(LocalWorld world, Vector center, Vector2D radius, int minY, int maxY) Deprecated.
CylinderRegion(Vector center, Vector2D radius, int minY, int maxY) Construct the region.
CylinderRegion(World world) Construct the region.
CylinderRegion(World world, Vector center, Vector2D radius, int minY, int maxY) Construct the region.

Method Summary

Modifier and Type	Method and Description
Iterable<Vector2D>	asFlatRegion() Get this region as an iterable flat region.
CylinderRegion	clone() Make a clone of the region.
boolean	contains(Vector position) Checks to see if a point is inside this region.
void	contract(Vector... changes) Contract the region.
static CylinderRegion	createRadius(Extent extent, Vector center, double radius) Return a new instance with the given center and radius in the X and Z axes with a Y that extends from the bottom of the extent to the top of the extent.
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() Get the center point of a 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
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, 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, setWorld

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CylinderRegion

public CylinderRegion()

Construct the region

CylinderRegion

@Deprecated
public CylinderRegion(LocalWorld world)

Deprecated. cast world to World

CylinderRegion

public CylinderRegion(World world)

Construct the region.

Parameters:

world - the world

CylinderRegion

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

Deprecated.

CylinderRegion

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

Construct the region.

Parameters:

world - the world

center - the center position

radius - the radius along the X and Z axes

minY - the minimum Y, inclusive

maxY - the maximum Y, inclusive

CylinderRegion

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

Construct the region.

Parameters:

center - the center position

radius - the radius along the X and Z axes

minY - the minimum Y, inclusive

maxY - the maximum Y, inclusive

CylinderRegion

public CylinderRegion(CylinderRegion region)

Method Detail

getCenter

public Vector getCenter()

Description copied from interface: Region

Get the center point of a region. Note: Coordinates will not be integers if the corresponding lengths are even.

Specified by:

getCenter in interface Region

Overrides:

getCenter in class AbstractRegion

Returns:

center point

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 - the center point

getRadius

public Vector2D getRadius()

Returns the radius of the cylinder

Returns:

the radius along the X and Z axes

setRadius

public void setRadius(Vector2D radius)

Sets the radius of the cylinder

Parameters:

radius - the radius along the X and Z axes

extendRadius

public void extendRadius(Vector2D minRadius)

Extends the radius to be at least the given radius

Parameters:

minRadius - the minimum radius

setMinimumY

public void setMinimumY(int y)

Set the minimum Y.

Parameters:

y - the y

setMaximumY

public void setMaximumY(int y)

Se 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

getMaximumY

public int getMaximumY()

Description copied from interface: FlatRegion

Gets the maximum Y value

Specified by:

getMaximumY in interface FlatRegion

Returns:

the Y value

getMinimumY

public int getMinimumY()

Description copied from interface: FlatRegion

Gets the minimum Y value

Specified by:

getMinimumY in interface FlatRegion

Returns:

the Y value

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

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

Parameters:

change - the change

Throws:

RegionOperationException

contains

public boolean contains(Vector position)

Checks to see if a point is inside this region.

Specified by:

contains in interface Region

Parameters:

position - the position

Returns:

true if contained

setY

public boolean setY(int y)

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

Parameters:

y - the y value

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 "(centerX, centerZ) - (radiusX, radiusZ) - (minY, maxY)"

Overrides:

toString in class Object

Returns:

string

clone

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

createRadius

public static CylinderRegion createRadius(Extent extent,
                                          Vector center,
                                          double radius)

Return a new instance with the given center and radius in the X and Z axes with a Y that extends from the bottom of the extent to the top of the extent.

Parameters:

extent - the extent

center - the center position

radius - the radius in the X and Z axes

Returns:

a region