com.sk89q.worldedit.regions

Class EllipsoidRegion

java.lang.Object

com.sk89q.worldedit.regions.AbstractRegion

com.sk89q.worldedit.regions.EllipsoidRegion

All Implemented Interfaces:

Region, Cloneable, Iterable<BlockVector>

public class EllipsoidRegion
extends AbstractRegion

Represents an ellipsoid region.

Field Summary

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

world

Constructor Summary

Constructors

Constructor and Description
EllipsoidRegion(EllipsoidRegion ellipsoidRegion)
EllipsoidRegion(LocalWorld world, Vector center, Vector radius) Deprecated.
EllipsoidRegion(Vector pos1, Vector pos2) Construct a new instance of this ellipsoid region.
EllipsoidRegion(World world, Vector center, Vector radius) Construct a new instance of this ellipsoid region.

Method Summary

Modifier and Type	Method and Description
EllipsoidRegion	clone() Make a clone of the 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.
void	extendRadius(Vector minRadius)
int	getArea() Get the number of blocks in the region.
Vector	getCenter() Get the center.
Set<Vector2D>	getChunks() Get a list of chunks.
int	getHeight() Get Y-size.
int	getLength() Get Z-size.
Vector	getMaximumPoint() Get the upper point of a region.
Vector	getMinimumPoint() Get the lower point of a region.
Vector	getRadius() Get the radii.
int	getWidth() Get X-size.
void	setCenter(Vector center) Set the center.
void	setRadius(Vector radius) Set the radii.
void	shift(Vector change) Shift the region.
String	toString() Returns string representation in the format "(centerX, centerY, centerZ) - (radiusX, radiusY, radiusZ)".

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

getChunkCubes, getWorld, iterator, polygonize, setWorld, setWorld

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

EllipsoidRegion

public EllipsoidRegion(Vector pos1,
                       Vector pos2)

Construct a new instance of this ellipsoid region.

Parameters:

pos1 - the first position

pos2 - the second position

EllipsoidRegion

@Deprecated
public EllipsoidRegion(LocalWorld world,
                                   Vector center,
                                   Vector radius)

Deprecated.

EllipsoidRegion

public EllipsoidRegion(World world,
                       Vector center,
                       Vector radius)

Construct a new instance of this ellipsoid region.

Parameters:

world - the world

center - the center

radius - the radius

EllipsoidRegion

public EllipsoidRegion(EllipsoidRegion ellipsoidRegion)

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

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.

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

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

getCenter

public Vector getCenter()

Get the center.

Specified by:

getCenter in interface Region

Overrides:

getCenter in class AbstractRegion

Returns:

center

setCenter

public void setCenter(Vector center)

Set the center.

Parameters:

center - the center

getRadius

public Vector getRadius()

Get the radii.

Returns:

radii

setRadius

public void setRadius(Vector radius)

Set the radii.

Parameters:

radius - the radius

getChunks

public Set<Vector2D> getChunks()

Description copied from class: AbstractRegion

Get a list of chunks.

Specified by:

getChunks in interface Region

Overrides:

getChunks in class AbstractRegion

Returns:

a set of chunks

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

toString

public String toString()

Returns string representation in the format "(centerX, centerY, centerZ) - (radiusX, radiusY, radiusZ)".

Overrides:

toString in class Object

Returns:

string

extendRadius

public void extendRadius(Vector minRadius)

clone

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