com.sk89q.worldedit.regions

Class TransformRegion

java.lang.Object

com.sk89q.worldedit.regions.AbstractRegion

com.sk89q.worldedit.regions.TransformRegion

All Implemented Interfaces:

Region, Cloneable, Iterable<BlockVector>

public class TransformRegion
extends AbstractRegion

Transforms another region according to a provided vector Transform.

See Also:

Transform

Field Summary

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

world

Constructor Summary

Constructors

Constructor and Description
TransformRegion(Region region, Transform transform) Create a new instance.
TransformRegion(World world, Region region, Transform transform) Create a new instance.

Method Summary

Modifier and Type	Method and Description
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.
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.
Vector	getMinimumPoint() Get the lower point of a region.
Region	getRegion() Get the untransformed, base region.
Transform	getTransform() Get the transform that is applied.
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	setTransform(Transform transform) Set the transform that is applied.
void	shift(Vector change) Shift the region.

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

clone, getChunkCubes, getChunks, getWorld, setWorld, setWorld

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TransformRegion

public TransformRegion(Region region,
                       Transform transform)

Create a new instance.

Parameters:

region - the region

transform - the transform

TransformRegion

public TransformRegion(@Nullable
                       World world,
                       Region region,
                       Transform transform)

Create a new instance.

Parameters:

world - the world, which may be null

region - the region

transform - the transform

Method Detail

getRegion

public Region getRegion()

Get the untransformed, base region.

Returns:

the base region

getTransform

public Transform getTransform()

Get the transform that is applied.

Returns:

the transform

setTransform

public void setTransform(Transform transform)

Set the transform that is applied.

Parameters:

transform - the transform

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

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

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

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

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.

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