Package com.sk89q.worldedit.function.mask

Class RegionMask

java.lang.Object

com.sk89q.worldedit.function.mask.AbstractMask

com.sk89q.worldedit.function.mask.RegionMask

All Implemented Interfaces:

Mask

public class RegionMask
extends AbstractMask

A mask that tests whether given positions are contained within a region.

Constructor Summary

Constructors

Constructor	Description
RegionMask(Region region)	Create a new region mask.

Method Summary

Modifier and Type	Method	Description
Mask	copy()	Returns a copy of the mask.
Region	getRegion()	Get the region.
Mask	optimize()
void	setRegion(Region region)	Set the region that positions must be contained within.
boolean	test(BlockVector3 vector)	Returns true if the criteria is met.
Mask2D	toMask2D()	Get the 2D version of this mask if one exists.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sk89q.worldedit.function.mask.Mask

inverse, replacesAir, toFilter, toFilter, tryCombine, tryOptimize, tryOr

Constructor Details

RegionMask

public RegionMask(Region region)

Create a new region mask.

Parameters:

region - the region

Method Details

getRegion

public Region getRegion()

Get the region.

Returns:

the region

setRegion

public void setRegion(Region region)

Set the region that positions must be contained within.

Parameters:

region - the region

test

public boolean test(BlockVector3 vector)

Description copied from interface: Mask

Returns true if the criteria is met.

Parameters:

vector - the vector to test

Returns:

true if the criteria is met

toMask2D

@Nullable
public Mask2D toMask2D()

Description copied from interface: Mask

Get the 2D version of this mask if one exists.

Returns:

a 2D mask version or null if this mask can't be 2D

copy

public Mask copy()

Description copied from interface: Mask

Returns a copy of the mask. Usually for multi-threaded operation

Returns:

a clone of the mask

optimize

public Mask optimize()